|
| 1 | +import { readFileSync } from 'node:fs'; |
| 2 | +import { dirname, resolve } from 'node:path'; |
| 3 | +import { beforeEach, describe, expect, it, vi } from 'vitest'; |
| 4 | +import { sentryCloudflareNitroPlugin } from '../../../src/runtime/plugins/cloudflare'; |
| 5 | + |
| 6 | +const mocks = vi.hoisted(() => ({ |
| 7 | + wrapRequestHandler: vi.fn((_wrapperOptions: unknown, handler: () => unknown) => handler()), |
| 8 | + setAsyncLocalStorageAsyncContextStrategy: vi.fn(), |
| 9 | + getDefaultIntegrations: vi.fn(() => [{ name: 'CloudflareDefault' }]), |
| 10 | +})); |
| 11 | + |
| 12 | +vi.mock('@sentry/cloudflare', () => ({ |
| 13 | + getDefaultIntegrations: mocks.getDefaultIntegrations, |
| 14 | + setAsyncLocalStorageAsyncContextStrategy: mocks.setAsyncLocalStorageAsyncContextStrategy, |
| 15 | +})); |
| 16 | + |
| 17 | +vi.mock('@sentry/cloudflare/request', () => ({ |
| 18 | + wrapRequestHandler: mocks.wrapRequestHandler, |
| 19 | +})); |
| 20 | + |
| 21 | +const executionContext = { waitUntil: vi.fn(), passThroughOnException: vi.fn() }; |
| 22 | + |
| 23 | +function createNitroApp(): any { |
| 24 | + return { |
| 25 | + fetch: vi.fn(() => new Response('ok')), |
| 26 | + hooks: { hook: vi.fn() }, |
| 27 | + }; |
| 28 | +} |
| 29 | + |
| 30 | +function createCloudflareRequest(url = 'https://example.com/'): Request { |
| 31 | + return Object.assign(new Request(url), { |
| 32 | + runtime: { name: 'cloudflare', cloudflare: { context: executionContext, env: {} } }, |
| 33 | + }); |
| 34 | +} |
| 35 | + |
| 36 | +describe('sentryCloudflareNitroPlugin', () => { |
| 37 | + beforeEach(() => { |
| 38 | + vi.clearAllMocks(); |
| 39 | + }); |
| 40 | + |
| 41 | + it('routes requests carrying a Cloudflare execution context through `wrapRequestHandler`', async () => { |
| 42 | + const nitroApp = createNitroApp(); |
| 43 | + const innerFetch = nitroApp.fetch; |
| 44 | + |
| 45 | + sentryCloudflareNitroPlugin({ dsn: 'https://public@example.ingest.sentry.io/1' })(nitroApp); |
| 46 | + const request = createCloudflareRequest(); |
| 47 | + await nitroApp.fetch(request); |
| 48 | + |
| 49 | + expect(mocks.wrapRequestHandler).toHaveBeenCalledTimes(1); |
| 50 | + expect(mocks.wrapRequestHandler.mock.calls[0]![0]).toMatchObject({ request, context: executionContext }); |
| 51 | + expect(innerFetch).toHaveBeenCalledWith(request); |
| 52 | + }); |
| 53 | + |
| 54 | + // Without an execution context there is nothing to hang the flush on, which is the case in |
| 55 | + // `nitro dev` and on every non-Workers preset. |
| 56 | + it('passes the request through untouched when there is no execution context', async () => { |
| 57 | + const nitroApp = createNitroApp(); |
| 58 | + const innerFetch = nitroApp.fetch; |
| 59 | + |
| 60 | + sentryCloudflareNitroPlugin({ dsn: 'https://public@example.ingest.sentry.io/1' })(nitroApp); |
| 61 | + const request = new Request('https://example.com/'); |
| 62 | + await nitroApp.fetch(request); |
| 63 | + |
| 64 | + expect(mocks.wrapRequestHandler).not.toHaveBeenCalled(); |
| 65 | + expect(innerFetch).toHaveBeenCalledWith(request); |
| 66 | + }); |
| 67 | + |
| 68 | + it('sets the async context strategy and registers the error hook', () => { |
| 69 | + const nitroApp = createNitroApp(); |
| 70 | + |
| 71 | + sentryCloudflareNitroPlugin({ dsn: 'https://public@example.ingest.sentry.io/1' })(nitroApp); |
| 72 | + |
| 73 | + expect(mocks.setAsyncLocalStorageAsyncContextStrategy).toHaveBeenCalledTimes(1); |
| 74 | + expect(nitroApp.hooks.hook).toHaveBeenCalledWith('error', expect.any(Function)); |
| 75 | + }); |
| 76 | + |
| 77 | + it('accepts a function so options can be read once the app exists', async () => { |
| 78 | + const nitroApp = createNitroApp(); |
| 79 | + const optionsFn = vi.fn(() => ({ dsn: 'https://public@example.ingest.sentry.io/2' })); |
| 80 | + |
| 81 | + sentryCloudflareNitroPlugin(optionsFn)(nitroApp); |
| 82 | + await nitroApp.fetch(createCloudflareRequest()); |
| 83 | + |
| 84 | + expect(optionsFn).toHaveBeenCalledWith(nitroApp); |
| 85 | + expect(mocks.wrapRequestHandler.mock.calls[0]![0]).toMatchObject({ |
| 86 | + options: { dsn: 'https://public@example.ingest.sentry.io/2' }, |
| 87 | + }); |
| 88 | + }); |
| 89 | + |
| 90 | + it('defaults to the `nodejs_compat` integrations but lets explicit options win', async () => { |
| 91 | + const nitroApp = createNitroApp(); |
| 92 | + |
| 93 | + sentryCloudflareNitroPlugin({ dsn: 'https://public@example.ingest.sentry.io/1' })(nitroApp); |
| 94 | + await nitroApp.fetch(createCloudflareRequest()); |
| 95 | + |
| 96 | + expect((mocks.wrapRequestHandler.mock.calls[0]![0] as any).options.defaultIntegrations).toEqual([ |
| 97 | + { name: 'CloudflareDefault' }, |
| 98 | + ]); |
| 99 | + |
| 100 | + vi.clearAllMocks(); |
| 101 | + const otherApp = createNitroApp(); |
| 102 | + sentryCloudflareNitroPlugin({ dsn: 'https://public@example.ingest.sentry.io/1', defaultIntegrations: false })( |
| 103 | + otherApp, |
| 104 | + ); |
| 105 | + await otherApp.fetch(createCloudflareRequest()); |
| 106 | + |
| 107 | + expect((mocks.wrapRequestHandler.mock.calls[0]![0] as any).options.defaultIntegrations).toBe(false); |
| 108 | + }); |
| 109 | +}); |
| 110 | + |
| 111 | +// See #22519 for the same class of bug reached through a barrel re-export. |
| 112 | +describe('the `@sentry/nitro/cloudflare` module graph', () => { |
| 113 | + it('never reaches `@sentry/node`', () => { |
| 114 | + const entry = resolve(__dirname, '../../../src/cloudflare/index.ts'); |
| 115 | + const seen = new Set<string>(); |
| 116 | + const offenders: string[] = []; |
| 117 | + |
| 118 | + const visit = (file: string): void => { |
| 119 | + if (seen.has(file)) { |
| 120 | + return; |
| 121 | + } |
| 122 | + seen.add(file); |
| 123 | + |
| 124 | + const source = readFileSync(file, 'utf8'); |
| 125 | + const specifiers = [...source.matchAll(/from\s+'([^']+)'/g)].map(match => match[1]!); |
| 126 | + |
| 127 | + for (const specifier of specifiers) { |
| 128 | + if (specifier === '@sentry/node' || specifier.startsWith('@sentry/node/')) { |
| 129 | + offenders.push(file); |
| 130 | + } |
| 131 | + if (specifier.startsWith('.')) { |
| 132 | + visit(resolve(dirname(file), `${specifier}.ts`)); |
| 133 | + } |
| 134 | + } |
| 135 | + }; |
| 136 | + |
| 137 | + visit(entry); |
| 138 | + |
| 139 | + expect(seen.size).toBeGreaterThan(1); |
| 140 | + expect(offenders).toEqual([]); |
| 141 | + }); |
| 142 | +}); |
0 commit comments