chore(e2e): move hash related test utils to the shared package

e2e/e2e-utils/src/index.ts

@@ -1,2 +1,4 @@
 export { derivePort } from './derivePort'
 export { localDummyServer } from './localDummyServer'
+export { toRuntimePath } from './to-runtime-path'
+export { resolveRuntimeSuffix } from './resolve-runtime-suffix'

e2e/e2e-utils/src/resolve-runtime-suffix.ts

@@ -0,0 +1,13 @@
+/**
+ * Resolves the runtime suffix based on the provided input or the environment variable `VITE_APP_HISTORY`.
+ *
+ * @param {string} [input] - Optional input to override the environment variable.
+ * @returns {string} Returns 'hash' if the input or `VITE_APP_HISTORY` is set to 'hash', otherwise returns 'browser'.
+ */
+export function resolveRuntimeSuffix(input?: string): string {
+  const value =
+    input === 'hash' || process.env.VITE_APP_HISTORY === 'hash'
+      ? 'hash'
+      : 'browser'
+  return value
+}

e2e/e2e-utils/src/to-runtime-path.ts

@@ -0,0 +1,17 @@
+/**
+ * Converts the given input string to a valid runtime path based on the environment configuration.
+ * If the environment variable `VITE_APP_HISTORY` is set to 'hash', the input will be prefixed with `/#`.
+ * Otherwise, the input will be returned as is.
+ *
+ * @param {string} input - The input string to be converted.
+ * @returns {string} - The converted test URL value.
+ * @example
+ * toRuntimePath('/normal-page') // '/normal-page'
+ * // or
+ * process.env.VITE_APP_HISTORY = 'hash'
+ * toRuntimePath('/normal-page') // '/#/normal-page'
+ */
+export function toRuntimePath(input: string) {
+  const value = process.env.VITE_APP_HISTORY === 'hash' ? `/#${input}` : input
+  return value
+}

e2e/react-router/basic-esbuild-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic-file-based-code-splitting/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic-react-query-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic-react-query/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic-scroll-restoration/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic-virtual-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic-virtual-named-export-config-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/basic/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/react-router/rspack-basic-file-based/.gitignore

@@ -6,6 +6,7 @@
 # Dist
 node_modules
 dist/
+dist-hash/
 
 # IDE
 .vscode/*

e2e/react-router/rspack-basic-virtual-named-export-config-file-based/.gitignore

@@ -6,6 +6,7 @@
 # Dist
 node_modules
 dist/
+dist-hash/
 
 # IDE
 .vscode/*

e2e/react-router/scroll-restoration-sandbox-vite/playwright.browser.config.ts

@@ -1,8 +1,10 @@
 import { defineConfig, devices } from '@playwright/test'
-import { derivePort } from '@tanstack/router-e2e-utils'
+import { derivePort, resolveRuntimeSuffix } from '@tanstack/router-e2e-utils'
 import packageJson from './package.json' with { type: 'json' }
 
-const PORT = derivePort(packageJson.name + '-browser')
+const PORT = derivePort(
+  packageJson.name + `-${resolveRuntimeSuffix('browser')}`,
+)
 const baseURL = `http://localhost:${PORT}`
 /**
  * See https://playwright.dev/docs/test-configuration.

e2e/react-router/scroll-restoration-sandbox-vite/playwright.hash.config.ts

@@ -1,8 +1,10 @@
 import { defineConfig, devices } from '@playwright/test'
-import { derivePort } from '@tanstack/router-e2e-utils'
+import { derivePort, resolveRuntimeSuffix } from '@tanstack/router-e2e-utils'
 import packageJson from './package.json' with { type: 'json' }
 
-const PORT = derivePort(packageJson.name + '-hash')
+const PORT = derivePort(
+  packageJson.name + `-${resolveRuntimeSuffix('browser')}`,
+)
 const baseURL = `http://localhost:${PORT}`
 /**
  * See https://playwright.dev/docs/test-configuration.

e2e/react-router/scroll-restoration-sandbox-vite/tests/app.spec.ts

@@ -1,13 +1,9 @@
 import { expect, test } from '@playwright/test'
 import { linkOptions } from '@tanstack/react-router'
-
-function toValue(input: string) {
-  const value = process.env.VITE_APP_HISTORY === 'hash' ? `/#${input}` : input
-  return value
-}
+import { toRuntimePath } from '@tanstack/router-e2e-utils'
 
 test('Smoke - Renders home', async ({ page }) => {
-  await page.goto(toValue('/'))
+  await page.goto(toRuntimePath('/'))
   await expect(
     page.getByRole('heading', { name: 'Welcome Home!' }),
   ).toBeVisible()
@@ -24,7 +20,7 @@ test('Smoke - Renders home', async ({ page }) => {
   test(`On navigate to ${options.to} (from the header), scroll should be at top`, async ({
     page,
   }) => {
-    await page.goto(toValue('/'))
+    await page.goto(toRuntimePath('/'))
     await page.getByRole('link', { name: `Head-${options.to}` }).click()
     await expect(page.getByTestId('at-the-top')).toBeInViewport()
   })
@@ -33,7 +29,7 @@ test('Smoke - Renders home', async ({ page }) => {
   test(`On navigate via index page tests to ${options.to}, scroll should resolve at the bottom`, async ({
     page,
   }) => {
-    await page.goto(toValue('/'))
+    await page.goto(toRuntimePath('/'))
     await page
       .getByRole('link', { name: `${options.to}#at-the-bottom` })
       .click()
@@ -48,7 +44,7 @@ test('Smoke - Renders home', async ({ page }) => {
     if ('search' in options) {
       url = `${url}?where=${options.search.where}`
     }
-    await page.goto(toValue(`${url}#at-the-bottom`))
+    await page.goto(toRuntimePath(`${url}#at-the-bottom`))
     await expect(page.getByTestId('at-the-bottom')).toBeInViewport()
   })
 })

e2e/react-router/sentry-integration/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-esbuild-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-file-based-code-splitting/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-scroll-restoration/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-solid-query-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-solid-query/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-virtual-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic-virtual-named-export-config-file-based/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/basic/.gitignore

@@ -1,6 +1,7 @@
 node_modules
 .DS_Store
 dist
+dist-hash
 dist-ssr
 *.local
 

e2e/solid-router/rspack-basic-file-based/.gitignore

@@ -6,6 +6,7 @@
 # Dist
 node_modules
 dist/
+dist-hash/
 
 # IDE
 .vscode/*

e2e/solid-router/rspack-basic-virtual-named-export-config-file-based/.gitignore

@@ -6,6 +6,7 @@
 # Dist
 node_modules
 dist/
+dist-hash/
 
 # IDE
 .vscode/*

e2e/solid-router/scroll-restoration-sandbox-vite/playwright.browser.config.ts

@@ -1,8 +1,10 @@
 import { defineConfig, devices } from '@playwright/test'
-import { derivePort } from '@tanstack/router-e2e-utils'
+import { derivePort, resolveRuntimeSuffix } from '@tanstack/router-e2e-utils'
 import packageJson from './package.json' with { type: 'json' }
 
-const PORT = derivePort(packageJson.name + '-browser')
+const PORT = derivePort(
+  packageJson.name + `-${resolveRuntimeSuffix('browser')}`,
+)
 const baseURL = `http://localhost:${PORT}`
 /**
  * See https://playwright.dev/docs/test-configuration.

e2e/solid-router/scroll-restoration-sandbox-vite/playwright.hash.config.ts

@@ -1,8 +1,8 @@
 import { defineConfig, devices } from '@playwright/test'
-import { derivePort } from '@tanstack/router-e2e-utils'
+import { derivePort, resolveRuntimeSuffix } from '@tanstack/router-e2e-utils'
 import packageJson from './package.json' with { type: 'json' }
 
-const PORT = derivePort(packageJson.name + '-hash')
+const PORT = derivePort(packageJson.name + `-${resolveRuntimeSuffix('hash')}`)
 const baseURL = `http://localhost:${PORT}`
 /**
  * See https://playwright.dev/docs/test-configuration.

e2e/solid-router/scroll-restoration-sandbox-vite/tests/app.spec.ts

@@ -1,12 +1,8 @@
 import { expect, test } from '@playwright/test'
-
-function toValue(input: string) {
-  const value = process.env.VITE_APP_HISTORY === 'hash' ? `/#${input}` : input
-  return value
-}
+import { toRuntimePath } from '@tanstack/router-e2e-utils'
 
 test('Smoke - Renders home', async ({ page }) => {
-  await page.goto(toValue('/'))
+  await page.goto(toRuntimePath('/'))
   await expect(
     page.getByRole('heading', { name: 'Welcome Home!' }),
   ).toBeVisible()
@@ -23,7 +19,7 @@ test('Smoke - Renders home', async ({ page }) => {
   test(`On navigate to ${options.to} (from the header), scroll should be at top`, async ({
     page,
   }) => {
-    await page.goto(toValue('/'))
+    await page.goto(toRuntimePath('/'))
     await page.getByRole('link', { name: `Head-${options.to}` }).click()
     await page.waitForTimeout(0)
     await expect(page.getByTestId('at-the-top')).toBeInViewport()
@@ -33,7 +29,7 @@ test('Smoke - Renders home', async ({ page }) => {
   test(`On navigate via index page tests to ${options.to}, scroll should resolve at the bottom`, async ({
     page,
   }) => {
-    await page.goto(toValue('/'))
+    await page.goto(toRuntimePath('/'))
     await page
       .getByRole('link', { name: `${options.to}#at-the-bottom` })
       .click()
@@ -49,7 +45,7 @@ test('Smoke - Renders home', async ({ page }) => {
     if ('search' in options) {
       url = `${url}?where=${options.search?.where}`
     }
-    await page.goto(toValue(`${url}#at-the-bottom`))
+    await page.goto(toRuntimePath(`${url}#at-the-bottom`))
     await page.waitForTimeout(0)
     await expect(page.getByTestId('at-the-bottom')).toBeInViewport()
   })