feat(gatsby-telemetry): adjust how we capture plugins for telemetry (#27835)

* Simplify interval math

* Capture installed gatsby dependencies

* Update packages/gatsby-telemetry/src/get-dependencies.ts

Co-authored-by: Ward Peeters <[email protected]>

* Add missing returntype

* Fix how we disable telemetry in tests

Co-authored-by: Ward Peeters <[email protected]>

Author: jamo

packages/gatsby-telemetry/src/__tests__/telemetry.ts

@@ -14,11 +14,12 @@ describe(`Telemetry`, () => {
     expect(EventStorage).toHaveBeenCalledTimes(1)
     expect(
       (EventStorage as jest.Mock).mock.instances[0].addEvent
-    ).toHaveBeenCalledTimes(1)
+    ).toHaveBeenCalledTimes(2)
   })
 
   it(`Doesn't add event to store if telemetry tracking is turned off`, () => {
-    telemetry.trackingEnabled = false
+    ;(EventStorage as jest.Mock).mockReset()
+    telemetry = new AnalyticsTracker({ trackingEnabled: false })
     telemetry.trackActivity(`demo`)
     expect(
       (EventStorage as jest.Mock).mock.instances[0].addEvent

packages/gatsby-telemetry/src/get-dependencies.ts

@@ -0,0 +1,39 @@
+import { readFileSync } from "fs-extra"
+
+export function getDependencies(): {
+  dependencies: Array<string> | undefined
+  devDependencies: Array<string> | undefined
+} {
+  const data = parsePackageJson()
+
+  return {
+    dependencies: mapData(data?.dependencies),
+    devDependencies: mapData(data?.devDependencies),
+  }
+}
+
+function mapData(deps: object): Array<string> | undefined {
+  if (!deps) {
+    return undefined
+  }
+  return Object.entries(deps)
+    .map(([name, version]) => {
+      return {
+        name,
+        version,
+      }
+    })
+    .map(({ name, version }) => `${name}@${version}`)
+}
+
+function parsePackageJson(): { dependencies: object; devDependencies: object } {
+  try {
+    const packageJson = readFileSync(`./package.json`, `utf8`)
+    if (!packageJson) {
+      return { dependencies: {}, devDependencies: {} }
+    }
+    return JSON.parse(packageJson)
+  } catch (e) {
+    return { dependencies: {}, devDependencies: {} }
+  }
+}

packages/gatsby-telemetry/src/index.ts

@@ -7,6 +7,7 @@ import {
 } from "./telemetry"
 import { Request, Response } from "express"
 import { createFlush } from "./create-flush"
+import time, { TimeUnit } from "@turist/time"
 
 const instance = new AnalyticsTracker()
 
@@ -22,7 +23,7 @@ const intervalDuration = process.env.TELEMETRY_BUFFER_INTERVAL
 const interval =
   intervalDuration && Number.isFinite(+intervalDuration)
     ? Math.max(Number(intervalDuration), 1000)
-    : 10 * 60 * 1000 // 10 min
+    : time(10, TimeUnit.Minute)
 
 function tick(): void {
   flush()
@@ -33,6 +34,7 @@ function tick(): void {
 export function trackFeatureIsUsed(name: string): void {
   instance.trackFeatureIsUsed(name)
 }
+
 export function trackCli(
   input: string | Array<string>,
   tags?: ITelemetryTagsPayload,

packages/gatsby-telemetry/src/telemetry.ts

@@ -14,6 +14,7 @@ import { createFlush } from "./create-flush"
 import { EventStorage } from "./event-storage"
 import { showAnalyticsNotification } from "./show-analytics-notification"
 import { cleanPaths } from "./error-helpers"
+import { getDependencies } from "./get-dependencies"
 
 import { join, sep } from "path"
 import isDocker from "is-docker"
@@ -53,6 +54,7 @@ export interface IAggregateStats {
 interface IAnalyticsTrackerConstructorParameters {
   componentId?: SemVer
   gatsbyCliVersion?: SemVer
+  trackingEnabled?: boolean
 }
 
 export interface IStructuredError {
@@ -92,6 +94,8 @@ export interface ITelemetryTagsPayload {
   error?: IStructuredError | Array<IStructuredError>
   cacheStatus?: string
   pluginCachePurged?: string
+  dependencies?: Array<string>
+  devDependencies?: Array<string>
   siteMeasurements?: {
     pagesCount?: number
     clientsCount?: number
@@ -132,12 +136,16 @@ export class AnalyticsTracker {
   constructor({
     componentId,
     gatsbyCliVersion,
+    trackingEnabled,
   }: IAnalyticsTrackerConstructorParameters = {}) {
     this.componentId = componentId || `gatsby-cli`
     try {
       if (this.store.isTrackingDisabled()) {
         this.trackingEnabled = false
       }
+      if (trackingEnabled !== undefined) {
+        this.trackingEnabled = trackingEnabled
+      }
 
       this.defaultTags = this.getTagsFromEnv()
 
@@ -149,6 +157,7 @@ export class AnalyticsTracker {
       // ignore
     }
     this.machineId = this.getMachineId()
+    this.captureMetadataEvent()
   }
 
   // We might have two instances of this lib loaded, one from globally installed gatsby-cli and one from local gatsby.
@@ -463,6 +472,19 @@ export class AnalyticsTracker {
     }
   }
 
+  captureMetadataEvent(): void {
+    if (!this.isTrackingEnabled()) {
+      return
+    }
+    const deps = getDependencies()
+    const evt = {
+      dependencies: deps?.dependencies,
+      devDependencies: deps?.devDependencies,
+    }
+
+    this.captureEvent(`METADATA`, evt)
+  }
+
   async sendEvents(): Promise<boolean> {
     if (!this.isTrackingEnabled()) {
       return true