perf(spec-parser): add namespace for plugin.json (#11377)

* perf(spec-parser): add namespace for plugin.json * perf: update schema version to 2.1 * perf: update test case --------- Co-authored-by: rentu <rentu@microsoft.com>
OfficeDev · Apr 16, 2024 · 587bbb4 · 587bbb4
1 parent 46b2d03
commit 587bbb4
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 17 deletions.
diff --git a/packages/spec-parser/src/manifestUpdater.ts b/packages/spec-parser/src/manifestUpdater.ts
@@ -209,9 +209,10 @@ export class ManifestUpdater {
       apiPlugin = await fs.readJSON(apiPluginFilePath);
     } else {
       apiPlugin = {
-        schema_version: "v2",
+        schema_version: "v2.1",
         name_for_human: "",
         description_for_human: "",
+        namespace: "",
         functions: [],
         runtimes: [],
       };
@@ -249,6 +250,10 @@ export class ManifestUpdater {
       apiPlugin.name_for_human = appName;
     }
 
+    if (!apiPlugin.namespace) {
+      apiPlugin.namespace = ManifestUpdater.removeAllSpecialCharacters(appName);
+    }
+
     if (!apiPlugin.description_for_human) {
       apiPlugin.description_for_human =
         spec.info.description ?? "<Please add description of the plugin>";
@@ -417,4 +422,8 @@ export class ManifestUpdater {
     }
     return newStr;
   }
+
+  static removeAllSpecialCharacters(str: string): string {
+    return str.toLowerCase().replace(/[^a-z0-9]/g, "");
+  }
 }
diff --git a/packages/spec-parser/test/manifestUpdater.test.ts b/packages/spec-parser/test/manifestUpdater.test.ts
@@ -71,8 +71,9 @@ describe("updateManifestWithAiPlugin", () => {
       };
 
       const expectedPlugins: PluginManifestSchema = {
-        schema_version: "v2",
+        schema_version: "v2.1",
         name_for_human: "Original Name",
+        namespace: "originalname",
         description_for_human: "My API description",
         functions: [
           {
@@ -221,8 +222,9 @@ describe("updateManifestWithAiPlugin", () => {
       };
 
       const expectedPlugins: PluginManifestSchema = {
-        schema_version: "v2",
+        schema_version: "v2.1",
         name_for_human: "Original Name",
+        namespace: "originalname",
         description_for_human: "My API description",
         functions: [
           {
@@ -388,8 +390,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "My API description",
       functions: [
         {
@@ -527,8 +530,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "<Please add description of the plugin>",
       functions: [
         {
@@ -668,8 +672,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "<Please add description of the plugin>",
       capabilities: {
         conversation_starters: [
@@ -817,8 +822,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "<Please add description of the plugin>",
       capabilities: {
         conversation_starters: [
@@ -884,7 +890,7 @@ describe("updateManifestWithAiPlugin", () => {
       .resolves(originalManifest)
       .withArgs(pluginFilePath)
       .resolves({
-        schema_version: "v2",
+        schema_version: "v2.1",
         name_for_human: "",
         description_for_human: "",
         capabilities: {
@@ -988,8 +994,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "My API description",
       functions: [
         {
@@ -1084,7 +1091,7 @@ describe("updateManifestWithAiPlugin", () => {
       .resolves(originalManifest)
       .withArgs(pluginFilePath)
       .resolves({
-        schema_version: "v2",
+        schema_version: "v2.1",
         name_for_human: "",
         description_for_human: "",
         functions: [
@@ -1219,8 +1226,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "exist_name",
+      namespace: "existnamespace",
       description_for_human: "exist_description",
       functions: [
         {
@@ -1277,8 +1285,9 @@ describe("updateManifestWithAiPlugin", () => {
       .resolves(originalManifest)
       .withArgs(pluginFilePath)
       .resolves({
-        schema_version: "v2",
+        schema_version: "v2.1",
         name_for_human: "exist_name",
+        namespace: "existnamespace",
         description_for_human: "exist_description",
       });
 
@@ -1370,8 +1379,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "My API description",
       functions: [
         {
@@ -1428,7 +1438,7 @@ describe("updateManifestWithAiPlugin", () => {
       .resolves(originalManifest)
       .withArgs(pluginFilePath)
       .resolves({
-        schema_version: "v2",
+        schema_version: "v2.1",
         name_for_human: "",
         description_for_human: "",
         functions: [
@@ -1572,8 +1582,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "My API description",
       functions: [
         {
@@ -1719,8 +1730,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "My API description",
       functions: [
         {
@@ -1826,8 +1838,9 @@ describe("updateManifestWithAiPlugin", () => {
     };
 
     const expectedPlugins: PluginManifestSchema = {
-      schema_version: "v2",
+      schema_version: "v2.1",
       name_for_human: "Original Name",
+      namespace: "originalname",
       description_for_human: "My API description",
       functions: [],
       runtimes: [