Skip to content

Commit

Permalink
chore: remove unnecessary error handling
Browse files Browse the repository at this point in the history
This error handling was unnecessary, as shown in the test I added. The validation section above it flags this, so there theoretically shouldn't be any errors bundling that wouldn't already be flagged in the validation section above.
  • Loading branch information
kanadgupta committed Jun 23, 2022
1 parent 51a5ebb commit 0327f34
Show file tree
Hide file tree
Showing 5 changed files with 323 additions and 9 deletions.
179 changes: 179 additions & 0 deletions __tests__/__fixtures__/invalid-ref-oas/external-components.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,179 @@
{
"requestBodies": {
"Pet": {
"content": {
"application/json": {
"schema": {
"$ref": "#/schemas/Pet"
}
},
"application/xml": {
"schema": {
"$ref": "#/schemas/Pet"
}
}
},
"description": "Pet object that needs to be added to the store",
"required": true
}
},
"schemas": {
"Order": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"petId": {
"type": "integer",
"format": "int64"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"shipDate": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string",
"description": "Order Status",
"enum": [
"placed",
"approved",
"delivered"
]
},
"complete": {
"type": "boolean",
"default": false
}
},
"xml": {
"name": "Order"
}
},
"Category": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"xml": {
"name": "Category"
}
},
"User": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"username": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string"
},
"email": {
"type": "string"
},
"password": {
"type": "string"
},
"phone": {
"type": "string"
},
"userStatus": {
"type": "integer",
"format": "int32",
"description": "User Status"
}
},
"xml": {
"name": "User"
}
},
"Tag": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
}
},
"xml": {
"name": "Tag"
}
},
"Pet": {
"type": "object",
"required": [
"name",
"photoUrls"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"default": 40,
"example": 25
},
"category": {
"$ref": "#/schemas/Category"
},
"name": {
"type": "string",
"example": "doggie"
},
"photoUrls": {
"type": "array",
"xml": {
"name": "photoUrl",
"wrapped": true
},
"items": {
"type": "string",
"example": "https://example.com/photo.png"
}
},
"tags": {
"type": "array",
"xml": {
"name": "tag",
"wrapped": true
},
"items": {
"$ref": "#/schemas/Tag"
}
},
"status": {
"type": "string",
"description": "pet status in the store",
"enum": [
"available",
"pending",
"sold"
]
}
},
"xml": {
"name": "Pet"
}
}
}
}
132 changes: 132 additions & 0 deletions __tests__/__fixtures__/invalid-ref-oas/petstore.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Example petstore to demo our handling of external $ref pointers"
},
"servers": [
{
"url": "http://petstore.swagger.io/v2"
}
],
"paths": {
"/pet": {
"post": {
"tags": ["pet"],
"summary": "Add a new pet to the store",
"description": "",
"operationId": "addPet",
"requestBody": {
"$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/requestBodies/Petty"
},
"responses": {
"405": {
"description": "Invalid input"
}
},
"security": [
{
"petstore_auth": ["write:pets", "read:pets"]
}
]
},
"put": {
"tags": ["pet"],
"summary": "Update an existing pet",
"description": "",
"operationId": "updatePet",
"requestBody": {
"$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/requestBodies/Petty"
},
"responses": {
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
},
"405": {
"description": "Validation exception"
}
},
"security": [
{
"petstore_auth": ["write:pets", "read:pets"]
}
]
}
},
"/pet/{petId}": {
"get": {
"tags": ["pet"],
"summary": "Find pet by ID",
"description": "Returns a single pet",
"operationId": "getPetById",
"parameters": [
{
"name": "petId",
"in": "path",
"description": "ID of pet to return",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/xml": {
"schema": {
"$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/schemas/Petty"
}
},
"application/json": {
"schema": {
"$ref": "__tests__/__fixtures__/ref-oas/external-components.json#/schemas/Petty"
}
}
}
},
"400": {
"description": "Invalid ID supplied"
},
"404": {
"description": "Pet not found"
},
"default": {
"description": "successful response"
}
},
"security": [
{
"api_key": []
}
]
}
}
},
"components": {
"securitySchemes": {
"petstore_auth": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
"scopes": {
"write:pets": "modify pets in your account",
"read:pets": "read your pets"
}
}
}
},
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "header"
}
}
}
}
2 changes: 2 additions & 0 deletions __tests__/cmds/__snapshots__/openapi.test.js.snap
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ REQUIRED must have required property 'name'
29 | }]
`;
exports[`rdme openapi error handling should throw an error if an invalid ref is supplied 1`] = `[MissingPointerError: Token "Petty" does not exist.]`;
exports[`rdme openapi upload should bundle and upload the expected content 1`] = `
Object {
"components": Object {
Expand Down
6 changes: 6 additions & 0 deletions __tests__/cmds/openapi.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,12 @@ describe('rdme openapi', () => {
).rejects.toMatchSnapshot();
});

it.only('should throw an error if an invalid ref is supplied', () => {
return expect(
openapi.run({ spec: './__tests__/__fixtures__/invalid-ref-oas/petstore.json', key, id, version })
).rejects.toMatchSnapshot();
});

it('should throw an error if an invalid Swagger definition is supplied (create)', async () => {
const errorObject = {
error: 'INTERNAL_ERROR',
Expand Down
13 changes: 4 additions & 9 deletions src/lib/prepareOas.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,10 @@ module.exports = async function prepare(path, bundle = false) {
let bundledSpec = '';

if (bundle) {
bundledSpec = await oas
.bundle()
.then(res => {
return JSON.stringify(res);
})
.catch(err => {
debug(`raw bundling error object: ${JSON.stringify(err)}`);
throw err;
});
bundledSpec = await oas.bundle().then(res => {
return JSON.stringify(res);
});

debug('spec bundled');
}

Expand Down

0 comments on commit 0327f34

Please sign in to comment.