verdnatura-mirror
/
loopback-component-explorer
mirror of https://github.com/strongloop/loopback-component-explorer.git
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SOBI-5087: Refactoring

This commit is contained in:
Mario 2022-08-03 10:38:36 +02:00
parent f0148f2df3
commit 67c83ea9f3
No known key found for this signature in database
GPG Key ID: 599DE5BA56E66F82
5 changed files with 648 additions and 592 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
.eslintrc
View File

@ -1,10 +1,3 @@
{
"extends": "loopback",
"rules": {
"max-len": ["error", 90, 4, {
"ignoreComments": true,
"ignoreUrls": true,
"ignorePattern": "^\\s*var\\s.+=\\s*(require\\s*\\()|(/)"
}]
}
"extends": "plume"
}

106
index.js
View File

@ -5,10 +5,6 @@
'use strict';
const SG = require('strong-globalize');
SG.SetRootDir(__dirname);
const g = SG();
/*!
* Adds dynamically-updated docs as /explorer
*/
@ -20,38 +16,48 @@ const createSwaggerObject = require('loopback-swagger').generateSwaggerSpec;
const SWAGGER_UI_ROOT = require('swagger-ui-dist').absolutePath();
const STATIC_ROOT = path.join(__dirname, 'public');
module.exports = explorer;
explorer.routes = routes;
/**
* Example usage:
* Setup Swagger documentation on the given express app.
*
* var explorer = require('loopback-component-explorer');
* explorer(app, options);
* @param {Application} loopbackApplication The loopback application to
* document.
* @param {Application} swaggerApp Swagger application used for hosting
* swagger documentation.
* @param {Object} opts Options.
*/
function mountSwagger(loopbackApplication, swaggerApp, opts) {
let swaggerObject = createSwaggerObject(loopbackApplication, opts);
function explorer(loopbackApplication, options) {
options = _defaults({}, options, {mountPath: '/explorer'});
loopbackApplication.use(
options.mountPath,
routes(loopbackApplication, options)
);
loopbackApplication.set('loopback-component-explorer', options);
function rebuildSwaggerObject() {
swaggerObject = createSwaggerObject(loopbackApplication, opts);
}
// listening to modelRemoted event for updating the swaggerObject
// with the newly created model to appear in the Swagger UI.
loopbackApplication.on('modelRemoted', rebuildSwaggerObject);
loopbackApplication.on('modelDeleted', rebuildSwaggerObject);
// listening to started event for updating the swaggerObject
// when a call to app.models.[modelName].nestRemoting([modelName])
// to appear that method in the Swagger UI.
loopbackApplication.on('remoteMethodAdded', rebuildSwaggerObject);
// listening to remoteMethodDisabled event for updating the swaggerObject
// when a remote method is disabled to hide that method in the Swagger UI.
loopbackApplication.on('remoteMethodDisabled', rebuildSwaggerObject);
let resourcePath = (opts && opts.resourcePath) || 'swagger.json';
if (resourcePath[0] !== '/') resourcePath = '/' + resourcePath;
swaggerApp.get(resourcePath, function sendSwaggerObject(req, res) {
res.status(200).send(swaggerObject);
});
}
function routes(loopbackApplication, options) {
const loopback = loopbackApplication.loopback;
const loopbackMajor =
(loopback && loopback.version && loopback.version.split('.')[0]) || 1;
if (loopbackMajor < 2) {
throw new Error(
g.f(
'{{loopback-component-explorer}} requires ' +
'{{loopback}} 2.0 or newer'
)
);
}
options = _defaults({}, options, {
resourcePath: 'swagger.json',
@ -109,40 +115,20 @@ function routes(loopbackApplication, options) {
}
/**
* Setup Swagger documentation on the given express app.
* Example usage:
*
* @param {Application} loopbackApplication The loopback application to
* document.
* @param {Application} swaggerApp Swagger application used for hosting
* swagger documentation.
* @param {Object} opts Options.
* var explorer = require('loopback-component-explorer');
* explorer(app, options);
*/
function mountSwagger(loopbackApplication, swaggerApp, opts) {
let swaggerObject = createSwaggerObject(loopbackApplication, opts);
// listening to modelRemoted event for updating the swaggerObject
// with the newly created model to appear in the Swagger UI.
loopbackApplication.on('modelRemoted', rebuildSwaggerObject);
loopbackApplication.on('modelDeleted', rebuildSwaggerObject);
// listening to started event for updating the swaggerObject
// when a call to app.models.[modelName].nestRemoting([modelName])
// to appear that method in the Swagger UI.
loopbackApplication.on('remoteMethodAdded', rebuildSwaggerObject);
// listening to remoteMethodDisabled event for updating the swaggerObject
// when a remote method is disabled to hide that method in the Swagger UI.
loopbackApplication.on('remoteMethodDisabled', rebuildSwaggerObject);
let resourcePath = (opts && opts.resourcePath) || 'swagger.json';
if (resourcePath[0] !== '/') resourcePath = '/' + resourcePath;
swaggerApp.get(resourcePath, function sendSwaggerObject(req, res) {
res.status(200).send(swaggerObject);
});
function rebuildSwaggerObject() {
swaggerObject = createSwaggerObject(loopbackApplication, opts);
}
function explorer(loopbackApplication, options) {
options = _defaults({}, options, {mountPath: '/explorer'});
loopbackApplication.use(
options.mountPath,
routes(loopbackApplication, options)
);
loopbackApplication.set('loopback-component-explorer', options);
}
module.exports = explorer;
explorer.routes = routes;

1075
package-lock.json generated
View File

File diff suppressed because it is too large Load Diff

3
package.json
View File

@ -21,8 +21,9 @@
"readmeFilename": "README.md",
"devDependencies": {
"chai": "^3.2.0",
"eslint": "^5.13.0",
"eslint": "^8.11.0",
"eslint-config-loopback": "^13.0.0",
"eslint-config-plume": "git+ssh://git@github.com/plume-design/eslint-config-plume.git#1.1.4",
"loopback": "^3.19.0",
"mocha": "^5.2.0",
"supertest": "^3.1.0"

47
test/explorer.test.js
View File

@ -13,6 +13,27 @@ const path = require('path');
const expect = require('chai').expect;
describe('explorer', function() {
function configureRestApiAndExplorer(app, explorerBase) {
const Product = loopback.PersistedModel.extend('product');
Product.attachTo(loopback.memory());
app.model(Product);
explorer(app, {mountPath: explorerBase});
app.set('legacyExplorer', false);
app.use(app.get('restApiRoot') || '/', loopback.rest());
}
function givenLoopBackAppWithExplorer(explorerBase) {
return function(done) {
const app = this.app = loopback();
app.set('remoting', {cors: false});
configureRestApiAndExplorer(app, explorerBase);
done();
};
}
describe('with default config', function() {
beforeEach(givenLoopBackAppWithExplorer());
@ -36,7 +57,7 @@ describe('explorer', function() {
.end(function(err, res) {
if (err) return done(err);
assert(!!~res.text.indexOf('<title>LoopBack API Explorer</title>'),
assert(Boolean(res.text.indexOf('<title>LoopBack API Explorer</title>') !== -1),
'text does not contain expected string');
done();
@ -70,7 +91,7 @@ describe('explorer', function() {
.end(function(err, res) {
if (err) throw err;
assert(!!~res.text.indexOf('<title>LoopBack API Explorer</title>'),
assert(Boolean(res.text.indexOf('<title>LoopBack API Explorer</title>') !== -1),
'text does not contain expected string');
done();
@ -413,7 +434,7 @@ describe('explorer', function() {
expect(paths).to.contain('/products/findOne');
const Product = app.models.Product;
Product.findOne2 = function(cb) { cb(null, 1); };
Product.findOne2 = (cb) => cb(null, 1);
Product.remoteMethod('findOne2', {});
// Request swagger.json again
@ -430,24 +451,4 @@ describe('explorer', function() {
});
});
});
function givenLoopBackAppWithExplorer(explorerBase) {
return function(done) {
const app = this.app = loopback();
app.set('remoting', {cors: false});
configureRestApiAndExplorer(app, explorerBase);
done();
};
}
function configureRestApiAndExplorer(app, explorerBase) {
const Product = loopback.PersistedModel.extend('product');
Product.attachTo(loopback.memory());
app.model(Product);
explorer(app, {mountPath: explorerBase});
app.set('legacyExplorer', false);
app.use(app.get('restApiRoot') || '/', loopback.rest());
}
});