perf: add confirm ui for api key (#10408)

OfficeDev · Nov 24, 2023 · 4a50152 · 4a50152
1 parent 5f6831f
commit 4a50152
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 3 deletions.
diff --git a/packages/fx-core/resource/package.nls.json b/packages/fx-core/resource/package.nls.json
@@ -291,7 +291,8 @@
   "core.createProjectQuestion.apiSpecInputUrl.label": "Enter OpenAPI Description Document Location",
   "core.createProjectQuestion.OpenAIPluginDomain": "OpenAI Plugin Manifest",
   "core.createProjectQuestion.OpenAIPluginDomain.placeholder": "Enter your website domain or manifest URL",
-  "core.createaProjectQuestion.ApiKey": "Client secret for API key in OpenAPI specification",
+  "core.createProjectQuestion.ApiKey": "Enter API Key in OpenAPI Description Document",
+  "core.createProjectQuestion.ApiKeyConfirm": "Teams Toolkit will upload the API key to Teams Developer Portal. The API key will be used by Teams client to securely access your API in runtime when API-Based Message Extension is triggered. Teams Toolkit will not store your API key.",
   "core.createProjectQuestion.invalidApiKey.message": "Client secret is invalid. The length of secret should be >= 10 and <= 128",
   "core.createProjectQuestion.invalidUrl.message": "Enter a valid HTTP URL without authentication to access your OpenAPI description document.",
   "core.createProjectQuestion.apiSpec.operation.title": "Select Operation(s) Teams Can Interact with",

diff --git a/packages/fx-core/src/component/driver/apiKey/create.ts b/packages/fx-core/src/component/driver/apiKey/create.ts
@@ -31,6 +31,7 @@ import { SpecParser } from "../../../common/spec-parser";
 import { getAbsolutePath } from "../../utils/common";
 import { ApiKeyFailedToGetDomainError } from "./error/apiKeyFailedToGetDomain";
 import { isApiKeyEnabled, isMultipleParametersEnabled } from "../../../common/featureFlags";
+import { TelemetryUtils } from "../teamsApp/utils/telemetry";
 
 const actionName = "apiKey/register"; // DO NOT MODIFY the name
 const helpLink = "https://aka.ms/teamsfx-actions/apiKey-register";
@@ -51,6 +52,7 @@ export class CreateApiKeyDriver implements StepDriver {
 
     try {
       context.logProvider?.info(getLocalizedString(logMessageKeys.startExecuteDriver, actionName));
+      TelemetryUtils.init(context);
 
       if (!outputEnvVarNames) {
         throw new OutputEnvironmentVariableUndefinedError(actionName);

diff --git a/packages/fx-core/src/question/other.ts b/packages/fx-core/src/question/other.ts
@@ -5,6 +5,7 @@ import {
   AppPackageFolderName,
   AzureAccountProvider,
   BuildFolderName,
+  ConfirmQuestion,
   DynamicPlatforms,
   IQTreeNode,
   Inputs,
@@ -918,13 +919,22 @@ export function resourceGroupQuestionNode(
   };
 }
 
+export function apiSpecApiKeyConfirmQestion(): ConfirmQuestion {
+  return {
+    name: QuestionNames.ApiSpecApiKeyConfirm,
+    title: getLocalizedString("core.createProjectQuestion.ApiKeyConfirm"),
+    type: "confirm",
+    default: true,
+  };
+}
+
 export function apiSpecApiKeyQuestion(): IQTreeNode {
   return {
     data: {
       type: "text",
       name: QuestionNames.ApiSpecApiKey,
       cliShortName: "k",
-      title: getLocalizedString("core.createaProjectQuestion.ApiKey"),
+      title: getLocalizedString("core.createProjectQuestion.ApiKey"),
       cliDescription: "Api key for OpenAPI spec.",
       forgetLastValue: true,
       validation: {
@@ -956,5 +966,10 @@ export function apiSpecApiKeyQuestion(): IQTreeNode {
         !inputs.clientSecret
       );
     },
+    children: [
+      {
+        data: apiSpecApiKeyConfirmQestion(),
+      },
+    ],
   };
 }
diff --git a/packages/fx-core/src/question/questionNames.ts b/packages/fx-core/src/question/questionNames.ts
@@ -37,6 +37,7 @@ export enum QuestionNames {
   ApiOperation = "api-operation",
   MeArchitectureType = "me-architecture",
   ApiSpecApiKey = "api-key",
+  ApiSpecApiKeyConfirm = "api-key-confirm",
 
   Features = "features",
   Env = "env",

diff --git a/packages/fx-core/tests/question/question.test.ts b/packages/fx-core/tests/question/question.test.ts
@@ -955,7 +955,7 @@ describe("selectAadManifestQuestion", async () => {
   });
 });
 
-describe("resourceGroupQuestionNode", async () => {
+describe("apiKeyQuestion", async () => {
   const sandbox = sinon.createSandbox();
   let mockedEnvRestore: RestoreFn = () => {};
   afterEach(() => {
@@ -972,6 +972,8 @@ describe("resourceGroupQuestionNode", async () => {
     const condition = question.condition;
     const res = await (condition as ConditionFunc)(inputs);
     assert.equal(res, true);
+    const confirmQuesion = question.children![0];
+    assert.equal(confirmQuesion.data.name, "api-key-confirm");
   });
 
   it("will not pop up question due to api key exists", async () => {