fix: add cli telemetry "account show" (#9273)

* fix: add cli telemetry account show * test: ut
OfficeDev · Jul 12, 2023 · d99ee8f · d99ee8f
1 parent 24f52e6
commit d99ee8f
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 3 deletions.
diff --git a/packages/cli/src/cmds/account.ts b/packages/cli/src/cmds/account.ts
@@ -21,6 +21,12 @@ import * as constants from "../constants";
 import { strings } from "../resource";
 import { toLocaleLowerCase } from "../utils";
 import { YargsCommand } from "../yargsCommand";
+import {
+  TelemetryEvent,
+  TelemetryProperty,
+  TelemetrySuccess,
+} from "../telemetry/cliTelemetryEvents";
+import CliTelemetry from "../telemetry/cliTelemetry";
 
 async function outputM365Info(commandType: "login" | "show"): Promise<boolean> {
   const appStudioTokenJsonRes = await M365TokenProvider.getJsonObject({ scopes: AppStudioScopes });
@@ -98,8 +104,10 @@ class AccountShow extends YargsCommand {
   }
 
   public async runCommand(_args: { [argName: string]: string }): Promise<Result<null, FxError>> {
+    CliTelemetry.sendTelemetryEvent(TelemetryEvent.AccountShowStart);
     const m365StatusRes = await M365TokenProvider.getStatus({ scopes: AppStudioScopes });
     if (m365StatusRes.isErr()) {
+      CliTelemetry.sendTelemetryErrorEvent(TelemetryEvent.AccountShow, m365StatusRes.error);
       return err(m365StatusRes.error);
     }
     const m365Status = m365StatusRes.value;
@@ -122,7 +130,9 @@ class AccountShow extends YargsCommand {
         "Use `teamsfx account login azure` or `teamsfx account login m365` to log in to Azure or Microsoft 365 account."
       );
     }
-
+    CliTelemetry.sendTelemetryEvent(TelemetryEvent.AccountShow, {
+      [TelemetryProperty.Success]: TelemetrySuccess.Yes,
+    });
     return ok(null);
   }
 }
@@ -157,6 +167,7 @@ export class M365Login extends YargsCommand {
   }
 
   public async runCommand(_args: { [argName: string]: string }): Promise<Result<null, FxError>> {
+    CliTelemetry.sendTelemetryEvent(TelemetryEvent.AccountShowStart);
     await M365TokenProvider.signout();
     await outputM365Info("login");
 

diff --git a/packages/cli/src/telemetry/cliTelemetryEvents.ts b/packages/cli/src/telemetry/cliTelemetryEvents.ts
@@ -4,6 +4,10 @@
 
 export enum TelemetryEvent {
   //TODO: define CLI telemetry event
+
+  AccountShowStart = "account-show-start",
+  AccountShow = "account-show",
+
   AccountLoginStart = "login-start",
   AccountLogin = "login",
 

diff --git a/packages/cli/tests/unit/cmds/account.tests.ts b/packages/cli/tests/unit/cmds/account.tests.ts
@@ -2,6 +2,7 @@
 // Licensed under the MIT license.
 
 import { err, ok } from "@microsoft/teamsfx-api";
+import { M365TokenJSONNotFoundError } from "@microsoft/teamsfx-core";
 import "mocha";
 import { RestoreFn } from "mocked-env";
 import sinon from "sinon";
@@ -10,16 +11,17 @@ import Account, { AzureLogin, M365Login } from "../../../src/cmds/account";
 import AzureTokenProvider from "../../../src/commonlib/azureLogin";
 import { signedOut } from "../../../src/commonlib/common/constant";
 import M365TokenProvider from "../../../src/commonlib/m365Login";
-import { expect, mockLogProvider, mockYargs } from "../utils";
-import { FileNotFoundError, M365TokenJSONNotFoundError } from "@microsoft/teamsfx-core";
+import { expect, mockLogProvider, mockTelemetry, mockYargs } from "../utils";
 
 describe("Account Command Tests", function () {
   const sandbox = sinon.createSandbox();
   let messages: string[] = [];
+  const telemetryEvents: string[] = [];
   const mockedEnvRestore: RestoreFn = () => {};
 
   beforeEach(() => {
     mockYargs(sandbox);
+    mockTelemetry(sandbox, telemetryEvents);
     mockLogProvider(sandbox, messages);
   });