fix tests

Author: lobsterkatie

packages/nextjs/test/config.test.ts

@@ -37,6 +37,33 @@ const mockExistsSync = (path: fs.PathLike) => {
 };
 const exitsSync = jest.spyOn(fs, 'existsSync').mockImplementation(mockExistsSync);
 
+// Make it so that all temporary folders, either created directly by tests or by the code they're testing, will go into
+// one spot that we know about, which we can then clean up when we're done
+const realTmpdir = jest.requireActual('os').tmpdir;
+const TEMP_DIR_PATH = path.join(realTmpdir(), 'sentry-nextjs-test');
+jest.spyOn(os, 'tmpdir').mockReturnValue(TEMP_DIR_PATH);
+// In theory, we should always land in the `else` here, but this saves the cases where the prior run got interrupted and
+// the `afterAll` below didn't happen.
+if (fs.existsSync(TEMP_DIR_PATH)) {
+  rimraf.sync(path.join(TEMP_DIR_PATH, '*'));
+} else {
+  fs.mkdirSync(TEMP_DIR_PATH);
+}
+
+afterAll(() => {
+  rimraf.sync(TEMP_DIR_PATH);
+});
+
+// In order to know what to expect in the webpack config `entry` property, we need to know the path of the temporary
+// directory created when doing the file injection, so wrap the real `mkdtempSync` and store the resulting path where we
+// can access it
+let tempDir: string;
+const realMkdtempSync = jest.requireActual('fs').mkdtempSync;
+jest.spyOn(fs, 'mkdtempSync').mockImplementation(prefix => {
+  tempDir = realMkdtempSync(prefix);
+  return tempDir;
+});
+
 /** Mocks of the arguments passed to `withSentryConfig` */
 const userNextConfig: Partial<NextConfigObject> = {
   publicRuntimeConfig: { location: 'dogpark', activities: ['fetch', 'chasing', 'digging'] },
@@ -103,7 +130,12 @@ function getBuildContext(
     dev: false,
     buildId: 'sItStAyLiEdOwN',
     dir: '/Users/Maisey/projects/squirrelChasingSimulator',
-    config: { target: 'server', ...userNextConfig } as NextConfigObject,
+    config: {
+      // nextjs's default values
+      target: 'server',
+      distDir: '.next',
+      ...userNextConfig,
+    } as NextConfigObject,
     webpack: { version: webpackVersion },
     isServer: buildTarget === 'server',
   };
@@ -279,26 +311,34 @@ describe('webpack config', () => {
         incomingWebpackBuildContext: serverBuildContext,
       });
 
+      const rewriteFramesHelper = path.join(tempDir, 'rewriteFramesHelper.js');
+
       expect(finalWebpackConfig.entry).toEqual(
         expect.objectContaining({
           // original entry point value is a string
           // (was 'private-next-pages/api/dogs/[name].js')
-          'pages/api/dogs/[name]': [serverConfigFilePath, 'private-next-pages/api/dogs/[name].js'],
+          'pages/api/dogs/[name]': [rewriteFramesHelper, serverConfigFilePath, 'private-next-pages/api/dogs/[name].js'],
 
           // original entry point value is a string array
           // (was ['./node_modules/smellOVision/index.js', 'private-next-pages/_app.js'])
-          'pages/_app': [serverConfigFilePath, './node_modules/smellOVision/index.js', 'private-next-pages/_app.js'],
+          'pages/_app': [
+            rewriteFramesHelper,
+            serverConfigFilePath,
+            './node_modules/smellOVision/index.js',
+            'private-next-pages/_app.js',
+          ],
 
           // original entry point value is an object containing a string `import` value
           // (`import` was 'private-next-pages/api/simulator/dogStats/[name].js')
           'pages/api/simulator/dogStats/[name]': {
-            import: [serverConfigFilePath, 'private-next-pages/api/simulator/dogStats/[name].js'],
+            import: [rewriteFramesHelper, serverConfigFilePath, 'private-next-pages/api/simulator/dogStats/[name].js'],
           },
 
           // original entry point value is an object containing a string array `import` value
           // (`import` was ['./node_modules/dogPoints/converter.js', 'private-next-pages/api/simulator/leaderboard.js'])
           'pages/api/simulator/leaderboard': {
             import: [
+              rewriteFramesHelper,
               serverConfigFilePath,
               './node_modules/dogPoints/converter.js',
               'private-next-pages/api/simulator/leaderboard.js',
@@ -308,14 +348,14 @@ describe('webpack config', () => {
           // original entry point value is an object containg properties besides `import`
           // (`dependOn` remains untouched)
           'pages/api/tricks/[trickName]': {
-            import: [serverConfigFilePath, 'private-next-pages/api/tricks/[trickName].js'],
+            import: [rewriteFramesHelper, serverConfigFilePath, 'private-next-pages/api/tricks/[trickName].js'],
             dependOn: 'treats',
           },
         }),
       );
     });
 
-    it('does not inject into non-_app, non-API routes', async () => {
+    it('does not inject anything into non-_app, non-API routes', async () => {
       const finalWebpackConfig = await materializeFinalWebpackConfig({
         userNextConfig,
         incomingWebpackConfig: clientWebpackConfig,
@@ -326,12 +366,60 @@ describe('webpack config', () => {
         expect.objectContaining({
           // no injected file
           main: './src/index.ts',
-          // was 'next-client-pages-loader?page=%2F_app'
+        }),
+      );
+    });
+
+    it('does not inject `RewriteFrames` helper into client routes', async () => {
+      const finalWebpackConfig = await materializeFinalWebpackConfig({
+        userNextConfig,
+        incomingWebpackConfig: clientWebpackConfig,
+        incomingWebpackBuildContext: clientBuildContext,
+      });
+
+      expect(finalWebpackConfig.entry).toEqual(
+        expect.objectContaining({
+          // was 'next-client-pages-loader?page=%2F_app', and now has client config but not`RewriteFrames` helper injected
           'pages/_app': [clientConfigFilePath, 'next-client-pages-loader?page=%2F_app'],
         }),
       );
     });
   });
+
+  describe('`distDir` value in default server-side `RewriteFrames` integration', () => {
+    it.each([
+      ['no custom `distDir`', undefined, '.next'],
+      ['custom `distDir`', 'dist', 'dist'],
+    ])(
+      'creates file injecting `distDir` value into `global` - %s',
+      async (_name, customDistDir, expectedInjectedValue) => {
+        // Note: the fact that the file tested here gets injected correctly is covered in the 'webpack `entry` property
+        // config' tests above
+
+        const userNextConfigDistDir = {
+          ...userNextConfig,
+          ...(customDistDir && { distDir: customDistDir }),
+        };
+        await materializeFinalWebpackConfig({
+          userNextConfig: userNextConfigDistDir,
+          incomingWebpackConfig: serverWebpackConfig,
+          incomingWebpackBuildContext: getBuildContext('server', userNextConfigDistDir),
+        });
+        const rewriteFramesHelper = path.join(tempDir, 'rewriteFramesHelper.js');
+
+        expect(fs.existsSync(rewriteFramesHelper)).toBe(true);
+
+        const injectedCode = fs.readFileSync(rewriteFramesHelper).toString();
+        expect(injectedCode).toEqual(`global.__rewriteFramesDistDir__ = '${expectedInjectedValue}';\n`);
+      },
+    );
+
+    describe('`RewriteFrames` ends up with correct `distDir` value', () => {
+      // TODO: this, along with any number of other parts of the build process, should be tested with an integration
+      // test which actually runs webpack and inspects the resulting bundles (and that integration test should test
+      // custom `distDir` values with and without a `.`, to make sure the regex escaping is working)
+    });
+  });
 });
 
 describe('Sentry webpack plugin config', () => {
@@ -580,19 +668,15 @@ describe('Sentry webpack plugin config', () => {
   });
 
   describe('getUserConfigFile', () => {
-    let tempDir: string;
-
     beforeAll(() => {
       exitsSync.mockImplementation(realExistsSync);
     });
 
     beforeEach(() => {
+      // these will get cleaned up by the file's overall `afterAll` function, and the `mkdtempSync` mock above ensures
+      // that the location of the created folder is stored in `tempDir`
       const tempDirPathPrefix = path.join(os.tmpdir(), 'sentry-nextjs-test-');
-      tempDir = fs.mkdtempSync(tempDirPathPrefix);
-    });
-
-    afterEach(() => {
-      rimraf.sync(tempDir);
+      fs.mkdtempSync(tempDirPathPrefix);
     });
 
     afterAll(() => {

packages/nextjs/test/index.server.test.ts

@@ -10,6 +10,9 @@ const { Integrations } = SentryNode;
 
 const global = getGlobalObject();
 
+// normally this is set as part of the build process, so mock it here
+(global as typeof global & { __rewriteFramesDistDir__: string }).__rewriteFramesDistDir__ = '.next';
+
 let configureScopeCallback: (scope: Scope) => void = () => undefined;
 jest.spyOn(SentryNode, 'configureScope').mockImplementation(callback => (configureScopeCallback = callback));
 const nodeInit = jest.spyOn(SentryNode, 'init');