chore: add 'Fastify' to integrations tests

Author: rustworthy

packages/remix/src/index.server.ts

@@ -109,6 +109,7 @@ export { withSentry } from './client/performance';
 export { captureRemixErrorBoundaryError } from './client/errors';
 export { browserTracingIntegration } from './client/browserTracingIntegration';
 export { wrapExpressCreateRequestHandler } from './utils/serverAdapters/express';
+export { wrapFastifyCreateRequestHandler } from './utils/serverAdapters/fastify';
 
 export type { SentryMetaArgs } from './utils/types';
 

packages/remix/test/integration/package.json

@@ -13,6 +13,8 @@
     "@remix-run/react": "1.17.0",
     "@remix-run/serve": "1.17.0",
     "@sentry/remix": "file:../..",
+    "express": "^4.19.2",
+    "fastify": "^4.26.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   },

packages/remix/test/integration/test/server/action.test.ts

@@ -1,11 +1,11 @@
-import { RemixTestEnv, assertSentryEvent, assertSentryTransaction } from './utils/helpers';
+import { Adapter, RemixTestEnv, assertSentryEvent, assertSentryTransaction } from './utils/helpers';
 
 const useV2 = process.env.REMIX_VERSION === '2';
 
 jest.spyOn(console, 'error').mockImplementation();
 
 // Repeat tests for each adapter
-describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', adapter => {
+describe.each([Adapter.Builtin, Adapter.Express, Adapter.Fastify])('Remix API Actions with adapter = %s', adapter => {
   it('correctly instruments a parameterized Remix API action', async () => {
     const env = await RemixTestEnv.init(adapter);
     const url = `${env.url}/action-json-response/123123`;

packages/remix/test/integration/test/server/loader.test.ts

@@ -1,12 +1,12 @@
 import { Event } from '@sentry/types';
-import { RemixTestEnv, assertSentryEvent, assertSentryTransaction } from './utils/helpers';
+import { Adapter, RemixTestEnv, assertSentryEvent, assertSentryTransaction } from './utils/helpers';
 
 const useV2 = process.env.REMIX_VERSION === '2';
 
 jest.spyOn(console, 'error').mockImplementation();
 
 // Repeat tests for each adapter
-describe.each(['builtin', 'express'])('Remix API Loaders with adapter = %s', adapter => {
+describe.each([Adapter.Builtin, Adapter.Express, Adapter.Fastify])('Remix API Loaders with adapter = %s', adapter => {
   it('reports an error thrown from the loader', async () => {
     const env = await RemixTestEnv.init(adapter);
     const url = `${env.url}/loader-json-response/-2`;

packages/remix/test/integration/test/server/ssr.test.ts

@@ -1,10 +1,10 @@
-import { RemixTestEnv, assertSentryEvent, assertSentryTransaction } from './utils/helpers';
+import { Adapter, RemixTestEnv, assertSentryEvent, assertSentryTransaction } from './utils/helpers';
 
 const useV2 = process.env.REMIX_VERSION === '2';
 
 describe('Server Side Rendering', () => {
   it('correctly reports a server side rendering error', async () => {
-    const env = await RemixTestEnv.init('builtin');
+    const env = await RemixTestEnv.init(Adapter.Builtin);
     const url = `${env.url}/ssr-error`;
     const envelopes = await env.getMultipleEnvelopeRequest({ url, count: 2, envelopeType: ['transaction', 'event'] });
     const [transaction] = envelopes.filter(envelope => envelope[1].type === 'transaction');

packages/remix/test/integration/test/server/utils/helpers.ts

@@ -1,33 +1,52 @@
 import * as http from 'http';
 import { AddressInfo } from 'net';
-import { createRequestHandler } from '@remix-run/express';
-import { wrapExpressCreateRequestHandler } from '@sentry/remix';
+import { createRequestHandler as createFastifyRequestHandler } from '@mcansh/remix-fastify';
+import { createRequestHandler as createExpressRequestHandler } from '@remix-run/express';
+import { wrapExpressCreateRequestHandler, wrapFastifyCreateRequestHandler } from '@sentry/remix';
 import express from 'express';
+import fastify from 'fastify';
+
 import { TestEnv } from '../../../../../../../dev-packages/node-integration-tests/utils';
 
 export * from '../../../../../../../dev-packages/node-integration-tests/utils';
 
-export class RemixTestEnv extends TestEnv {
-  private constructor(public readonly server: http.Server, public readonly url: string) {
-    super(server, url);
-  }
+export const enum Adapter {
+  Builtin = 'builtin',
+  Express = 'express',
+  Fastify = 'fastify',
+}
 
-  public static async init(adapter: string = 'builtin'): Promise<RemixTestEnv> {
-    const requestHandlerFactory =
-      adapter === 'express' ? wrapExpressCreateRequestHandler(createRequestHandler) : createRequestHandler;
+const adapters = {
+  [Adapter.Builtin]: createExpressRequestHandler,
+  [Adapter.Express]: wrapExpressCreateRequestHandler(createExpressRequestHandler),
+  [Adapter.Fastify]: wrapFastifyCreateRequestHandler(createFastifyRequestHandler),
+};
 
-    let serverPort;
-    const server = await new Promise<http.Server>(resolve => {
-      const app = express();
+const runExpressApp = (adapter: Adapter.Builtin | Adapter.Express): Promise<http.Server> => new Promise(
+  res => {
+  const app = express();
+  app.all('*', adapters[adapter]({ build: require('../../../build') }));
+  res(app.listen(0));
+  }
+)
 
-      app.all('*', requestHandlerFactory({ build: require('../../../build') }));
+const runFastifyApp = (): Promise<http.Server> => new Promise(res => {
+  const app = fastify();
+  // @ts-ignore
+  app.all('*', adapters[Adapter.Fastify]({ build: require('../../../build') }));
+  app.listen({port: 0}, (_err, _addr) => {
+    res(app.server)
+  });
+})
 
-      const server = app.listen(0, () => {
-        serverPort = (server.address() as AddressInfo).port;
-        resolve(server);
-      });
-    });
+export class RemixTestEnv extends TestEnv {
+  private constructor(public readonly server: http.Server, public readonly url: string) {
+    super(server, url);
+  }
 
-    return new RemixTestEnv(server, `http://localhost:${serverPort}`);
+  public static async init(adapter: Adapter): Promise<RemixTestEnv> {
+    const srv = adapter === Adapter.Fastify ? await runFastifyApp() : await runExpressApp(adapter);
+    const port = (srv.address() as AddressInfo).port
+    return new RemixTestEnv(srv, `http://localhost:${port}`);
   }
 }