Merge pull request #6674 from ORCID/StopSendingGAAnaliticsEventsFromAPIs

Add properties values to enable/disable sending GA events from the APIs

Author: Camelia-Orcid

orcid-api-web/src/main/java/org/orcid/api/filters/AnalyticsFilter.java

@@ -11,16 +11,24 @@
 import org.orcid.core.manager.ProfileEntityCacheManager;
 import org.orcid.core.manager.impl.OrcidUrlManager;
 import org.orcid.core.utils.OrcidRequestUtil;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
+import org.springframework.stereotype.Component;
 
 import com.sun.jersey.api.core.InjectParam;
 import com.sun.jersey.spi.container.ContainerRequest;
 import com.sun.jersey.spi.container.ContainerResponse;
 import com.sun.jersey.spi.container.ContainerResponseFilter;
 
 @Provider
-public class AnalyticsFilter implements ContainerResponseFilter {
+@Component
+public class AnalyticsFilter implements ContainerResponseFilter, InitializingBean {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(AnalyticsFilter.class);
+    
     @InjectParam("orcidSecurityManager")
     private OrcidSecurityManager orcidSecurityManager;
 
@@ -39,10 +47,15 @@ public class AnalyticsFilter implements ContainerResponseFilter {
     @Context
     private HttpServletRequest httpServletRequest;
 
+    @Value("${org.orcid.mapi.enableAnalytics:false}")
+    private boolean enableMemberAPIAnalytics;
+    
     @Override
     public ContainerResponse filter(ContainerRequest request, ContainerResponse response) {
-        AnalyticsProcess analyticsProcess = getAnalyticsProcess(request, response);
-        apiAnalyticsTaskExecutor.execute(analyticsProcess);
+        if (enableMemberAPIAnalytics) {
+            AnalyticsProcess analyticsProcess = getAnalyticsProcess(request, response);
+            apiAnalyticsTaskExecutor.execute(analyticsProcess);
+        }
         return response;
     }
 
@@ -60,4 +73,8 @@ private AnalyticsProcess getAnalyticsProcess(ContainerRequest request, Container
         return process;
     }
 
+    @Override
+    public void afterPropertiesSet() throws Exception {
+        LOGGER.info("Is Members Api Analytics filter enabled? " + enableMemberAPIAnalytics);
+    }
 }

orcid-api-web/src/main/resources/orcid-api-web-context.xml

@@ -9,7 +9,7 @@
 
     <import resource="classpath*:orcid-core-context.xml"/>
 
-    <context:component-scan base-package="org.orcid.api.common, org.orcid.api.member.common, org.orcid.core.security"/>
+    <context:component-scan base-package="org.orcid.api.common, org.orcid.api.member.common, org.orcid.core.security, org.orcid.api.filters"/>
     <aop:aspectj-autoproxy />
 
     <bean id="beanConfig" class="io.swagger.jaxrs.config.BeanConfig">

orcid-pub-web/src/main/java/org/orcid/api/filters/AnalyticsFilter.java

@@ -11,16 +11,24 @@
 import org.orcid.core.manager.ProfileEntityCacheManager;
 import org.orcid.core.manager.impl.OrcidUrlManager;
 import org.orcid.core.utils.OrcidRequestUtil;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.InitializingBean;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor;
+import org.springframework.stereotype.Component;
 
 import com.sun.jersey.api.core.InjectParam;
 import com.sun.jersey.spi.container.ContainerRequest;
 import com.sun.jersey.spi.container.ContainerResponse;
 import com.sun.jersey.spi.container.ContainerResponseFilter;
 
 @Provider
-public class AnalyticsFilter implements ContainerResponseFilter {
+@Component
+public class AnalyticsFilter implements ContainerResponseFilter, InitializingBean {
 
+    private static final Logger LOGGER = LoggerFactory.getLogger(AnalyticsFilter.class);
+    
     @InjectParam("orcidSecurityManager")
     private OrcidSecurityManager orcidSecurityManager;
 
@@ -39,10 +47,15 @@ public class AnalyticsFilter implements ContainerResponseFilter {
     @Context
     private HttpServletRequest httpServletRequest;
 
+    @Value("${org.orcid.papi.enableAnalytics:false}")
+    private boolean enablePublicAPIAnalytics;
+    
     @Override
     public ContainerResponse filter(ContainerRequest request, ContainerResponse response) {
-        AnalyticsProcess analyticsProcess = getAnalyticsProcess(request, response);
-        apiAnalyticsTaskExecutor.execute(analyticsProcess);
+        if (enablePublicAPIAnalytics) {
+            AnalyticsProcess analyticsProcess = getAnalyticsProcess(request, response);
+            apiAnalyticsTaskExecutor.execute(analyticsProcess);
+        }
         return response;
     }
 
@@ -60,4 +73,9 @@ private AnalyticsProcess getAnalyticsProcess(ContainerRequest request, Container
         return process;
     }
 
+    @Override
+    public void afterPropertiesSet() throws Exception {
+        LOGGER.info("Is Public Api Analytics filter enabled? " + enablePublicAPIAnalytics);
+    }
+
 }

orcid-pub-web/src/main/resources/orcid-t1-web-context.xml

@@ -12,7 +12,7 @@
     <import resource="orcid-core-context.xml"/>
     <import resource="statistics-core-context.xml"/>
 
-    <context:component-scan base-package="org.orcid.api.common, org.orcid.api.t1, org.orcid.api.common, org.orcid.core.security"/>
+    <context:component-scan base-package="org.orcid.api.common, org.orcid.api.t1, org.orcid.api.common, org.orcid.core.security, org.orcid.api.filters"/>
     <aop:aspectj-autoproxy />
     <task:annotation-driven />