@freestyle-sh/with-playwright 0.2.8

package/README.md

@@ -0,0 +1,97 @@
+# @freestyle-sh/with-playwright
+
+Playwright runtime for [Freestyle](https://freestyle.sh) VMs, including browser installs.
+
+## Installation
+
+```bash
+npm install @freestyle-sh/with-playwright freestyle-sandboxes
+```
+
+## Usage
+
+```typescript
+import { freestyle } from "freestyle-sandboxes";
+import { VmPlaywright } from "@freestyle-sh/with-playwright";
+
+const { vm } = await freestyle.vms.create({
+  with: {
+    playwright: new VmPlaywright(),
+  },
+});
+
+const res = await vm.playwright.runCode({
+  code: `
+  const { chromium } = require("playwright");
+  (async () => {
+    const browser = await chromium.launch();
+    const page = await browser.newPage();
+    await page.goto("https://example.com");
+    const title = await page.title();
+    await browser.close();
+    console.log(JSON.stringify({ title }));
+  })();
+  `,
+});
+
+console.log(res);
+```
+
+## Options
+
+```typescript
+new VmPlaywright({
+  nodeVersion: "24",
+  playwrightVersion: "1.47.0",
+  installDeps: true,
+  browsers: ["chromium"],
+})
+```
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `nodeVersion` | `string` | `"24"` | Node.js version to install via NVM. |
+| `playwrightVersion` | `string` | `undefined` | Playwright version to install. |
+| `installDeps` | `boolean` | `true` | Install Playwright system dependencies via `--with-deps`. |
+| `browsers` | `("chromium" \| "firefox" \| "webkit")[]` | `undefined` | Limit browser installs; default installs all. |
+
+## API
+
+### `vm.playwright.runCode({ code: string })`
+
+Executes JavaScript code in the Playwright-ready Node.js runtime.
+
+**Returns:** `Promise<RunCodeResponse>`
+
+```typescript
+type RunCodeResponse<Result> = {
+  result: Result;
+  stdout?: string;
+  stderr?: string;
+  statusCode?: number;
+};
+```
+
+### `vm.playwright.install(options?)`
+
+Installs npm packages with `npm install`.
+
+```typescript
+await vm.playwright.install({ deps: ["@playwright/test"] });
+```
+
+**Returns:** `Promise<InstallResult>`
+
+```typescript
+type InstallResult = {
+  success: boolean;
+  stdout?: string;
+  stderr?: string;
+};
+```
+
+## Documentation
+
+- [Freestyle Documentation](https://docs.freestyle.sh)
+- [Playwright Documentation](https://playwright.dev)
+```

package/dist/index.d.ts

@@ -0,0 +1,35 @@
+import { VmWith, VmWithInstance, VmSpec } from 'freestyle-sandboxes';
+import { VmJavaScriptRuntimeInstance, JSONValue, RunCodeResponse, InstallOptions, InstallResult, VmJavaScriptRuntime } from '@freestyle-sh/with-type-js';
+
+type PlaywrightOptions = {
+    nodeVersion?: string;
+    playwrightVersion?: string;
+    installDeps?: boolean;
+    browsers?: Array<"chromium" | "firefox" | "webkit">;
+};
+type PlaywrightResolvedOptions = {
+    nodeVersion: string;
+    playwrightVersion?: string;
+    installDeps: boolean;
+    browsers?: Array<"chromium" | "firefox" | "webkit">;
+};
+declare class VmPlaywright extends VmWith<PlaywrightRuntimeInstance> implements VmJavaScriptRuntime<VmJavaScriptRuntimeInstance> {
+    options: PlaywrightResolvedOptions;
+    constructor(options?: PlaywrightOptions);
+    configureSnapshotSpec(spec: VmSpec): VmSpec;
+    createInstance(): PlaywrightRuntimeInstance;
+    installServiceName(): string;
+}
+declare class PlaywrightRuntimeInstance extends VmWithInstance implements VmJavaScriptRuntimeInstance {
+    builder: VmPlaywright;
+    constructor(builder: VmPlaywright);
+    runCode<Result extends JSONValue = any>(args: string | {
+        code: string;
+        argv?: string[];
+        env?: Record<string, string>;
+        workdir?: string;
+    }): Promise<RunCodeResponse<Result>>;
+    install(options?: InstallOptions): Promise<InstallResult>;
+}
+
+export { VmPlaywright };

package/dist/index.js

@@ -0,0 +1,142 @@
+import { VmWith, VmSpec, VmWithInstance } from 'freestyle-sandboxes';
+
+class VmPlaywright extends VmWith {
+  options;
+  constructor(options) {
+    super();
+    this.options = {
+      nodeVersion: options?.nodeVersion ?? "24",
+      playwrightVersion: options?.playwrightVersion,
+      installDeps: options?.installDeps ?? true,
+      browsers: options?.browsers
+    };
+  }
+  configureSnapshotSpec(spec) {
+    const playwrightVersionArg = this.options.playwrightVersion ? `@${this.options.playwrightVersion}` : "";
+    const browserArgs = this.options.browsers?.length ? ` ${this.options.browsers.join(" ")}` : "";
+    const depsFlag = this.options.installDeps ? " --with-deps" : "";
+    const installScript = `#!/bin/bash
+set -e
+export NVM_DIR="/opt/nvm"
+mkdir -p "$NVM_DIR"
+curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
+source "$NVM_DIR/nvm.sh"
+nvm install ${this.options.nodeVersion}
+nvm alias default ${this.options.nodeVersion}
+node -v
+npm -v
+
+export PLAYWRIGHT_BROWSERS_PATH="/opt/playwright-browsers"
+mkdir -p /opt/playwright-browsers
+mkdir -p /opt/playwright
+cd /opt/playwright
+npm init -y
+npm install playwright${playwrightVersionArg}
+npx playwright install${depsFlag}${browserArgs}
+`;
+    const nvmInit = `export NVM_DIR="/opt/nvm"
+[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
+[ -s "$NVM_DIR/bash_completion" ] && . "$NVM_DIR/bash_completion"
+`;
+    const playwrightEnv = `export PLAYWRIGHT_BROWSERS_PATH="/opt/playwright-browsers"
+export NODE_PATH="/opt/playwright/node_modules"
+`;
+    return this.composeSpecs(
+      spec,
+      new VmSpec({
+        additionalFiles: {
+          "/opt/install-playwright.sh": {
+            content: installScript
+          },
+          "/etc/profile.d/nvm.sh": {
+            content: nvmInit
+          },
+          "/etc/profile.d/playwright.sh": {
+            content: playwrightEnv
+          }
+        },
+        systemd: {
+          services: [
+            {
+              name: "install-playwright",
+              mode: "oneshot",
+              deleteAfterSuccess: true,
+              exec: ["bash /opt/install-playwright.sh"],
+              timeoutSec: 600
+            }
+          ]
+        }
+      })
+    );
+  }
+  createInstance() {
+    return new PlaywrightRuntimeInstance(this);
+  }
+  installServiceName() {
+    return "install-playwright.service";
+  }
+}
+class PlaywrightRuntimeInstance extends VmWithInstance {
+  builder;
+  constructor(builder) {
+    super();
+    this.builder = builder;
+  }
+  async runCode(args) {
+    const options = typeof args === "string" ? { code: args } : args;
+    const { code, argv, env, workdir } = options;
+    const shellEscape = (value) => `'${value.replace(/'/g, "'\\''")}'`;
+    const argvArgs = argv?.map(shellEscape).join(" ");
+    const mergedEnv = {
+      NODE_PATH: "/opt/playwright/node_modules",
+      PLAYWRIGHT_BROWSERS_PATH: "/opt/playwright-browsers",
+      ...env ?? {}
+    };
+    const envPrefix = Object.entries(mergedEnv).map(([key, value]) => `${key}=${shellEscape(value)}`).join(" ");
+    const cdPrefix = workdir ? `cd ${shellEscape(workdir)} && ` : "";
+    const command = `${cdPrefix}${envPrefix ? `${envPrefix} ` : ""}node -e "${code.replace(/"/g, '\\"')}"${argvArgs ? ` -- ${argvArgs}` : ""}`;
+    const result = await this.vm.exec({
+      command
+    });
+    let parsedResult = void 0;
+    if (result.stdout) {
+      const lines = result.stdout.split(/\r?\n/).map((line) => line.trim()).filter((line) => line.length > 0);
+      const lastLine = lines[lines.length - 1];
+      if (lastLine) {
+        try {
+          parsedResult = JSON.parse(lastLine);
+        } catch (e) {
+        }
+      }
+    }
+    return {
+      result: parsedResult,
+      stdout: result.stdout ?? void 0,
+      stderr: result.stderr ?? void 0,
+      statusCode: result.statusCode ?? -1
+    };
+  }
+  async install(options) {
+    let command;
+    if (options?.global) {
+      command = `npm install -g ${options.deps.join(" ")}`;
+    } else {
+      const cdPrefix = options?.directory ? `cd ${options.directory} && ` : "";
+      if (!options?.deps) {
+        command = `${cdPrefix}npm install`;
+      } else {
+        const deps = Array.isArray(options.deps) ? options.deps : Object.entries(options.deps).map(([pkg, ver]) => `${pkg}@${ver}`);
+        const devFlag = options.dev ? " --save-dev" : "";
+        command = `${cdPrefix}npm install${devFlag} ${deps.join(" ")}`;
+      }
+    }
+    const result = await this.vm.exec({ command });
+    return {
+      success: result.statusCode === 0,
+      stdout: result.stdout ?? void 0,
+      stderr: result.stderr ?? void 0
+    };
+  }
+}
+
+export { VmPlaywright };

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@freestyle-sh/with-playwright",
+  "version": "0.2.8",
+  "private": false,
+  "dependencies": {
+    "freestyle-sandboxes": "^0.1.28",
+    "@freestyle-sh/with-type-js": "^0.2.8"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "source": "./src/index.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "pkgroll"
+  }
+}