@lvce-editor/test-with-playwright-worker 5.0.1 → 6.0.0

package/package.json

@@ -1,26 +1,21 @@
 {
   "name": "@lvce-editor/test-with-playwright-worker",
-  "version": "5.0.1",
-  "description": "",
-  "main": "src/workerMain.js",
-  "type": "module",
+  "version": "6.0.0",
+  "description": "Worker package for test-with-playwright",
   "repository": {
     "type": "git",
     "url": "git@github.com:lvce-editor/test-with-playwright.git",
     "directory": "packages/test-with-playwright-worker"
   },
-  "keywords": [],
-  "author": "Lvce Editor",
   "license": "MIT",
+  "author": "Lvce Editor",
+  "type": "module",
+  "main": "dist/workerMain.js",
   "dependencies": {
-    "@lvce-editor/assert": "^1.4.0",
-    "@lvce-editor/rpc": "^4.18.0",
-    "@lvce-editor/rpc-registry": "^3.6.0",
-    "@lvce-editor/verror": "^1.7.0",
-    "@playwright/test": "1.55.0",
-    "get-port": "^7.1.0"
+    "@playwright/test": "1.55.0"
   },
-  "devDependencies": {
-    "@types/jest": "^30.0.0"
+  "devDependencies": {},
+  "engines": {
+    "node": ">=22"
   }
 }

package/src/parts/Assert/Assert.js

@@ -1 +0,0 @@
-export * from '@lvce-editor/assert'

package/src/parts/CliCommandType/CliCommandType.js

@@ -1,2 +0,0 @@
-export const HandleResult = 'HandleResult'
-export const HandleFinalResult = 'HandleFinalResult'

package/src/parts/Command/Command.js

@@ -1 +0,0 @@
-export * from '@lvce-editor/command'

package/src/parts/CommandMap/CommandMap.js

@@ -1,6 +0,0 @@
-import * as RunAllTests from '../RunAllTests/RunAllTests.js'
-import * as TestWorkerCommandType from '../TestWorkerCommandType/TestWorkerCommandType.js'
-
-export const commandMap = {
-  [TestWorkerCommandType.RunAllTests]: RunAllTests.runAllTests,
-}

package/src/parts/ErrorCodes/ErrorCodes.js

@@ -1,2 +0,0 @@
-export const ENOENT = 'ENOENT'
-export const E_NO_TEST_FILES = 'E_NO_TEST_FILES'

package/src/parts/GetPort/GetPort.js

@@ -1,5 +0,0 @@
-import _getPort from 'get-port'
-
-export const getPort = () => {
-  return _getPort()
-}

package/src/parts/GetPossibleServerPaths/GetPossibleServerPaths.js

@@ -1,11 +0,0 @@
-import { join } from 'node:path'
-import { pathToFileURL } from 'node:url'
-
-export const getPossibleServerPaths = () => {
-  const toTry = [
-    '@lvce-editor/server',
-    pathToFileURL(join(process.cwd(), '..', 'server', 'node_modules', '@lvce-editor', 'server', 'index.js')).toString(),
-    pathToFileURL(join(process.cwd(), '..', 'build', 'node_modules', '@lvce-editor', 'server', 'index.js')).toString(),
-  ]
-  return toTry
-}

package/src/parts/GetServerPath/GetServerPath.js

@@ -1,14 +0,0 @@
-import * as GetPossibleServerPaths from '../GetPossibleServerPaths/GetPossibleServerPaths.js'
-
-export const getServerPath = async () => {
-  const toTry = GetPossibleServerPaths.getPossibleServerPaths()
-  for (const path of toTry) {
-    try {
-      const { serverPath } = await import(path)
-      return serverPath
-    } catch (error) {
-      // ignore
-    }
-  }
-  throw new Error(`[test-with-playwright] server path not found`)
-}

package/src/parts/GetTestState/GetTestState.js

@@ -1,24 +0,0 @@
-import * as TestOverlayState from '../TestOverlayState/TestOverlayState.js'
-import * as TestState from '../TestState/TestState.js'
-
-export const getTestState = (testOverlayState, text) => {
-  switch (testOverlayState) {
-    case TestOverlayState.Pass:
-      return {
-        status: TestState.Pass,
-        error: '',
-      }
-    case TestOverlayState.Skip:
-      return {
-        status: TestState.Skip,
-        error: '',
-      }
-    case TestOverlayState.Fail:
-      return {
-        status: TestState.Fail,
-        error: `${text}`,
-      }
-    default:
-      throw new Error(`unexpected test state: ${testOverlayState}`)
-  }
-}

package/src/parts/GetTests/GetTests.js

@@ -1,26 +0,0 @@
-import { VError } from '@lvce-editor/verror'
-import { readdir } from 'fs/promises'
-import * as IsEnoentError from '../IsEnoentError/IsEnoentError.js'
-import * as IsTestFile from '../IsTestFile/IsTestFile.js'
-import { NoTestFilesFoundError } from '../NoTestFilesFoundError/NoTestFilesFoundError.js'
-
-const getName = (dirent) => {
-  return dirent.name
-}
-
-/**
- * @param {string} testSrc
- */
-export const getTests = async (testSrc) => {
-  try {
-    const dirents = await readdir(testSrc, {
-      withFileTypes: true,
-    })
-    return dirents.filter(IsTestFile.isTestFile).map(getName)
-  } catch (error) {
-    if (IsEnoentError.isEnoentError(error)) {
-      throw new NoTestFilesFoundError(testSrc)
-    }
-    throw new VError(error, `Failed to get test files`)
-  }
-}

package/src/parts/IsEnoentError/IsEnoentError.js

@@ -1,8 +0,0 @@
-import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
-
-/**
- * @param {any} error
- */
-export const isEnoentError = (error) => {
-  return error && error.code === ErrorCodes.ENOENT
-}

package/src/parts/IsTestFile/IsTestFile.js

@@ -1,8 +0,0 @@
-import { Dirent } from 'node:fs'
-
-/**
- * @param {Dirent} dirent
- */
-export const isTestFile = (dirent) => {
-  return dirent.isFile() && !dirent.name.startsWith('_')
-}

package/src/parts/Main/Main.js

@@ -1,34 +0,0 @@
-import { NodeWorkerRpcClient } from '@lvce-editor/rpc'
-import * as CommandMap from '../CommandMap/CommandMap.js'
-import * as Process from '../Process/Process.js'
-import * as ProcessListeners from '../ProcessListeners/ProcessListeners.js'
-import { set } from '@lvce-editor/rpc-registry'
-import { Cli } from '../RpcId/RpcId.js'
-
-const handleDisconnect = () => {
-  console.log('[test-worker] disconnected')
-}
-
-const handleExit = () => {
-  console.log('[test-worker] exiting')
-}
-
-const handleSigint = () => {
-  console.log('[test-worker] sigint')
-}
-
-const handleSigTerm = () => {
-  console.log('[test-worker] sigterm')
-}
-
-export const main = async () => {
-  Process.on('disconnect', handleDisconnect)
-  Process.on('exit', handleExit)
-  Process.on('SIGINT', handleSigint)
-  Process.on('SIGTERM', handleSigTerm)
-  Process.on('uncaughtExceptionMonitor', ProcessListeners.handleUncaughtExceptionMonitor)
-  const rpc = await NodeWorkerRpcClient.create({
-    commandMap: CommandMap.commandMap,
-  })
-  set(Cli, rpc)
-}

package/src/parts/NoTestFilesFoundError/NoTestFilesFoundError.js

@@ -1,8 +0,0 @@
-import * as ErrorCodes from '../ErrorCodes/ErrorCodes.js'
-
-export class NoTestFilesFoundError extends Error {
-  constructor(root) {
-    super(`No test files found at ${root}`)
-    this.code = ErrorCodes.E_NO_TEST_FILES
-  }
-}

package/src/parts/Process/Process.js

@@ -1,8 +0,0 @@
-/**
- *
- * @param {string} event
- * @param {any} listener
- */
-export const on = (event, listener) => {
-  process.on(event, listener)
-}

package/src/parts/ProcessListeners/ProcessListeners.js

@@ -1,3 +0,0 @@
-export const handleUncaughtExceptionMonitor = (error) => {
-  console.log(`[test-worker] uncaught exception ${error}`)
-}

package/src/parts/RpcId/RpcId.js

@@ -1 +0,0 @@
-export const Cli = 6001

package/src/parts/RunAllTests/RunAllTests.js

@@ -1,46 +0,0 @@
-import { get } from '@lvce-editor/rpc-registry'
-import { join } from 'path'
-import * as Assert from '../Assert/Assert.js'
-import * as CliCommandType from '../CliCommandType/CliCommandType.js'
-import * as GetTests from '../GetTests/GetTests.js'
-import { Cli } from '../RpcId/RpcId.js'
-import * as RunTests from '../RunTests/RunTests.js'
-import * as SetupTests from '../SetupTests/SetupTests.js'
-import * as TearDownTests from '../TearDownTests/TearDownTests.js'
-
-/**
- * @param {string} extensionPath
- * @param {string} testPath
- * @param {string} cwd
- * @param {boolean} headless
- * @param {number} headless
- */
-export const runAllTests = async (extensionPath, testPath, cwd, headless, timeout) => {
-  Assert.string(extensionPath)
-  Assert.string(testPath)
-  Assert.string(cwd)
-  Assert.boolean(headless)
-  Assert.number(timeout)
-  const rpc = get(Cli)
-  const controller = new AbortController()
-  const signal = controller.signal
-  const { page, child, port } = await SetupTests.setupTests({
-    signal,
-    headless,
-    onlyExtension: extensionPath,
-    testPath,
-  })
-  const testSrc = join(testPath, 'src')
-  const tests = await GetTests.getTests(testSrc)
-  const onResult = async (result) => {
-    await rpc.invoke(CliCommandType.HandleResult, result)
-  }
-  const onFinalResult = (finalResult) => {
-    rpc.invoke(CliCommandType.HandleFinalResult, finalResult)
-  }
-  await RunTests.runTests({ testSrc, tests, headless, port, page, timeout, onResult, onFinalResult })
-  await TearDownTests.tearDownTests({
-    controller,
-    child,
-  })
-}

package/src/parts/RunTest/RunTest.js

@@ -1,36 +0,0 @@
-import { expect } from '@playwright/test'
-import { basename } from 'node:path'
-import * as GetTestState from '../GetTestState/GetTestState.js'
-
-/**
- * @param {string} absolutePath
- * @param {number} port
- */
-const getUrlFromTestFile = (absolutePath, port) => {
-  const baseName = basename(absolutePath)
-  const htmlFileName = baseName.slice(0, -'.js'.length) + '.html'
-  return `http://localhost:${port}/tests/${htmlFileName}`
-}
-
-export const runTest = async ({ test, page, testSrc, port, timeout }) => {
-  const start = performance.now()
-  const url = getUrlFromTestFile(test, port)
-  await page.goto(url, {
-    waitUntil: 'networkidle',
-  })
-  const testOverlay = page.locator('#TestOverlay')
-  await expect(testOverlay).toBeVisible({
-    timeout,
-  })
-  const text = await testOverlay.textContent()
-  const testOverlayState = await testOverlay.getAttribute('data-state')
-  const testState = GetTestState.getTestState(testOverlayState)
-  const end = performance.now()
-  return {
-    ...testState,
-    name: test,
-    start,
-    end,
-    error: text,
-  }
-}

package/src/parts/RunTests/RunTests.js

@@ -1,44 +0,0 @@
-import * as RunTest from '../RunTest/RunTest.js'
-import * as TestState from '../TestState/TestState.js'
-
-/**
- *
- * @param {{testSrc:string, tests:string[], headless:boolean, page: import('@playwright/test').Page, port:number, timeout:number, onResult:any, onFinalResult:any}} param0
- */
-export const runTests = async ({ testSrc, tests, headless, page, port, timeout, onResult, onFinalResult }) => {
-  let failed = 0
-  let skipped = 0
-  let passed = 0
-  const start = performance.now()
-  for (const test of tests) {
-    const result = await RunTest.runTest({
-      test,
-      page,
-      testSrc,
-      port,
-      timeout,
-    })
-    await onResult(result)
-    switch (result.status) {
-      case TestState.Fail:
-        failed++
-        break
-      case TestState.Skip:
-        skipped++
-        break
-      case TestState.Pass:
-        passed++
-        break
-      default:
-        break
-    }
-  }
-  const end = performance.now()
-  await onFinalResult({
-    passed,
-    failed,
-    skipped,
-    start,
-    end,
-  })
-}

package/src/parts/SetupTests/SetupTests.js

@@ -1,25 +0,0 @@
-import * as StartBrowser from '../StartBrowser/StartBrowser.js'
-import * as StartServer from '../StartServer/StartServer.js'
-import * as GetPort from '../GetPort/GetPort.js'
-import * as GetServerPath from '../GetServerPath/GetServerPath.js'
-
-/**
- *
- * @param {{signal:AbortSignal, headless: boolean, onlyExtension:string, testPath:string}} options
- * @returns
- */
-export const setupTests = async ({ signal, headless, onlyExtension, testPath }) => {
-  const port = await GetPort.getPort()
-  const { browser, page } = await StartBrowser.startBrowser({
-    signal,
-    headless,
-  })
-  const serverPath = await GetServerPath.getServerPath()
-  const child = await StartServer.startServer({ signal, port, serverPath, onlyExtension, testPath })
-  return {
-    port,
-    browser,
-    page,
-    child,
-  }
-}

package/src/parts/Signal/Signal.js

@@ -1 +0,0 @@
-export const SIGINT = 'SIGINT'

package/src/parts/StartBrowser/StartBrowser.js

@@ -1,21 +0,0 @@
-import { chromium } from '@playwright/test'
-
-/**
- *
- * @param {{signal:AbortSignal, headless:boolean}} options
- * @returns
- */
-export const startBrowser = async ({ signal, headless }) => {
-  const browser = await chromium.launch({
-    headless,
-  })
-  const page = await browser.newPage()
-  signal.addEventListener('abort', async () => {
-    await page.close()
-    await browser.close()
-  })
-  return {
-    browser,
-    page,
-  }
-}

package/src/parts/StartServer/StartServer.js

@@ -1,29 +0,0 @@
-import { fork } from 'child_process'
-
-/**
- *
- * @param {{signal:AbortSignal, port:number, serverPath:string, onlyExtension:string, testPath:string}} param0
- * @returns
- */
-export const startServer = async ({ signal, port, serverPath, onlyExtension, testPath }) => {
-  const child = fork(serverPath, {
-    stdio: 'inherit',
-    // signal,
-    env: {
-      ...process.env,
-      PORT: String(port),
-      ONLY_EXTENSION: onlyExtension,
-      TEST_PATH: testPath,
-    },
-  })
-  child.on('error', (x) => {
-    if (x.name === 'AbortError') {
-      return
-    }
-    console.log('child error', x)
-  })
-  await new Promise((resolve) => {
-    child.on('message', resolve)
-  })
-  return child
-}

package/src/parts/TearDownTests/TearDownTests.js

@@ -1,6 +0,0 @@
-import * as Signal from '../Signal/Signal.js'
-
-export const tearDownTests = ({ controller, child }) => {
-  controller.abort()
-  child.kill(Signal.SIGINT)
-}

package/src/parts/TestOverlayState/TestOverlayState.js

@@ -1,3 +0,0 @@
-export const Pass = 'pass'
-export const Skip = 'skip'
-export const Fail = 'fail'

package/src/parts/TestState/TestState.js

@@ -1,3 +0,0 @@
-export const Pass = 1
-export const Skip = 2
-export const Fail = 3

package/src/parts/TestWorkerCommandType/TestWorkerCommandType.js

@@ -1 +0,0 @@
-export const RunAllTests = 'RunAllTests'

package/src/workerMain.js

@@ -1,3 +0,0 @@
-import * as Main from './parts/Main/Main.js'
-
-Main.main()