fix: analytics make sure first event is flushed

garden-io · Jan 22, 2020 · c4d6935 · c4d6935
1 parent c26eee8
commit c4d6935
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 11 deletions.
diff --git a/garden-service/src/analytics/analytics.ts b/garden-service/src/analytics/analytics.ts
@@ -124,7 +124,7 @@ export class AnalyticsHandler {
   private projectMetadata: ProjectMetadata
 
   private constructor(garden: Garden, log: LogEntry) {
-    this.segment = new segmentClient(API_KEY, { flushAt: 10, flushInterval: 300 })
+    this.segment = new segmentClient(API_KEY, { flushAt: 20, flushInterval: 300 })
     this.log = log
     this.garden = garden
     this.globalConfigStore = new GlobalConfigStore()
@@ -207,6 +207,7 @@ export class AnalyticsHandler {
             platform: platform(),
             platformVersion: release(),
             gardenVersion: getPackageVersion(),
+            isCI: this.isCI,
           },
         })
       }
@@ -222,9 +223,9 @@ export class AnalyticsHandler {
   /**
    * Handler used internally to process the TaskGraph events.
    */
-  private processEvent<T extends EventName>(name: T, payload: Events[T]) {
+  private async processEvent<T extends EventName>(name: T, payload: Events[T]) {
     if (AnalyticsHandler.isSupportedEvent(name, payload)) {
-      this.trackTask(payload.batchId, payload.name, payload.type, name)
+      await this.trackTask(payload.batchId, payload.name, payload.type, name)
     }
   }
 
@@ -308,7 +309,7 @@ export class AnalyticsHandler {
    * @returns
    * @memberof AnalyticsHandler
    */
-  private track(event: AnalyticsEvent) {
+  private async track(event: AnalyticsEvent) {
     if (this.segment && this.hasOptedIn()) {
       const segmentEvent: SegmentEvent = {
         userId: this.globalConfig.userId || "unknown",
@@ -319,15 +320,20 @@ export class AnalyticsHandler {
         },
       }
 
+      // NOTE: We need to wrap the track method in a Promise because of the race condition
+      // when tracking flushing the first event. See: https://github.com/segmentio/analytics-node/issues/219
       const trackToRemote = (eventToTrack: SegmentEvent) => {
-        this.segment.track(eventToTrack, (err) => {
-          if (err && this.log) {
-            this.log.debug(`Error sending tracking event: ${err}`)
-          }
+        return new Promise((resolve) => {
+          this.segment.track(eventToTrack, (err) => {
+            if (err && this.log) {
+              this.log.debug(`Error sending tracking event: ${err}`)
+            }
+            resolve(true)
+          })
         })
       }
 
-      return trackToRemote(segmentEvent)
+      return await trackToRemote(segmentEvent)
     }
     return false
   }

diff --git a/garden-service/src/cli/cli.ts b/garden-service/src/cli/cli.ts
@@ -322,7 +322,7 @@ export class GardenCli {
           // the file writers depend on the project root.
           await this.initFileWriters(logger, garden.projectRoot, garden.gardenDirPath)
           const analytics = await AnalyticsHandler.init(garden, log)
-          analytics.trackCommand(command.getFullName())
+          await analytics.trackCommand(command.getFullName())
 
           cliContext.details.analytics = analytics
 

diff --git a/garden-service/src/server/server.ts b/garden-service/src/server/server.ts
@@ -121,7 +121,7 @@ export class GardenServer {
         this.analytics = await AnalyticsHandler.init(this.garden, this.log)
       }
 
-      this.analytics.trackApi("POST", ctx.originalUrl, { ...ctx.request.body })
+      await this.analytics.trackApi("POST", ctx.originalUrl, { ...ctx.request.body })
 
       // TODO: set response code when errors are in result object?
       const result = await resolveRequest(ctx, this.garden, this.log, commands, ctx.request.body)