refactor code and test with twilio plugin

lowcoder-org · FalkWolsky · Aug 10, 2024 · Aug 2, 2024 · Aug 2, 2024 · Aug 5, 2024
commit da3c0aa0d661c95dc1d377cb158c2c5f1970395c
diff --git a/server/node-service/src/common/util.ts b/server/node-service/src/common/util.ts
@@ -1,5 +1,9 @@
 import yaml from "yaml";
 import fs from "fs";
+import { MultiOpenApiSpecItem } from "../plugins/openApi/parse";
+import path from "path";
+import { appendTags } from "../plugins/openApi/util";
+import _ from "lodash";
 
 export function kvToRecord(
   kvs: { key: string; value: string }[],
@@ -85,3 +89,36 @@ export function safeJsonStringify(data: any) {
     return null;
   }
 }
+
+export function specsToOptions(specs: any) {
+  return Object.keys(specs).map(k => ({value: k, label: k}));
+}
+
+function genTagFromFileName(name: string) {
+  const fileName = name.replace(/\.yaml|twilio_|\.json/g, "");
+  const parts = fileName.split("_");
+  return parts.reduce((a, b) => {
+    if (/v\d+/.test(b)) {
+      return `${a}(${b})`;
+    }
+    return a + _.upperFirst(b);
+  }, "");
+}
+
+export function dirToSpecList(specDir: string) {
+  const specList: MultiOpenApiSpecItem[] = [];
+
+  const start = performance.now();
+  const specFiles = fs.readdirSync(specDir);
+  specFiles.forEach((specFile) => {
+    const spec = readYaml(path.join(specDir, specFile));
+    const tag = genTagFromFileName(specFile);
+    appendTags(spec, tag);
+    specList.push({
+      id: tag,
+      spec,
+    });
+  });
+  logger.info("spec list loaded %s, duration: %d ms",specDir, performance.now() - start);
+  return specList;
+}
diff --git a/server/node-service/src/plugins/asana/index.ts b/server/node-service/src/plugins/asana/index.ts
@@ -1,4 +1,4 @@
-import { readYaml } from "../../common/util";
+import { readYaml, specsToOptions } from "../../common/util";
 import _ from "lodash";
 import path from "path";
 import { OpenAPIV3, OpenAPI } from "openapi-types";
@@ -8,7 +8,10 @@ import { parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 
 
 const spec = readYaml(path.join(__dirname, "./asana.spec.yaml"));
-
+const specs = {
+  "v1.0": spec,
+  "v2.0": spec,
+}
 
 const dataSourceConfig = {
   type: "dataSource",
@@ -30,16 +33,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ]
 } as const;

diff --git a/server/node-service/src/plugins/circleCi/index.ts b/server/node-service/src/plugins/circleCi/index.ts
@@ -5,6 +5,11 @@ import { runOpenApi } from "../openApi";
 import { parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 
 import spec from "./circleCi.spec.json";
+import { specsToOptions } from "../../common/util";
+const specs = {
+  "v1.0": spec,
+  "v2.0": spec,
+}
 
 const dataSourceConfig = {
   type: "dataSource",
@@ -22,16 +27,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;

diff --git a/server/node-service/src/plugins/cloudinary/index.ts b/server/node-service/src/plugins/cloudinary/index.ts
@@ -1,4 +1,4 @@
-import { readYaml } from "../../common/util";
+import { readYaml, specsToOptions } from "../../common/util";
 import _ from "lodash";
 import path from "path";
 import { OpenAPI } from "openapi-types";
@@ -14,7 +14,12 @@ const specList = [
   { spec: adminApiSpec, id: "admin" },
   { spec: uploadApiSpec, id: "upload" },
 ];
+const specs = {
+  "v1.0": specList,
+  "v2.0": specList,
+}
 
+//TODO: Thomas
 const dataSourceConfig = {
   type: "dataSource",
   params: [
@@ -38,16 +43,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;

diff --git a/server/node-service/src/plugins/couchdb/index.ts b/server/node-service/src/plugins/couchdb/index.ts
@@ -4,7 +4,11 @@ import { ConfigToType, DataSourcePlugin } from "lowcoder-sdk/dataSource";
 import { runOpenApi } from "../openApi";
 import { defaultParseOpenApiOptions, parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 import spec from "./CouchDB-3.1.1-resolved.json";
-
+import { specsToOptions } from "../../common/util";
+const specs = {
+  "v1.0": spec,
+  "v2.0": spec,
+}
 const dataSourceConfig = {
   type: "dataSource",
   params: [
@@ -44,16 +48,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;

diff --git a/server/node-service/src/plugins/datadog/index.ts b/server/node-service/src/plugins/datadog/index.ts
@@ -1,4 +1,4 @@
-import { readYaml } from "../../common/util";
+import { readYaml, specsToOptions } from "../../common/util";
 import _ from "lodash";
 import path from "path";
 import { OpenAPIV3, OpenAPI } from "openapi-types";
@@ -7,6 +7,10 @@ import { runOpenApi } from "../openApi";
 import { parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 
 const spec = readYaml(path.join(__dirname, "./datadog.spec.yaml"));
+const specs = {
+  "v1.0": spec,
+  "v2.0": spec,
+}
 
 const dataSourceConfig = {
   type: "dataSource",
@@ -33,16 +37,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;

diff --git a/server/node-service/src/plugins/did/index.ts b/server/node-service/src/plugins/did/index.ts
@@ -1,26 +1,14 @@
-import { readYaml } from "../../common/util";
+import { dirToSpecList, specsToOptions } from "../../common/util";
 import _ from "lodash";
 import path from "path";
-import { OpenAPIV3, OpenAPI } from "openapi-types";
-import { QueryConfig, ConfigToType, DataSourcePlugin } from "lowcoder-sdk/dataSource";
+import { OpenAPI } from "openapi-types";
+import { ConfigToType, DataSourcePlugin, QueryConfig } from "lowcoder-sdk/dataSource";
 import { runOpenApi } from "../openApi";
-import { MultiOpenApiSpecItem, parseMultiOpenApi, ParseOpenApiOptions } from "../openApi/parse";
-import { appendTags } from "../../plugins/openApi/util";
-import { readdirSync } from "fs";
+import { parseMultiOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 
-const specList: MultiOpenApiSpecItem[] = [];
-const specFiles = readdirSync(path.join(__dirname, "./did.spec"));
-const start = performance.now();
-specFiles.forEach((specFile) => {
-  const spec = readYaml(path.join(__dirname, "./did.spec", specFile));
-  const tag = _.upperFirst(specFile.replace(".json", ""));
-  appendTags(spec, tag);
-  specList.push({
-    spec,
-    id: tag,
-  });
-});
-logger.info("did spec list loaded, duration: %d ms", performance.now() - start);
+const specs = {
+  "v1.0": dirToSpecList(path.join(__dirname, "./did.spec")),
+}
 
 const dataSourceConfig = {
   type: "dataSource",
@@ -50,16 +38,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;
@@ -80,9 +59,9 @@ const didPlugin: DataSourcePlugin<any, DataSourceConfigType> = {
   icon: "did.svg",
   category: "api",
   dataSourceConfig,
-  queryConfig: async () => {
+  queryConfig: async (data) => {
     if (!queryConfig) {
-      const { actions, categories } = await parseMultiOpenApi(specList, parseOptions);
+      const { actions, categories } = await parseMultiOpenApi(specs[data.specVersion as keyof typeof specs], parseOptions);
       queryConfig = {
         type: "query",
         label: "Action",
@@ -102,7 +81,7 @@ const didPlugin: DataSourcePlugin<any, DataSourceConfigType> = {
       dynamicParamsConfig: dataSourceConfig,
       specVersion: dataSourceConfig.specVersion,
     };
-    return runOpenApi(actionData, runApiDsConfig, specList);
+    return runOpenApi(actionData, runApiDsConfig, specs[dataSourceConfig.specVersion as keyof typeof specs]);
   },
 };
 

diff --git a/server/node-service/src/plugins/front/index.ts b/server/node-service/src/plugins/front/index.ts
@@ -5,6 +5,11 @@ import { runOpenApi } from "../openApi";
 import { parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 
 import spec from "./front.spec.json";
+import { specsToOptions } from "../../common/util";
+const specs = {
+  "v1.0": spec,
+  "v2.0": spec,
+}
 
 const dataSourceConfig = {
   type: "dataSource",
@@ -20,16 +25,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;

diff --git a/server/node-service/src/plugins/github/index.ts b/server/node-service/src/plugins/github/index.ts
@@ -1,4 +1,4 @@
-import { readYaml } from "../../common/util";
+import { readYaml, specsToOptions } from "../../common/util";
 import _ from "lodash";
 import path from "path";
 import { OpenAPIV3, OpenAPI } from "openapi-types";
@@ -8,6 +8,10 @@ import { parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 import SwaggerParser from "@apidevtools/swagger-parser";
 
 const spec = readYaml(path.join(__dirname, "./github.spec.yaml"));
+const specs = {
+  "v1.0": spec,
+  "v2.0": spec,
+}
 
 const dataSourceConfig = {
   type: "dataSource",
@@ -33,16 +37,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;

diff --git a/server/node-service/src/plugins/huggingFaceEndpoint/index.ts b/server/node-service/src/plugins/huggingFaceEndpoint/index.ts
@@ -5,6 +5,11 @@ import { runOpenApi } from "../openApi";
 import { parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";
 
 import spec from "./huggingFace.spec.json";
+import { specsToOptions } from "../../common/util";
+const specs = {
+  "v1.0": spec,
+  "v2.0": spec,
+}
 
 const dataSourceConfig = {
   type: "dataSource",
@@ -31,16 +36,7 @@ const dataSourceConfig = {
       type: "select",
       tooltip: "Version of the spec file.",
       placeholder: "v1.0",
-      options: [
-        {
-          value: "v1.0",
-          label: "v1.0",
-        },
-        {
-          value: "v2.0",
-          label: "v2.0",
-        }
-      ]
+      options: specsToOptions(specs)
     },
   ],
 } as const;