Optimize the runOpenApi plugin

snowe2010 · FalkWolsky · commit 3bf3ebfa9164 · 2024-03-24T14:55:55.000+01:00
allow passing in an already dereferenced OpenAPI Document for plugins
that have large openapi specs like github. This takes the runtime for
Github from over 10s to ~1s on an M1 Max.

Adjust the github plugin to use this new capability by dereferencing on
plugin initialization, passing the derefed document to the runOpenApi
function.
diff --git a/server/node-service/src/plugins/openApi/index.ts b/server/node-service/src/plugins/openApi/index.ts
@@ -79,6 +79,27 @@ export async function runOpenApi(
   defaultHeaders?: Record<string, string>,
   openApiSpecDereferenced?: OpenAPI.Document,
 ) {
+
+  const specList = Array.isArray(spec) ? spec : [{ spec, id: "" }];
+  let definitions;
+
+  if (!openApiSpecDereferenced) {
+    definitions = await Promise.all(
+      specList.map(async ({id, spec}) => {
+        const deRefedSpec = await SwaggerParser.dereference(spec);
+        return {
+          def: deRefedSpec,
+          id,
+        };
+      })
+    );
+  } else {
+    definitions = [{
+      def: openApiSpecDereferenced,
+      id: "",
+    }]
+  }
+
   const { actionName, ...otherActionData } = actionData;
   const { serverURL } = dataSourceConfig;
 
