[JN-1533] mixpanel integration tab (#1322)

broadinstitute · Dec 10, 2024 · 5680da0 · 5680da0
1 parent d092110
commit 5680da0
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 6 deletions.
diff --git a/api-admin/src/main/java/bio/terra/pearl/api/admin/service/ConfigExtService.java b/api-admin/src/main/java/bio/terra/pearl/api/admin/service/ConfigExtService.java
@@ -7,6 +7,7 @@
 import bio.terra.pearl.core.service.address.AddressValidationConfig;
 import bio.terra.pearl.core.service.export.integration.AirtableExporter;
 import bio.terra.pearl.core.service.kit.pepper.LivePepperDSMClient;
+import bio.terra.pearl.core.service.logging.MixpanelService;
 import bio.terra.pearl.core.shared.ApplicationRoutingPaths;
 import java.util.Map;
 import org.apache.commons.lang3.StringUtils;
@@ -21,18 +22,21 @@ public class ConfigExtService {
   private final LivePepperDSMClient.PepperDSMConfig pepperDSMConfig;
   private final AddressValidationConfig addressValidationConfig;
   private final AirtableExporter.AirtableConfig airtableConfig;
+  private final MixpanelService.MixpanelConfig mixpanelConfig;
 
   public ConfigExtService(
       B2CConfiguration b2CConfiguration,
       ApplicationRoutingPaths applicationRoutingPaths,
       LivePepperDSMClient.PepperDSMConfig pepperDSMConfig,
       AddressValidationConfig addressValidationConfig,
-      AirtableExporter.AirtableConfig airtableConfig) {
+      AirtableExporter.AirtableConfig airtableConfig,
+      MixpanelService.MixpanelConfig mixpanelConfig) {
     this.b2CConfiguration = b2CConfiguration;
     this.pepperDSMConfig = pepperDSMConfig;
     this.applicationRoutingPaths = applicationRoutingPaths;
     this.addressValidationConfig = addressValidationConfig;
     this.airtableConfig = airtableConfig;
+    this.mixpanelConfig = mixpanelConfig;
 
     configMap = buildConfigMap();
   }
@@ -85,7 +89,11 @@ private Map<String, String> buildConfigMap() {
                 "smartyAuthId", addressValidationConfig.getAuthId(),
                 "smartyAuthToken", maskSecret(addressValidationConfig.getAuthToken())),
             "airtable",
-            Map.of("authToken", maskSecret(airtableConfig.getAuthToken())));
+            Map.of("authToken", maskSecret(airtableConfig.getAuthToken())),
+            "mixpanel",
+            Map.of(
+                "enabled", mixpanelConfig.getEnabled(),
+                "token", mixpanelConfig.getToken()));
     return internalConfigMap;
   }
 

diff --git a/api-admin/src/test/java/bio/terra/pearl/api/admin/service/ConfigExtServiceTests.java b/api-admin/src/test/java/bio/terra/pearl/api/admin/service/ConfigExtServiceTests.java
@@ -13,6 +13,7 @@
 import bio.terra.pearl.core.service.address.AddressValidationConfig;
 import bio.terra.pearl.core.service.export.integration.AirtableExporter;
 import bio.terra.pearl.core.service.kit.pepper.LivePepperDSMClient;
+import bio.terra.pearl.core.service.logging.MixpanelService;
 import bio.terra.pearl.core.shared.ApplicationRoutingPaths;
 import java.util.List;
 import java.util.Map;
@@ -32,6 +33,7 @@ public class ConfigExtServiceTests {
   @MockBean private LivePepperDSMClient.PepperDSMConfig pepperDSMConfig;
   @MockBean private AddressValidationConfig addressValidationConfig;
   @MockBean private AirtableExporter.AirtableConfig airtableConfig;
+  @MockBean private MixpanelService.MixpanelConfig mixpanelConfig;
 
   @Test
   public void testAllMethodsAnnotated() {
@@ -41,7 +43,8 @@ public void testAllMethodsAnnotated() {
             applicationRoutingPaths,
             pepperDSMConfig,
             addressValidationConfig,
-            airtableConfig),
+            airtableConfig,
+            mixpanelConfig),
         Map.of(
             "maskSecret",
             AuthAnnotationSpec.withPublicAnnotation(),
@@ -66,7 +69,8 @@ public void testConfigMap() {
             applicationRoutingPaths,
             pepperDSMConfig,
             addressValidationConfig,
-            airtableConfig);
+            airtableConfig,
+            mixpanelConfig);
     Map<String, String> configMap = configExtService.getConfigMap();
     Assertions.assertEquals("something.org", configMap.get("participantUiHostname"));
   }
@@ -81,19 +85,24 @@ public void testInternalConfigMap() {
             .withProperty("env.dsm.secret", "superSecret")
             .withProperty("env.addrValidation.addrValidationServiceClass", "someClass")
             .withProperty("env.addrValidation.smartyAuthId", "sm_id")
-            .withProperty("env.addrValidation.smartyAuthToken", "sm_token");
+            .withProperty("env.addrValidation.smartyAuthToken", "sm_token")
+            .withProperty("env.mixpanel.enabled", "true")
+            .withProperty("env.mixpanel.token", "mp_token");
 
     LivePepperDSMClient.PepperDSMConfig testPepperConfig =
         new LivePepperDSMClient.PepperDSMConfig(mockEnvironment);
 
     AddressValidationConfig testAddrConfig = new AddressValidationConfig(mockEnvironment);
+    MixpanelService.MixpanelConfig testMixpanelConfig =
+        new MixpanelService.MixpanelConfig(mockEnvironment);
     ConfigExtService configExtService =
         new ConfigExtService(
             b2CConfiguration,
             applicationRoutingPaths,
             testPepperConfig,
             testAddrConfig,
-            airtableConfig);
+            airtableConfig,
+            testMixpanelConfig);
     @SuppressWarnings("unchecked")
     Map<String, ?> dsmConfigMap =
         (Map<String, ?>)
@@ -113,6 +122,9 @@ public void testInternalConfigMap() {
     assertThat(addressValidationConfigMap.get("addrValidationServiceClass"), equalTo("someClass"));
     assertThat(addressValidationConfigMap.get("smartyAuthId"), equalTo("sm_id"));
     assertThat(addressValidationConfigMap.get("smartyAuthToken"), equalTo("sm..."));
+
+    assertThat(testMixpanelConfig.getEnabled(), equalTo("true"));
+    assertThat(testMixpanelConfig.getToken(), equalTo("mp_token"));
   }
 
   @Test

diff --git a/core/src/main/java/bio/terra/pearl/core/service/logging/MixpanelService.java b/core/src/main/java/bio/terra/pearl/core/service/logging/MixpanelService.java
@@ -3,10 +3,13 @@
 import com.mixpanel.mixpanelapi.ClientDelivery;
 import com.mixpanel.mixpanelapi.MessageBuilder;
 import com.mixpanel.mixpanelapi.MixpanelAPI;
+import lombok.Getter;
+import lombok.Setter;
 import lombok.extern.slf4j.Slf4j;
 import org.json.JSONArray;
 import org.json.JSONObject;
 import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Component;
 import org.springframework.stereotype.Service;
 
 import java.io.IOException;
@@ -86,4 +89,16 @@ protected void deliverEvents(ClientDelivery delivery) {
         }
     }
 
+    @Component
+    @Getter @Setter
+    public static class MixpanelConfig {
+        private String token;
+        private String enabled;
+
+        public MixpanelConfig(Environment environment) {
+            this.token = environment.getProperty("env.mixpanel.token");
+            this.enabled = environment.getProperty("env.mixpanel.enabled");
+        }
+    }
+
 }
diff --git a/ui-admin/src/api/api.tsx b/ui-admin/src/api/api.tsx
@@ -338,6 +338,7 @@ export type InternalConfig = {
   pepperDsmConfig: Record<string, string>
   addrValidationConfig: Record<string, string>
   airtable: Record<string, string>
+  mixpanel: Record<string, string>
 }
 
 export type ParticipantTaskUpdateDto = {

diff --git a/ui-admin/src/integration/IntegrationDashboard.tsx b/ui-admin/src/integration/IntegrationDashboard.tsx
@@ -5,6 +5,7 @@ import AddressValidationIntegrationDashboard from './AddressValidationIntegratio
 import { navDivStyle, navLinkStyleFunc, navListItemStyle } from 'util/subNavStyles'
 import { renderPageHeader } from 'util/pageUtils'
 import AirtableIntegrationDashboard from './AirtableIntegrationDashboard'
+import MixpanelIntegrationDashboard from './MixpanelIntegrationDashboard'
 
 /** shows links to the populate control panels, and handles the routing for them */
 export default function IntegrationDashboard() {
@@ -17,13 +18,15 @@ export default function IntegrationDashboard() {
           <li style={navListItemStyle}><NavLink to="addressValidation" style={navLinkStyleFunc}>Address
             Validation</NavLink></li>
           <li style={navListItemStyle}><NavLink to="airtable" style={navLinkStyleFunc}>Airtable</NavLink></li>
+          <li style={navListItemStyle}><NavLink to="mixpanel" style={navLinkStyleFunc}>Mixpanel</NavLink></li>
         </ul>
       </div>
       <div className="px-3">
         <Routes>
           <Route path="kits" element={<KitIntegrationDashboard/>}/>
           <Route path="addressValidation" element={<AddressValidationIntegrationDashboard/>}/>
           <Route path="airtable" element={<AirtableIntegrationDashboard/>}/>
+          <Route path="mixpanel" element={<MixpanelIntegrationDashboard/>}/>
         </Routes>
         <Outlet/>
       </div>

diff --git a/ui-admin/src/integration/MixpanelIntegrationDashboard.tsx b/ui-admin/src/integration/MixpanelIntegrationDashboard.tsx
@@ -0,0 +1,28 @@
+import React, { useState } from 'react'
+import { useLoadingEffect } from 'api/api-utils'
+import Api, { InternalConfig } from 'api/api'
+import LoadingSpinner from 'util/LoadingSpinner'
+
+
+export default function MixpanelIntegrationDashboard() {
+  const [config, setConfig] = useState<InternalConfig>()
+
+  const { isLoading } = useLoadingEffect(async () => {
+    const response = await Api.fetchInternalConfig()
+    setConfig(response)
+  })
+
+  return <div>
+    <h2 className="h3">Mixpanel</h2>
+    <div className="mt-4">
+      <h3 className="h5">Config</h3>
+      {!isLoading && <dl>
+        <dt>enabled</dt>
+        <dd>{config?.mixpanel.enabled}</dd>
+        <dt>token</dt>
+        <dd>{config?.mixpanel.token}</dd>
+      </dl>}
+      {isLoading && <LoadingSpinner/>}
+    </div>
+  </div>
+}