pw-automation-framework 2.0.1

package/src/installer/frameworkLauncher.ts

@@ -0,0 +1,242 @@
+/**
+ * frameworkLauncher.ts
+ * ====================
+ * Called by your MAIN APP's backend to ensure the framework is running.
+ * Handles: health check → install if missing → start → return URL.
+ *
+ * Usage in your main app's API route:
+ *   import { ensureFramework, submitExecution } from './frameworkLauncher';
+ *   const url = await ensureFramework();
+ *   const run = await submitExecution(payload);
+ */
+
+import { execFile, exec } from "child_process";
+import { promisify } from "util";
+import path from "path";
+import http from "http";
+import fs from "fs";
+
+const execFileAsync = promisify(execFile);
+const execAsync     = promisify(exec);
+
+const FRAMEWORK_PORT    = parseInt(process.env.FRAMEWORK_PORT || "3000", 10);
+const FRAMEWORK_BASE    = `http://localhost:${FRAMEWORK_PORT}`;
+const INSTALL_DIR       = path.join(
+  process.env.HOME || process.env.USERPROFILE || "/tmp",
+  ".pw-automation-framework"
+);
+const PID_FILE          = path.join(INSTALL_DIR, ".pid");
+const LOG_FILE          = path.join(INSTALL_DIR, "server.log");
+const VERSION_FILE      = path.join(INSTALL_DIR, "VERSION");
+const CURRENT_VERSION   = "2.0.0";
+// ⬇️ Update this to your actual hosted bundle URL
+const BUNDLE_BASE_URL   = process.env.FRAMEWORK_BUNDLE_URL || "https://your-registry.example.com/releases";
+
+// ─── Health check ─────────────────────────────────────────────────────────────
+
+export async function isFrameworkRunning(): Promise<boolean> {
+  return new Promise((resolve) => {
+    const req = http.get(
+      `${FRAMEWORK_BASE}/api/health`,
+      { timeout: 800 },
+      (res) => resolve(res.statusCode === 200)
+    );
+    req.on("error",   () => resolve(false));
+    req.on("timeout", () => { req.destroy(); resolve(false); });
+  });
+}
+
+export async function getFrameworkVersion(): Promise<string | null> {
+  try {
+    if (fs.existsSync(VERSION_FILE)) {
+      return fs.readFileSync(VERSION_FILE, "utf-8").trim();
+    }
+  } catch { /* ignore */ }
+  return null;
+}
+
+// ─── Download & install ───────────────────────────────────────────────────────
+
+export async function installFramework(
+  onLog?: (msg: string) => void
+): Promise<void> {
+  const log = (msg: string) => { console.log(`[Installer] ${msg}`); onLog?.(msg); };
+
+  fs.mkdirSync(INSTALL_DIR, { recursive: true });
+
+  log(`Installing framework v${CURRENT_VERSION} to ${INSTALL_DIR}…`);
+
+  const bundleURL = `${BUNDLE_BASE_URL}/pw-framework-v${CURRENT_VERSION}.tar.gz`;
+  const bundleTmp = path.join(INSTALL_DIR, "bundle.tar.gz");
+
+  // Download bundle
+  log("Downloading framework bundle…");
+  await new Promise<void>((resolve, reject) => {
+    const file = fs.createWriteStream(bundleTmp);
+    http.get(bundleURL.replace("https://", "http://"), (res) => {
+      res.pipe(file);
+      file.on("finish", () => { file.close(); resolve(); });
+    }).on("error", (err) => {
+      fs.unlink(bundleTmp, () => {});
+      reject(new Error(`Download failed: ${err.message}. \nManually download from: ${bundleURL}`));
+    });
+  });
+
+  log("Extracting…");
+  await execAsync(`tar -xzf "${bundleTmp}" -C "${INSTALL_DIR}" --strip-components=1`);
+  fs.unlinkSync(bundleTmp);
+
+  log("Installing dependencies (this may take a minute)…");
+  await execAsync(`npm install --omit=dev --silent`, { cwd: INSTALL_DIR });
+
+  log("Installing Playwright browsers…");
+  try {
+    await execAsync(`npx playwright install chromium --with-deps`, { cwd: INSTALL_DIR });
+  } catch {
+    await execAsync(`npx playwright install chromium`, { cwd: INSTALL_DIR });
+  }
+
+  // Write version marker
+  fs.writeFileSync(VERSION_FILE, CURRENT_VERSION);
+  log(`Installation complete ✓`);
+}
+
+// ─── Start server ─────────────────────────────────────────────────────────────
+
+export async function startFramework(onLog?: (msg: string) => void): Promise<void> {
+  const log = (msg: string) => { console.log(`[Launcher] ${msg}`); onLog?.(msg); };
+
+  log(`Starting framework on port ${FRAMEWORK_PORT}…`);
+
+  const serverFile = path.join(INSTALL_DIR, "dist", "server.js");
+  if (!fs.existsSync(serverFile)) {
+    throw new Error(`server.js not found at ${serverFile}. Run installFramework() first.`);
+  }
+
+  // const child = execFile("node", [serverFile], {
+  //   env:      { ...process.env, PORT: String(FRAMEWORK_PORT) },
+  //   cwd:      INSTALL_DIR,
+  //   detached: true,
+  //   stdio:    ["ignore", fs.openSync(LOG_FILE, "a"), fs.openSync(LOG_FILE, "a")],
+  // });
+  const child = execFile(
+  "node",
+  [serverFile],
+  {
+    env: { ...process.env, PORT: String(FRAMEWORK_PORT) },
+    cwd: INSTALL_DIR,
+    detached: true,
+    stdio: ["ignore", fs.openSync(LOG_FILE, "a"), fs.openSync(LOG_FILE, "a")]
+  } as any   // 👈 THIS LINE FIXES YOUR ERROR
+);
+
+  child.unref();
+  if (child.pid) fs.writeFileSync(PID_FILE, String(child.pid));
+
+  // Wait for health (up to 15s)
+  for (let i = 0; i < 30; i++) {
+    await new Promise(r => setTimeout(r, 500));
+    if (await isFrameworkRunning()) {
+      log(`Framework ready at ${FRAMEWORK_BASE} ✓`);
+      return;
+    }
+  }
+
+  throw new Error(`Framework did not start within 15s. Check ${LOG_FILE}`);
+}
+
+// ─── Main entry — ensures framework is running ────────────────────────────────
+
+export interface EnsureResult {
+  baseUrl:    string;
+  installed:  boolean;
+  started:    boolean;
+  version:    string;
+}
+
+export async function ensureFramework(
+  onLog?: (msg: string) => void
+): Promise<EnsureResult> {
+  const log = (msg: string) => { console.log(`[ensureFramework] ${msg}`); onLog?.(msg); };
+
+  // 1. Already running?
+  if (await isFrameworkRunning()) {
+    log("Framework already running ✓");
+    return { baseUrl: FRAMEWORK_BASE, installed: false, started: false, version: CURRENT_VERSION };
+  }
+
+  // 2. Installed but not running?
+  const installedVersion = await getFrameworkVersion();
+  let needsInstall       = installedVersion !== CURRENT_VERSION;
+
+  if (needsInstall) {
+    log(installedVersion
+      ? `Updating from v${installedVersion} → v${CURRENT_VERSION}…`
+      : "First install…");
+    await installFramework(onLog);
+  }
+
+  // 3. Start
+  await startFramework(onLog);
+
+  return {
+    baseUrl:   FRAMEWORK_BASE,
+    installed: needsInstall,
+    started:   true,
+    version:   CURRENT_VERSION,
+  };
+}
+
+// ─── Submit execution ─────────────────────────────────────────────────────────
+
+export async function submitExecution(
+  payload: any,
+  onLog?:  (msg: string) => void
+): Promise<{ executionId: string; dashboardURL: string; status: string }> {
+
+  await ensureFramework(onLog);
+
+  const body = JSON.stringify(payload);
+  return new Promise((resolve, reject) => {
+    const req = http.request(
+      {
+        hostname: "localhost",
+        port:     FRAMEWORK_PORT,
+        path:     "/api/run-test",
+        method:   "POST",
+        headers:  { "Content-Type": "application/json", "Content-Length": Buffer.byteLength(body) },
+      },
+      (res) => {
+        let data = "";
+        res.on("data", c => data += c);
+        res.on("end",  () => {
+          try { resolve(JSON.parse(data)); }
+          catch { reject(new Error(`Invalid response: ${data}`)); }
+        });
+      }
+    );
+    req.on("error", reject);
+    req.write(body);
+    req.end();
+  });
+}
+
+// ─── Cancel execution ─────────────────────────────────────────────────────────
+
+export async function cancelExecution(executionId: string): Promise<{ success: boolean; message: string }> {
+  return new Promise((resolve, reject) => {
+    const req = http.request(
+      { hostname: "localhost", port: FRAMEWORK_PORT, path: `/api/cancel/${executionId}`, method: "DELETE" },
+      (res) => {
+        let data = "";
+        res.on("data", c => data += c);
+        res.on("end",  () => {
+          try { resolve(JSON.parse(data)); }
+          catch { reject(new Error(`Invalid response: ${data}`)); }
+        });
+      }
+    );
+    req.on("error", reject);
+    req.end();
+  });
+}

package/src/installer/install.sh

@@ -0,0 +1,107 @@
+#!/usr/bin/env bash
+# ============================================================
+#  PW Automation Framework — Auto Installer
+#  Triggered from the web UI on first Execute click.
+#  Runs silently, installs framework locally, starts server.
+# ============================================================
+
+set -e
+
+FRAMEWORK_VERSION="2.0.0"
+INSTALL_DIR="$HOME/.pw-automation-framework"
+PORT="${PW_PORT:-3000}"
+PID_FILE="$INSTALL_DIR/.pid"
+LOG_FILE="$INSTALL_DIR/server.log"
+REGISTRY_URL="${PW_REGISTRY_URL:-https://your-registry.example.com/releases}"
+
+log() { echo "[$(date '+%H:%M:%S')] $*"; }
+
+# ── 1. Check if already running ──────────────────────────────────────────────
+if [ -f "$PID_FILE" ]; then
+  PID=$(cat "$PID_FILE")
+  if kill -0 "$PID" 2>/dev/null; then
+    # Check if it's the right version
+    CURRENT_VER=$(curl -s "http://localhost:$PORT/api/health" 2>/dev/null | grep -o '"version":"[^"]*"' | grep -o '[0-9.]*' || echo "")
+    if [ "$CURRENT_VER" = "$FRAMEWORK_VERSION" ]; then
+      log "Framework v$FRAMEWORK_VERSION already running (PID $PID)"
+      echo "RUNNING:$PORT"
+      exit 0
+    else
+      log "Outdated version ($CURRENT_VER) running — upgrading to $FRAMEWORK_VERSION"
+      kill "$PID" 2>/dev/null || true
+      sleep 1
+    fi
+  fi
+fi
+
+# ── 2. Check Node.js ─────────────────────────────────────────────────────────
+if ! command -v node &>/dev/null; then
+  log "ERROR: Node.js not found. Please install Node.js 18+ from https://nodejs.org"
+  exit 1
+fi
+
+NODE_MAJOR=$(node -e "process.stdout.write(process.version.slice(1).split('.')[0])")
+if [ "$NODE_MAJOR" -lt 18 ]; then
+  log "ERROR: Node.js 18+ required. Current: $(node -v)"
+  exit 1
+fi
+
+log "Node.js $(node -v) ✓"
+
+# ── 3. Install / update framework ────────────────────────────────────────────
+mkdir -p "$INSTALL_DIR"
+
+INSTALLED_VER=""
+[ -f "$INSTALL_DIR/package.json" ] && \
+  INSTALLED_VER=$(node -e "try{process.stdout.write(require('$INSTALL_DIR/package.json').version||'')}catch{}" 2>/dev/null || echo "")
+
+if [ "$INSTALLED_VER" != "$FRAMEWORK_VERSION" ]; then
+  log "Installing framework v$FRAMEWORK_VERSION → $INSTALL_DIR"
+
+  # Download release bundle (update URL to your actual hosting)
+  BUNDLE_URL="$REGISTRY_URL/pw-framework-v$FRAMEWORK_VERSION.tar.gz"
+  BUNDLE_TMP="/tmp/pw-framework-$FRAMEWORK_VERSION.tar.gz"
+
+  if command -v curl &>/dev/null; then
+    curl -fsSL "$BUNDLE_URL" -o "$BUNDLE_TMP"
+  elif command -v wget &>/dev/null; then
+    wget -q "$BUNDLE_URL" -O "$BUNDLE_TMP"
+  else
+    log "ERROR: Neither curl nor wget found"
+    exit 1
+  fi
+
+  tar -xzf "$BUNDLE_TMP" -C "$INSTALL_DIR" --strip-components=1
+  rm -f "$BUNDLE_TMP"
+
+  cd "$INSTALL_DIR"
+  log "Installing npm dependencies…"
+  npm install --omit=dev --silent
+
+  log "Installing Playwright browsers…"
+  npx playwright install chromium firefox webkit --with-deps 2>/dev/null || \
+    npx playwright install chromium --with-deps 2>/dev/null || true
+
+  log "Build complete ✓"
+fi
+
+# ── 4. Start the server ───────────────────────────────────────────────────────
+cd "$INSTALL_DIR"
+log "Starting framework server on port $PORT…"
+
+PORT=$PORT nohup node dist/server.js >> "$LOG_FILE" 2>&1 &
+echo $! > "$PID_FILE"
+log "Server started (PID $(cat $PID_FILE))"
+
+# ── 5. Wait for health check ──────────────────────────────────────────────────
+for i in $(seq 1 20); do
+  sleep 0.5
+  if curl -sf "http://localhost:$PORT/api/health" >/dev/null 2>&1; then
+    log "Framework ready at http://localhost:$PORT ✓"
+    echo "RUNNING:$PORT"
+    exit 0
+  fi
+done
+
+log "ERROR: Framework did not start within 10 seconds. Check $LOG_FILE"
+exit 1