Start moving gatsby-telemetry to typescript (#25812)

* Fix camelCase * Start moving gatsby-telemetry to ts * Continue converting base to typescript * Debug transpilation issues * Debug transpilation issues * Fix telemetry tests
gatsbyjs · Jul 20, 2020 · 2a72ec1 · 2a72ec1
1 parent 16ee206
commit 2a72ec1
Show file tree

Hide file tree

Showing 10 changed files with 162 additions and 110 deletions.
diff --git a/packages/gatsby-core-utils/src/ci.ts b/packages/gatsby-core-utils/src/ci.ts
@@ -1,7 +1,7 @@
 import ci from "ci-info"
 
 const CI_DEFINITIONS = [
-  envFromCIandCIName,
+  envFromCIAndCIName,
   getEnvDetect({ key: `NOW_BUILDER_ANNOTATE`, name: `ZEIT Now` }),
   getEnvDetect({ key: `NOW_REGION`, name: `ZEIT Now v1` }),
   herokuDetect,
@@ -73,7 +73,7 @@ function herokuDetect(): false | "Heroku" {
   )
 }
 
-function envFromCIandCIName(): string | null {
+function envFromCIAndCIName(): string | null {
   if (process.env.CI_NAME && process.env.CI) {
     return process.env.CI_NAME
   }

diff --git a/...tsby-telemetry/src/__tests__/telemetry.js → ...tsby-telemetry/src/__tests__/telemetry.ts b/...tsby-telemetry/src/__tests__/telemetry.js → ...tsby-telemetry/src/__tests__/telemetry.ts
@@ -1,11 +1,11 @@
 jest.mock(`../event-storage`)
 const eventStore = require(`../event-storage`)
-const Telemetry = require(`../telemetry`)
+import { AnalyticsTracker } from "../telemetry"
 
 let telemetry
 beforeEach(() => {
   eventStore.mockReset()
-  telemetry = new Telemetry()
+  telemetry = new AnalyticsTracker()
 })
 
 describe(`Telemetry`, () => {

diff --git a/packages/gatsby-telemetry/src/declarations.d.ts b/packages/gatsby-telemetry/src/declarations.d.ts
@@ -0,0 +1,8 @@
+type UUID = string
+
+declare namespace NodeJS {
+  interface Process {
+    gatsbyTelemetrySessionId: UUID;
+  }
+}
+
diff --git a/packages/gatsby-telemetry/src/index.js b/packages/gatsby-telemetry/src/index.js
diff --git a/packages/gatsby-telemetry/src/index.ts b/packages/gatsby-telemetry/src/index.ts
@@ -0,0 +1,56 @@
+import { AnalyticsTracker, IAggregateStats } from "./telemetry"
+import * as express from "express"
+
+const instance = new AnalyticsTracker()
+
+const flush = require(`./flush`)(instance.isTrackingEnabled())
+
+process.on(`exit`, flush)
+
+// For long running commands we want to occasionally flush the data
+//
+// The data is also sent on exit.
+
+const intervalDuration = process.env.TELEMETRY_BUFFER_INTERVAL
+const interval =
+  intervalDuration && Number.isFinite(+intervalDuration)
+    ? Math.max(Number(intervalDuration), 1000)
+    : 10 * 60 * 1000 // 10 min
+
+function tick(): void {
+  flush()
+    .catch(console.error)
+    .then(() => setTimeout(tick, interval))
+}
+
+module.exports = {
+  trackCli: (input, tags, opts): void =>
+    instance.captureEvent(input, tags, opts),
+  trackError: (input, tags): void => instance.captureError(input, tags),
+  trackBuildError: (input, tags): void =>
+    instance.captureBuildError(input, tags),
+  setDefaultTags: (tags): void => instance.decorateAll(tags),
+  decorateEvent: (event, tags): void => instance.decorateNextEvent(event, tags),
+  setTelemetryEnabled: (enabled): void => instance.setTelemetryEnabled(enabled),
+  startBackgroundUpdate: (): void => {
+    setTimeout(tick, interval)
+  },
+  isTrackingEnabled: (): boolean => instance.isTrackingEnabled(),
+  aggregateStats: (data): IAggregateStats => instance.aggregateStats(data),
+  addSiteMeasurement: (event, obj): void =>
+    instance.addSiteMeasurement(event, obj),
+  expressMiddleware: function (source: string) {
+    return function (
+      _req: express.Request,
+      _res: express.Response,
+      next
+    ): void {
+      try {
+        instance.trackActivity(`${source}_ACTIVE`)
+      } catch (e) {
+        // ignore
+      }
+      next()
+    }
+  },
+}
diff --git a/packages/gatsby-telemetry/src/repository-id.ts b/packages/gatsby-telemetry/src/repository-id.ts
@@ -15,7 +15,7 @@ interface IRepositoryData {
   name?: string
 }
 
-interface IRepositoryId {
+export interface IRepositoryId {
   repositoryId: string
   repositoryData?: IRepositoryData | null
 }

diff --git a/packages/gatsby-telemetry/src/send.js b/packages/gatsby-telemetry/src/send.js
diff --git a/packages/gatsby-telemetry/src/send.ts b/packages/gatsby-telemetry/src/send.ts
@@ -0,0 +1,10 @@
+import { AnalyticsTracker } from "./telemetry"
+const instance = new AnalyticsTracker()
+
+function flush(): void {
+  instance.sendEvents().catch(_e => {
+    // ignore
+  })
+}
+
+flush()
diff --git a/...elemetry/src/showAnalyticsNotification.js → ...emetry/src/show-analytics-notification.ts b/...elemetry/src/showAnalyticsNotification.js → ...emetry/src/show-analytics-notification.ts
@@ -1,10 +1,10 @@
-const boxen = require(`boxen`)
+import boxen from "boxen"
 
 const defaultConfig = {
   padding: 1,
   borderColor: `blue`,
   borderStyle: `double`,
-}
+} as boxen.Options
 
 const defaultMessage =
   `Gatsby collects anonymous usage analytics\n` +
@@ -15,14 +15,10 @@ const defaultMessage =
 
 /**
  * Analytics notice for the end-user
- * @param {Object} config - The configuration that boxen accepts. https://github.com/sindresorhus/boxen#api
- * @param {string} message - Message shown to the end-user
  */
-const showAnalyticsNotification = (
-  config = defaultConfig,
-  message = defaultMessage
-) => {
+export function showAnalyticsNotification(
+  config: boxen.Options = defaultConfig,
+  message: string = defaultMessage
+): void {
   console.log(boxen(message, config))
 }
-
-module.exports = showAnalyticsNotification