Merge pull request #2059 from sswguo/npm_folo_fix

Fix the tracking path of npm metadata

Author: sswguo

addons/folo/common/src/main/java/org/commonjava/indy/folo/change/FoloTrackingListener.java

@@ -51,6 +51,7 @@
 import java.net.MalformedURLException;
 import java.util.Map;
 
+import static org.commonjava.indy.folo.ctl.FoloConstants.ORIGIN_PATH;
 import static org.commonjava.indy.model.core.StoreType.group;
 
 @ApplicationScoped
@@ -112,15 +113,17 @@ public void onFileAccess( @Observes final FileAccessEvent event )
                 return;
             }
 
-            logger.trace( "Tracking report: {} += {} in {} (DOWNLOAD)", trackingKey, transfer.getPath(),
+            final String trackingPath = metadata.get( ORIGIN_PATH ) == null ? transfer.getPath() : (String)metadata.get( ORIGIN_PATH );
+
+            logger.trace( "Tracking report: {} += {} in {} (DOWNLOAD)", trackingKey, trackingPath,
                           keyedLocation.getKey() );
 
             //Here we need to think about npm metadata retrieving case. As almost all npm metadata retrieving is through
             // /$pkg from remote, but we use STORAGE_PATH in EventMetadata with /$pkg/package.json to store this metadata,
             //so the real path for this transfer should be /$pkg but its current path is /$pkg/package.json. We need to
             //think about if need to do the replacement here, especially for the originalUrl.
             recordManager.recordArtifact(
-                    createEntry( trackingKey, keyedLocation.getKey(), accessChannel, transfer.getPath(),
+                    createEntry( trackingKey, keyedLocation.getKey(), accessChannel, trackingPath,
                                  StoreEffect.DOWNLOAD, event.getEventMetadata() ) );
         }
         catch ( final FoloContentException | IndyWorkflowException e )

addons/folo/common/src/main/java/org/commonjava/indy/folo/ctl/FoloConstants.java

@@ -26,6 +26,8 @@ public class FoloConstants
 
     public static final String LEGACY = "legacy";
 
+    public static final String ORIGIN_PATH = "origin-path";
+
     public enum TRACKING_TYPE
     {
         IN_PROGRESS("in_progress"),

addons/folo/ftests/src/main/java/org/commonjava/indy/folo/ftest/content/GroupMetadataExcludedFromTrackingReportTest.java

@@ -31,11 +31,12 @@
 import static org.hamcrest.CoreMatchers.notNullValue;
 import static org.junit.Assert.assertThat;
 
+// Ignore this since group metadata had been enabled in the tracking on production via track.group.content=true
 public class GroupMetadataExcludedFromTrackingReportTest
     extends AbstractFoloContentManagementTest
 {
 
-    @Test
+    //@Test
     public void run()
         throws Exception
     {

addons/folo/ftests/src/main/java/org/commonjava/indy/folo/ftest/content/VerifyTrackedEntriesForNPMTest.java

@@ -0,0 +1,95 @@
+/**
+ * Copyright (C) 2011-2020 Red Hat, Inc. (https://github.com/Commonjava/indy)
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.commonjava.indy.folo.ftest.content;
+
+import org.commonjava.indy.folo.client.IndyFoloAdminClientModule;
+import org.commonjava.indy.folo.client.IndyFoloContentClientModule;
+import org.commonjava.indy.folo.dto.TrackedContentDTO;
+import org.commonjava.indy.folo.dto.TrackedContentEntryDTO;
+import org.commonjava.indy.model.core.StoreKey;
+import org.junit.Test;
+
+import java.io.ByteArrayInputStream;
+import java.util.Set;
+
+import static org.commonjava.indy.model.core.StoreType.remote;
+import static org.commonjava.indy.model.core.StoreType.group;
+import static org.commonjava.indy.pkg.npm.model.NPMPackageTypeDescriptor.NPM_PKG_KEY;
+import static org.hamcrest.CoreMatchers.equalTo;
+import static org.hamcrest.CoreMatchers.notNullValue;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertThat;
+
+/**
+ * <b>GIVEN:</b>
+ * <ul>
+ *     <li>Repository(remote or group) for npm and path</li>
+ * </ul>
+ *
+ * <br/>
+ * <b>WHEN:</b>
+ * <ul>
+ *     <li>Access path through folo track</li>
+ * </ul>
+ *
+ * <br/>
+ * <b>THEN:</b>
+ * <ul>
+ *     <li>The path can be tracked correctly</li>
+ * </ul>
+ */
+public class VerifyTrackedEntriesForNPMTest
+        extends AbstractNPMFoloContentManagementTest
+{
+
+    @Test
+    public void verifyTrackedEntryForStore() throws Exception
+    {
+
+        final String packageContent =
+                "{\"name\": \"jquery\",\n" + "\"description\": \"JavaScript library for DOM operations\",\n" + "\"license\": \"MIT\"}";
+
+        final String packagePath = "jquery";
+
+        final String trackingId = newName();
+
+        npmjsServer.expect( npmjsServer.formatUrl( packagePath ), 200, new ByteArrayInputStream( packageContent.getBytes() ) );
+
+        IndyFoloContentClientModule folo = client.module( IndyFoloContentClientModule.class );
+
+        final StoreKey storeKey = new StoreKey( NPM_PKG_KEY, group, PUBLIC );
+
+        folo.get( trackingId, storeKey,  packagePath );
+
+        IndyFoloAdminClientModule adminModule = client.module( IndyFoloAdminClientModule.class );
+        boolean success = adminModule.sealTrackingRecord( trackingId );
+        assertThat( success, equalTo( true ) );
+
+        // check report
+        final TrackedContentDTO report = adminModule.getTrackingReport( trackingId );
+        assertThat( report, notNullValue() );
+
+        final Set<TrackedContentEntryDTO> downloads = report.getDownloads();
+        assertThat( downloads, notNullValue() );
+        assertThat( downloads.size(), equalTo( 1 ) );
+
+        downloads.stream().forEach( trackedContentEntryDTO -> {
+            assertEquals("/jquery", trackedContentEntryDTO.getPath());
+        });
+
+    }
+
+}

addons/folo/jaxrs/src/main/java/org/commonjava/indy/folo/bind/jaxrs/FoloNPMContentAccessResource.java

@@ -48,9 +48,8 @@
 import java.nio.file.Paths;
 
 import static org.commonjava.indy.IndyContentConstants.CHECK_CACHE_ONLY;
+import static org.commonjava.indy.folo.ctl.FoloConstants.*;
 import static org.commonjava.indy.util.RequestContextHelper.CONTENT_TRACKING_ID;
-import static org.commonjava.indy.folo.ctl.FoloConstants.ACCESS_CHANNEL;
-import static org.commonjava.indy.folo.ctl.FoloConstants.TRACKING_KEY;
 import static org.commonjava.indy.pkg.PackageTypeConstants.PKG_TYPE_NPM;
 import static org.commonjava.indy.pkg.npm.model.NPMPackageTypeDescriptor.NPM_PKG_KEY;
 import static org.commonjava.maven.galley.spi.cache.CacheProvider.STORE_HTTP_HEADERS;
@@ -199,7 +198,8 @@ public Response doGet( @ApiParam( "User-assigned tracking session key" ) @PathPa
         final String baseUri = getBasePath( uriInfo, id );
 
         EventMetadata metadata = new EventMetadata().set( TRACKING_KEY, tk )
-                                                    .set( ACCESS_CHANNEL, AccessChannel.NATIVE );
+                                                    .set( ACCESS_CHANNEL, AccessChannel.NATIVE )
+                                                    .set( ORIGIN_PATH, packageName );
 
         RequestContextHelper.setContext( CONTENT_TRACKING_ID, id );
 

ftests/common/src/main/java/org/commonjava/indy/ftest/core/AbstractIndyFunctionalTest.java

@@ -305,7 +305,7 @@ protected void initBaseTestConfig( CoreServerFixture fixture )
                         + "store.storage=infinispan\n"
                         + "schedule.storage=infinispan");
 
-        writeConfigFile( "conf.d/folo.conf", "[folo]\nfolo.cassandra=true"+ "\nfolo.cassandra.keyspace=folo");
+        writeConfigFile( "conf.d/folo.conf", "[folo]\nfolo.cassandra=true"+ "\nfolo.cassandra.keyspace=folo" + "\ntrack.group.content=True");
 
         if ( isSchedulerEnabled() )
         {