test: Move e2e tests into shared library (#807)

packages/e2e/next/cypress.config.ts

@@ -1,5 +1,4 @@
-import { defineConfig } from 'cypress'
-import cypressTerminalReport from 'cypress-terminal-report/src/installLogsPrinter'
+import { defineConfig } from 'e2e-shared/cypress.config'
 import fs from 'node:fs'
 import semver from 'semver'
 
@@ -9,20 +8,11 @@ const basePath =
 const nextJsVersion = readNextJsVersion()
 
 export default defineConfig({
-  e2e: {
-    baseUrl: `http://localhost:3001${basePath}`,
-    video: false,
-    fixturesFolder: false,
-    testIsolation: true,
-    setupNodeEvents(on) {
-      cypressTerminalReport(on)
-    },
-    retries: 2,
-    env: {
-      basePath,
-      supportsShallowRouting: supportsShallowRouting(nextJsVersion),
-      nextJsVersion
-    }
+  baseUrl: `http://localhost:3001${basePath}`,
+  env: {
+    basePath,
+    supportsShallowRouting: supportsShallowRouting(nextJsVersion),
+    nextJsVersion
   }
 })
 

packages/e2e/next/cypress/e2e/persist-across-navigation.cy.js

@@ -3,7 +3,7 @@
 it('Persists search params across navigation using a generated Link href', () => {
   cy.visit('/app/persist-across-navigation/a')
   cy.contains('#hydration-marker', 'hydrated').should('be.hidden')
-  cy.get('input[type=text]').type('foo')
+  cy.get('input[type=text]').type('foo', { delay: 0 })
   cy.get('input[type=checkbox]').check()
   cy.get('a').click()
   cy.location('pathname').should(

packages/e2e/next/cypress/e2e/shared/basic-io.cy.ts

@@ -0,0 +1,25 @@
+import { testBasicIO } from 'e2e-shared/specs/basic-io.cy'
+
+testBasicIO({
+  hook: 'useQueryState',
+  path: '/app/basic-io/useQueryState',
+  nextJsRouter: 'app'
+})
+
+testBasicIO({
+  hook: 'useQueryStates',
+  path: '/app/basic-io/useQueryStates',
+  nextJsRouter: 'app'
+})
+
+testBasicIO({
+  hook: 'useQueryState',
+  path: '/pages/basic-io/useQueryState',
+  nextJsRouter: 'pages'
+})
+
+testBasicIO({
+  hook: 'useQueryStates',
+  path: '/pages/basic-io/useQueryStates',
+  nextJsRouter: 'pages'
+})

packages/e2e/next/cypress/e2e/shared/hash-preservation.cy.ts

@@ -0,0 +1,25 @@
+import { testHashPreservation } from 'e2e-shared/specs/hash-preservation.cy'
+
+testHashPreservation({
+  path: '/app/hash-preservation',
+  nextJsRouter: 'app',
+  description: 'standard route'
+})
+
+testHashPreservation({
+  path: '/app/hash-preservation/dynamic/route',
+  nextJsRouter: 'app',
+  description: 'dynamic route'
+})
+
+testHashPreservation({
+  path: '/pages/hash-preservation',
+  nextJsRouter: 'pages',
+  description: 'standard route'
+})
+
+testHashPreservation({
+  path: '/pages/hash-preservation/dynamic/route',
+  nextJsRouter: 'pages',
+  description: 'dynamic route'
+})

packages/e2e/next/cypress/e2e/shared/linking.cy.ts

@@ -0,0 +1,25 @@
+import { testLinking } from 'e2e-shared/specs/linking.cy'
+
+testLinking({
+  hook: 'useQueryState',
+  path: '/app/linking/useQueryState',
+  nextJsRouter: 'app'
+})
+
+testLinking({
+  hook: 'useQueryStates',
+  path: '/app/linking/useQueryStates',
+  nextJsRouter: 'app'
+})
+
+testLinking({
+  hook: 'useQueryState',
+  path: '/pages/linking/useQueryState',
+  nextJsRouter: 'pages'
+})
+
+testLinking({
+  hook: 'useQueryStates',
+  path: '/pages/linking/useQueryStates',
+  nextJsRouter: 'pages'
+})

packages/e2e/next/cypress/e2e/shared/push.cy.ts

@@ -0,0 +1,59 @@
+import { testPush } from 'e2e-shared/specs/push.cy'
+
+testPush({
+  path: '/app/push/useQueryState',
+  hook: 'useQueryState',
+  nextJsRouter: 'app',
+  description: 'standard route'
+})
+
+testPush({
+  path: '/app/push/useQueryStates',
+  hook: 'useQueryStates',
+  nextJsRouter: 'app',
+  description: 'standard route'
+})
+
+testPush({
+  path: '/pages/push/useQueryState',
+  hook: 'useQueryState',
+  nextJsRouter: 'pages',
+  description: 'standard route'
+})
+
+testPush({
+  path: '/pages/push/useQueryStates',
+  hook: 'useQueryStates',
+  nextJsRouter: 'pages',
+  description: 'standard route'
+})
+
+// --
+
+testPush({
+  path: '/app/push/useQueryState/dynamic/route',
+  hook: 'useQueryState',
+  nextJsRouter: 'app',
+  description: 'dynamic route'
+})
+
+testPush({
+  path: '/app/push/useQueryStates/dynamic/route',
+  hook: 'useQueryStates',
+  nextJsRouter: 'app',
+  description: 'dynamic route'
+})
+
+testPush({
+  path: '/pages/push/useQueryState/dynamic/route',
+  hook: 'useQueryState',
+  nextJsRouter: 'pages',
+  description: 'dynamic route'
+})
+
+testPush({
+  path: '/pages/push/useQueryStates/dynamic/route',
+  hook: 'useQueryStates',
+  nextJsRouter: 'pages',
+  description: 'dynamic route'
+})

packages/e2e/next/cypress/e2e/shared/routing.cy.ts

@@ -0,0 +1,25 @@
+import { testRouting } from 'e2e-shared/specs/routing.cy'
+
+testRouting({
+  path: '/app/routing/useQueryState',
+  hook: 'useQueryState',
+  nextJsRouter: 'app'
+})
+
+testRouting({
+  path: '/app/routing/useQueryStates',
+  hook: 'useQueryStates',
+  nextJsRouter: 'app'
+})
+
+testRouting({
+  path: '/pages/routing/useQueryState',
+  hook: 'useQueryState',
+  nextJsRouter: 'pages'
+})
+
+testRouting({
+  path: '/pages/routing/useQueryStates',
+  hook: 'useQueryStates',
+  nextJsRouter: 'pages'
+})

packages/e2e/next/cypress/support/e2e.ts

@@ -1,3 +1 @@
-import setup from 'cypress-terminal-report/src/installLogsCollector'
-
-setup()
+import 'e2e-shared/cypress/support/e2e'

packages/e2e/next/next.config.mjs

@@ -10,6 +10,7 @@ const config = {
     ...(process.env.REACT_COMPILER === 'true' ? { reactCompiler: true } : {}),
     serverSourceMaps: true
   },
+  transpilePackages: ['e2e-shared'],
   rewrites: async () => [
     {
       source: '/app/rewrites/source',

packages/e2e/next/package.json

@@ -34,8 +34,9 @@
     "babel-plugin-react-compiler": "19.0.0-beta-a7bf2bd-20241110",
     "cypress": "^13.15.2",
     "cypress-terminal-report": "^7.0.4",
-    "semver": "^7.6.3",
+    "e2e-shared": "workspace:*",
     "start-server-and-test": "^2.0.8",
+    "semver": "^7.6.3",
     "typescript": "^5.6.3"
   }
 }

packages/e2e/next/src/app/app/(shared)/basic-io/useQueryState/page.tsx

@@ -0,0 +1,10 @@
+import { UseQueryStateBasicIO } from 'e2e-shared/specs/basic-io'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <UseQueryStateBasicIO />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/basic-io/useQueryStates/page.tsx

@@ -0,0 +1,10 @@
+import { UseQueryStatesBasicIO } from 'e2e-shared/specs/basic-io'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <UseQueryStatesBasicIO />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/hash-preservation/dynamic/[route]/page.tsx

@@ -0,0 +1,10 @@
+import { HashPreservation } from 'e2e-shared/specs/hash-preservation'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <HashPreservation />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/hash-preservation/page.tsx

@@ -0,0 +1,10 @@
+import { HashPreservation } from 'e2e-shared/specs/hash-preservation'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <HashPreservation />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/linking/useQueryState/other/page.tsx

@@ -0,0 +1,10 @@
+import { LinkingUseQueryState } from 'e2e-shared/specs/linking'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <LinkingUseQueryState path="/app/linking/useQueryState" />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/linking/useQueryState/page.tsx

@@ -0,0 +1,10 @@
+import { LinkingUseQueryState } from 'e2e-shared/specs/linking'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <LinkingUseQueryState path="/app/linking/useQueryState" />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/linking/useQueryStates/other/page.tsx

@@ -0,0 +1,10 @@
+import { LinkingUseQueryStates } from 'e2e-shared/specs/linking'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <LinkingUseQueryStates path="/app/linking/useQueryStates" />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/linking/useQueryStates/page.tsx

@@ -0,0 +1,10 @@
+import { LinkingUseQueryStates } from 'e2e-shared/specs/linking'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <LinkingUseQueryStates path="/app/linking/useQueryStates" />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/push/useQueryState/dynamic/[route]/page.tsx

@@ -0,0 +1,10 @@
+import { PushUseQueryState } from 'e2e-shared/specs/push'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <PushUseQueryState />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/push/useQueryState/page.tsx

@@ -0,0 +1,10 @@
+import { PushUseQueryState } from 'e2e-shared/specs/push'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <PushUseQueryState />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/push/useQueryStates/dynamic/[route]/page.tsx

@@ -0,0 +1,10 @@
+import { PushUseQueryStates } from 'e2e-shared/specs/push'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <PushUseQueryStates />
+    </Suspense>
+  )
+}

packages/e2e/next/src/app/app/(shared)/push/useQueryStates/page.tsx

@@ -0,0 +1,10 @@
+import { PushUseQueryStates } from 'e2e-shared/specs/push'
+import { Suspense } from 'react'
+
+export default function Page() {
+  return (
+    <Suspense>
+      <PushUseQueryStates />
+    </Suspense>
+  )
+}