tabwright 1.0.0 → 2.0.0

package/src/wait-for-page-load.ts

@@ -1,198 +0,0 @@
-import type { Page } from '@xmorse/playwright-core'
-import { sleep } from './utils.js'
-
-const FILTERED_DOMAINS = [
-  'doubleclick',
-  'googlesyndication',
-  'googleadservices',
-  'google-analytics',
-  'googletagmanager',
-  'facebook.net',
-  'fbcdn.net',
-  'twitter.com',
-  'linkedin.com',
-  'hotjar',
-  'mixpanel',
-  'segment.io',
-  'segment.com',
-  'newrelic',
-  'datadoghq',
-  'sentry.io',
-  'fullstory',
-  'amplitude',
-  'intercom',
-  'crisp.chat',
-  'zdassets.com',
-  'zendesk',
-  'tawk.to',
-  'hubspot',
-  'marketo',
-  'pardot',
-  'optimizely',
-  'crazyegg',
-  'mouseflow',
-  'clarity.ms',
-  'bing.com/bat',
-  'ads.',
-  'analytics.',
-  'tracking.',
-  'pixel.',
-]
-
-const FILTERED_EXTENSIONS = ['.gif', '.ico', '.cur', '.woff', '.woff2', '.ttf', '.otf', '.eot']
-
-export interface WaitForPageLoadOptions {
-  page: Page
-  timeout?: number
-  pollInterval?: number
-  minWait?: number
-}
-
-export interface WaitForPageLoadResult {
-  success: boolean
-  readyState: string
-  pendingRequests: string[]
-  waitTimeMs: number
-  timedOut: boolean
-}
-
-export async function waitForPageLoad(options: WaitForPageLoadOptions): Promise<WaitForPageLoadResult> {
-  const { page, timeout = 30000, pollInterval = 100, minWait = 500 } = options
-
-  const startTime = Date.now()
-  let timedOut = false
-  let lastReadyState = ''
-  let lastPendingRequests: string[] = []
-
-  const checkPageReady = async (): Promise<{ ready: boolean; readyState: string; pendingRequests: string[] }> => {
-    const result = await page.evaluate(
-      ({
-        filteredDomains,
-        filteredExtensions,
-        stuckThreshold,
-        slowResourceThreshold,
-      }): {
-        ready: boolean
-        readyState: string
-        pendingRequests: string[]
-      } => {
-        const doc = globalThis.document as { readyState: string }
-        const readyState = doc.readyState
-
-        if (readyState !== 'complete') {
-          return { ready: false, readyState, pendingRequests: [`document.readyState: ${readyState}`] }
-        }
-
-        const resources = (performance as any).getEntriesByType('resource') as Array<{
-          name: string
-          startTime: number
-          responseEnd: number
-        }>
-        const now = (performance as any).now() as number
-
-        const pendingRequests = resources
-          .filter((r) => {
-            if (r.responseEnd > 0) {
-              return false
-            }
-
-            const elapsed = now - r.startTime
-            const url = r.name.toLowerCase()
-
-            if (url.startsWith('data:')) {
-              return false
-            }
-
-            if (filteredDomains.some((domain: string) => url.includes(domain))) {
-              return false
-            }
-
-            if (elapsed > stuckThreshold) {
-              return false
-            }
-
-            if (elapsed > slowResourceThreshold && filteredExtensions.some((ext: string) => url.includes(ext))) {
-              return false
-            }
-
-            return true
-          })
-          .map((r) => r.name)
-
-        return {
-          ready: pendingRequests.length === 0,
-          readyState,
-          pendingRequests,
-        }
-      },
-      {
-        filteredDomains: FILTERED_DOMAINS,
-        filteredExtensions: FILTERED_EXTENSIONS,
-        stuckThreshold: 10000,
-        slowResourceThreshold: 3000,
-      },
-    )
-
-    return result
-  }
-
-  // Fast path: check immediately first. If already ready, return without waiting.
-  try {
-    const firstCheck = await checkPageReady()
-    if (firstCheck.ready) {
-      return {
-        success: true,
-        readyState: firstCheck.readyState,
-        pendingRequests: [],
-        waitTimeMs: Date.now() - startTime,
-        timedOut: false,
-      }
-    }
-    lastReadyState = firstCheck.readyState
-    lastPendingRequests = firstCheck.pendingRequests
-  } catch (e) {
-    // First check failed, continue with polling
-  }
-
-  // Not ready yet - wait minWait to let JS settle and catch late-starting requests
-  await sleep(minWait)
-
-  while (Date.now() - startTime < timeout) {
-    try {
-      const { ready, readyState, pendingRequests } = await checkPageReady()
-      lastReadyState = readyState
-      lastPendingRequests = pendingRequests
-
-      if (ready) {
-        return {
-          success: true,
-          readyState,
-          pendingRequests: [],
-          waitTimeMs: Date.now() - startTime,
-          timedOut: false,
-        }
-      }
-    } catch (e) {
-      console.error('[waitForPageLoad] page.evaluate failed:', e)
-      return {
-        success: false,
-        readyState: 'error',
-        pendingRequests: ['page.evaluate failed - page may have closed or navigated'],
-        waitTimeMs: Date.now() - startTime,
-        timedOut: false,
-      }
-    }
-
-    await sleep(pollInterval)
-  }
-
-  timedOut = true
-
-  return {
-    success: false,
-    readyState: lastReadyState,
-    pendingRequests: lastPendingRequests.slice(0, 10),
-    waitTimeMs: Date.now() - startTime,
-    timedOut,
-  }
-}

package/src/workflow-capability.ts

@@ -1,417 +0,0 @@
-import {
-  createCapability,
-  readCapabilityScript,
-  toCapabilitySummary,
-  updateCapabilityManifest,
-  updateCapabilityScript,
-  type CapabilityExample,
-  type CapabilityLocation,
-  type CapabilityRecord,
-  type CapabilitySideEffect,
-} from './capability-registry.js'
-
-export interface SaveWorkflowCapabilityOptions {
-  id: string
-  title: string
-  description?: string
-  script: string
-  cwd?: string
-  location?: CapabilityLocation
-  overwrite?: boolean
-  sourceRecordingId?: string
-  whenToUse?: string[]
-  whenNotToUse?: string[]
-  match?: string[]
-  tags?: string[]
-  inputSchema?: Record<string, unknown>
-  outputSchema?: Record<string, unknown>
-  examples?: CapabilityExample[]
-  sideEffect?: CapabilitySideEffect
-  requiresConfirmation?: boolean
-}
-
-export interface SavedWorkflowCapability {
-  capability: Record<string, unknown>
-  script: string
-}
-
-type WorkflowValue =
-  | {
-      inputPath: string
-      fallback?: unknown
-    }
-  | {
-      value: unknown
-    }
-
-export type RecordingWorkflowStep =
-  | {
-      action: 'goto'
-      url: string | WorkflowValue
-    }
-  | {
-      action: 'fill'
-      locator: string
-      value: WorkflowValue
-    }
-  | {
-      action: 'click'
-      locator: string
-    }
-  | {
-      action: 'setInputFiles'
-      locator: string
-      path: WorkflowValue
-    }
-  | {
-      action: 'selectOption'
-      locator: string
-      value: WorkflowValue
-    }
-  | {
-      action: 'waitForURL'
-      url: string | WorkflowValue
-    }
-
-export interface RecordingWorkflowFinalRequest {
-  url: string
-  method?: string | string[]
-  title?: string
-  description?: string
-  trigger: RecordingWorkflowStep
-}
-
-export interface SaveWorkflowFromRecordingOptions
-  extends Omit<SaveWorkflowCapabilityOptions, 'script' | 'sourceRecordingId'> {
-  recordingId: string
-  steps: RecordingWorkflowStep[]
-  finalRequest?: RecordingWorkflowFinalRequest
-  batch?: {
-    inputPath?: string
-    continueOnError?: boolean
-  }
-}
-
-function workflowTags(options: SaveWorkflowCapabilityOptions): string[] {
-  const tags = new Set(['workflow', 'recording-derived', ...(options.tags || [])])
-  if (options.sourceRecordingId) {
-    tags.add(`recording:${options.sourceRecordingId}`)
-  }
-  return Array.from(tags)
-}
-
-function workflowWhenToUse(options: SaveWorkflowCapabilityOptions): string[] {
-  const whenToUse = options.whenToUse || []
-  if (whenToUse.length > 0) {
-    return whenToUse
-  }
-  return [
-    options.description ||
-      `Run the workflow generated from recording ${options.sourceRecordingId || 'a user demonstration'}.`,
-  ]
-}
-
-function saveScriptCapability(options: SaveWorkflowCapabilityOptions): CapabilityRecord {
-  const capability = createCapability({
-    id: options.id,
-    title: options.title,
-    description: options.description,
-    location: options.location || 'project',
-    cwd: options.cwd,
-    overwrite: options.overwrite,
-    createdBy: 'ai',
-    runtime: 'browser',
-  })
-
-  updateCapabilityScript({
-    id: capability.manifest.id,
-    cwd: options.cwd,
-    source: options.script,
-  })
-
-  return updateCapabilityManifest({
-    id: capability.manifest.id,
-    cwd: options.cwd,
-    patch: {
-      description: options.description || capability.manifest.description,
-      whenToUse: workflowWhenToUse(options),
-      whenNotToUse: options.whenNotToUse || [],
-      match: options.match || [],
-      tags: workflowTags(options),
-      inputSchema: options.inputSchema || { type: 'object', properties: {}, required: [] },
-      outputSchema: options.outputSchema || { type: 'object', properties: {} },
-      permissions: ['browser.read', 'browser.write'],
-      sideEffect: options.sideEffect || 'write',
-      requiresConfirmation: options.requiresConfirmation ?? true,
-      examples: options.examples || [],
-      status: 'draft',
-      createdBy: 'ai',
-      runtime: 'browser',
-    },
-  })
-}
-
-export function saveWorkflowCapability(options: SaveWorkflowCapabilityOptions): SavedWorkflowCapability {
-  const capability = saveScriptCapability(options)
-  return {
-    capability: toCapabilitySummary(capability),
-    script: readCapabilityScript({ id: capability.manifest.id, cwd: options.cwd }),
-  }
-}
-
-function workflowLiteral(value: unknown): string {
-  return JSON.stringify(value, null, 2)
-}
-
-function buildWorkflowScript(options: SaveWorkflowFromRecordingOptions): string {
-  const continueOnError = options.batch?.continueOnError ?? false
-  const batchInputPath = options.batch?.inputPath || 'items'
-
-  return [
-    '// Generated from a user recording: run fast by default, and return needs_ai when the live page diverges.',
-    `const workflowSteps = ${workflowLiteral(options.steps)};`,
-    `const finalRequest = ${workflowLiteral(options.finalRequest)};`,
-    `const batchInputPath = ${workflowLiteral(batchInputPath)};`,
-    `const sourceRecordingId = ${workflowLiteral(options.recordingId)};`,
-    `const continueOnError = ${continueOnError ? 'true' : 'false'};`,
-    '',
-    'function getPathValue(source, path, fallback) {',
-    '  if (!path) return fallback;',
-    '  const parts = path.split(".").filter((part) => part.length > 0);',
-    '  const value = parts.reduce((current, part) => {',
-    '    if (!current || typeof current !== "object") return undefined;',
-    '    if (!Object.prototype.hasOwnProperty.call(current, part)) return undefined;',
-    '    return current[part];',
-    '  }, source);',
-    '  return value === undefined ? fallback : value;',
-    '}',
-    '',
-    'function resolveWorkflowValue(item, value) {',
-    '  if (typeof value === "string") return value;',
-    '  if (!value || typeof value !== "object") return value;',
-    '  if (Object.prototype.hasOwnProperty.call(value, "inputPath")) return getPathValue(item, value.inputPath, value.fallback);',
-    '  if (Object.prototype.hasOwnProperty.call(value, "value")) return value.value;',
-    '  return value;',
-    '}',
-    '',
-    'function errorMessage(error) {',
-    '  if (error && typeof error === "object" && typeof error.message === "string") return error.message;',
-    '  return String(error);',
-    '}',
-    '',
-    'function escapeRegex(value) {',
-    '  return value.replace(/[.*+?^${}()|[\\]\\\\]/g, "\\\\$&");',
-    '}',
-    '',
-    'function globToRegExp(pattern) {',
-    '  return new RegExp("^" + String(pattern).split("*").map(escapeRegex).join(".*") + "$");',
-    '}',
-    '',
-    'function normalizedMethods(method) {',
-    '  if (Array.isArray(method)) return method.map((item) => String(item).toUpperCase());',
-    '  if (method) return [String(method).toUpperCase()];',
-    '  return ["POST", "PUT", "PATCH", "DELETE"];',
-    '}',
-    '',
-    'function requestMatchesFinalRequest(request) {',
-    '  if (!finalRequest || !finalRequest.url) return false;',
-    '  const methods = normalizedMethods(finalRequest.method);',
-    '  if (!methods.includes(request.method().toUpperCase())) return false;',
-    '  return globToRegExp(finalRequest.url).test(request.url());',
-    '}',
-    '',
-    'async function readSnapshotText() {',
-    '  if (typeof snapshot !== "function") return undefined;',
-    '  try {',
-    '    const value = await snapshot({ page });',
-    '    const text = typeof value === "string" ? value : JSON.stringify(value, null, 2);',
-    '    return text.slice(0, 12000);',
-    '  } catch (error) {',
-    '    return "snapshot failed: " + errorMessage(error);',
-    '  }',
-    '}',
-    '',
-    'async function captureWorkflowContext({ step, item, index, phase, reason, error }) {',
-    '  return {',
-    '    status: "needs_ai",',
-    '    reason,',
-    '    error: error ? errorMessage(error) : undefined,',
-    '    phase,',
-    '    step,',
-    '    item,',
-    '    index,',
-    '    sourceRecordingId,',
-    '    context: {',
-    '      url: page.url(),',
-    '      title: await page.title().catch(() => ""),',
-    '      snapshot: await readSnapshotText(),',
-    '    },',
-    '  };',
-    '}',
-    '',
-    'async function getWorkflowLocator(step, item, index, phase) {',
-    '  const target = page.locator(step.locator).first();',
-    '  try {',
-    '    await target.waitFor({ state: "attached", timeout: 2500 });',
-    '    return { target };',
-    '  } catch (error) {',
-    '    return {',
-    '      handoff: await captureWorkflowContext({',
-    '        step,',
-    '        item,',
-    '        index,',
-    '        phase,',
-    '        reason: "Expected locator was not found on the live page.",',
-    '        error,',
-    '      }),',
-    '    };',
-    '  }',
-    '}',
-    '',
-    'async function runWorkflowStep(step, item, options) {',
-    '  const index = options.index;',
-    '  const phase = options.phase;',
-    '  try {',
-    '    if (step.action === "goto") {',
-    '      await page.goto(String(resolveWorkflowValue(item, step.url)));',
-    '      return { status: "ok" };',
-    '    }',
-    '    if (step.action === "waitForURL") {',
-    '      await page.waitForURL(String(resolveWorkflowValue(item, step.url)));',
-    '      return { status: "ok" };',
-    '    }',
-    '    if (!step.locator) {',
-    '      return await captureWorkflowContext({ step, item, index, phase, reason: "Workflow step is missing a locator." });',
-    '    }',
-    '    const located = await getWorkflowLocator(step, item, index, phase);',
-    '    if (located.handoff) return located.handoff;',
-    '    if (step.action === "fill") {',
-    '      await located.target.fill(String(resolveWorkflowValue(item, step.value) ?? ""));',
-    '      return { status: "ok" };',
-    '    }',
-    '    if (step.action === "click") {',
-    '      await located.target.click();',
-    '      return { status: "ok" };',
-    '    }',
-    '    if (step.action === "setInputFiles") {',
-    '      await located.target.setInputFiles(String(resolveWorkflowValue(item, step.path)));',
-    '      return { status: "ok" };',
-    '    }',
-    '    if (step.action === "selectOption") {',
-    '      await located.target.selectOption(String(resolveWorkflowValue(item, step.value)));',
-    '      return { status: "ok" };',
-    '    }',
-    '    return await captureWorkflowContext({ step, item, index, phase, reason: "Unsupported workflow step." });',
-    '  } catch (error) {',
-    '    return await captureWorkflowContext({ step, item, index, phase, reason: "Workflow step failed on the live page.", error });',
-    '  }',
-    '}',
-    '',
-    'async function runFinalRequestTrigger(item, index) {',
-    '  if (!finalRequest || !finalRequest.trigger) return { status: "completed" };',
-    '  const requestPromise = page.waitForRequest((request) => {',
-    '    return requestMatchesFinalRequest(request);',
-    '  }, { timeout: 8000 }).catch((error) => {',
-    '    return { error };',
-    '  });',
-    '  const triggerResult = await runWorkflowStep(finalRequest.trigger, item, { index, phase: "final-request" });',
-    '  if (triggerResult.status !== "ok") return triggerResult;',
-    '  const request = await requestPromise;',
-    '  if (request && request.error) {',
-    '    return await captureWorkflowContext({',
-    '      step: finalRequest.trigger,',
-    '      item,',
-    '      index,',
-    '      phase: "final-request",',
-    '      reason: "The expected final request was not observed after the trigger.",',
-    '      error: request.error,',
-    '    });',
-    '  }',
-    '  const response = await request.response().catch(() => null);',
-    '  return {',
-    '    status: "completed",',
-    '    finalRequest: {',
-    '      method: request.method(),',
-    '      url: request.url(),',
-    '      headers: request.headers(),',
-    '      postData: request.postData(),',
-    '      responseStatus: response ? response.status() : undefined,',
-    '    },',
-    '  };',
-    '}',
-    '',
-    'async function runOneWorkflowItem({ item, index }) {',
-    '  for (let stepIndex = 0; stepIndex < workflowSteps.length; stepIndex += 1) {',
-    '    const step = workflowSteps[stepIndex];',
-    '    const result = await runWorkflowStep(step, item, { index, phase: "step-" + (stepIndex + 1) });',
-    '    if (result.status !== "ok") return result;',
-    '  }',
-    '  if (!finalRequest || !finalRequest.trigger) {',
-    '    return {',
-    '      status: "completed",',
-    '      item,',
-    '      index,',
-    '    };',
-    '  }',
-    '  const finalResult = await runFinalRequestTrigger(item, index);',
-    '  if (finalResult.status !== "completed") return finalResult;',
-    '  return {',
-    '    status: "completed",',
-    '    item,',
-    '    index,',
-    '    finalRequest: finalResult.finalRequest,',
-    '  };',
-    '}',
-    '',
-    'const batchInput = getPathValue(input, batchInputPath, undefined);',
-    'const items = Array.isArray(batchInput) ? batchInput : [input];',
-    'const results = [];',
-    'let completed = 0;',
-    'let failed = 0;',
-    'let needsAi = null;',
-    'for (let index = 0; index < items.length; index += 1) {',
-    '  const item = items[index];',
-    '  try {',
-    '    const result = await runOneWorkflowItem({ item, index });',
-    '    results.push(result);',
-    '    if (result.status === "completed") {',
-    '      completed += 1;',
-    '    } else if (result.status === "needs_ai") {',
-    '      needsAi = result;',
-    '      if (!continueOnError) break;',
-    '    } else {',
-    '      failed += 1;',
-    '      if (!continueOnError) break;',
-    '    }',
-    '  } catch (error) {',
-    '    const result = await captureWorkflowContext({',
-    '      item,',
-    '      index,',
-    '      phase: "item",',
-    '      reason: "Workflow item failed before completion.",',
-    '      error,',
-    '    });',
-    '    results.push(result);',
-    '    needsAi = result;',
-    '    if (!continueOnError) break;',
-    '  }',
-    '}',
-    'return {',
-    '  status: needsAi ? "needs_ai" : failed > 0 ? "failed" : "completed",',
-    '  total: items.length,',
-    '  completed,',
-    '  failed,',
-    '  needsAi,',
-    '  results,',
-    '};',
-    '',
-  ].join('\n')
-}
-
-export function saveWorkflowFromRecording(options: SaveWorkflowFromRecordingOptions): SavedWorkflowCapability {
-  return saveWorkflowCapability({
-    ...options,
-    sourceRecordingId: options.recordingId,
-    script: buildWorkflowScript(options),
-  })
-}