send track events to crowd tenant

Author: garrrikkotua

backend/config/custom-environment-variables.json

@@ -188,5 +188,11 @@
   "auth0": {
     "clientId": "CROWD_AUTH0_CLIENT_ID",
     "jwks": "CROWD_AUTH0_JWKS"
+  },
+  "crowdAnalytics": {
+    "tenantId": "CROWD_ANALYTICS_TENANT_ID",
+    "isEnabled": "CROWD_ANALYTICS_IS_ENABLED",
+    "baseUrl": "CROWD_ANALYTICS_BASE_URL",
+    "apiToken": "CROWD_ANALYTICS_API_TOKEN"
   }
 }

backend/src/conf/configTypes.ts

@@ -232,3 +232,10 @@ export interface IOpenSearchConfig {
   accessKeyId?: string
   secretAccessKey?: string
 }
+
+export interface CrowdAnalyticsConfiguration {
+  isEnabled: string
+  tenantId: string
+  baseUrl: string
+  apiToken: string
+}

backend/src/conf/index.ts

@@ -33,6 +33,7 @@ import {
   IOpenSearchConfig,
   Auth0Configuration,
   WeeklyEmailsConfiguration,
+  CrowdAnalyticsConfiguration,
 } from './configTypes'
 
 // TODO-kube
@@ -130,3 +131,6 @@ export const INTEGRATION_PROCESSING_CONFIG: IntegrationProcessingConfiguration =
 
 export const WEEKLY_EMAILS_CONFIG: WeeklyEmailsConfiguration =
   config.get<WeeklyEmailsConfiguration>('weeklyEmails')
+
+export const CROWD_ANALYTICS_CONFIG: CrowdAnalyticsConfiguration =
+  config.get<CrowdAnalyticsConfiguration>('crowdAnalytics')

backend/src/database/repositories/tenantRepository.ts

@@ -505,6 +505,22 @@ class TenantRepository {
 
     return platforms
   }
+
+  static async getTenantInfo(id: string, options: IRepositoryOptions) {
+    const query = `
+        select name, plan, "isTrialPlan", "trialEndsAt" from tenants where "tenantId" = :tenantId
+    `
+    const parameters: any = {
+      tenantId: id,
+    }
+
+    const info = await options.database.sequelize.query(query, {
+      replacements: parameters,
+      type: QueryTypes.SELECT,
+    })
+
+    return info
+  }
 }
 
 export default TenantRepository

backend/src/segment/addProductDataToCrowdTenant.ts

@@ -0,0 +1,95 @@
+import axios from 'axios'
+import { CROWD_ANALYTICS_CONFIG } from '@/conf'
+import UserRepository from '../database/repositories/userRepository'
+import TenantRepository from '../database/repositories/tenantRepository'
+import SequelizeRepository from '../database/repositories/sequelizeRepository'
+
+const IS_CROWD_ANALYTICS_ENABLED = CROWD_ANALYTICS_CONFIG.isEnabled === 'true'
+const CROWD_ANALYTICS_TENANT_ID = CROWD_ANALYTICS_CONFIG.tenantId
+const CROWD_ANALYTICS_BASE_URL = CROWD_ANALYTICS_CONFIG.baseUrl
+const CROWD_ANALYTICS_TOKEN = CROWD_ANALYTICS_CONFIG.apiToken
+
+// createdAnAccount (boolean)
+
+// email
+
+// firstName
+
+// lastName
+
+// plan
+
+// is_trial
+
+// trialEndsDate
+
+// workspace <> organization
+
+// Workspace → organization attributes
+
+// Name
+
+interface CrowdAnalyticsData {
+  userId: string
+  tenantId: string
+  event: string
+  timestamp: string
+  properties: any
+}
+
+export default async function addProductData(data: CrowdAnalyticsData) {
+  if (!IS_CROWD_ANALYTICS_ENABLED) {
+    return
+  }
+
+  if (!CROWD_ANALYTICS_TENANT_ID) {
+    return
+  }
+
+  if (!CROWD_ANALYTICS_BASE_URL) {
+    return
+  }
+
+  if (!CROWD_ANALYTICS_TOKEN) {
+    return
+  }
+
+  try {
+    const repositoryOptions = await SequelizeRepository.getDefaultIRepositoryOptions()
+
+    const user = await UserRepository.findById(data.userId, repositoryOptions)
+
+    const tenant = await TenantRepository.getTenantInfo(data.tenantId, repositoryOptions)
+
+    const obj = {
+      member: {
+        username: {
+          'crowd.dev': user.email,
+        },
+        emails: [user.email],
+        displayName: user.fullName,
+        attributes: {
+          email: user.email,
+          createdAnAccount: true,
+          firstName: user.firstName,
+          lastName: user.lastName,
+          plan: tenant.plan,
+          isTrialPlan: tenant.isTrialPlan,
+          trialEndsAt: tenant.trialEndsAt,
+        },
+      },
+      type: data.event,
+      timestamp: data.timestamp,
+      platform: 'crowd.dev',
+      sourceId: `${data.userId}-${data.timestamp}-${data.event}`,
+    }
+    const endpoint = `${CROWD_ANALYTICS_BASE_URL}/api/tenant/${CROWD_ANALYTICS_TENANT_ID}/activity/with-member`
+    await axios.post(endpoint, obj, {
+      headers: {
+        Authorization: `Bearer ${CROWD_ANALYTICS_TOKEN}`,
+      },
+    })
+  } catch (error) {
+    // nothing
+  }
+}

backend/src/segment/track.ts

@@ -2,6 +2,8 @@ import { getServiceChildLogger } from '@crowd/logging'
 import { Edition } from '@crowd/types'
 import { API_CONFIG, IS_TEST_ENV, SEGMENT_CONFIG } from '../conf'
 import getTenatUser from './trackHelper'
+// eslint-disable-next-line import/no-cycle
+import addProductData from './addProductDataToCrowdTenant'
 
 const log = getServiceChildLogger('segment')
 
@@ -35,6 +37,15 @@ export default function identify(
 
     try {
       analytics.track(payload)
+
+      // send product analytics data to crowd tenant workspace
+      addProductData({
+        userId: userIdOut,
+        tenantId: tenantIdOut,
+        event,
+        timestamp,
+        properties,
+      })
     } catch (error) {
       log.error(error, { payload }, 'ERROR: Could not send the following payload to Segment')
     }