Fix/multiple event instances (#171)

* feat: add swagger event configuration

* feat: add multiple instance configuration

* feat: add tests

* fix: swagger events method

* docs: update readme

* feat: add fix to the linter

.github/workflows/runTests.yml

@@ -22,7 +22,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
-      - run: npm run lint
+      - run: npm run lint -- --fix
       - run: npm test
   coverage:
     name: coverage

README.md

@@ -56,6 +56,8 @@ const options = {
   // you can extend swagger-ui-express config. You can checkout an example of this
   // in the `example/configuration/swaggerOptions.js`
   swaggerUiOptions: {},
+  // multiple option in case you want more that one instance
+  multiple: true,
 };
 
 const app = express();

config/swaggerEvents.js

@@ -0,0 +1,6 @@
+
+const swaggerEvents = options => ({
+  multiple: options.multiple !== undefined ? options.multiple : false,
+});
+
+module.exports = swaggerEvents;

examples/configuration/multipleInstance/index.js

@@ -19,6 +19,7 @@ const optionsClientAPIInstance = {
   exposeSwaggerUI: true,
   exposeApiDocs: true,
   apiDocsPath: '/api/v1/client/api-docs',
+  multiple: true,
 };
 
 // It is a fictitious configuration
@@ -41,10 +42,19 @@ const optionsAdminAPIInstance = {
   exposeSwaggerUI: true,
   exposeApiDocs: true,
   apiDocsPath: '/api/v1/admin/api-docs',
+  multiple: true,
 };
 
-expressJSDocSwagger(app)(optionsClientAPIInstance);
-expressJSDocSwagger(app)(optionsAdminAPIInstance);
+const instance = expressJSDocSwagger(app)(optionsClientAPIInstance);
+const instance2 = expressJSDocSwagger(app)(optionsAdminAPIInstance);
+
+instance.on('finish', data => {
+  console.log(data);
+})
+
+instance2.on('finish', data => {
+  console.log(data);
+})
 
 
 app.listen(port, () => logger.info(`Example app listening at http://localhost:${port}`));

index.js

@@ -2,11 +2,13 @@ const swaggerUi = require('swagger-ui-express');
 const merge = require('merge');
 
 const defaultOptions = require('./config/default');
+const swaggerEventsOptions = require('./config/swaggerEvents');
 const processSwagger = require('./processSwagger');
 const swaggerEvents = require('./swaggerEvents');
 
+
 const expressJSDocSwagger = app => (userOptions = {}, userSwagger = {}) => {
-  const events = swaggerEvents();
+  const events = swaggerEvents(swaggerEventsOptions(userOptions));
   const { instance } = events;
   let swaggerObject = {};
 

swaggerEvents.js

@@ -18,8 +18,8 @@ const finish = eventEmitter => (info, methods) => (
   eventEmitter.emit(FINISH_EVENT_NAME, info, methods)
 );
 
-const swaggerEvents = () => {
-  if (api) return api;
+const swaggerEvents = ({ multiple } = {}) => {
+  if (api && !multiple) return api;
   const instance = new EventEmitter();
 
   api = {

test/e2e/multipleInstance/admin-v1-docs.js

@@ -0,0 +1,5 @@
+/**
+ * GET /api/admin/v1
+ * @summary This is the summary of the endpoint
+ * @return {string} 200 - success response
+ */

test/e2e/multipleInstance/client-v1-docs.js

@@ -0,0 +1,5 @@
+/**
+ * GET /api/client/v1
+ * @summary This is the summary of the endpoint
+ * @return {string} 200 - success response
+ */

test/e2e/multipleInstance/index.js

@@ -0,0 +1,13 @@
+const express = require('express');
+const expressJSDocSwagger = require('../../..');
+
+const app = express();
+
+const setupInstance = options => new Promise(resolve => {
+  const instance = expressJSDocSwagger(app)(options);
+  instance.on('finish', data => {
+    resolve(data);
+  });
+});
+
+module.exports = setupInstance;

test/e2e/multipleInstance/multipleInstance.test.js

@@ -0,0 +1,50 @@
+const multipleInstance = require('.');
+
+const instance1Options = {
+  info: {
+    version: '1.0.0',
+    title: 'Admin API',
+    description: 'Only admin accounts authorized to use this API',
+  },
+  security: {
+    BearerAuth: {
+      type: 'http',
+      scheme: 'bearer',
+      bearerFormat: 'JWT',
+    },
+  },
+  filesPattern: './admin-v1-docs.js',
+  swaggerUIPath: '/api/v1/admin/docs',
+  baseDir: __dirname,
+  exposeSwaggerUI: true,
+  exposeApiDocs: true,
+  apiDocsPath: '/api/v1/admin/api-docs',
+};
+
+const instance2Options = {
+  info: {
+    version: '1.0.0',
+    title: 'Client API',
+    description: 'For client',
+  },
+  filesPattern: './client-v1-docs.js',
+  swaggerUIPath: '/api/v1/client/docs',
+  baseDir: __dirname,
+  exposeSwaggerUI: true,
+  exposeApiDocs: true,
+  apiDocsPath: '/api/v1/client/api-docs',
+};
+
+describe('multipleInstance test', () => {
+  it('multipleInstance should be different when multiple option is "true"', async () => {
+    const instance1Data = await multipleInstance({
+      ...instance1Options,
+      multiple: true,
+    });
+    const instance2Data = await multipleInstance({
+      ...instance2Options,
+      multiple: true,
+    });
+    expect(instance1Data).not.toEqual(instance2Data);
+  });
+});