Merge pull request #169 from exadel-inc/feature/EB-168

[EB-168] remove the usages of Guava library

Author: liubou-masiuk

README.md

@@ -13,12 +13,14 @@ When you select e.g. a page for inclusion into package, all the assets reference
 
 ### Project structure
 
-The project consists of two modules: 
+The project is organized as a multi-module Maven build:
 
-* *core module* runs in an AEM instance containing to respond to user commands and provide data processing service.
-* *ui/application module* embeds into AEM administering interface and runs in browser to give to the user control over package creation and storage, as well as detailed feedback. This module is built upon the modern Coral 3 graphic interface and TouchUI-ready.
+* `core` — the server-side OSGi bundle. It contains the Java code that implements BackPack services, request processing, package handling logic, and tests.
+* `ui.apps` — the AEM application package. It contains the repository content installed under the application area, including the UI assets and browser-facing integration.
+* `ui.apps.structure` — the repository structure package. It defines the AEM repository roots required by the application packages.
+* `ui.config` — the AEM configuration package. It contains configuration content packaged separately from the application code.
+* `all` — the aggregate container package. It embeds the `core`, `ui.apps`, and `ui.config` artifacts into a single package for deployment.
 
-The two modules communicate via JSON-based REST protocol. Basically, a user command is sent to an endpoint, parsed and processed by a specially designed AEM service, then result and/or status message returned to user.
 
 ### Installation
 
@@ -57,10 +59,6 @@ There is also the specific "test" profile that helps to collect code quality sta
 
 The project is in active development stage. Community contribution is heartily welcome.
 
-### Known issues
-
-The project uses `com.google.common.cache.Cache` bundled in `uber-jar-6.3.0` which is in "beta" status. Despite this class is out of beta stage in standalone Google Guava releases since *20.0*, we are currently sticking to *uber-jar* version to avoid inconsistency. We have tested this doesn't cause trouble in regular usage.
-
 ### Licensing
 
-The project is licensed under [Apache License, Version 2.0](LICENSE). All runtime project dependencies are guaranteed to be compliant with the license. Dependencies such as Adobe's *uber-jar* are considered *provided* in the end-user environment and are not explicitly engaged. The end user is to comply with the regulations of the corresponding licenses. 
+The project is licensed under [Apache License, Version 2.0](LICENSE). All runtime project dependencies are guaranteed to be compliant with the license. Dependencies such as Adobe's *uber-jar* are considered *provided* in the end-user environment and are not explicitly engaged. The end user is to comply with the regulations of the corresponding licenses.

core/pom.xml

@@ -50,8 +50,7 @@
                 </executions>
                 <configuration>
                     <instructions>
-                        <Embed-Dependency>commons-lang3;scope=compile,guava;scope=compile</Embed-Dependency>
-                        <Import-Package>sun.misc;resolution:=optional,*</Import-Package>
+                        <Embed-Dependency>commons-lang3;scope=compile</Embed-Dependency>
                     </instructions>
                 </configuration>
             </plugin>
@@ -174,10 +173,6 @@
             <groupId>com.google.code.gson</groupId>
             <artifactId>gson</artifactId>
         </dependency>
-        <dependency>
-            <groupId>com.google.guava</groupId>
-            <artifactId>guava</artifactId>
-        </dependency>
         <!-- Testing -->
         <dependency>
             <groupId>junit</groupId>

core/src/main/java/com/exadel/etoolbox/backpack/core/model/PackageEntriesDatasource.java

@@ -11,7 +11,6 @@
 import com.exadel.etoolbox.backpack.core.servlets.model.PackageInfoModel;
 import com.exadel.etoolbox.backpack.request.RequestAdapter;
 import com.exadel.etoolbox.backpack.request.validator.ValidatorResponse;
-import com.google.common.collect.ImmutableMap;
 import org.apache.sling.api.SlingHttpServletRequest;
 import org.apache.sling.api.resource.Resource;
 import org.apache.sling.api.resource.ValueMap;
@@ -110,7 +109,7 @@ private Resource createPackageEntry(String type, String title, Map<String, Objec
     private void addSubsidiaries(List<Resource> subsidiaries, Set<String> subsidiaryPaths, String type) {
         if (!subsidiaryPaths.isEmpty()) {
             subsidiaries.addAll(subsidiaryPaths.stream()
-                    .map(path -> createPackageEntry(type, path, ImmutableMap.of("upstream", path)))
+                    .map(path -> createPackageEntry(type, path, Collections.singletonMap("upstream", path)))
                     .collect(Collectors.toList()));
         }
     }

core/src/main/java/com/exadel/etoolbox/backpack/core/services/pckg/BasePackageService.java

@@ -25,8 +25,6 @@
 import javax.jcr.RepositoryException;
 import javax.jcr.Session;
 import java.util.Collection;
-import java.util.concurrent.ConcurrentMap;
-
 /**
  * Represents a service running in an AEM instance responsible for base operation with package
  */
@@ -83,7 +81,6 @@ public interface BasePackageService {
      * @param jcrPackageDefinition {@code JcrPackageDefinition} Definition of the package to update
      * @param userSession          Current user {@code Session} as adapted from the acting {@code ResourceResolver}
      * @param packageInfo          {@code PackageInfo} object to store status information in
-     * @param paths                {@code List} of {@code PathModel} will be stored in package metadata information and used in future package modifications
      * @param filter               {@code DefaultWorkspaceFilter} instance representing resource selection mechanism for the package
      */
     void setPackageInfo(JcrPackageDefinition jcrPackageDefinition,
@@ -125,13 +122,11 @@ boolean isPackageExist(JcrPackageManager packageMgr,
                            String version) throws RepositoryException;
 
     /**
-     * Gets current {@link PackageInfo} objects cache
+     * Gets current {@link PackageInfo} objects cache via a narrow cache-specific API
      *
-     * @return {@code Cache<String, PackageInfo>} object
+     * @return {@link PackageInfoCache} object
      */
-    @SuppressWarnings("UnstableApiUsage")
-    // sticking to Guava Cache version bundled in uber-jar; still safe to use
-    ConcurrentMap<String, PackageInfo> getPackageCacheAsMap();
+    PackageInfoCache getPackageCache();
 
     /**
      * @param resourceResolver {@code ResourceResolver} used to collect assets details

core/src/main/java/com/exadel/etoolbox/backpack/core/services/pckg/PackageInfoCache.java

@@ -0,0 +1,18 @@
+package com.exadel.etoolbox.backpack.core.services.pckg;
+
+import com.exadel.etoolbox.backpack.core.dto.response.PackageInfo;
+
+/**
+ * Narrow cache-facing API for storing and retrieving package build information.
+ */
+public interface PackageInfoCache {
+
+    PackageInfo get(String packagePath);
+
+    PackageInfo put(String packagePath, PackageInfo packageInfo);
+
+    PackageInfo remove(String packagePath);
+
+    void clear();
+}
+

core/src/main/java/com/exadel/etoolbox/backpack/core/services/pckg/impl/BasePackageServiceImpl.java

@@ -18,10 +18,9 @@
 import com.exadel.etoolbox.backpack.core.dto.response.PackageInfo;
 import com.exadel.etoolbox.backpack.core.dto.response.PackageStatus;
 import com.exadel.etoolbox.backpack.core.services.pckg.BasePackageService;
+import com.exadel.etoolbox.backpack.core.services.pckg.PackageInfoCache;
 import com.exadel.etoolbox.backpack.core.services.util.constants.BackpackConstants;
 import com.exadel.etoolbox.backpack.core.servlets.model.PackageModel;
-import com.google.common.cache.Cache;
-import com.google.common.cache.CacheBuilder;
 import com.google.gson.Gson;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.exception.ExceptionUtils;
@@ -53,7 +52,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.concurrent.ConcurrentMap;
 import java.util.concurrent.TimeUnit;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
@@ -78,10 +76,8 @@ public class BasePackageServiceImpl implements BasePackageService {
     private SlingRepository slingRepository;
 
 
-    @SuppressWarnings("UnstableApiUsage") // sticking to Guava Cache version bundled in uber-jar; still safe to use
-    protected Cache<String, PackageInfo> packageInfos;
-
     protected boolean enableStackTrace;
+    private PackageInfoCache packageCache;
 
     /**
      * Run upon this OSGi service activation to initialize cache storage of collected {@link PackageInfo} objects
@@ -92,10 +88,8 @@ public class BasePackageServiceImpl implements BasePackageService {
     @SuppressWarnings("unused") // run internally by the OSGi mechanism
     private void activate(Configuration config) {
         enableStackTrace = config.enableStackTraceShowing();
-        packageInfos = CacheBuilder.newBuilder()
-                .maximumSize(100)
-                .expireAfterWrite(config.buildInfoTTL(), TimeUnit.DAYS)
-                .build();
+        long cacheTtlMillis = TimeUnit.DAYS.toMillis(config.buildInfoTTL());
+        packageCache = new PackageInfoCacheImpl(cacheTtlMillis);
     }
 
     @Override
@@ -110,7 +104,8 @@ public boolean isEnableStackTrace() {
     @interface Configuration {
         @AttributeDefinition(
                 name = "Package Build Info TTL",
-                description = "Specify TTL for package build information cache (in days).",
+                description = "Specify TTL for package build information cache (in days). " +
+                        "A negative value means that the cache is indefinite, 0 means that the cache is disabled.",
                 type = AttributeType.INTEGER
         )
         int buildInfoTTL() default 1;
@@ -297,11 +292,9 @@ public long getAssetSize(ResourceResolver resourceResolver, String path) {
     /**
      * {@inheritDoc}
      */
-    @SuppressWarnings("UnstableApiUsage")
-    // sticking to Guava Cache version bundled in uber-jar; still safe to use
     @Override
-    public ConcurrentMap<String, PackageInfo> getPackageCacheAsMap() {
-        return packageInfos.asMap();
+    public PackageInfoCache getPackageCache() {
+        return packageCache;
     }
 
     @Override
@@ -371,6 +364,6 @@ private String getPackageId(final String packageGroupName, final String packageN
     }
 
     private void clearCache(String key) {
-        getPackageCacheAsMap().remove(key);
+        getPackageCache().remove(key);
     }
 }

core/src/main/java/com/exadel/etoolbox/backpack/core/services/pckg/impl/BuildPackageServiceImpl.java

@@ -22,8 +22,8 @@
 import com.exadel.etoolbox.backpack.core.services.util.SessionService;
 import com.exadel.etoolbox.backpack.core.services.util.constants.BackpackConstants;
 import com.exadel.etoolbox.backpack.core.servlets.model.BuildPackageModel;
-import com.google.common.reflect.TypeToken;
 import com.google.gson.Gson;
+import com.google.gson.reflect.TypeToken;
 import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.time.StopWatch;
 import org.apache.jackrabbit.vault.fs.api.PathFilterSet;
@@ -57,7 +57,6 @@
  */
 @Component(service = BuildPackageService.class)
 public class BuildPackageServiceImpl implements BuildPackageService {
-    private static final String SERVICE_NAME = "backpack-service";
 
     private static final Logger LOGGER = LoggerFactory.getLogger(BuildPackageServiceImpl.class);
 
@@ -197,7 +196,7 @@ public PackageInfo buildPackage(final ResourceResolver resourceResolver,
         if (!PackageStatus.BUILD_IN_PROGRESS.equals(packageInfo.getPackageStatus()) && !PackageStatus.INSTALL_IN_PROGRESS.equals(packageInfo.getPackageStatus())) {
             packageInfo.setPackageStatus(PackageStatus.BUILD_IN_PROGRESS);
             packageInfo.clearLog();
-            basePackageService.getPackageCacheAsMap().put(requestInfo.getPackagePath(), packageInfo);
+            basePackageService.getPackageCache().put(requestInfo.getPackagePath(), packageInfo);
             buildPackageAsync(resourceResolver.getUserID(), packageInfo, requestInfo.getReferencedResources());
         }
 

core/src/main/java/com/exadel/etoolbox/backpack/core/services/pckg/impl/CreatePackageServiceImpl.java

@@ -55,7 +55,7 @@ public PackageInfo createPackage(ResourceResolver resourceResolver, PackageModel
         createPackage(session, packageInfo, basePackageService.buildWorkspaceFilter(packageInfo.getPaths()));
 
         if (PackageStatus.CREATED.equals(packageInfo.getPackageStatus())) {
-            basePackageService.getPackageCacheAsMap().put(packageInfo.getPackagePath(), packageInfo);
+            basePackageService.getPackageCache().put(packageInfo.getPackagePath(), packageInfo);
         }
 
         return packageInfo;

core/src/main/java/com/exadel/etoolbox/backpack/core/services/pckg/impl/EditPackageServiceImpl.java

@@ -81,8 +81,8 @@ public PackageInfo editPackage(final ResourceResolver resourceResolver, final Pa
         modifyPackage(session, modificationPackageModel.getPackagePath(), packageInfo, basePackageService.buildWorkspaceFilter(packageInfo.getPaths()));
 
         if (PackageStatus.MODIFIED.equals(packageInfo.getPackageStatus())) {
-            basePackageService.getPackageCacheAsMap().remove(modificationPackageModel.getPackagePath());
-            basePackageService.getPackageCacheAsMap().put(packageInfo.getPackagePath(), packageInfo);
+            basePackageService.getPackageCache().remove(modificationPackageModel.getPackagePath());
+            basePackageService.getPackageCache().put(packageInfo.getPackagePath(), packageInfo);
         }
 
         return packageInfo;

core/src/main/java/com/exadel/etoolbox/backpack/core/services/pckg/impl/InstallPackageServiceImpl.java

@@ -60,7 +60,7 @@ public PackageInfo installPackage(ResourceResolver resourceResolver, InstallPack
             packageInfo.clearLog();
             packageInfo.addLogMessage(START_INSTALL_MESSAGE + packageInfo.getPackagePath());
             packageInfo.addLogMessage(LocalDateTime.now().format(BackpackConstants.DATE_TIME_FORMATTER));
-            basePackageService.getPackageCacheAsMap().put(installPackageModel.getPackagePath(), packageInfo);
+            basePackageService.getPackageCache().put(installPackageModel.getPackagePath(), packageInfo);
             installPackageAsync(resourceResolver.getUserID(), installPackageModel, packageInfo);
         }
         return packageInfo;