|
| 1 | +import { describe, expect, it, vi } from 'vitest'; |
| 2 | + |
| 3 | +import { Middleware } from './common/types/common-types'; |
| 4 | +import { isGlobalRoute, wrapEarlyMiddlewareHandler } from './wrap-early-middleware-handler'; |
| 5 | + |
| 6 | +/** |
| 7 | + * Reproduces the shape of body-parser's `json()`/`urlencoded()` return values, whose function |
| 8 | + * names (`jsonParser`/`urlencodedParser`) are what NestJS's ExpressAdapter checks for. |
| 9 | + */ |
| 10 | +function makeParser(name: 'jsonParser' | 'urlencodedParser') { |
| 11 | + const fn = vi.fn(); |
| 12 | + Object.defineProperty(fn, 'name', { value: name }); |
| 13 | + return fn; |
| 14 | +} |
| 15 | + |
| 16 | +// https://github.com/vendurehq/vendure/issues/5028 |
| 17 | +describe('wrapEarlyMiddlewareHandler', () => { |
| 18 | + it('wraps a route-scoped jsonParser so its name no longer collides', () => { |
| 19 | + const handler = makeParser('jsonParser'); |
| 20 | + const mid: Middleware = { handler, route: '/admin-api', beforeListen: true }; |
| 21 | + |
| 22 | + const wrapped = wrapEarlyMiddlewareHandler(mid); |
| 23 | + |
| 24 | + expect(wrapped).not.toBe(handler); |
| 25 | + expect((wrapped as any).name).not.toBe('jsonParser'); |
| 26 | + }); |
| 27 | + |
| 28 | + it('wraps a route-scoped urlencodedParser', () => { |
| 29 | + const handler = makeParser('urlencodedParser'); |
| 30 | + const mid: Middleware = { handler, route: '/admin-api', beforeListen: true }; |
| 31 | + |
| 32 | + expect(wrapEarlyMiddlewareHandler(mid)).not.toBe(handler); |
| 33 | + }); |
| 34 | + |
| 35 | + it('the wrapped handler delegates to the original with the same arguments', () => { |
| 36 | + const handler = makeParser('jsonParser'); |
| 37 | + const mid: Middleware = { handler, route: '/admin-api', beforeListen: true }; |
| 38 | + const wrapped = wrapEarlyMiddlewareHandler(mid) as (...args: any[]) => void; |
| 39 | + |
| 40 | + const req = {} as any; |
| 41 | + const res = {} as any; |
| 42 | + const next = vi.fn(); |
| 43 | + wrapped(req, res, next); |
| 44 | + |
| 45 | + expect(handler).toHaveBeenCalledWith(req, res, next); |
| 46 | + }); |
| 47 | + |
| 48 | + it.each(['/', '', '*', '*splat', '/*splat', '{*splat}', '/{*splat}', '(.*)', '/(.*)'])( |
| 49 | + 'leaves a parser on the catch-all route "%s" untouched (preserves global-parser replacement)', |
| 50 | + route => { |
| 51 | + const handler = makeParser('jsonParser'); |
| 52 | + const mid: Middleware = { handler, route, beforeListen: true }; |
| 53 | + |
| 54 | + expect(wrapEarlyMiddlewareHandler(mid)).toBe(handler); |
| 55 | + }, |
| 56 | + ); |
| 57 | + |
| 58 | + it('does not wrap a handler whose name is not a parser name', () => { |
| 59 | + const handler = vi.fn(); |
| 60 | + Object.defineProperty(handler, 'name', { value: 'myCustomMiddleware' }); |
| 61 | + const mid: Middleware = { handler, route: '/admin-api', beforeListen: true }; |
| 62 | + |
| 63 | + expect(wrapEarlyMiddlewareHandler(mid)).toBe(handler); |
| 64 | + }); |
| 65 | + |
| 66 | + it('leaves a NestJS middleware class untouched (its name does not collide)', () => { |
| 67 | + class SomeNestMiddleware {} |
| 68 | + const mid: Middleware = { handler: SomeNestMiddleware, route: '/admin-api', beforeListen: true }; |
| 69 | + |
| 70 | + expect(wrapEarlyMiddlewareHandler(mid)).toBe(SomeNestMiddleware); |
| 71 | + }); |
| 72 | +}); |
| 73 | + |
| 74 | +describe('isGlobalRoute', () => { |
| 75 | + it.each(['/', '', ' ', '*', '/*', '*splat', '/*splat', '{*splat}', '/{*splat}', '(.*)', '/(.*)'])( |
| 76 | + 'treats "%s" as global', |
| 77 | + route => { |
| 78 | + expect(isGlobalRoute(route)).toBe(true); |
| 79 | + }, |
| 80 | + ); |
| 81 | + |
| 82 | + it.each(['/admin-api', '/shop-api', '/webhooks/stripe', '/api/*', '/admin'])( |
| 83 | + 'treats "%s" as scoped', |
| 84 | + route => { |
| 85 | + expect(isGlobalRoute(route)).toBe(false); |
| 86 | + }, |
| 87 | + ); |
| 88 | +}); |
0 commit comments