perf(spec-parser): fix AC gen issue due to special chars in operation…

…Id (#11819) Co-authored-by: rentu <[email protected]>
OfficeDev · Jun 13, 2024 · 3031916 · 3031916
1 parent 90d9b49
commit 3031916
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/packages/fx-core/src/component/generator/copilotPlugin/helper.ts b/packages/fx-core/src/component/generator/copilotPlugin/helper.ts
@@ -803,9 +803,9 @@ async function updateAdaptiveCardForCustomApi(
     await fs.ensureDir(adaptiveCardsFolderPath);
 
     for (const item of specItems) {
-      const name = item.item.operationId;
+      const name = item.item.operationId!.replace(/[^a-zA-Z0-9]/g, "_");
       const [card] = AdaptiveCardGenerator.generateAdaptiveCard(item.item, true);
-      const cardFilePath = path.join(adaptiveCardsFolderPath, `${name!}.json`);
+      const cardFilePath = path.join(adaptiveCardsFolderPath, `${name}.json`);
       await fs.writeFile(cardFilePath, JSON.stringify(card, null, 2));
     }
   }
@@ -874,7 +874,8 @@ app.ai.action("{{operationId}}", async (context, state, parameter) => {
     const result = await path.{{method}}(parameter.path, parameter.body, {
       params: parameter.query,
     });
-    const card = generateAdaptiveCard("../adaptiveCards/{{operationId}}.json", result);
+    const cardName = "{{operationId}}".replace(/[^a-zA-Z0-9]/g, "_");
+    const card = generateAdaptiveCard("../adaptiveCards/" + cardName + ".json", result);
     await context.sendActivity({ attachments: [card] });
   } else {
     await context.sendActivity("no result");
@@ -891,7 +892,8 @@ app.ai.action("{{operationId}}", async (context: TurnContext, state: Application
     const result = await path.{{method}}(parameter.path, parameter.body, {
       params: parameter.query,
     });
-    const card = generateAdaptiveCard("../adaptiveCards/{{operationId}}.json", result);
+    const cardName = "{{operationId}}".replace(/[^a-zA-Z0-9]/g, "_");
+    const card = generateAdaptiveCard("../adaptiveCards/" + cardName + ".json", result);
     await context.sendActivity({ attachments: [card] });
   } else {
     await context.sendActivity("no result");

diff --git a/packages/spec-parser/src/specParser.ts b/packages/spec-parser/src/specParser.ts
@@ -366,12 +366,13 @@ export class SpecParser {
               const operation = (newSpec.paths[url] as any)[method] as OpenAPIV3.OperationObject;
               try {
                 const [card, jsonPath] = AdaptiveCardGenerator.generateAdaptiveCard(operation);
-                const fileName = path.join(adaptiveCardFolder, `${operation.operationId!}.json`);
+                const safeAdaptiveCardName = operation.operationId!.replace(/[^a-zA-Z0-9]/g, "_");
+                const fileName = path.join(adaptiveCardFolder, `${safeAdaptiveCardName}.json`);
                 const wrappedCard = wrapAdaptiveCard(card, jsonPath);
                 await fs.outputJSON(fileName, wrappedCard, { spaces: 2 });
                 const dataFileName = path.join(
                   adaptiveCardFolder,
-                  `${operation.operationId!}.data.json`
+                  `${safeAdaptiveCardName}.data.json`
                 );
                 await fs.outputJSON(dataFileName, {}, { spaces: 2 });
               } catch (err) {

diff --git a/packages/spec-parser/test/specParser.test.ts b/packages/spec-parser/test/specParser.test.ts
@@ -1320,6 +1320,7 @@ describe("SpecParser", () => {
         paths: {
           "/hello": {
             get: {
+              operationId: "helloApi",
               responses: {
                 200: {
                   content: {
@@ -1395,6 +1396,7 @@ describe("SpecParser", () => {
           "/hello": {
             description: "additional description",
             get: {
+              operationId: "helloApi",
               responses: {
                 200: {
                   content: {