report processed analytics event (#204)

src/server/config.ts

@@ -2,5 +2,4 @@ export const config = {
   jwtToken: process.env.JWT_TOKEN,
   jwtTokenLogin: process.env.JWT_TOKEN_LOGIN,
   feUrl: process.env.FE_URL,
-  analyticsIdentifier: process.env.ANALYTICS_IDENTIFIER,
 }

src/server/controllers/item/shared/item-data-processing.ts

@@ -17,6 +17,7 @@ import { getScenarioSettings, currentScenarioMetrics } from "../../../queries/sc
 import { sendNotifications } from "../../../utils/notifications/send-notification"
 import { scenarioThresholdsCalc } from "../utils/scenario-thresholds-calc"
 import { extraIntervalMilliseconds } from "./extra-intervals-mapping"
+import { AnalyticsEvent } from "../../../utils/analytics/anyltics-event"
 
 export const itemDataProcessing = async ({ projectName, scenarioName, itemId }) => {
     const MAX_LABEL_CHART_LENGTH = 100000
@@ -72,7 +73,6 @@ export const itemDataProcessing = async ({ projectName, scenarioName, itemId })
             const overviewChart = await db.many(chartOverviewQuery(interval, itemId))
             const statusCodeChart = await db.many(chartOverviewStatusCodesQuery(interval, itemId))
             if (parseInt(index, 10) === 0) { // default interval
-                console.log(overviewChart)
                 chartData = prepareChartDataForSaving(
                     {
                         overviewData: overviewChart,
@@ -117,6 +117,7 @@ export const itemDataProcessing = async ({ projectName, scenarioName, itemId })
         })
 
         logger.info(`Item: ${itemId} processing finished`)
+        AnalyticsEvent.reportProcessingFinished()
 
         if (scenarioSettings.deleteSamples) {
             logger.info(`Item: ${itemId} deleting samples data`)

src/server/utils/analytics/analytics-event.spec.ts

@@ -0,0 +1,41 @@
+import { AnalyticsEvent } from "./anyltics-event"
+import { analytics } from "../analytics"
+
+jest.mock("../analytics")
+
+
+describe("AnalyticEvents", () => {
+    describe("isAnalyticEnabled", () => {
+        it("should return true when OPT_OUT_ANALYTICS not set", function () {
+            const isEnabled = AnalyticsEvent.isAnalyticEnabled()
+            expect(isEnabled).toEqual(true)
+        })
+
+        it("should return true when OPT_OUT_ANALYTICS not disabled", function () {
+            process.env.OPT_OUT_ANALYTICS = "false"
+            const isEnabled = AnalyticsEvent.isAnalyticEnabled()
+            expect(isEnabled).toEqual(true)
+        })
+        it("should return false when OPT_OUT_ANALYTICS disabled", function () {
+            process.env.OPT_OUT_ANALYTICS = "true"
+            const isEnabled = AnalyticsEvent.isAnalyticEnabled()
+            expect(isEnabled).toEqual(false)
+        })
+    })
+    describe("reportProcessingFinished", () => {
+        it("should not track the event when analytics disabled", function () {
+            process.env.OPT_OUT_ANALYTICS = "true"
+            const trackMock = (analytics.track as any).mockResolvedValueOnce(undefined)
+            AnalyticsEvent.reportProcessingFinished()
+            expect(trackMock).not.toHaveBeenCalled()
+
+        })
+        it("should track the even only when analytics enabled", function () {
+            process.env.OPT_OUT_ANALYTICS = "false"
+            const trackMock = (analytics.track as any).mockResolvedValueOnce(undefined)
+            AnalyticsEvent.reportProcessingFinished()
+            expect(trackMock).toHaveBeenCalled()
+        })
+    })
+
+})

src/server/utils/analytics/anyltics-event.ts

@@ -0,0 +1,18 @@
+import { analytics } from "../analytics"
+
+export class AnalyticsEvent {
+
+    static isAnalyticEnabled(): boolean {
+        return !(process.env.OPT_OUT_ANALYTICS === "true")
+    }
+
+    static reportProcessingFinished() {
+        if (this.isAnalyticEnabled()) {
+            console.log(process.env.ANALYTICS_IDENTIFIER)
+            analytics.track("reportProcessingFinished", {
+                // eslint-disable-next-line camelcase
+                distinct_id: process.env.ANALYTICS_IDENTIFIER,
+            })
+        }
+    }
+}

src/server/utils/scheduled-tasks/jobs/analytics-report.ts

@@ -1,11 +1,9 @@
 import { analytics } from "../../analytics"
-import { config } from "../../../config";
-
 
 (async function () {
     await analytics.track("appAlive", {
         $os: process.platform,
-        distinct_id: config.analyticsIdentifier,
+        distinct_id: process.env.ANALYTICS_IDENTIFIER,
     })
 }())