Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: continue openapi imports on error with a partial import #4535

Merged
merged 2 commits into from
Nov 25, 2024
Merged

chore: continue openapi imports on error with a partial import #4535

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34e8e21
fix: continue parsing openapi doc instead of failing
amk-dev Nov 13, 2024
668027d
fix: add a very basic validation for openapi docs
amk-dev Nov 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 69 additions & 2 deletions packages/hoppscotch-common/src/helpers/import-export/import/openapi.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,42 @@ const objectHasProperty = <T extends string>(
typeof obj === "object" &&
Object.prototype.hasOwnProperty.call(obj, propName)

// basic validation for OpenAPI V2 Document
const isOpenAPIV2Document = (doc: unknown): doc is OpenAPIV2.Document => {
return (
objectHasProperty(doc, "swagger") &&
typeof doc.swagger === "string" &&
doc.swagger === "2.0"
)
}

// basic validation for OpenAPI V3 Document
const isOpenAPIV3Document = (
doc: unknown
): doc is OpenAPIV3.Document | OpenAPIV31.Document => {
return (
objectHasProperty(doc, "openapi") &&
typeof doc.openapi === "string" &&
doc.openapi.startsWith("3.")
)
}

const hasRequiredOpenAPIFields = (doc: unknown): boolean => {
return (
objectHasProperty(doc, "info") &&
objectHasProperty(doc.info, "title") &&
objectHasProperty(doc.info, "version") &&
objectHasProperty(doc, "paths")
)
}

const isABasicOpenAPIDoc = (doc: unknown): boolean => {
return (
(isOpenAPIV2Document(doc) || isOpenAPIV3Document(doc)) &&
hasRequiredOpenAPIFields(doc)
)
}

type OpenAPIPathInfoType =
| OpenAPIV2.PathItemObject<Record<string, unknown>>
| OpenAPIV3.PathItemObject<Record<string, unknown>>
Expand Down Expand Up @@ -869,8 +905,39 @@ export const hoppOpenAPIImporter = (fileContents: string[]) =>
const resultDoc = []

for (const docObj of docArr) {
const validatedDoc = await SwaggerParser.validate(docObj)
resultDoc.push(validatedDoc)
try {
const isValidOpenAPISpec = isABasicOpenAPIDoc(docObj)

if (!isValidOpenAPISpec) {
throw new Error("INVALID_OPENAPI_SPEC")
}

const validatedDoc = await SwaggerParser.validate(docObj, {
// @ts-expect-error - this is a valid option, but seems like the types are not updated
continueOnError: true,
})

resultDoc.push(validatedDoc)
} catch (err) {
if (
err instanceof Error &&
err.message === "INVALID_OPENAPI_SPEC"
) {
throw new Error("INVALID_OPENAPI_SPEC")
}

if (
// @ts-expect-error the type for err is not exported from the library
err.files &&
// @ts-expect-error the type for err is not exported from the library
err.files instanceof SwaggerParser &&
// @ts-expect-error the type for err is not exported from the library
err.files.schema
) {
// @ts-expect-error the type for err is not exported from the library
resultDoc.push(err.files.schema)
}
}
}

return resultDoc
Expand Down