Skip to content
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

Name middleware #583

Merged
merged 5 commits into from
Apr 23, 2021
Merged

Name middleware #583

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
85004b7
Name middleware
benblack86 Apr 14, 2021
674aabc
Fix this
benblack86 Apr 14, 2021
0e05599
Add comment
benblack86 Apr 14, 2021
c609851
Updates
benblack86 Apr 20, 2021
cb223c3
Lowercase
benblack86 Apr 22, 2021
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
63 changes: 32 additions & 31 deletions src/openapi.validator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,10 +116,11 @@ export class OpenApiValidator {
};
});

const self = this; // using named functions instead of anonymous functions to allow traces to be more useful
let inited = false;
// install path params
middlewares.push((req, res, next) =>
pContext
middlewares.push(function PathParamsMiddleware(req, res, next) {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one more nit. use lower case camelCase for the function names e.g. pathParamsMiddleware. apologies for not being clear with my first comment

return pContext
.then(({ context, error }) => {
// Throw if any error occurred during spec load.
if (error) throw error;
Expand All @@ -129,61 +130,61 @@ export class OpenApiValidator {
// Doing so would enable path params to be type coerced when provided to
// the final middleware.
// Unfortunately, it is not possible to get the current Router from a handler function
this.installPathParams(req.app, context);
self.installPathParams(req.app, context);
inited = true;
}
next();
})
.catch(next),
);
.catch(next);
});

// metadata middleware
let metamw;
middlewares.push((req, res, next) =>
pContext
middlewares.push(function MetadataMiddleware(req, res, next) {
return pContext
.then(({ context, responseApiDoc }) => {
metamw = metamw || this.metadataMiddleware(context, responseApiDoc);
metamw = metamw || self.metadataMiddleware(context, responseApiDoc);
return metamw(req, res, next);
})
.catch(next),
);
.catch(next);
});

if (this.options.fileUploader) {
// multipart middleware
let fumw;
middlewares.push((req, res, next) =>
pContext
middlewares.push(function MultipartMiddleware(req, res, next) {
return pContext
.then(({ context: { apiDoc } }) => {
fumw = fumw || this.multipartMiddleware(apiDoc);
fumw = fumw || self.multipartMiddleware(apiDoc);
return fumw(req, res, next);
})
.catch(next),
);
.catch(next);
});
}

// security middlware
let scmw;
middlewares.push((req, res, next) =>
pContext
middlewares.push(function SecurityMiddleware(req, res, next) {
return pContext
.then(({ context: { apiDoc } }) => {
const components = apiDoc.components;
if (this.options.validateSecurity && components?.securitySchemes) {
scmw = scmw || this.securityMiddleware(apiDoc);
if (self.options.validateSecurity && components?.securitySchemes) {
scmw = scmw || self.securityMiddleware(apiDoc);
return scmw(req, res, next);
} else {
next();
}
})
.catch(next),
);
.catch(next);
});

// request middlweare
if (this.options.validateRequests) {
let reqmw;
middlewares.push((req, res, next) => {
middlewares.push(function RequestMiddleware(req, res, next) {
return pContext
.then(({ context: { apiDoc } }) => {
reqmw = reqmw || this.requestValidationMiddleware(apiDoc);
reqmw = reqmw || self.requestValidationMiddleware(apiDoc);
return reqmw(req, res, next);
})
.catch(next);
Expand All @@ -193,25 +194,25 @@ export class OpenApiValidator {
// response middleware
if (this.options.validateResponses) {
let resmw;
middlewares.push((req, res, next) =>
pContext
middlewares.push(function ResponseMiddleware(req, res, next) {
return pContext
.then(({ responseApiDoc }) => {
resmw = resmw || this.responseValidationMiddleware(responseApiDoc);
resmw = resmw || self.responseValidationMiddleware(responseApiDoc);
return resmw(req, res, next);
})
.catch(next),
);
.catch(next);
})
}

// op handler middleware
if (this.options.operationHandlers) {
let router: Router = null;
middlewares.push((req, res, next) => {
middlewares.push(function OperationHandlersMiddleware(req, res, next) {
if (router) return router(req, res, next);
pContext
return pContext
.then(
({ context }) =>
(router = this.installOperationHandlers(req.baseUrl, context)),
(router = self.installOperationHandlers(req.baseUrl, context)),
)
.then((router) => router(req, res, next))
.catch(next);
Expand Down