Skip to content

Fixes https://github.com/strongloop/loopback-next/issues/4553 #7

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

Merged
raymondfeng merged 2 commits into from
Mar 27, 2020
Merged

Fixes https://github.com/strongloop/loopback-next/issues/4553 #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
306d849
chore: update dependencies
raymondfeng Feb 3, 2020
fddc1df
Ensure swagger parser instances are not shared
raymondfeng Feb 3, 2020
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
6 changes: 2 additions & 4 deletions lib/openapi-connector.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ function OpenApiConnector(settings) {
this.spec = settings.spec;
this.cache = settings.cache;
this.connectorHooks = new ConnectorHooks();
this.specResolver = new SpecResolver();

if (debug.enabled) {
debug('Settings: %j', settings);
Expand Down Expand Up @@ -82,7 +83,7 @@ OpenApiConnector.prototype.connect = function(cb) {
}

const validate = !!self.settings.validate;
SpecResolver.resolve(
self.specResolver.resolve(
self.spec,
{validate: {schema: validate, spec: validate}},
function(err, api) {
Expand Down Expand Up @@ -135,7 +136,6 @@ OpenApiConnector.prototype.setupDataAccessObject = function() {

this.specParsed = true;

/* eslint-disable one-const */
for (const tag in this.client.apis) {
const api = this.client.apis[tag];

Expand Down Expand Up @@ -185,8 +185,6 @@ OpenApiConnector.prototype.setupDataAccessObject = function() {
this.dataSource.mixin(this._models[model].model);
}
return this.DataAccessObject;

/* eslint-enable one-const */
};

function createWrapper(method, operation, options = {positional: false}) {
Expand Down
14 changes: 9 additions & 5 deletions lib/spec-resolver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,20 @@

const SwaggerParser = require('swagger-parser');

const parser = new SwaggerParser();
function SpecResolver() {
this.parser = new SwaggerParser();
}

exports.resolve = function resolveSpec(spec, options, cb) {
SpecResolver.prototype.resolve = function resolveSpec(spec, options, cb) {
if (typeof options === 'function' && !cb) {
cb = options;
}
options = Object.assign({validate: {schema: false, spec: false}}, options);
return parser.validate(spec, options, cb);
return this.parser.validate(spec, options, cb);
};

exports.validate = function validateSpec(spec, cb) {
return parser.validate(spec, {validate: {spec: true, schema: true}}, cb);
SpecResolver.prototype.validate = function validateSpec(spec, cb) {
return this.parser.validate(spec, {validate: {spec: true, schema: true}}, cb);
};

module.exports = SpecResolver;
8 changes: 4 additions & 4 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@
"debug": "^4.1.1",
"js-yaml": "^3.12.2",
"swagger-client": "^3.8.25",
"swagger-parser": "^6.0.5"
"swagger-parser": "^8.0.4"
},
"devDependencies": {
"@loopback/example-todo": "^1.5.1",
"eslint": "^5.14.1",
"eslint": "^6.8.0",
"eslint-config-loopback": "^13.0.0",
"loopback": "^3.25.0",
"mocha": "^6.0.2",
"mocha": "^7.0.1",
"p-event": "^4.0.0",
"should": "^11.1.2"
"should": "^13.2.3"
},
"repository": {
"type": "git",
Expand Down
32 changes: 18 additions & 14 deletions test/test-spec-resolver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,22 @@
/* eslint-disable max-len */

const should = require('should');
const resolveSpec = require('../lib/spec-resolver').resolve;
const validateSpec = require('../lib/spec-resolver').validate;
const SpecResolver = require('../lib/spec-resolver');

describe('OpenAPI Spec SpecResolver', () => {
let specResolver;
beforeEach(() => {
specResolver = new SpecResolver();
});

describe('OpenAPI Spec resolver', () => {
it('Should set url when given spec is a url', async () => {
const spec = 'http://sample.com/swaggerAPI.json';
resolveSpec(spec).should.be.rejectedWith('');
specResolver.resolve(spec).should.be.rejectedWith('');
});

it('Should set spec object when given spec is swagger specification object', function(done) {
const spec = require('./fixtures/2.0/petstore');
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
if (err) return done(err);
api.should.have.property('swagger');
done();
Expand All @@ -28,7 +32,7 @@ describe('OpenAPI Spec resolver', () => {

it('Should not accept specification types other than string/plain object', function(done) {
const spec = function test() {};
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
should.exist(err);
done();
});
Expand All @@ -37,7 +41,7 @@ describe('OpenAPI Spec resolver', () => {
describe('File handling & spec resolution', function() {
it('should read & set swagger spec from a local .json file', function(done) {
const spec = './test/fixtures/2.0/petstore.json';
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
if (err) return done(err);
api.should.have.property('swagger');
done();
Expand All @@ -46,7 +50,7 @@ describe('OpenAPI Spec resolver', () => {

it('should read & set swagger spec from a local .yaml file', function(done) {
const spec = './test/fixtures/2.0/petstore.yaml';
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
if (err) return done(err);
api.should.have.property('swagger');
done();
Expand All @@ -55,7 +59,7 @@ describe('OpenAPI Spec resolver', () => {

it('should support .yml extension for YAML spec files', function(done) {
const spec = './test/fixtures/2.0/petstore.yml';
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
if (err) return done(err);
api.should.have.property('swagger');
done();
Expand All @@ -64,7 +68,7 @@ describe('OpenAPI Spec resolver', () => {

it('should not accept other spec file formats than .json/.yaml', function(done) {
const spec = './test/fixtures/2.0/petstore.yaaml';
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
should.exist(err);
done();
});
Expand All @@ -74,16 +78,16 @@ describe('OpenAPI Spec resolver', () => {
describe('Spec validation against Swagger schema 2.0', function() {
it('should validate provided specification against swagger spec. 2.0', function(done) {
const spec = './test/fixtures/2.0/petstore.yaml';
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
if (err) return done(err);
validateSpec(api, done);
specResolver.validate(api, done);
});
});

it('should throw error if validation fails', function(done) {
const spec = {this: 'that'};

validateSpec(spec, function(err, api) {
specResolver.validate(spec, function(err, api) {
should.exist(err);
done();
});
Expand All @@ -93,7 +97,7 @@ describe('OpenAPI Spec resolver', () => {
describe('OpenAPI 3.0', function() {
it('loads OpenAPI spec 3.0 yaml', function(done) {
const spec = './test/fixtures/3.0/petstore.yaml';
resolveSpec(spec, function(err, api) {
specResolver.resolve(spec, function(err, api) {
if (err) return done(err);
api.should.have.property('openapi', '3.0.0');
done();
Expand Down