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

Jump to bottom

Fix/rename on error middleware #4

Merged
merged 3 commits into from Aug 14, 2017
Merged

Fix/rename on error middleware #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b5539f4
renamed error middleware handler
dkatavic Aug 14, 2017
b2b151a
rename back runErrorMiddlewares
dkatavic Aug 14, 2017
2ecf5fe
rename _middlewares ro __midlewares
dkatavic Aug 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
80 changes: 40 additions & 40 deletions __tests__/index.js
View file
Open in desktop
Expand Up @@ -6,53 +6,53 @@ describe('🛵 Middy test suite', () => {
expect(() => { handler.use(() => {}) }).toThrow('Middleware must be an object')
})

test('Middleware attached with "use" must be an object exposing at least a key among "before", "after", "error"', () => {
test('Middleware attached with "use" must be an object exposing at least a key among "before", "after", "onError"', () => {
const handler = middy(jest.fn())
expect(() => { handler.use({foo: 'bar'}) }).toThrow('Middleware must contain at least one key among "before", "after", "error"')
expect(() => { handler.use({foo: 'bar'}) }).toThrow('Middleware must contain at least one key among "before", "after", "onError"')
})

test('"use" can add before middlewares', () => {
const before = jest.fn()
const middleware = () => ({ before })
const handler = middy(jest.fn())
handler.use(middleware())
expect(handler._middlewares.before[0]).toBe(before)
expect(handler.__middlewares.before[0]).toBe(before)
})

test('"use" can add after middlewares', () => {
const after = jest.fn()
const middleware = () => ({ after })
const handler = middy(jest.fn())
handler.use(middleware())
expect(handler._middlewares.after[0]).toBe(after)
expect(handler.__middlewares.after[0]).toBe(after)
})

test('"use" can add error middlewares', () => {
const error = jest.fn()
const middleware = () => ({ error })
const onError = jest.fn()
const middleware = () => ({ onError })
const handler = middy(jest.fn())
handler.use(middleware())
expect(handler._middlewares.error[0]).toBe(error)
expect(handler.__middlewares.onError[0]).toBe(onError)
})

test('"use" can add all types of middlewares', () => {
const before = jest.fn()
const after = jest.fn()
const error = jest.fn()
const onError = jest.fn()

const middleware = () => ({
before,
after,
error
onError
})

const handler = middy(jest.fn())

handler.use(middleware())

expect(handler._middlewares.before[0]).toBe(before)
expect(handler._middlewares.after[0]).toBe(after)
expect(handler._middlewares.error[0]).toBe(error)
expect(handler.__middlewares.before[0]).toBe(before)
expect(handler.__middlewares.after[0]).toBe(after)
expect(handler.__middlewares.onError[0]).toBe(onError)
})

test('"before" should add a before middleware', () => {
Expand All @@ -61,7 +61,7 @@ describe('🛵 Middy test suite', () => {
const handler = middy(jest.fn())

handler.before(beforeMiddleware)
expect(handler._middlewares.before[0]).toBe(beforeMiddleware)
expect(handler.__middlewares.before[0]).toBe(beforeMiddleware)
})

test('"after" should add an after middleware', () => {
Expand All @@ -70,16 +70,16 @@ describe('🛵 Middy test suite', () => {
const handler = middy(jest.fn())

handler.after(afterMiddleware)
expect(handler._middlewares.after[0]).toBe(afterMiddleware)
expect(handler.__middlewares.after[0]).toBe(afterMiddleware)
})

test('"error" should add an error middleware', () => {
test('"onError" should add an error middleware', () => {
const errorMiddleware = jest.fn()

const handler = middy(jest.fn())

handler.error(errorMiddleware)
expect(handler._middlewares.error[0]).toBe(errorMiddleware)
handler.onError(errorMiddleware)
expect(handler.__middlewares.onError[0]).toBe(errorMiddleware)
})

test('It should execute before and after middlewares in the right order', (endTest) => {
Expand Down Expand Up @@ -176,18 +176,18 @@ describe('🛵 Middy test suite', () => {
next(error)
}

const errorMiddleware = jest.fn((ctx, next) => {
const onErrorMiddleware = jest.fn((ctx, next) => {
expect(ctx.error).toBe(error)
next()
})

handler
.before(failingMiddleware)
.error(errorMiddleware)
.onError(onErrorMiddleware)

handler({}, {}, function () {
expect(originalHandler).not.toBeCalled()
expect(errorMiddleware).toBeCalled()
expect(onErrorMiddleware).toBeCalled()
endTest()
})
})
Expand All @@ -198,16 +198,16 @@ describe('🛵 Middy test suite', () => {
return callback(error)
})

const errorMiddleware = jest.fn((ctx, next) => {
const onErrorMiddleware = jest.fn((ctx, next) => {
expect(ctx.error).toBe(error)
next()
})

handler
.error(errorMiddleware)
.onError(onErrorMiddleware)

handler({}, {}, function () {
expect(errorMiddleware).toBeCalled()
expect(onErrorMiddleware).toBeCalled()
endTest()
})
})
Expand All @@ -223,44 +223,44 @@ describe('🛵 Middy test suite', () => {
next(error)
}

const errorMiddleware = jest.fn((ctx, next) => {
const onErrorMiddleware = jest.fn((ctx, next) => {
expect(ctx.error).toBe(error)
next()
})

handler
.after(failingMiddleware)
.error(errorMiddleware)
.onError(onErrorMiddleware)

handler({}, {}, function () {
expect(originalHandler).toBeCalled()
expect(errorMiddleware).toBeCalled()
expect(onErrorMiddleware).toBeCalled()
endTest()
})
})

test('If theres an error and one error middleware handles the error, the next error middlewares is not executed', (endTest) => {
const expectedResponse = { message: 'error handled' }

const errorMiddleware1 = jest.fn((ctx, next) => {
const onErrorMiddleware1 = jest.fn((ctx, next) => {
ctx.response = expectedResponse
next() // the error has been handled
})

const errorMiddleware2 = jest.fn()
const onErrorMiddleware2 = jest.fn()

const handler = middy((event, context, callback) => {
return callback(new Error('some error'))
})

handler
.error(errorMiddleware1)
.error(errorMiddleware2)
.onError(onErrorMiddleware1)
.onError(onErrorMiddleware2)

handler({}, {}, (err, response) => {
expect(err).toBe(null)
expect(errorMiddleware1).toBeCalled()
expect(errorMiddleware2).not.toBeCalled()
expect(onErrorMiddleware1).toBeCalled()
expect(onErrorMiddleware2).not.toBeCalled()
expect(response).toBe(expectedResponse)

endTest()
Expand All @@ -270,11 +270,11 @@ describe('🛵 Middy test suite', () => {
test('If theres an error and the first error middleware doesn\'t handle the error, the next error middlewares is executed', (endTest) => {
const expectedResponse = { message: 'error handled' }

const errorMiddleware1 = jest.fn((ctx, next) => {
const onErrorMiddleware1 = jest.fn((ctx, next) => {
next(ctx.error) // propagates the error
})

const errorMiddleware2 = jest.fn((ctx, next) => {
const onErrorMiddleware2 = jest.fn((ctx, next) => {
ctx.response = expectedResponse
next() // the error has been handled
})
Expand All @@ -284,13 +284,13 @@ describe('🛵 Middy test suite', () => {
})

handler
.error(errorMiddleware1)
.error(errorMiddleware2)
.onError(onErrorMiddleware1)
.onError(onErrorMiddleware2)

handler({}, {}, (err, response) => {
expect(err).toBe(null)
expect(errorMiddleware1).toBeCalled()
expect(errorMiddleware2).toBeCalled()
expect(onErrorMiddleware1).toBeCalled()
expect(onErrorMiddleware2).toBeCalled()
expect(response).toBe(expectedResponse)

endTest()
Expand Down Expand Up @@ -351,7 +351,7 @@ describe('🛵 Middy test suite', () => {
test('It handler synchronous errors generated by throw statements in the error middleware', (endTest) => {
const expectedError = new Error('successive error in error handler')

const errorMiddleware = (ctx, next) => {
const onErrorMiddleware = (ctx, next) => {
throw expectedError
}

Expand All @@ -360,7 +360,7 @@ describe('🛵 Middy test suite', () => {
})

handler
.error(errorMiddleware)
.onError(onErrorMiddleware)

handler({}, {}, (err, response) => {
expect(err).toBe(expectedError)
Expand Down
14 changes: 7 additions & 7 deletions index.js
View file
Open in desktop
Expand Up @@ -97,8 +97,8 @@ const middy = (handler) => {
throw new Error('Middleware must be an object')
}

if (!middleware.before && !middleware.after && !middleware.error) {
throw new Error('Middleware must contain at least one key among "before", "after", "error"')
if (!middleware.before && !middleware.after && !middleware.onError) {
throw new Error('Middleware must contain at least one key among "before", "after", "onError"')
}

if (middleware.before) {
Expand All @@ -109,8 +109,8 @@ const middy = (handler) => {
instance.after(middleware.after)
}

if (middleware.error) {
instance.error(middleware.error)
if (middleware.onError) {
instance.onError(middleware.onError)
}

return instance
Expand All @@ -128,16 +128,16 @@ const middy = (handler) => {
return instance
}

instance.error = (errorMiddleware) => {
instance.onError = (errorMiddleware) => {
errorMiddlewares.push(errorMiddleware)

return instance
}

instance._middlewares = {
instance.__middlewares = {
before: beforeMiddlewares,
after: afterMiddlewares,
error: errorMiddlewares
onError: errorMiddlewares
}

return instance
Expand Down
1 change: 1 addition & 0 deletions middlewares/__tests__/jsonBodyParser.js
View file
Open in desktop
@@ -1 +1,2 @@
// TODO
test.skip('Json Body Parser')
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Expand Up @@ -6,6 +6,7 @@
"scripts": {
"test:lint": "eslint --ignore-pattern='node_modules' --ignore-pattern='coverage/' .",
"test:unit": "jest --verbose --coverage",
"test:unit:watch": "jest --verbose --coverage --watch",
"test": "npm run test:lint && npm run test:unit"
},
"repository": {
Expand All @@ -18,7 +19,7 @@
"Serverless",
"Framework"
],
"author": "Luciano Mammino, Peter Caulfield, Joe Minichino",
"author": "Luciano Mammino, Peter Caulfield, Joe Minichino, Domagoj Katavic",
Copy link
Member

Choose a reason for hiding this comment

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

👍 this is the most important change! :)

"license": "MIT",
"bugs": {
"url": "https://github.com/Plnt9/middy/issues"
Expand Down