Skip to content

Commit

Permalink
feat(morgan): add middleware for morgan
Browse files Browse the repository at this point in the history
  • Loading branch information
wbhob committed Nov 23, 2017
1 parent 125f4fd commit a2ec8ce
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 0 deletions.
34 changes: 34 additions & 0 deletions src/morgan/index.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import { MorganMiddleware } from './index';
import { expect } from 'chai';

describe('MorganMiddleware', () => {
let middleware: MorganMiddleware;
describe('properly configured', () => {
beforeEach(() => {
MorganMiddleware.configure('tiny');
middleware = new MorganMiddleware();
});

it('should be defined', () => {
expect(middleware).to.not.be.undefined;
});

it('should have a function called resolve', () => {
expect(middleware.resolve).to.be.instanceof(Function);
});

it('should should return a middleware from calling resolve', () => {
expect(middleware.resolve()).to.be.an.instanceof(Function);
});
});

describe('not configured', () => {
middleware = new MorganMiddleware();
it('should should throw when not passed a format', () => {
expect(middleware.resolve.bind(middleware)).to.throw(Error);
});
});
afterEach(() => {
MorganMiddleware.configure(undefined);
});
});
26 changes: 26 additions & 0 deletions src/morgan/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import * as morgan from 'morgan';

import { Middleware, NestMiddleware } from '@nestjs/common';

import { RequestHandler } from 'express';

@Middleware()
export class MorganMiddleware implements NestMiddleware {

// DELETE THESE LINES IF MIDDLEWARE DOES NOT TAKE OPTIONS
public static configure(format: string | morgan.FormatFn, opts?: morgan.Options) {
this.format = format;
this.options = opts;
}

private static options: morgan.Options;
private static format: string | morgan.FormatFn;

public resolve(...args: any[]): RequestHandler {
if (MorganMiddleware.format) {
return morgan(MorganMiddleware.format as any, MorganMiddleware.options);
} else {
throw new Error('MorganMiddleware must be configured with a logger format.');
}
}
}
28 changes: 28 additions & 0 deletions src/morgan/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"name": "@nest-middlewares/morgan",
"version": "1.0.0",
"description": "NestJS middleware for Morgan",
"main": "index",
"repository": {
"type": "git",
"url": "git+https://github.com/wbhob/nest-middlewares.git"
},
"keywords": [
"nest",
"middlewares",
"express",
"node"
],
"author": "Wilson Hobbs <wilsonhobbs1@gmail.com>",
"license": "MIT",
"bugs": {
"url": "https://github.com/wbhob/nest-middlewares/issues"
},
"homepage": "https://github.com/wbhob/nest-middlewares#readme",
"peerDependencies": {
"@nestjs/common": "^4.0.0"
},
"dependencies": {
"morgan": "^1.9.0"
}
}

0 comments on commit a2ec8ce

Please sign in to comment.