-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #113 from JaredCE/better-model-behaviour
Big rewrite of the schema handling
- Loading branch information
Showing
21 changed files
with
9,686 additions
and
586 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,189 @@ | ||
| 'use strict' | ||
|
|
||
| const path = require('path') | ||
|
|
||
| const $RefParser = require("@apidevtools/json-schema-ref-parser") | ||
| const SchemaConvertor = require('json-schema-for-openapi') | ||
| const isEqual = require('lodash.isequal') | ||
| const { v4: uuid } = require('uuid') | ||
|
|
||
| class SchemaHandler { | ||
| constructor(serverless, openAPI) { | ||
| this.documentation = serverless.service.custom.documentation | ||
| this.openAPI = openAPI | ||
|
|
||
| this.modelReferences = {} | ||
|
|
||
| this.__standardiseModels() | ||
|
|
||
| try { | ||
| this.refParserOptions = require(path.resolve('options', 'ref-parser.js')) | ||
| } catch (err) { | ||
| this.refParserOptions = {} | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Standardises the models to a specific format | ||
| */ | ||
| __standardiseModels() { | ||
| const standardModel = (model) => { | ||
| if (model.schema) { | ||
| return model | ||
| } | ||
|
|
||
| const contentType = Object.keys(model.content)[0] | ||
| model.contentType = contentType | ||
| model.schema = model.content[contentType].schema | ||
|
|
||
| return model | ||
| } | ||
|
|
||
| const standardisedModels = this.documentation?.models?.map(standardModel) || [] | ||
| const standardisedModelsList = this.documentation?.modelsList?.map(standardModel) || [] | ||
|
|
||
| this.models = standardisedModels.length ? standardisedModels.concat(standardisedModelsList) : standardisedModelsList | ||
| } | ||
|
|
||
| async addModelsToOpenAPI() { | ||
| for (const model of this.models) { | ||
| const modelName = model.name | ||
| const modelSchema = model.schema | ||
|
|
||
| const dereferencedSchema = await this.__dereferenceSchema(modelSchema) | ||
| .catch(err => { | ||
| if(err.errors) { | ||
| for (const error of err?.errors) { | ||
| if (error.message.includes('HTTP ERROR')) { | ||
| throw err | ||
| } | ||
| } | ||
| } | ||
| return modelSchema | ||
| }) | ||
|
|
||
| const convertedSchemas = SchemaConvertor.convert(dereferencedSchema, modelName) | ||
|
|
||
| for (const [schemaName, schemaValue] of Object.entries(convertedSchemas.schemas)) { | ||
| if (schemaName === modelName) { | ||
| this.modelReferences[schemaName] = `#/components/schemas/${modelName}` | ||
| } | ||
|
|
||
| this.__addToComponents('schemas', schemaValue, schemaName) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| async createSchema(name, schema) { | ||
| let originalName = name; | ||
| let finalName = name; | ||
|
|
||
| if (this.modelReferences[name] && schema === undefined) { | ||
| return this.modelReferences[name] | ||
| } | ||
|
|
||
| const dereferencedSchema = await this.__dereferenceSchema(schema) | ||
| .catch(err => { | ||
| throw err | ||
| }) | ||
|
|
||
| const convertedSchemas = SchemaConvertor.convert(dereferencedSchema, name) | ||
|
|
||
| for (const [schemaName, schemaValue] of Object.entries(convertedSchemas.schemas)) { | ||
| if (this.__existsInComponents(schemaName)) { | ||
| if (this.__isTheSameSchema(schemaValue, schemaName) === false) { | ||
| if (schemaName === originalName) { | ||
| finalName = `${schemaName}-${uuid()}` | ||
| this.__addToComponents('schemas', schemaValue, finalName) | ||
| } else { | ||
| this.__addToComponents('schemas', schemaValue, schemaName) | ||
| } | ||
| } | ||
| } else { | ||
| this.__addToComponents('schemas', schemaValue, schemaName) | ||
| } | ||
| } | ||
|
|
||
| return `#/components/schemas/${finalName}` | ||
| } | ||
|
|
||
| async __dereferenceSchema(schema) { | ||
| const bundledSchema = await $RefParser.bundle(schema, this.refParserOptions) | ||
| .catch(err => { | ||
| throw err | ||
| }) | ||
|
|
||
| let deReferencedSchema = await $RefParser.dereference(bundledSchema, this.refParserOptions) | ||
| .catch(err => { | ||
| throw err | ||
| }) | ||
|
|
||
| // deal with schemas that have been de-referenced poorly: naive | ||
| if (deReferencedSchema?.$ref === '#') { | ||
| const oldRef = bundledSchema.$ref | ||
| const path = oldRef.split('/') | ||
|
|
||
| const pathTitle = path[path.length - 1] | ||
| const referencedProperties = deReferencedSchema.definitions[pathTitle] | ||
|
|
||
| Object.assign(deReferencedSchema, { ...referencedProperties }) | ||
|
|
||
| delete deReferencedSchema.$ref | ||
| deReferencedSchema = await this.__dereferenceSchema(deReferencedSchema) | ||
| .catch((err) => { | ||
| throw err | ||
| }) | ||
| } | ||
|
|
||
| return deReferencedSchema | ||
| } | ||
|
|
||
| /** | ||
| * @function existsInComponents | ||
| * @param {string} name - The name of the Schema | ||
| * @returns {boolean} Whether it exists in components already | ||
| */ | ||
| __existsInComponents(name) { | ||
| return Boolean(this.openAPI?.components?.schemas?.[name]) | ||
| } | ||
|
|
||
| /** | ||
| * @function isTheSameSchema | ||
| * @param {object} schema - The schema value | ||
| * @param {string} otherSchemaName - The name of the schema | ||
| * @returns {boolean} Whether the schema provided is the same one as in components already | ||
| */ | ||
| __isTheSameSchema(schema, otherSchemaName) { | ||
| return isEqual(schema, this.openAPI.components.schemas[otherSchemaName]) | ||
| } | ||
|
|
||
| /** | ||
| * @function addToComponents | ||
| * @param {string} type - The component type | ||
| * @param {object} schema - The schema | ||
| * @param {string} name - The name of the schema | ||
| */ | ||
| __addToComponents(type, schema, name) { | ||
| const schemaObj = { | ||
| [name]: schema | ||
| } | ||
|
|
||
| if (this.openAPI?.components) { | ||
| if (this.openAPI.components[type]) { | ||
| Object.assign(this.openAPI.components[type], schemaObj) | ||
| } else { | ||
| Object.assign(this.openAPI.components, { [type]: schemaObj }) | ||
| } | ||
| } else { | ||
| const components = { | ||
| components: { | ||
| [type]: schemaObj | ||
| } | ||
| } | ||
|
|
||
| Object.assign(this.openAPI, components) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| module.exports = SchemaHandler; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| { | ||
| "models": [ | ||
| { | ||
| "name": "ErrorResponse", | ||
| "description": "The Error Response", | ||
| "contentType": "application/json", | ||
| "schema": { | ||
| "type": "object", | ||
| "properties": { | ||
| "error": { | ||
| "type": "string" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } |
Oops, something went wrong.