Commit ffa595a

authored

Merge pull request #750 from snowe2010/optimize-runOpenApi

optimize /runOpenApi to allow pre-dereferencing OpenAPI Spec

2 parents 4f80cae + 275cf68 commit ffa595aCopy full SHA for ffa595a

File tree

2 files changed

+32

-19

lines changed

server/node-service/src/plugins
- github
  - index.ts
- openApi
  - index.ts

2 files changed

+32

-19

lines changed

`‎server/node-service/src/plugins/github/index.ts‎`

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import { OpenAPIV3, OpenAPI } from "openapi-types";`
`5`	`5`	`import { ConfigToType, DataSourcePlugin } from "lowcoder-sdk/dataSource";`
`6`	`6`	`import { runOpenApi } from "../openApi";`
`7`	`7`	`import { parseOpenApi, ParseOpenApiOptions } from "../openApi/parse";`
	`8`	`+import SwaggerParser from "@apidevtools/swagger-parser";`
`8`	`9`
`9`	`10`	`const spec = readYaml(path.join(__dirname, "./github.spec.yaml"));`
`10`	`11`
`@@ -34,6 +35,7 @@ const parseOptions: ParseOpenApiOptions = {`
`34`	`35`	`return _.upperFirst(operation.operationId \|\| "");`
`35`	`36`	`},`
`36`	`37`	`};`
	`38`	`+const deRefedSpec = SwaggerParser.dereference(spec);`
`37`	`39`
`38`	`40`	`type DataSourceConfigType = ConfigToType<typeof dataSourceConfig>;`
`39`	`41`
`@@ -55,13 +57,13 @@ const gitHubPlugin: DataSourcePlugin<any, DataSourceConfigType> = {`
`55`	`57`	`actions,`
`56`	`58`	`};`
`57`	`59`	`},`
`58`		`- run: function (actionData, dataSourceConfig): Promise<any> {`
	`60`	`+ run: asyncfunction (actionData, dataSourceConfig,ctx): Promise<any> {`
`59`	`61`	`const runApiDsConfig = {`
`60`	`62`	`url: "",`
`61`	`63`	`serverURL: "https://api.github.com",`
`62`	`64`	`dynamicParamsConfig: dataSourceConfig,`
`63`	`65`	`};`
`64`		`- return runOpenApi(actionData, runApiDsConfig, spec as OpenAPIV3.Document);`
	`66`	`+ return runOpenApi(actionData, runApiDsConfig, spec as OpenAPIV3.Document,undefined,awaitdeRefedSpec);`
`65`	`67`	`},`
`66`	`68`	`};`
`67`	`69`

`‎server/node-service/src/plugins/openApi/index.ts‎`

Lines changed: 28 additions & 17 deletions

Original file line number	Diff line number	Diff line change
`@@ -12,11 +12,10 @@ import {`
`12`	`12`	`isFile,`
`13`	`13`	`} from "./util";`
`14`	`14`	`import { badRequest } from "../../common/error";`
`15`		`-import { safeJsonParse } from "../../common/util";`
`16`	`15`	`import { OpenAPI, OpenAPIV2, OpenAPIV3 } from "openapi-types";`
`17`	`16`	`import _ from "lodash";`
`18`	`17`	`import { fetch } from "../../common/fetch";`
`19`		`-import { RequestInit,Response } from "node-fetch";`
	`18`	`+import { RequestInit } from "node-fetch";`
`20`	`19`
`21`	`20`	`const dataSourceConfig = {`
`22`	`21`	`type: "dataSource",`
`@@ -50,30 +49,42 @@ interface ActionDataType {`
`50`	`49`	`[key: string]: any;`
`51`	`50`	`}`
`52`	`51`
	`52`	`+async function getDefinitions(`
	`53`	`+ spec: OpenAPI.Document \| MultiOpenApiSpecItem[],`
	`54`	`+ openApiSpecDereferenced?: OpenAPI.Document,`
	`55`	`+): Promise<{ def: OpenAPI.Document; id: string }[]> {`
	`56`	`+ if (openApiSpecDereferenced) {`
	`57`	`+ return [{`
	`58`	`+ def: openApiSpecDereferenced,`
	`59`	`+ id: "",`
	`60`	`+ }]`
	`61`	`+ } else {`
	`62`	`+ const specList = Array.isArray(spec) ? spec : [{ spec, id: "" }];`
	`63`	`+ return await Promise.all(`
	`64`	`+ specList.map(async ({id, spec}) => {`
	`65`	`+ const deRefedSpec = await SwaggerParser.dereference(spec);`
	`66`	`+ return {`
	`67`	`+ def: deRefedSpec,`
	`68`	`+ id,`
	`69`	`+ };`
	`70`	`+ })`
	`71`	`+ );`
	`72`	`+ }`
	`73`	`+}`
	`74`	`+`
`53`	`75`	`export async function runOpenApi(`
`54`	`76`	`actionData: ActionDataType,`
`55`	`77`	`dataSourceConfig: DataSourceDataType,`
`56`	`78`	`spec: OpenAPI.Document \| MultiOpenApiSpecItem[],`
`57`		`- defaultHeaders?: Record<string, string>`
	`79`	`+ defaultHeaders?: Record<string, string>,`
	`80`	`+ openApiSpecDereferenced?: OpenAPI.Document,`
`58`	`81`	`) {`
`59`		`- const specList = Array.isArray(spec) ? spec : [{ spec, id: "" }];`
`60`		`- const definitions = await Promise.all(`
`61`		`- specList.map(async ({ id, spec }) => {`
`62`		`- const deRefedSpec = await SwaggerParser.dereference(spec);`
`63`		`- return {`
`64`		`- def: deRefedSpec,`
`65`		`- id,`
`66`		`- };`
`67`		`- })`
`68`		`- );`
`69`	`82`	`const { actionName, ...otherActionData } = actionData;`
`70`	`83`	`const { serverURL } = dataSourceConfig;`
`71`	`84`
`72`		`- let definition: OpenAPI.Document \| undefined;`
`73`		`- let operation;`
`74`		`- let realOperationId;`
	`85`	`+ let operation, realOperationId, definition: OpenAPI.Document \| undefined;`
`75`	`86`
`76`		`- for (const {id, def} of definitions) {`
	`87`	`+ for (const {id, def} of awaitgetDefinitions(spec,openApiSpecDereferenced)) {`
`77`	`88`	`const ret = findOperation(actionName, def, id);`
`78`	`89`	`if (ret) {`
`79`	`90`	`definition = def;`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit ffa595a

File tree

2 files changed

2 files changed

`‎server/node-service/src/plugins/github/index.ts‎`

`‎server/node-service/src/plugins/openApi/index.ts‎`

0 commit comments