test(remix): Add Remix v2 future flags integration tests. (#8397)

onurtemizkan · web-flow · commit 0c194462a034 · 2023-06-26T13:23:51.000-04:00
Added an integration test application using [Remix 1.17.0](https://github.com/remix-run/remix/releases/tag/remix%401.17.0) and [v2 future flags](https://remix.run/docs/en/main/pages/api-development-strategy) to see the state of current SDK support for v2.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -685,7 +685,7 @@ jobs:
           yarn test
 
   job_remix_integration_tests:
-    name: Remix (Node ${{ matrix.node }}) Tests
+    name: Remix v${{ matrix.remix }} (Node ${{ matrix.node }}) Tests
     needs: [job_get_metadata, job_build]
     if: needs.job_get_metadata.outputs.changed_remix == 'true' || github.event_name != 'pull_request'
     runs-on: ubuntu-20.04
@@ -694,6 +694,7 @@ jobs:
       fail-fast: false
       matrix:
         node: [14, 16, 18]
+        remix: [1, 2]
     steps:
       - name: Check out current commit (${{ needs.job_get_metadata.outputs.commit_label }})
         uses: actions/checkout@v3
@@ -710,6 +711,7 @@ jobs:
       - name: Run integration tests
         env:
           NODE_VERSION: ${{ matrix.node }}
+          REMIX_VERSION: ${{ matrix.remix }}
         run: |
           cd packages/remix
           yarn test:integration:ci
diff --git a/packages/remix/package.json b/packages/remix/package.json
@@ -59,7 +59,9 @@
     "lint:eslint": "eslint . --format stylish",
     "lint:prettier": "prettier --check \"{src,test,scripts}/**/**.ts\"",
     "test": "yarn test:unit",
-    "test:integration": "run-s test:integration:clean test:integration:prepare test:integration:client test:integration:server",
+    "test:integration": "run-s test:integration:v1 test:integration:v2",
+    "test:integration:v1": "run-s test:integration:clean test:integration:prepare test:integration:client test:integration:server",
+    "test:integration:v2": "export REMIX_VERSION=2 && run-s test:integration:v1",
     "test:integration:ci": "run-s test:integration:clean test:integration:prepare test:integration:client:ci test:integration:server",
     "test:integration:prepare": "(cd test/integration && yarn)",
     "test:integration:clean": "(cd test/integration && rimraf .cache node_modules build)",
diff --git a/packages/remix/test/integration/app_v1/entry.client.tsx b/packages/remix/test/integration/app_v1/entry.client.tsx
diff --git a/packages/remix/test/integration/app_v1/entry.server.tsx b/packages/remix/test/integration/app_v1/entry.server.tsx
diff --git a/packages/remix/test/integration/app_v1/root.tsx b/packages/remix/test/integration/app_v1/root.tsx
diff --git a/packages/remix/test/integration/app_v1/routes/action-json-response/$id.tsx b/packages/remix/test/integration/app_v1/routes/action-json-response/$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../../common/routes/action-json-response.$id';
+export { default } from '../../../common/routes/action-json-response.$id';
diff --git a/packages/remix/test/integration/app_v1/routes/capture-exception.tsx b/packages/remix/test/integration/app_v1/routes/capture-exception.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/capture-exception';
+export { default } from '../../common/routes/capture-exception';
diff --git a/packages/remix/test/integration/app_v1/routes/capture-message.tsx b/packages/remix/test/integration/app_v1/routes/capture-message.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/capture-message';
+export { default } from '../../common/routes/capture-message';
diff --git a/packages/remix/test/integration/app_v1/routes/error-boundary-capture/$id.tsx b/packages/remix/test/integration/app_v1/routes/error-boundary-capture/$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../../common/routes/error-boundary-capture.$id';
+export { default } from '../../../common/routes/error-boundary-capture.$id';
diff --git a/packages/remix/test/integration/app_v1/routes/index.tsx b/packages/remix/test/integration/app_v1/routes/index.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/index';
+export { default } from '../../common/routes/index';
diff --git a/packages/remix/test/integration/app_v1/routes/loader-defer-response/index.tsx b/packages/remix/test/integration/app_v1/routes/loader-defer-response/index.tsx
@@ -0,0 +1,2 @@
+export * from '../../../common/routes/loader-defer-response';
+export { default } from '../../../common/routes/loader-defer-response';
diff --git a/packages/remix/test/integration/app_v1/routes/loader-json-response/$id.tsx b/packages/remix/test/integration/app_v1/routes/loader-json-response/$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../../common/routes/loader-json-response.$id';
+export { default } from '../../../common/routes/loader-json-response.$id';
diff --git a/packages/remix/test/integration/app_v1/routes/manual-tracing/$id.tsx b/packages/remix/test/integration/app_v1/routes/manual-tracing/$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../../common/routes/manual-tracing.$id';
+export { default } from '../../../common/routes/manual-tracing.$id';
diff --git a/packages/remix/test/integration/app_v1/routes/scope-bleed/$id.tsx b/packages/remix/test/integration/app_v1/routes/scope-bleed/$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../../common/routes/scope-bleed.$id';
+export { default } from '../../../common/routes/scope-bleed.$id';
diff --git a/packages/remix/test/integration/app_v2/entry.client.tsx b/packages/remix/test/integration/app_v2/entry.client.tsx
@@ -0,0 +1,16 @@
+import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
+import { hydrate } from 'react-dom';
+import * as Sentry from '@sentry/remix';
+import { useEffect } from 'react';
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  tracesSampleRate: 1,
+  integrations: [
+    new Sentry.BrowserTracing({
+      routingInstrumentation: Sentry.remixRouterInstrumentation(useEffect, useLocation, useMatches),
+    }),
+  ],
+});
+
+hydrate(<RemixBrowser />, document);
diff --git a/packages/remix/test/integration/app_v2/entry.server.tsx b/packages/remix/test/integration/app_v2/entry.server.tsx
@@ -0,0 +1,27 @@
+import type { EntryContext } from '@remix-run/node';
+import { RemixServer } from '@remix-run/react';
+import { renderToString } from 'react-dom/server';
+import * as Sentry from '@sentry/remix';
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  tracesSampleRate: 1,
+  // Disabling to test series of envelopes deterministically.
+  autoSessionTracking: false,
+});
+
+export default function handleRequest(
+  request: Request,
+  responseStatusCode: number,
+  responseHeaders: Headers,
+  remixContext: EntryContext,
+) {
+  let markup = renderToString(<RemixServer context={remixContext} url={request.url} />);
+
+  responseHeaders.set('Content-Type', 'text/html');
+
+  return new Response('<!DOCTYPE html>' + markup, {
+    status: responseStatusCode,
+    headers: responseHeaders,
+  });
+}
diff --git a/packages/remix/test/integration/app_v2/root.tsx b/packages/remix/test/integration/app_v2/root.tsx
@@ -0,0 +1,60 @@
+import { V2_MetaFunction, LoaderFunction, json, defer, redirect } from '@remix-run/node';
+import { Links, LiveReload, Meta, Outlet, Scripts, ScrollRestoration } from '@remix-run/react';
+import { withSentry } from '@sentry/remix';
+
+export const meta: V2_MetaFunction = ({ data }) => [
+  { charset: 'utf-8' },
+  { title: 'New Remix App' },
+  { name: 'viewport', content: 'width=device-width,initial-scale=1' },
+  { name: 'sentry-trace', content: data.sentryTrace },
+  { name: 'baggage', content: data.sentryBaggage },
+];
+
+export const loader: LoaderFunction = async ({ request }) => {
+  const url = new URL(request.url);
+  const type = url.searchParams.get('type');
+
+  switch (type) {
+    case 'empty':
+      return {};
+    case 'plain':
+      return {
+        data_one: [],
+        data_two: 'a string',
+      };
+    case 'json':
+      return json({ data_one: [], data_two: 'a string' }, { headers: { 'Cache-Control': 'max-age=300' } });
+    case 'defer':
+      return defer({ data_one: [], data_two: 'a string' });
+    case 'null':
+      return null;
+    case 'undefined':
+      return undefined;
+    case 'throwRedirect':
+      throw redirect('/?type=plain');
+    case 'returnRedirect':
+      return redirect('/?type=plain');
+    default: {
+      return {};
+    }
+  }
+};
+
+function App() {
+  return (
+    <html lang="en">
+      <head>
+        <Meta />
+        <Links />
+      </head>
+      <body>
+        <Outlet />
+        <ScrollRestoration />
+        <Scripts />
+        <LiveReload />
+      </body>
+    </html>
+  );
+}
+
+export default withSentry(App);
diff --git a/packages/remix/test/integration/app_v2/routes/action-json-response.$id.tsx b/packages/remix/test/integration/app_v2/routes/action-json-response.$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/action-json-response.$id';
+export { default } from '../../common/routes/action-json-response.$id';
diff --git a/packages/remix/test/integration/app_v2/routes/capture-exception.tsx b/packages/remix/test/integration/app_v2/routes/capture-exception.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/capture-exception';
+export { default } from '../../common/routes/capture-exception';
diff --git a/packages/remix/test/integration/app_v2/routes/capture-message.tsx b/packages/remix/test/integration/app_v2/routes/capture-message.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/capture-message';
+export { default } from '../../common/routes/capture-message';
diff --git a/packages/remix/test/integration/app_v2/routes/error-boundary-capture.$id.tsx b/packages/remix/test/integration/app_v2/routes/error-boundary-capture.$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/error-boundary-capture.$id';
+export { default } from '../../common/routes/error-boundary-capture.$id';
diff --git a/packages/remix/test/integration/app_v2/routes/index.tsx b/packages/remix/test/integration/app_v2/routes/index.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/index';
+export { default } from '../../common/routes/index';
diff --git a/packages/remix/test/integration/app_v2/routes/loader-defer-response.tsx b/packages/remix/test/integration/app_v2/routes/loader-defer-response.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/loader-defer-response';
+export { default } from '../../common/routes/loader-defer-response';
diff --git a/packages/remix/test/integration/app_v2/routes/loader-json-response.$id.tsx b/packages/remix/test/integration/app_v2/routes/loader-json-response.$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/loader-json-response.$id';
+export { default } from '../../common/routes/loader-json-response.$id';
diff --git a/packages/remix/test/integration/app_v2/routes/manual-tracing.$id.tsx b/packages/remix/test/integration/app_v2/routes/manual-tracing.$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/manual-tracing.$id';
+export { default } from '../../common/routes/manual-tracing.$id';
diff --git a/packages/remix/test/integration/app_v2/routes/scope-bleed.$id.tsx b/packages/remix/test/integration/app_v2/routes/scope-bleed.$id.tsx
@@ -0,0 +1,2 @@
+export * from '../../common/routes/scope-bleed.$id';
+export { default } from '../../common/routes/scope-bleed.$id';
diff --git a/packages/remix/test/integration/common/routes/action-json-response.$id.tsx b/packages/remix/test/integration/common/routes/action-json-response.$id.tsx
diff --git a/packages/remix/test/integration/common/routes/capture-exception.tsx b/packages/remix/test/integration/common/routes/capture-exception.tsx
diff --git a/packages/remix/test/integration/common/routes/capture-message.tsx b/packages/remix/test/integration/common/routes/capture-message.tsx
@@ -3,5 +3,5 @@ import * as Sentry from '@sentry/remix';
 export default function ErrorBoundaryCapture() {
   Sentry.captureMessage('Sentry Manually Captured Message');
 
-  return <div/>;
+  return <div />;
 }
diff --git a/packages/remix/test/integration/common/routes/error-boundary-capture.$id.tsx b/packages/remix/test/integration/common/routes/error-boundary-capture.$id.tsx
diff --git a/packages/remix/test/integration/common/routes/index.tsx b/packages/remix/test/integration/common/routes/index.tsx
diff --git a/packages/remix/test/integration/common/routes/loader-defer-response.tsx b/packages/remix/test/integration/common/routes/loader-defer-response.tsx
diff --git a/packages/remix/test/integration/common/routes/loader-json-response.$id.tsx b/packages/remix/test/integration/common/routes/loader-json-response.$id.tsx
diff --git a/packages/remix/test/integration/common/routes/manual-tracing.$id.tsx b/packages/remix/test/integration/common/routes/manual-tracing.$id.tsx
@@ -3,5 +3,5 @@ import * as Sentry from '@sentry/remix';
 export default function ManualTracing() {
   const transaction = Sentry.startTransaction({ name: 'test_transaction_1' });
   transaction.finish();
-  return <div/>;
+  return <div />;
 }
diff --git a/packages/remix/test/integration/common/routes/scope-bleed.$id.tsx b/packages/remix/test/integration/common/routes/scope-bleed.$id.tsx
diff --git a/packages/remix/test/integration/remix.config.js b/packages/remix/test/integration/remix.config.js
@@ -1,7 +1,16 @@
 /** @type {import('@remix-run/dev').AppConfig} */
+const useV2 = process.env.REMIX_VERSION === '2';
+
 module.exports = {
-  appDirectory: 'app',
+  appDirectory: useV2 ? 'app_v2' : 'app_v1',
   assetsBuildDirectory: 'public/build',
   serverBuildPath: 'build/index.js',
   publicPath: '/build/',
+  future: {
+    v2_errorBoundary: useV2,
+    v2_headers: useV2,
+    v2_meta: useV2,
+    v2_normalizeFormMethod: useV2,
+    v2_routeConvention: useV2,
+  },
 };
diff --git a/packages/remix/test/integration/test/client/errorboundary.test.ts b/packages/remix/test/integration/test/client/errorboundary.test.ts
@@ -2,6 +2,8 @@ import { getMultipleSentryEnvelopeRequests } from './utils/helpers';
 import { test, expect } from '@playwright/test';
 import { Event } from '@sentry/types';
 
+const useV2 = process.env.REMIX_VERSION === '2';
+
 test('should capture React component errors.', async ({ page }) => {
   const envelopes = await getMultipleSentryEnvelopeRequests<Event>(page, 2, {
     url: '/error-boundary-capture/0',
@@ -12,7 +14,9 @@ test('should capture React component errors.', async ({ page }) => {
   expect(pageloadEnvelope.contexts?.trace.op).toBe('pageload');
   expect(pageloadEnvelope.tags?.['routing.instrumentation']).toBe('remix-router');
   expect(pageloadEnvelope.type).toBe('transaction');
-  expect(pageloadEnvelope.transaction).toBe('routes/error-boundary-capture/$id');
+  expect(pageloadEnvelope.transaction).toBe(
+    useV2 ? 'routes/error-boundary-capture.$id' : 'routes/error-boundary-capture/$id',
+  );
 
   expect(errorEnvelope.level).toBe('error');
   expect(errorEnvelope.sdk?.name).toBe('sentry.javascript.remix');
diff --git a/packages/remix/test/integration/test/client/manualtracing.test.ts b/packages/remix/test/integration/test/client/manualtracing.test.ts
@@ -2,6 +2,8 @@ import { getMultipleSentryEnvelopeRequests } from './utils/helpers';
 import { test, expect } from '@playwright/test';
 import { Event } from '@sentry/types';
 
+const useV2 = process.env.REMIX_VERSION === '2';
+
 test('should report a manually created / finished transaction.', async ({ page }) => {
   const envelopes = await getMultipleSentryEnvelopeRequests<Event>(page, 2, {
     url: '/manual-tracing/0',
@@ -17,5 +19,5 @@ test('should report a manually created / finished transaction.', async ({ page }
   expect(pageloadEnvelope.contexts?.trace?.op).toBe('pageload');
   expect(pageloadEnvelope.tags?.['routing.instrumentation']).toBe('remix-router');
   expect(pageloadEnvelope.type).toBe('transaction');
-  expect(pageloadEnvelope.transaction).toBe('routes/manual-tracing/$id');
+  expect(pageloadEnvelope.transaction).toBe(useV2 ? 'routes/manual-tracing.$id' : 'routes/manual-tracing/$id');
 });
diff --git a/packages/remix/test/integration/test/client/pageload.test.ts b/packages/remix/test/integration/test/client/pageload.test.ts
@@ -1,3 +1,5 @@
+const useV2 = process.env.REMIX_VERSION === '2';
+
 import { getFirstSentryEnvelopeRequest } from './utils/helpers';
 import { test, expect } from '@playwright/test';
 import { Event } from '@sentry/types';
@@ -8,5 +10,6 @@ test('should add `pageload` transaction on load.', async ({ page }) => {
   expect(envelope.contexts?.trace.op).toBe('pageload');
   expect(envelope.tags?.['routing.instrumentation']).toBe('remix-router');
   expect(envelope.type).toBe('transaction');
-  expect(envelope.transaction).toBe('routes/index');
+
+  expect(envelope.transaction).toBe(useV2 ? 'root' : 'routes/index');
 });
diff --git a/packages/remix/test/integration/test/server/action.test.ts b/packages/remix/test/integration/test/server/action.test.ts
@@ -1,5 +1,7 @@
 import { assertSentryTransaction, assertSentryEvent, RemixTestEnv } from './utils/helpers';
 
+const useV2 = process.env.REMIX_VERSION === '2';
+
 jest.spyOn(console, 'error').mockImplementation();
 
 // Repeat tests for each adapter
@@ -11,22 +13,22 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
     const transaction = envelope[2];
 
     assertSentryTransaction(transaction, {
-      transaction: 'routes/action-json-response/$id',
+      transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       spans: [
         {
-          description: 'routes/action-json-response/$id',
+          description: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
           op: 'function.remix.action',
         },
         {
           description: 'root',
           op: 'function.remix.loader',
         },
         {
-          description: 'routes/action-json-response/$id',
+          description: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
           op: 'function.remix.loader',
         },
         {
-          description: 'routes/action-json-response/$id',
+          description: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
           op: 'function.remix.document_request',
         },
       ],
@@ -102,7 +104,7 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
     const [event] = envelopes.filter(envelope => envelope[1].type === 'event');
 
     assertSentryTransaction(transaction[2], {
-      transaction: 'routes/action-json-response/$id',
+      transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       request: {
         method: 'POST',
         url,
@@ -161,7 +163,7 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
         },
       },
       tags: {
-        transaction: 'routes/action-json-response/$id',
+        transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       },
     });
 
@@ -177,7 +179,7 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
         },
       },
       tags: {
-        transaction: 'routes/action-json-response/$id',
+        transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       },
     });
 
@@ -227,7 +229,7 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
         },
       },
       tags: {
-        transaction: 'routes/action-json-response/$id',
+        transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       },
     });
 
@@ -277,7 +279,7 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
         },
       },
       tags: {
-        transaction: 'routes/action-json-response/$id',
+        transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       },
     });
 
@@ -327,7 +329,7 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
         },
       },
       tags: {
-        transaction: 'routes/action-json-response/$id',
+        transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       },
     });
 
@@ -377,7 +379,7 @@ describe.each(['builtin', 'express'])('Remix API Actions with adapter = %s', ada
         },
       },
       tags: {
-        transaction: 'routes/action-json-response/$id',
+        transaction: `routes/action-json-response${useV2 ? '.' : '/'}$id`,
       },
     });
 
diff --git a/packages/remix/test/integration/test/server/loader.test.ts b/packages/remix/test/integration/test/server/loader.test.ts
diff --git a/packages/remix/test/integration/tsconfig.json b/packages/remix/test/integration/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from '../../../common/routes/action-json-response.$id';`
	`2`	`+export { default } from '../../../common/routes/action-json-response.$id';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from '../../common/routes/capture-exception';`
	`2`	`+export { default } from '../../common/routes/capture-exception';`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+export * from '../../common/routes/index';`
	`2`	`+export { default } from '../../common/routes/index';`