@remix-run/test 0.0.0 → 0.1.0

package/dist/lib/utils.js

@@ -0,0 +1,27 @@
+const noColor = process.env.CI === 'true' || !!process.env.NO_COLOR;
+export const colors = {
+    reset: noColor ? '' : '\x1b[0m',
+    dim: noColor ? (s) => s : (s) => `\x1b[2m${s}\x1b[0m`,
+    green: noColor ? (s) => s : (s) => `\x1b[32m${s}\x1b[0m`,
+    red: noColor ? (s) => s : (s) => `\x1b[31m${s}\x1b[0m`,
+    cyan: noColor ? (s) => s : (s) => `\x1b[36m${s}\x1b[0m`,
+    yellow: noColor ? (s) => s : (s) => `\x1b[2m\x1b[33m${s}\x1b[0m`,
+};
+function normalizeFilePath(path) {
+    let locSuffix = path.match(/(:\d+:\d+)$/)?.[0] || '';
+    let normalized = path
+        .replace(/^\/scripts\/@pkg\/([^):]+)/g, (...args) => args[1])
+        .replace(/^\/scripts\/@test\/([^):]+)/g, (...args) => args[1])
+        .replace(/^\/scripts\/([^):]+)/g, (...args) => args[1])
+        .replace(/^\s+/, '  ') + locSuffix;
+    return path.includes('/@test/') ? `./${normalized}` : normalized;
+}
+export function normalizeLine(line) {
+    let match = line.match(/ \(.*\)$/);
+    if (match) {
+        let filepath = match[0].slice(2, -1);
+        filepath = filepath.replace(/https?:\/\/localhost:\d+\//g, '/');
+        return line.slice(0, match.index) + ' (' + normalizeFilePath(filepath) + ')';
+    }
+    return line;
+}

package/dist/lib/watcher.d.ts

@@ -0,0 +1,5 @@
+export declare function createWatcher(onChange: (file: string) => void): {
+    update: (files: string[]) => void;
+    close: () => void;
+};
+//# sourceMappingURL=watcher.d.ts.map

package/dist/lib/watcher.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"watcher.d.ts","sourceRoot":"","sources":["../../src/lib/watcher.ts"],"names":[],"mappings":"AAUA,wBAAgB,aAAa,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI;;;EAmC7D"}

package/dist/lib/watcher.js

@@ -0,0 +1,39 @@
+import * as fs from 'node:fs';
+function getFileModTime(file) {
+    try {
+        return fs.statSync(file).mtimeMs;
+    }
+    catch {
+        return 0;
+    }
+}
+export function createWatcher(onChange) {
+    let watchers = new Set();
+    let fileModTimes = new Map();
+    function update(files) {
+        for (let watcher of watchers) {
+            watcher.close();
+        }
+        watchers.clear();
+        for (let file of files) {
+            fileModTimes.set(file, getFileModTime(file));
+            watchers.add(fs.watch(file, () => {
+                // macOS FSEvents can fire multiple callbacks per save (e.g. write +
+                // metadata flush). Guard with mtime so only a real content change
+                // triggers a rerun instead of every duplicate event.
+                let mtime = getFileModTime(file);
+                if (mtime !== fileModTimes.get(file)) {
+                    fileModTimes.set(file, mtime);
+                    onChange(file);
+                }
+            }));
+        }
+    }
+    function close() {
+        for (let watcher of watchers) {
+            watcher.close();
+        }
+        watchers.clear();
+    }
+    return { update, close };
+}

package/dist/lib/worker-e2e.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=worker-e2e.d.ts.map

package/dist/lib/worker-e2e.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker-e2e.d.ts","sourceRoot":"","sources":["../../src/lib/worker-e2e.ts"],"names":[],"mappings":""}

package/dist/lib/worker-e2e.js

@@ -0,0 +1,48 @@
+import { workerData, parentPort } from 'node:worker_threads';
+import { tsImport } from 'tsx/esm/api';
+import { createServer } from "./e2e-server.js";
+import { runTests } from "./executor.js";
+import { getBrowserLauncher, getPlaywrightLaunchOptions, getPlaywrightPageOptions, } from "./playwright.js";
+try {
+    await tsImport(workerData.file, import.meta.url);
+    let launcher = await getBrowserLauncher(workerData.playwrightUseOpts);
+    let opts = getPlaywrightLaunchOptions(workerData.playwrightUseOpts);
+    let browser = await launcher.launch(opts);
+    try {
+        let results = await runTests({
+            browser,
+            createServer,
+            open: workerData.open,
+            playwrightPageOptions: getPlaywrightPageOptions(workerData.playwrightUseOpts),
+        });
+        parentPort.postMessage(results);
+        if (workerData.open) {
+            console.log('\nBrowser is open. Press Ctrl+C to close.');
+            await new Promise((resolve) => browser.on('disconnected', () => resolve()));
+        }
+    }
+    finally {
+        await browser.close();
+    }
+}
+catch (e) {
+    let results = {
+        passed: 0,
+        failed: 1,
+        skipped: 0,
+        todo: 0,
+        tests: [
+            {
+                name: '',
+                suiteName: '',
+                status: 'failed',
+                duration: 0,
+                error: {
+                    message: e instanceof Error ? e.message : String(e),
+                    stack: e instanceof Error ? e.stack : undefined,
+                },
+            },
+        ],
+    };
+    parentPort.postMessage(results);
+}

package/dist/lib/worker.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=worker.d.ts.map

package/dist/lib/worker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"worker.d.ts","sourceRoot":"","sources":["../../src/lib/worker.ts"],"names":[],"mappings":""}

package/dist/lib/worker.js

@@ -0,0 +1,29 @@
+import { workerData, parentPort } from 'node:worker_threads';
+import { tsImport } from 'tsx/esm/api';
+import { runTests } from "./executor.js";
+try {
+    await tsImport(workerData.file, import.meta.url);
+    let results = await runTests();
+    parentPort.postMessage(results);
+}
+catch (e) {
+    let results = {
+        passed: 0,
+        failed: 1,
+        skipped: 0,
+        todo: 0,
+        tests: [
+            {
+                name: '',
+                suiteName: '',
+                status: 'failed',
+                duration: 0,
+                error: {
+                    message: e instanceof Error ? e.message : String(e),
+                    stack: e instanceof Error ? e.stack : undefined,
+                },
+            },
+        ],
+    };
+    parentPort.postMessage(results);
+}

package/package.json

@@ -1,14 +1,67 @@
 {
   "name": "@remix-run/test",
-  "version": "0.0.0",
-  "description": "Placeholder package for Remix CI/OIDC setup",
+  "version": "0.1.0",
+  "description": "A browser-based test framework for Remix components",
+  "author": "Shopify Inc.",
   "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/remix-run/remix.git",
     "directory": "packages/test"
   },
-  "publishConfig": {
-    "access": "public"
+  "homepage": "https://github.com/remix-run/remix/tree/main/packages/test#readme",
+  "files": [
+    "tsconfig.json",
+    "LICENSE",
+    "README.md",
+    "dist",
+    "src",
+    "!src/**/*.test.*"
+  ],
+  "type": "module",
+  "bin": {
+    "remix-test": "./dist/cli.js"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json",
+    "./cli": "./dist/cli.js"
+  },
+  "dependencies": {
+    "tsx": "^4.21.0",
+    "@remix-run/component": "0.7.0",
+    "@remix-run/fetch-router": "0.18.1",
+    "@remix-run/node-fetch-server": "0.13.0"
+  },
+  "peerDependencies": {
+    "playwright": "^1.59.0"
+  },
+  "peerDependenciesMeta": {
+    "playwright": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^24.6.0",
+    "@typescript/native-preview": "7.0.0-dev.20251125.1",
+    "playwright": "^1.59.0",
+    "@remix-run/assert": "0.1.0"
+  },
+  "keywords": [
+    "testing",
+    "browser",
+    "test",
+    "remix",
+    "component",
+    "playwright"
+  ],
+  "scripts": {
+    "build": "tsgo -p tsconfig.build.json",
+    "clean": "git clean -fdX",
+    "test": "node src/cli.ts",
+    "typecheck": "tsgo --noEmit"
   }
-}
+}

package/src/cli.ts

@@ -0,0 +1,210 @@
+#!/usr/bin/env node
+import * as fsp from 'node:fs/promises'
+import * as path from 'node:path'
+import { tsImport } from 'tsx/esm/api'
+import { runServerTests } from './lib/runner.ts'
+import { createReporter } from './lib/reporters/index.ts'
+import { createWatcher } from './lib/watcher.ts'
+import { loadPlaywrightConfig, resolveProjects } from './lib/playwright.ts'
+import { loadConfig, type ResolvedRemixTestConfig } from './lib/config.ts'
+import type { Counts } from './lib/utils.ts'
+
+const config = await loadConfig()
+
+let hasExited = false
+let latestExitCode = 0
+let watcher: ReturnType<typeof createWatcher> | undefined
+let running = false
+let queued = false
+let rerunTimer: NodeJS.Timeout | undefined
+
+process.on('SIGINT', () => cleanupAndExit(latestExitCode))
+process.on('SIGTERM', () => cleanupAndExit(latestExitCode))
+
+try {
+  await executeRun()
+
+  if (config.watch) {
+    console.log('Watching for changes. Press Ctrl+C to stop.')
+  }
+} catch {
+  cleanupAndExit(1)
+}
+
+async function executeRun() {
+  if (hasExited) return
+
+  running = true
+
+  let globalTeardown: (() => Promise<void> | void) | undefined
+
+  try {
+    if (config.setup) {
+      let mod = await tsImport(path.resolve(process.cwd(), config.setup), {
+        parentURL: import.meta.url,
+      })
+      let globalSetup: (() => Promise<void> | void) | undefined = mod.globalSetup
+      globalTeardown = mod.globalTeardown
+      await globalSetup?.()
+    }
+
+    let { files, serverFiles, e2eFiles } = await discoverTests(config)
+
+    if (config.watch) {
+      watcher ??= createWatcher((file) => queueRerun(file))
+      watcher.update(files)
+    }
+
+    let playwrightConfig =
+      config.playwrightConfig == null || typeof config.playwrightConfig === 'string'
+        ? await loadPlaywrightConfig(config.playwrightConfig)
+        : config.playwrightConfig
+
+    let reporter = createReporter(config.reporter)
+    let startTime = performance.now()
+
+    let counts: Counts = {
+      passed: 0,
+      failed: 0,
+      skipped: 0,
+      todo: 0,
+    }
+
+    // Run server tests
+    if (serverFiles.length > 0) {
+      reporter.onSectionStart('\nRunning server tests:')
+      let serverResult = await runServerTests(serverFiles, reporter, config.concurrency, 'server')
+      counts.failed += serverResult.failed
+      counts.passed += serverResult.passed
+      counts.skipped += serverResult.skipped
+      counts.todo += serverResult.todo
+    }
+
+    // Run e2e tests for all browsers configured by the user
+    if (e2eFiles.length > 0) {
+      let projects = resolveProjects(playwrightConfig)
+      if (config.project) {
+        let projectNames = config.project.split(',').map((p) => p.trim())
+        projects = projects.filter((p) => p.name && projectNames.includes(p.name))
+        if (projects.length === 0) {
+          throw new Error(`No playwright projects found with name(s) "${config.project}"`)
+        }
+      }
+
+      for (let project of projects) {
+        reporter.onSectionStart(`\nRunning tests for project \`${project.name}\`:`)
+
+        if (config.browser?.open) {
+          if (project.playwrightUseOpts?.headless === true) {
+            let label = project.name ? ` (project "${project.name}")` : ''
+            console.warn(
+              `Warning: browser.open is set but playwright headless is explicitly true${label} — ignoring browser.open`,
+            )
+          } else {
+            project.playwrightUseOpts = { ...project.playwrightUseOpts, headless: false }
+          }
+        }
+
+        let e2eResult =
+          e2eFiles.length > 0
+            ? await runServerTests(e2eFiles, reporter, config.concurrency, 'e2e', {
+                open: config.browser?.open,
+                playwrightUseOpts: project.playwrightUseOpts,
+                projectName: project.name,
+              })
+            : null
+
+        counts.passed += e2eResult?.passed ?? 0
+        counts.failed += e2eResult?.failed ?? 0
+        counts.skipped += e2eResult?.skipped ?? 0
+        counts.todo += e2eResult?.todo ?? 0
+      }
+    }
+
+    reporter.onSummary(counts, performance.now() - startTime)
+
+    latestExitCode = counts.failed > 0 ? 1 : 0
+  } catch (error) {
+    console.error('Error running tests:', error)
+    latestExitCode = 1
+  } finally {
+    await globalTeardown?.()
+    running = false
+    if (queued) {
+      queued = false
+      queueRerun('queued change')
+    } else if (!config.watch) {
+      cleanupAndExit(latestExitCode)
+    }
+  }
+}
+
+async function discoverTests(config: ResolvedRemixTestConfig): Promise<{
+  files: string[]
+  serverFiles: string[]
+  e2eFiles: string[]
+}> {
+  async function findFiles(pattern: string) {
+    let files: string[] = []
+    let exclude = ['node_modules/**', '.git/**']
+
+    for await (let file of fsp.glob(pattern, { cwd: process.cwd(), exclude })) {
+      files.push(path.resolve(process.cwd(), file))
+    }
+
+    return files
+  }
+
+  let files = await findFiles(config.glob.test)
+
+  if (files.length === 0) {
+    console.log(`No test files found matching pattern: ${config.glob.test}`)
+    process.exit(1)
+  }
+
+  let e2eSet = new Set(await findFiles(config.glob.e2e))
+
+  let types = new Set(config.type.split(','))
+  let e2eFiles = types.has('e2e') ? files.filter((f) => e2eSet.has(f)) : []
+  let serverFiles = types.has('server') ? files.filter((f) => !e2eSet.has(f)) : []
+
+  let totalFiles = serverFiles.length + e2eFiles.length
+
+  if (totalFiles === 0) {
+    console.log(`No test files remain after filtering for type ${config.type}`)
+    process.exit(1)
+  }
+
+  console.log(
+    `Found ${totalFiles} test file(s) (${serverFiles.length} server, ${e2eFiles.length} e2e)`,
+  )
+
+  return {
+    files,
+    serverFiles,
+    e2eFiles,
+  }
+}
+
+function queueRerun(reason: string) {
+  if (!config.watch || hasExited) return
+
+  clearTimeout(rerunTimer)
+
+  rerunTimer = setTimeout(() => {
+    rerunTimer = undefined
+    if (running) {
+      queued = true
+    } else {
+      console.log(`\n↻ Change detected (${reason}), re-running tests...\n`)
+      void executeRun()
+    }
+  }, 100)
+}
+
+function cleanupAndExit(code: number) {
+  if (hasExited) return
+  hasExited = true
+  watcher?.close()
+  process.exit(code)
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+export type { RemixTestConfig } from './lib/config.ts'
+export {
+  describe,
+  it,
+  suite,
+  test,
+  before,
+  after,
+  beforeEach,
+  afterEach,
+  beforeAll,
+  afterAll,
+} from './lib/framework.ts'
+export { mock } from './lib/mock.ts'
+export type { TestContext } from './lib/context.ts'