WIP testing

Author: mischnic

test/production/app-dir/actions-tree-shaking/_testing/utils.ts

@@ -1,71 +1,89 @@
-// @ts-ignore avoid ts errors during manual testing
-import { type NextInstance } from 'e2e-utils'
+import { nextTestSetup, type NextInstance } from 'e2e-utils'
+
+// This is from 'next/dist/build/webpack/plugins/flight-client-entry-plugin', but unfortunately
+// Typescript breaks when importing it directly.
+type Actions = {
+  [actionId: string]: {
+    exportedName?: string
+    filename?: string
+    workers: {
+      [name: string]: {
+        moduleId: string | number
+        async: boolean
+      }
+    }
+    layer: {
+      [name: string]: string
+    }
+  }
+}
 
 async function getActionsMappingByRuntime(
   next: NextInstance,
   runtime: 'node' | 'edge'
-) {
+): Promise<Actions> {
   const manifest = JSON.parse(
     await next.readFile('.next/server/server-reference-manifest.json')
   )
 
   return manifest[runtime]
 }
 
-export function markLayoutAsEdge(next: NextInstance) {
-  beforeAll(async () => {
-    await next.stop()
-    const layoutContent = await next.readFile('app/layout.js')
-    await next.patchFile(
-      'app/layout.js',
-      layoutContent + `\nexport const runtime = 'edge'`
-    )
-    await next.start()
+export function nextTestSetupActionTreeShaking(opts) {
+  let result = nextTestSetup({
+    ...opts,
+    skipStart: !!process.env.TEST_EDGE,
   })
-}
 
-/* 
-{ 
-  [route path]: { [layer]: Set<workerId> ]
-}
-*/
-type ActionsMappingOfRuntime = {
-  [actionId: string]: {
-    workers: {
-      [route: string]: string
-    }
-    layer: {
-      [route: string]: string
-    }
+  if (process.env.TEST_EDGE) {
+    beforeAll(async () => {
+      const layoutContent = await result.next.readFile('app/layout.js')
+      await result.next.patchFile(
+        'app/layout.js',
+        layoutContent + `\nexport const runtime = 'edge'`
+      )
+      await result.next.start()
+    })
   }
+
+  return result
 }
+
 type ActionState = {
   [route: string]: {
-    [layer: string]: number
+    [layer: string]: string[]
   }
 }
 
-function getActionsRoutesState(
-  actionsMappingOfRuntime: ActionsMappingOfRuntime
-): ActionState {
+function getActionsRoutesState(actionsMappingOfRuntime: Actions): ActionState {
   const state: ActionState = {}
-  Object.keys(actionsMappingOfRuntime).forEach((actionId) => {
+  for (const actionId in actionsMappingOfRuntime) {
     const action = actionsMappingOfRuntime[actionId]
-    const routePaths = Object.keys(action.workers)
-
-    routePaths.forEach((routePath) => {
+    for (const routePath in action.workers) {
       if (!state[routePath]) {
         state[routePath] = {}
       }
       const layer = action.layer[routePath]
 
       if (!state[routePath][layer]) {
-        state[routePath][layer] = 0
+        state[routePath][layer] = []
       }
 
-      state[routePath][layer]++
-    })
-  })
+      // Normalize when NEXT_SKIP_ISOLATE=1
+      const filename = action.filename.startsWith('test/tmp/next-test-')
+        ? action.filename.slice(
+            action.filename.indexOf('/', 'test/tmp/next-test-'.length) + 1
+          )
+        : action.filename
+      state[routePath][layer].push(`${filename}#${action.exportedName}`)
+    }
+  }
+
+  for (const layer of Object.values(state)) {
+    for (const list of Object.values(layer)) {
+      list.sort()
+    }
+  }
 
   return state
 }

test/production/app-dir/actions-tree-shaking/basic/basic.test.ts

@@ -1,37 +1,39 @@
-import { nextTestSetup } from 'e2e-utils'
 import {
+  nextTestSetupActionTreeShaking,
   getActionsRoutesStateByRuntime,
-  markLayoutAsEdge,
 } from '../_testing/utils'
 
 // TODO: revisit when we have a better side-effect free transform approach for server action
 ;(process.env.IS_TURBOPACK_TEST ? describe : describe.skip)(
   'actions-tree-shaking - basic',
   () => {
-    const { next } = nextTestSetup({
+    const { next } = nextTestSetupActionTreeShaking({
       files: __dirname,
     })
 
-    if (process.env.TEST_EDGE) {
-      markLayoutAsEdge(next)
-    }
-
     it('should not have the unused action in the manifest', async () => {
       const actionsRoutesState = await getActionsRoutesStateByRuntime(next)
-
-      expect(actionsRoutesState).toMatchObject({
-        // only one server layer action
-        'app/server/page': {
-          rsc: 3,
-        },
-        // only one browser layer action
-        'app/client/page': {
-          'action-browser': 1,
-        },
-        'app/inline/page': {
-          rsc: 1,
-        },
-      })
+      expect(actionsRoutesState).toMatchInlineSnapshot(`
+       {
+         "app/client/page": {
+           "action-browser": [
+             "app/actions.js#clientComponentAction",
+           ],
+         },
+         "app/inline/page": {
+           "rsc": [
+             "app/inline/page.js#$$RSC_SERVER_ACTION_0",
+           ],
+         },
+         "app/server/page": {
+           "rsc": [
+             "app/actions.js#clientComponentAction",
+             "app/actions.js#serverComponentAction",
+             "app/actions.js#unusedExportedAction",
+           ],
+         },
+       }
+      `)
     })
   }
 )