Inject the app insights key at build time

Uses a github secret.  When building the extension, set the
APP_INSIGHTS_KEY environment variable to the key and the build process
will inject this value as the key to use.

Author: aeisenberg

.github/workflows/main.yml

@@ -30,6 +30,8 @@ jobs:
 
       - name: Build
         working-directory: extensions/ql-vscode
+        env:
+          APP_INSIGHTS_KEY: '${{ secrets.APP_INSIGHTS_KEY }}'
         run: |
           npm run build
         shell: bash
@@ -71,6 +73,8 @@ jobs:
 
       - name: Build
         working-directory: extensions/ql-vscode
+        env:
+          APP_INSIGHTS_KEY: '${{ secrets.APP_INSIGHTS_KEY }}'
         run: |
           npm run build
         shell: bash

.github/workflows/release.yml

@@ -20,7 +20,8 @@ jobs:
   build:
     name: Release
     runs-on: ubuntu-latest
-    # TODO Share steps with the main workflow.
+    env:
+      APP_INSIGHTS_KEY: '${{ secrets.APP_INSIGHTS_KEY }}'
     steps:
       - name: Checkout
         uses: actions/checkout@v2

extensions/ql-vscode/gulpfile.ts/appInsights.ts

@@ -0,0 +1,16 @@
+import * as gulp from 'gulp';
+import * as replace from 'gulp-replace';
+
+/** Inject the application insights key into the telemetry file */
+export function injectAppInsightsKey() {
+  if (!process.env.APP_INSIGHTS_KEY) {
+    // noop
+    console.log('APP_INSIGHTS_KEY environment variable is not set. So, cannot inject it into the application.');
+    return Promise.resolve();
+  }
+
+  // replace the key
+  return gulp.src(['out/telemetry.js'])
+    .pipe(replace(/REPLACE-APP-INSIGHTS-KEY/, process.env.APP_INSIGHTS_KEY))
+    .pipe(gulp.dest('out/'));
+}

extensions/ql-vscode/gulpfile.ts/index.ts

@@ -4,7 +4,14 @@ import { compileTextMateGrammar } from './textmate';
 import { copyTestData } from './tests';
 import { compileView } from './webpack';
 import { packageExtension } from './package';
+import { injectAppInsightsKey } from './appInsights';
 
-export const buildWithoutPackage = gulp.parallel(compileTypeScript, compileTextMateGrammar, compileView, copyTestData, copyViewCss);
-export { compileTextMateGrammar, watchTypeScript, compileTypeScript, copyTestData };
-exports.default = gulp.series(exports.buildWithoutPackage, packageExtension);
+export const buildWithoutPackage =
+  gulp.series(
+    gulp.parallel(
+      compileTypeScript, compileTextMateGrammar, compileView, copyTestData, copyViewCss
+    ),
+    injectAppInsightsKey
+  );
+export { compileTextMateGrammar, watchTypeScript, compileTypeScript, copyTestData, injectAppInsightsKey };
+exports.default = gulp.series(buildWithoutPackage, packageExtension);

extensions/ql-vscode/package-lock.json

@@ -758,6 +758,7 @@
     "@types/glob": "^7.1.1",
     "@types/google-protobuf": "^3.2.7",
     "@types/gulp": "^4.0.6",
+    "@types/gulp-replace": "0.0.31",
     "@types/gulp-sourcemaps": "0.0.32",
     "@types/js-yaml": "^3.12.5",
     "@types/jszip": "~3.1.6",
@@ -788,6 +789,7 @@
     "eslint-plugin-react": "~7.19.0",
     "glob": "^7.1.4",
     "gulp": "^4.0.2",
+    "gulp-replace": "^1.0.0",
     "gulp-sourcemaps": "^2.6.5",
     "gulp-typescript": "^5.0.1",
     "husky": "~4.2.5",

extensions/ql-vscode/package.json

@@ -6,7 +6,8 @@ import { logger } from './logging';
 import { UserCancellationException } from './commandRunner';
 import { showBinaryChoiceDialog } from './helpers';
 
-const key = '6f88c20e-2879-41ed-af73-218b82e1ff44';
+// Key is injected at build time through the APP_INSIGHTS_KEY environment variable.
+const key = 'REPLACE-APP-INSIGHTS-KEY';
 
 let reporter: TelemetryReporter | undefined;
 let listener: Disposable | undefined;