Add analytics about firebasePath and FIREBASE_BINARY.

Author: yuchenshi

firebase-vscode/src/analytics.ts

@@ -5,7 +5,7 @@ import { env as monospaceEnv } from "../src/core/env";
 
 export const IDX_METRIC_NOTICE = `
 When you use the Firebase Data Connect Extension, Google collects telemetry data such as usage statistics, error metrics, and crash reports. Telemetry helps us better understand how the Firebase Extension is performing, where improvements need to be made, and how features are being used. Firebase uses this data, consistent with our [Google Privacy Policy](https://policies.google.com/privacy?hl=en-US), to provide, improve, and develop Firebase products and services.
-We take steps to protect your privacy as part of this process. This includes disconnecting your telemetry data from your Google Account, fully anonymizing it, and storing that data for up to 14 months. 
+We take steps to protect your privacy as part of this process. This includes disconnecting your telemetry data from your Google Account, fully anonymizing it, and storing that data for up to 14 months.
 Read more in our [Privacy Policy](https://policies.google.com/privacy?hl=en-US).
 `;
 
@@ -31,6 +31,7 @@ export enum DATA_CONNECT_EVENT_NAME {
   START_EMULATORS = "start_emulators",
   AUTO_COMPLETE = "auto_complete",
   SESSION_CHAR_COUNT = "session_char_count",
+  SETUP_FIREBASE_BINARY = "setup_firebase_binary",
 }
 
 export class AnalyticsLogger {

firebase-vscode/src/data-connect/deploy.ts

@@ -42,12 +42,16 @@ export function registerFdcDeploy(
   );
 
   const deployAllCmd = vscode.commands.registerCommand("fdc.deploy-all", () => {
-    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.DEPLOY_ALL);
+    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.DEPLOY_ALL, {
+      firebase_binary_kind: settings.firebaseBinaryKind,
+    });
     deploySpy.call(`${settings.firebasePath} deploy --only dataconnect`);
   });
 
   const deployCmd = vscode.commands.registerCommand("fdc.deploy", async () => {
-    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.DEPLOY_INDIVIDUAL);
+    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.DEPLOY_INDIVIDUAL, {
+      firebase_binary_kind: settings.firebaseBinaryKind,
+    });
     const configs = await firstWhereDefined(dataConnectConfigs).then(
       (c) => c.requireValue,
     );

firebase-vscode/src/data-connect/sdk-generation.ts

@@ -37,7 +37,9 @@ export function registerFdcSdkGeneration(
   const initSdkCmd = vscode.commands.registerCommand(
     "fdc.init-sdk",
     (args: { appFolder: string }) => {
-      telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.INIT_SDK_CLI);
+      telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.INIT_SDK_CLI, {
+        firebase_binary_kind: settings.firebaseBinaryKind,
+      });
       // Lets do it from the right directory
       setTerminalEnvVars(FDC_APP_FOLDER, args.appFolder);
       runCommand(`${settings.firebasePath} init dataconnect:sdk`);

firebase-vscode/src/data-connect/terminal.ts

@@ -74,7 +74,9 @@ export function registerTerminalTasks(
   const settings = getSettings();
 
   const loginTaskBroker = broker.on("executeLogin", () => {
-    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.IDX_LOGIN);
+    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.IDX_LOGIN, {
+      firebase_binary_kind: settings.firebaseBinaryKind,
+    });
     runTerminalTask(
       "firebase login",
       `${settings.firebasePath} login --no-localhost`,
@@ -84,7 +86,9 @@ export function registerTerminalTasks(
   });
 
   const startEmulatorsTaskBroker = broker.on("runStartEmulators", () => {
-    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.START_EMULATORS);
+    telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.START_EMULATORS, {
+      firebase_binary_kind: settings.firebaseBinaryKind,
+    });
     // TODO: optional debug mode
     runTerminalTask(
       "firebase emulators",

firebase-vscode/src/extension.ts

@@ -11,7 +11,11 @@ import {
 import { logSetup, pluginLogger } from "./logger-wrapper";
 import { registerWebview } from "./webview";
 import { registerCore } from "./core";
-import { getSettings, updateIdxSetting } from "./utils/settings";
+import {
+  getSettings,
+  setupFirebasePath,
+  updateIdxSetting,
+} from "./utils/settings";
 import { registerFdc } from "./data-connect";
 import { AuthService } from "./auth/service";
 import {
@@ -25,9 +29,12 @@ import { suggestGraphqlSyntaxExtension } from "./data-connect/graphql-syntax-hig
 
 // This method is called when your extension is activated
 export async function activate(context: vscode.ExtensionContext) {
+  const analyticsLogger = new AnalyticsLogger();
+
   // Suggest installing the GraphQL syntax highlighter extension
   await suggestGraphqlSyntaxExtension();
 
+  await setupFirebasePath(analyticsLogger.logger);
   const settings = getSettings();
   logSetup();
   pluginLogger.debug("Activating Firebase extension.");
@@ -39,7 +46,6 @@ export async function activate(context: vscode.ExtensionContext) {
   >(new ExtensionBroker());
 
   const authService = new AuthService(broker);
-  const analyticsLogger = new AnalyticsLogger();
 
   // show IDX data collection notice
   if (settings.shouldShowIdxMetricNotice && env.value.isMonospace) {

firebase-vscode/src/utils/settings.ts

@@ -1,7 +1,10 @@
+import * as vscode from "vscode";
 import { ConfigurationTarget, window, workspace } from "vscode";
+import { DATA_CONNECT_EVENT_NAME } from "../analytics";
 
 export interface Settings {
   readonly firebasePath: string;
+  readonly firebaseBinaryKind: string;
   readonly npmPath: string;
   readonly useFrameworks: boolean;
   readonly shouldShowIdxMetricNotice: boolean;
@@ -12,22 +15,23 @@ const DEFAULT_FIREBASE_BINARY = "npx -y firebase-tools@latest";
 
 export function getSettings(): Settings {
   const config = workspace.getConfiguration("firebase");
+  const firebasePath =
+    config.get<string>("firebasePath") || DEFAULT_FIREBASE_BINARY;
 
-  // TODO: Consider moving side effect out of getSettings
-  // Persist env var as path setting when path setting doesn't exist
-  if (process.env.FIREBASE_BINARY && !config.get<string>("firebasePath")) {
-    config.update(
-      "firebasePath",
-      process.env.FIREBASE_BINARY,
-      ConfigurationTarget.Global,
-    );
-    window.showInformationMessage(
-      "Detected FIREBASE_BINARY env var. Saving to `Firebase Path` setting.",
-    );
+  let firebaseBinaryKind = "unknown"; // Used for analytics.
+  if (firebasePath === DEFAULT_FIREBASE_BINARY) {
+    firebaseBinaryKind = "npx";
+  } else if (firebasePath.endsWith("/.local/bin/firebase")) {
+    // https://firebase.tools/dataconnect defaults to $HOME/.local/bin
+    firebaseBinaryKind = "firepit-local";
+  } else if (firebasePath.endsWith("/local/bin/firebase")) {
+    // https://firebase.tools/ defaults to /usr/local/bin
+    firebaseBinaryKind = "firepit-global";
   }
 
   return {
-    firebasePath: config.get<string>("firebasePath") || DEFAULT_FIREBASE_BINARY,
+    firebasePath,
+    firebaseBinaryKind,
     npmPath: config.get<string>("npmPath", "npm"),
     useFrameworks: config.get<boolean>("hosting.useFrameworks", false),
     shouldShowIdxMetricNotice: config.get<boolean>(
@@ -41,3 +45,16 @@ export function updateIdxSetting(shouldShow: boolean) {
   const config = workspace.getConfiguration("firebase");
   config.update("idx.viewMetricNotice", shouldShow, ConfigurationTarget.Global);
 }
+
+// Persist env var as path setting when path setting doesn't exist
+export function setupFirebasePath(telemetryLogger: vscode.TelemetryLogger) {
+  const config = workspace.getConfiguration("firebase");
+  if (process.env.FIREBASE_BINARY && !config.get<string>("firebasePath")) {
+    config.update(
+      "firebasePath",
+      process.env.FIREBASE_BINARY,
+      ConfigurationTarget.Global,
+    );
+  }
+  telemetryLogger.logUsage(DATA_CONNECT_EVENT_NAME.SETUP_FIREBASE_BINARY);
+}