-
Notifications
You must be signed in to change notification settings - Fork 188
/
specParser.ts
452 lines (400 loc) · 15.1 KB
/
specParser.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
"use strict";
import SwaggerParser from "@apidevtools/swagger-parser";
import { OpenAPIV3 } from "openapi-types";
import converter from "swagger2openapi";
import jsyaml from "js-yaml";
import fs from "fs-extra";
import path from "path";
import {
APIInfo,
APIMap,
AuthInfo,
ErrorResult,
ErrorType,
GenerateResult,
ListAPIInfo,
ListAPIResult,
ParseOptions,
ProjectType,
ValidateResult,
ValidationStatus,
WarningResult,
WarningType,
} from "./interfaces";
import { ConstantString } from "./constants";
import { SpecParserError } from "./specParserError";
import { SpecFilter } from "./specFilter";
import { Utils } from "./utils";
import { ManifestUpdater } from "./manifestUpdater";
import { AdaptiveCardGenerator } from "./adaptiveCardGenerator";
import { wrapAdaptiveCard } from "./adaptiveCardWrapper";
import { ValidatorFactory } from "./validators/validatorFactory";
import { Validator } from "./validators/validator";
/**
* A class that parses an OpenAPI specification file and provides methods to validate, list, and generate artifacts.
*/
export class SpecParser {
public readonly pathOrSpec: string | OpenAPIV3.Document;
public readonly parser: SwaggerParser;
public readonly options: Required<ParseOptions>;
private validator: Validator | undefined;
private spec: OpenAPIV3.Document | undefined;
private unResolveSpec: OpenAPIV3.Document | undefined;
private isSwaggerFile: boolean | undefined;
private defaultOptions: ParseOptions = {
allowMissingId: true,
allowSwagger: true,
allowAPIKeyAuth: false,
allowBearerTokenAuth: false,
allowMultipleParameters: false,
allowOauth2: false,
allowMethods: ["get", "post"],
allowConversationStarters: false,
allowResponseSemantics: false,
projectType: ProjectType.SME,
};
/**
* Creates a new instance of the SpecParser class.
* @param pathOrDoc The path to the OpenAPI specification file or the OpenAPI specification object.
* @param options The options for parsing the OpenAPI specification file.
*/
constructor(pathOrDoc: string | OpenAPIV3.Document, options?: ParseOptions) {
this.pathOrSpec = pathOrDoc;
this.parser = new SwaggerParser();
this.options = {
...this.defaultOptions,
...(options ?? {}),
} as Required<ParseOptions>;
}
/**
* Validates the OpenAPI specification file and returns a validation result.
*
* @returns A validation result object that contains information about any errors or warnings in the specification file.
*/
async validate(): Promise<ValidateResult> {
try {
try {
await this.loadSpec();
await this.parser.validate(this.spec!);
} catch (e) {
return {
status: ValidationStatus.Error,
warnings: [],
errors: [{ type: ErrorType.SpecNotValid, content: (e as Error).toString() }],
};
}
const errors: ErrorResult[] = [];
const warnings: WarningResult[] = [];
if (!this.options.allowSwagger && this.isSwaggerFile) {
return {
status: ValidationStatus.Error,
warnings: [],
errors: [
{ type: ErrorType.SwaggerNotSupported, content: ConstantString.SwaggerNotSupported },
],
};
}
// Remote reference not supported
const refPaths = this.parser.$refs.paths();
// refPaths [0] is the current spec file path
if (refPaths.length > 1) {
errors.push({
type: ErrorType.RemoteRefNotSupported,
content: Utils.format(ConstantString.RemoteRefNotSupported, refPaths.join(", ")),
data: refPaths,
});
}
if (!!this.isSwaggerFile && this.options.allowSwagger) {
warnings.push({
type: WarningType.ConvertSwaggerToOpenAPI,
content: ConstantString.ConvertSwaggerToOpenAPI,
});
}
const validator = this.getValidator(this.spec!);
const validationResult = validator.validateSpec();
warnings.push(...validationResult.warnings);
errors.push(...validationResult.errors);
let status = ValidationStatus.Valid;
if (warnings.length > 0 && errors.length === 0) {
status = ValidationStatus.Warning;
} else if (errors.length > 0) {
status = ValidationStatus.Error;
}
return {
status: status,
warnings: warnings,
errors: errors,
};
} catch (err) {
throw new SpecParserError((err as Error).toString(), ErrorType.ValidateFailed);
}
}
// eslint-disable-next-line @typescript-eslint/require-await
async listSupportedAPIInfo(): Promise<APIInfo[]> {
throw new Error("Method not implemented.");
}
/**
* Lists all the OpenAPI operations in the specification file.
* @returns A string array that represents the HTTP method and path of each operation, such as ['GET /pets/{petId}', 'GET /user/{userId}']
* according to copilot plugin spec, only list get and post method without auth
*/
async list(): Promise<ListAPIResult> {
try {
await this.loadSpec();
const spec = this.spec!;
const apiMap = this.getAPIs(spec);
const result: ListAPIResult = {
APIs: [],
allAPICount: 0,
validAPICount: 0,
};
for (const apiKey in apiMap) {
const { operation, isValid, reason } = apiMap[apiKey];
const [method, path] = apiKey.split(" ");
const operationId =
operation.operationId ?? `${method.toLowerCase()}${Utils.convertPathToCamelCase(path)}`;
const apiResult: ListAPIInfo = {
api: apiKey,
server: "",
operationId: operationId,
isValid: isValid,
reason: reason,
};
if (isValid) {
const serverObj = Utils.getServerObject(spec, method.toLocaleLowerCase(), path);
if (serverObj) {
apiResult.server = Utils.resolveEnv(serverObj.url);
}
const authArray = Utils.getAuthArray(operation.security, spec);
for (const auths of authArray) {
if (auths.length === 1) {
apiResult.auth = auths[0];
break;
}
}
}
result.APIs.push(apiResult);
}
result.allAPICount = result.APIs.length;
result.validAPICount = result.APIs.filter((api) => api.isValid).length;
return result;
} catch (err) {
if (err instanceof SpecParserError) {
throw err;
}
throw new SpecParserError((err as Error).toString(), ErrorType.ListFailed);
}
}
/**
* Generate specs according to the filters.
* @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
*/
async getFilteredSpecs(
filter: string[],
signal?: AbortSignal
): Promise<[OpenAPIV3.Document, OpenAPIV3.Document]> {
try {
if (signal?.aborted) {
throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
}
await this.loadSpec();
if (signal?.aborted) {
throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
}
const newUnResolvedSpec = SpecFilter.specFilter(
filter,
this.unResolveSpec!,
this.spec!,
this.options
);
if (signal?.aborted) {
throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
}
const newSpec = (await this.parser.dereference(newUnResolvedSpec)) as OpenAPIV3.Document;
return [newUnResolvedSpec, newSpec];
} catch (err) {
if (err instanceof SpecParserError) {
throw err;
}
throw new SpecParserError((err as Error).toString(), ErrorType.GetSpecFailed);
}
}
/**
* Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
* @param manifestPath A file path of the Teams app manifest file to update.
* @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
* @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
* @param pluginFilePath File path of the api plugin file to generate.
*/
async generateForCopilot(
manifestPath: string,
filter: string[],
outputSpecPath: string,
pluginFilePath: string,
signal?: AbortSignal
): Promise<GenerateResult> {
const result: GenerateResult = {
allSuccess: true,
warnings: [],
};
try {
const newSpecs = await this.getFilteredSpecs(filter, signal);
const newUnResolvedSpec = newSpecs[0];
const newSpec = newSpecs[1];
let resultStr;
if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
resultStr = jsyaml.dump(newUnResolvedSpec);
} else {
resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
}
await fs.outputFile(outputSpecPath, resultStr);
if (signal?.aborted) {
throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
}
const [updatedManifest, apiPlugin] = await ManifestUpdater.updateManifestWithAiPlugin(
manifestPath,
outputSpecPath,
pluginFilePath,
newSpec,
this.options
);
await fs.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
await fs.outputJSON(pluginFilePath, apiPlugin, { spaces: 2 });
} catch (err) {
if (err instanceof SpecParserError) {
throw err;
}
throw new SpecParserError((err as Error).toString(), ErrorType.GenerateFailed);
}
return result;
}
/**
* Generates and update artifacts from the OpenAPI specification file. Generate Adaptive Cards, update Teams app manifest, and generate a new OpenAPI specification file.
* @param manifestPath A file path of the Teams app manifest file to update.
* @param filter An array of strings that represent the filters to apply when generating the artifacts. If filter is empty, it would process nothing.
* @param outputSpecPath File path of the new OpenAPI specification file to generate. If not specified or empty, no spec file will be generated.
* @param adaptiveCardFolder Folder path where the Adaptive Card files will be generated. If not specified or empty, Adaptive Card files will not be generated.
*/
async generate(
manifestPath: string,
filter: string[],
outputSpecPath: string,
adaptiveCardFolder?: string,
signal?: AbortSignal
): Promise<GenerateResult> {
const result: GenerateResult = {
allSuccess: true,
warnings: [],
};
try {
const newSpecs = await this.getFilteredSpecs(filter, signal);
const newUnResolvedSpec = newSpecs[0];
const newSpec = newSpecs[1];
let hasMultipleAuth = false;
let authInfo: AuthInfo | undefined = undefined;
for (const url in newSpec.paths) {
for (const method in newSpec.paths[url]) {
const operation = (newSpec.paths[url] as any)[method] as OpenAPIV3.OperationObject;
const authArray = Utils.getAuthArray(operation.security, newSpec);
if (authArray && authArray.length > 0) {
const currentAuth = authArray[0][0];
if (!authInfo) {
authInfo = authArray[0][0];
} else if (authInfo.name !== currentAuth.name) {
hasMultipleAuth = true;
break;
}
}
}
}
if (hasMultipleAuth && this.options.projectType !== ProjectType.TeamsAi) {
throw new SpecParserError(
ConstantString.MultipleAuthNotSupported,
ErrorType.MultipleAuthNotSupported
);
}
let resultStr;
if (outputSpecPath.endsWith(".yaml") || outputSpecPath.endsWith(".yml")) {
resultStr = jsyaml.dump(newUnResolvedSpec);
} else {
resultStr = JSON.stringify(newUnResolvedSpec, null, 2);
}
await fs.outputFile(outputSpecPath, resultStr);
if (adaptiveCardFolder) {
for (const url in newSpec.paths) {
for (const method in newSpec.paths[url]) {
// paths object may contain description/summary which is not a http method, so we need to check if it is a operation object
if (this.options.allowMethods.includes(method)) {
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 wrappedCard = wrapAdaptiveCard(card, jsonPath);
await fs.outputJSON(fileName, wrappedCard, { spaces: 2 });
const dataFileName = path.join(
adaptiveCardFolder,
`${operation.operationId!}.data.json`
);
await fs.outputJSON(dataFileName, {}, { spaces: 2 });
} catch (err) {
result.allSuccess = false;
result.warnings.push({
type: WarningType.GenerateCardFailed,
content: (err as Error).toString(),
data: operation.operationId!,
});
}
}
}
}
}
if (signal?.aborted) {
throw new SpecParserError(ConstantString.CancelledMessage, ErrorType.Cancelled);
}
const [updatedManifest, warnings] = await ManifestUpdater.updateManifest(
manifestPath,
outputSpecPath,
newSpec,
this.options,
adaptiveCardFolder,
authInfo
);
await fs.outputJSON(manifestPath, updatedManifest, { spaces: 2 });
result.warnings.push(...warnings);
} catch (err) {
if (err instanceof SpecParserError) {
throw err;
}
throw new SpecParserError((err as Error).toString(), ErrorType.GenerateFailed);
}
return result;
}
private async loadSpec(): Promise<void> {
if (!this.spec) {
this.unResolveSpec = (await this.parser.parse(this.pathOrSpec)) as OpenAPIV3.Document;
// Convert swagger 2.0 to openapi 3.0
if (!this.unResolveSpec.openapi && (this.unResolveSpec as any).swagger === "2.0") {
const specObj = await converter.convert(this.unResolveSpec as any, {});
this.unResolveSpec = specObj.openapi as OpenAPIV3.Document;
this.isSwaggerFile = true;
}
const clonedUnResolveSpec = JSON.parse(JSON.stringify(this.unResolveSpec));
this.spec = (await this.parser.dereference(clonedUnResolveSpec)) as OpenAPIV3.Document;
}
}
private getAPIs(spec: OpenAPIV3.Document): APIMap {
const validator = this.getValidator(spec);
const apiMap = validator.listAPIs();
return apiMap;
}
private getValidator(spec: OpenAPIV3.Document): Validator {
if (this.validator) {
return this.validator;
}
const validator = ValidatorFactory.create(spec, this.options);
this.validator = validator;
return validator;
}
}