feat: usage analytics in code-snippet (#285)

Author: NetaMolcho

packages/backend/.nycrc.json

@@ -4,7 +4,7 @@
   "exclude": [
     "src/logger/*.ts",
     "src/panels/*.ts",
-    "src/swa-tracker/*.ts",
+    "src/usage-report/*.ts",
     "src/webSocketServer/*.ts",
     "src/output-channel-log.ts",
     "src/youi-adapter.ts"

packages/backend/package.json

@@ -114,7 +114,7 @@
   },
   "dependencies": {
     "@sap-devx/webview-rpc": "0.3.1",
-    "@sap/swa-for-sapbas-vsx": "1.2.15",
+    "@sap/swa-for-sapbas-vsx": "2.0.4",
     "@vscode-logging/logger": "1.2.3",
     "code-snippet-frontend": "^1.3.2",
     "fs-extra": "9.1.0",

packages/backend/src/code-snippet.ts

@@ -6,7 +6,7 @@ import { IRpc } from "@sap-devx/webview-rpc/out.ext/rpc-common";
 import Generator = require("yeoman-generator");
 import { IChildLogger } from "@vscode-logging/logger";
 import TerminalAdapter = require("yeoman-environment/lib/adapter");
-import { SWA } from "./swa-tracker/swa-tracker-wrapper";
+import { AnalyticsWrapper } from "./usage-report/usage-analytics-wrapper";
 import messages from "./messages";
 import { State } from "./utils";
 
@@ -206,7 +206,10 @@ export class CodeSnippet {
       const questions: any[] = await this.createCodeSnippetQuestions();
       this.currentQuestions = questions;
       const normalizedQuestions = this.normalizeFunctions(questions);
-      SWA.updateSnippetStarted(this.uiOptions.messages.title, this.logger);
+      AnalyticsWrapper.updateSnippetStarted(
+        this.uiOptions.messages.title,
+        this.logger
+      );
       const response: any = await this.rpc.invoke("showPrompt", [
         normalizedQuestions,
       ]);
@@ -253,7 +256,7 @@ export class CodeSnippet {
   private onSuccess(showDoneMessage: boolean, snippetName: string) {
     const message = `'${snippetName}' snippet has been created.`;
     this.logger.debug("done running code-snippet! " + message);
-    SWA.updateSnippetEnded(snippetName, true, this.logger);
+    AnalyticsWrapper.updateSnippetEnded(snippetName, true, this.logger);
     if (showDoneMessage) {
       this.appEvents.doSnippeDone(true, message);
     }
@@ -267,7 +270,12 @@ export class CodeSnippet {
   ) {
     const messagePrefix = `${snippetrName} snippet failed.`;
     const errorMessage: string = this.logError(error, messagePrefix);
-    SWA.updateSnippetEnded(snippetrName, false, this.logger, errorMessage);
+    AnalyticsWrapper.updateSnippetEnded(
+      snippetrName,
+      false,
+      this.logger,
+      errorMessage
+    );
     if (showDoneMessage) {
       this.appEvents.doSnippeDone(false, errorMessage);
     }

packages/backend/src/extension.ts

@@ -5,7 +5,7 @@ import {
 } from "./logger/logger-wrapper";
 import { CodeSnippetPanel } from "./panels/CodeSnippetPanel";
 import { AbstractWebviewPanel } from "./panels/AbstractWebviewPanel";
-import { SWA } from "./swa-tracker/swa-tracker-wrapper";
+import { AnalyticsWrapper } from "./usage-report/usage-analytics-wrapper";
 
 let extContext: vscode.ExtensionContext;
 let codeSnippetPanel: CodeSnippetPanel;
@@ -15,7 +15,7 @@ export function activate(context: vscode.ExtensionContext): void {
 
   try {
     createExtensionLoggerAndSubscribeToLogSettingsChanges(context);
-    SWA.createSWATracker(getLogger());
+    AnalyticsWrapper.createTracker(getLogger());
   } catch (error: any) {
     console.error(
       "Extension activation failed due to Logger configuration failure:",

packages/backend/src/swa-tracker/swa-tracker-wrapper.ts

@@ -0,0 +1,108 @@
+import {
+  initTelemetrySettings,
+  BASClientFactory,
+  BASTelemetryClient,
+} from "@sap/swa-for-sapbas-vsx";
+import { IChildLogger } from "@vscode-logging/logger";
+import { join } from "path";
+import { readFileSync } from "fs";
+
+/**
+ * A Simple Wrapper for reporting usage analytics
+ */
+export class AnalyticsWrapper {
+  // Event types used by Application Wizard
+  private static readonly EVENT_TYPES = {
+    SNIPPET_CREATION_STARTED: "Snippet creation started",
+    SNIPPET_CREATION_SUCCESSFULLY: "Snippet creation successfully",
+    SNIPPET_CREATION_FAILED: "Snippet creation failed",
+  };
+
+  private static startTime: number = Date.now();
+
+  /**
+   * Note the use of a getter function so the value would be lazy resolved on each use.
+   * This enables concise and simple consumption of the tracker throughout our Extension.
+   *
+   * @returns { Tracker }
+   */
+  public static getTracker(): BASTelemetryClient {
+    return BASClientFactory.getBASTelemetryClient();
+  }
+
+  public static createTracker(logger?: IChildLogger): void {
+    try {
+      const packageJsonPath = join(__dirname, "..", "package.json");
+      const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+      const vscodeExtentionFullName = `${packageJson.publisher}.${packageJson.name}`;
+      initTelemetrySettings(vscodeExtentionFullName, packageJson.version);
+      logger?.info(
+        `SAP Web Analytics tracker was created for ${vscodeExtentionFullName}`
+      );
+    } catch (error: any) {
+      logger?.error(error);
+    }
+  }
+
+  private static report(opt: {
+    eventName: string;
+    properties?: any;
+    logger?: IChildLogger;
+  }): void {
+    // We want to report only if we are not in Local VSCode environment
+    const eventName = opt.eventName;
+    if (process.env.LANDSCAPE_ENVIRONMENT) {
+      void AnalyticsWrapper.getTracker().report(opt.eventName, opt.properties);
+      opt.logger?.trace("SAP Web Analytics tracker was called", {
+        eventName,
+      });
+    } else {
+      opt.logger?.trace(
+        "SAP Web Analytics tracker was not called because LANDSCAPE_ENVIRONMENT is not set",
+        {
+          eventName,
+        }
+      );
+    }
+  }
+
+  public static updateSnippetStarted(
+    snippetName: string,
+    logger?: IChildLogger
+  ): void {
+    try {
+      const eventName = AnalyticsWrapper.EVENT_TYPES.SNIPPET_CREATION_STARTED;
+      AnalyticsWrapper.startTime = Date.now();
+      const properties = { snippetName };
+      AnalyticsWrapper.report({ eventName, properties, logger });
+    } catch (error: any) {
+      logger?.error(error);
+    }
+  }
+
+  public static updateSnippetEnded(
+    snippetName: string,
+    isSucceeded: boolean,
+    logger?: IChildLogger,
+    errorMessage?: string
+  ): void {
+    try {
+      const eventName = isSucceeded
+        ? AnalyticsWrapper.EVENT_TYPES.SNIPPET_CREATION_SUCCESSFULLY
+        : AnalyticsWrapper.EVENT_TYPES.SNIPPET_CREATION_FAILED;
+      const endTime = Date.now();
+      const snippetTimeMilliSec = endTime - AnalyticsWrapper.startTime;
+      const snippetTimeSec = Math.round(snippetTimeMilliSec / 1000);
+      const properties: any = {
+        snippetName,
+        snippetTime: snippetTimeSec.toString(),
+      };
+      if (errorMessage) {
+        properties.push(errorMessage);
+      }
+      AnalyticsWrapper.report({ eventName, properties, logger });
+    } catch (error: any) {
+      logger?.error(error);
+    }
+  }
+}