added initAsync function to support external $ref (#135)

Author: shahar240

README.md

@@ -16,24 +16,26 @@ There are no code changes in `[email protected]` compared to `e
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 **Table of Contents**  <!-- *generated with [DocToc](https://github.com/thlorenz/doctoc)* -->
 
-- [Installation](#installation)
-- [API](#api)
-  - [openapi-validator-middleware.validate(fastifyOptions)](#openapi-validator-middlewarevalidatefastifyoptions)
-    - [fastifyOptions](#fastifyoptions)
-  - [openapi-validator-middleware.init(pathToSwaggerFile, options)](#openapi-validator-middlewareinitpathtoswaggerfile-options)
-    - [Options](#options)
-- [Usage Example](#usage-example)
-  - [Express](#express)
-  - [Koa](#koa)
-  - [Fastify](#fastify)
-- [Important Notes](#important-notes)
-  - [Schema Objects](#schema-objects)
-  - [Multipart/form-data (files)](#multipartform-data-files)
-  - [Fastify support](#fastify-support)
-  - [Koa support](#koa-support)
-  - [Koa packages](#koa-packages)
-- [Known Issues with OpenAPI 3](#known-issues-with-openapi-3)
-- [Running Tests](#running-tests)
+- [openapi-validator-middleware](#openapi-validator-middleware)
+  - [Installation](#installation)
+  - [API](#api)
+    - [openapi-validator-middleware.validate(fastifyOptions)](#openapi-validator-middlewarevalidatefastifyoptions)
+      - [fastifyOptions](#fastifyoptions)
+    - [openapi-validator-middleware.init(pathToSwaggerFile, options)](#openapi-validator-middlewareinitpathtoswaggerfile-options)
+    - [openapi-validator-middleware.initAsync(pathToSwaggerFile, options)](#openapi-validator-middlewareinitasyncpathtoswaggerfile-options)
+      - [Options](#options)
+  - [Usage Example](#usage-example)
+    - [Express](#express)
+    - [Koa](#koa)
+    - [Fastify](#fastify)
+  - [Important Notes](#important-notes)
+    - [Schema Objects](#schema-objects)
+    - [Multipart/form-data (files)](#multipartform-data-files)
+    - [Fastify support](#fastify-support)
+    - [Koa support](#koa-support)
+    - [Koa packages](#koa-packages)
+  - [Known Issues with OpenAPI 3](#known-issues-with-openapi-3)
+  - [Running Tests](#running-tests)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -69,7 +71,17 @@ Initialize the middleware using a swagger definition.
 The function executes synchronously and does not return anything.
 
 - `pathToSwaggerFile`: Path to the swagger definition.
-- `options`: Additional options for the middleware (see below).
+- `options`: Additional options for the middleware ([see below](#options)).
+
+### openapi-validator-middleware.initAsync(pathToSwaggerFile, options)
+
+Initialize the middleware using a swagger definition.
+The function executes asynchronously and the resolved promise does not return anything.
+
+This Initilaztion function also supports schema with references to external files. 
+
+- `pathToSwaggerFile`: Path to the swagger definition.
+- `options`: Additional options for the middleware ([see below](#options)).
 
 #### Options
 

src/middleware.js

@@ -13,6 +13,24 @@ let schemaEndpointResolver;
 let validationMiddleware;
 
 function init(swaggerPath, options) {
+    _baseInit(swaggerPath, options);
+    // build schema for requests only
+    const schemaBuilderOptions = Object.assign({}, options, { buildRequests: true, buildResponses: false });
+    schemas = apiSchemaBuilder.buildSchemaSync(swaggerPath, schemaBuilderOptions);
+}
+
+async function initAsync(swaggerPath, options){
+    _baseInit(swaggerPath, options);
+    // build schema for requests only
+    const schemaBuilderOptions = Object.assign({}, options, { buildRequests: true, buildResponses: false });
+    schemas = await apiSchemaBuilder.buildSchema(swaggerPath, schemaBuilderOptions);
+}
+
+function validate(...args) {
+    return validationMiddleware(...args);
+}
+
+function _baseInit(swaggerPath, options) {
     middlewareOptions = options || {};
     const frameworkToLoad = allowedFrameworks.find((frameworkName) => {
         return middlewareOptions.framework === frameworkName;
@@ -21,14 +39,6 @@ function init(swaggerPath, options) {
     framework = frameworkToLoad ? require(`./frameworks/${frameworkToLoad}`) : require('./frameworks/express');
     validationMiddleware = framework.getValidator(_validateRequest);
     schemaEndpointResolver = new SchemaEndpointResolver();
-
-    // build schema for requests only
-    const schemaBuilderOptions = Object.assign({}, options, { buildRequests: true, buildResponses: false });
-    schemas = apiSchemaBuilder.buildSchemaSync(swaggerPath, schemaBuilderOptions);
-}
-
-function validate(...args) {
-    return validationMiddleware(...args);
 }
 
 function _getContentType(headers) {
@@ -90,6 +100,7 @@ function _validateParams(requestOptions) {
 
 module.exports = {
     init,
+    initAsync,
     validate,
     InputValidationError
 };

test/express/middleware-test.js

@@ -2,6 +2,7 @@
 
 const chai = require('chai'),
     expect = chai.expect,
+    assert = chai.assert,
     chaiSinon = require('sinon-chai'),
     request = require('supertest');
 chai.use(chaiSinon);
@@ -20,6 +21,24 @@ describe('input-validation middleware tests - Express', function () {
             middleware.init('test/pet-store-swagger.yaml');
         });
     });
+    describe('initAsync function tests', async function () {
+        it('should throw an error in case the file doesn\'t exists', async function () {
+            const middleware = require('../../src/middleware');
+            try {
+                await middleware.initAsync('test/pet-store-swagger1.yaml');
+                assert.fail('no error was thrown');
+            } catch (err) { }
+        });
+        it('should resolve without formats', async function () {
+            const rewire = require('rewire');
+            const middleware = rewire('../../src/middleware');
+            try {
+                await middleware.initAsync('test/pet-store-swagger.yaml');
+            } catch (err){
+                assert.fail('unexpected error: ' + err.message);
+            }
+        });
+    });
     describe('Simple server - no options', function () {
         let app;
         before(function () {

types/index.d.ts

@@ -10,6 +10,17 @@ declare function init(schemaPath: string, options?: ajvValidatorOptions): void;
 declare function init(jsonSchema: Object, options?: ajvValidatorOptions): void;
 export { init };
 
+/**
+ * Initialize the input validation middleware by
+ * providing it with the swagger file path and
+ * configuration options. This function should be called
+ * and awaited before using `validate` middleware.
+ * This init variant support loading of external references.
+ */
+declare function initAsync(schemaPath: string, options?: ajvValidatorOptions): Promise<void>;
+declare function initAsync(jsonSchema: Object, options?: ajvValidatorOptions): Promise<void>;
+export { initAsync };
+
 /**
  * Middleware that validates the request against the swagger
  * file, according to the request method and route