playwright 1.63.0: chromium.launch

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify chromium.launch in pkg:npm/playwright@1.63.0
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:npm/playwright@1.63.0
Demonstrate these symbols/APIs:
  - chromium.launch

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:dad9e616d658c92a16161c1cd25d3fb125df21dedac2986a80dcf13acad86d05","contract":["chromium.launch is an exported function on chromium and returns a Promise","chromium.executablePath returns the default browser executable path string","chromium.launch rejects with an error when given an unsupported browser channel","chromium.launch rejects with an error when configured executablePath does not exist","chromium.launch without an installed browser binary in offline environment rejects with an executable missing error"],"goal":"verify chromium.launch in pkg:npm/playwright@1.63.0","kind":"HOW","packages":["pkg:npm/playwright@1.63.0"],"schemaVersion":1,"symbols":["chromium.launch"]},"contractCommand":["node","test/contract.mjs"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"npm","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"npm","schemaVersion":1},"license":"MIT-0","packages":["pkg:npm/playwright@1.63.0"],"schemaVersion":1,"subject":"pkg:npm/playwright@1.63.0","symbols":["chromium.launch"],"verifierAdapter":"node-typescript@1"}

import { chromium } from 'playwright';

/**
 * Returns the browser name for the chromium browser type.
 * @returns {string}
 */
export function getBrowserName() {
  return chromium.name();
}

/**
 * Returns the default executable path for chromium.
 * @returns {string}
 */
export function getExecutablePath() {
  return chromium.executablePath();
}

/**
 * Launches a chromium browser instance with optional launch configuration.
 * @param {import('playwright').LaunchOptions} [options]
 * @returns {Promise<import('playwright').Browser>}
 */
export async function launchChromium(options = {}) {
  return chromium.launch(options);
}

export { chromium };
export default chromium;

{
  "name": "sample-playwright-chromium-launch",
  "version": "1.0.0",
  "lockfileVersion": 3,
  "requires": true,
  "packages": {
    "": {
      "name": "sample-playwright-chromium-launch",
      "version": "1.0.0",
      "dependencies": {
        "playwright": "1.63.0"
      }
    },
    "node_modules/playwright": {
      "version": "1.63.0",
      "resolved": "https://registry.npmjs.org/playwright/-/playwright-1.63.0.tgz",
      "integrity": "sha512-+7ziBLidS4NaNCdt57SUDT+wYmmd5fmiQejUic/kb+YsYSCPyOOE9sebzMjNmQrsnNpDJqd4WHvV/8lfKfUDUg==",
      "license": "Apache-2.0",
      "dependencies": {
        "playwright-core": "1.63.0"
      },
      "bin": {
        "playwright": "cli.js"
      },
      "engines": {
        "node": ">=20"
      }
    },
    "node_modules/playwright-core": {
      "version": "1.63.0",
      "resolved": "https://registry.npmjs.org/playwright-core/-/playwright-core-1.63.0.tgz",
      "integrity": "sha512-rYCsBF/M5HjUch52bbtVONEFjv6Xu8sm8h72dNlR5bzIE1fvC/bxgspzkjSfU+MweEMmPM8KJebG6nnyxo5mCg==",
      "license": "Apache-2.0",
      "bin": {
        "playwright-core": "cli.js"
      },
      "engines": {
        "node": ">=20"
      }
    }
  }
}

{
  "name": "sample-playwright-chromium-launch",
  "version": "1.0.0",
  "type": "module",
  "description": "Clean-room verification sample for chromium.launch in pkg:npm/playwright@1.63.0",
  "main": "index.mjs",
  "license": "MIT-0",
  "dependencies": {
    "playwright": "1.63.0"
  }
}

{
  "schemaVersion": 1,
  "goal": "verify chromium.launch in pkg:npm/playwright@1.63.0",
  "kind": "HOW",
  "packages": [
    "pkg:npm/playwright@1.63.0"
  ],
  "symbols": [
    "chromium.launch"
  ]
}

import assert from 'node:assert/strict';
import { chromium, launchChromium, getBrowserName, getExecutablePath } from '../index.mjs';

// 1. chromium.launch is an exported function on chromium and returns a Promise
{
  assert.strictEqual(typeof chromium.launch, 'function', 'chromium.launch must be a function');
  assert.strictEqual(typeof launchChromium, 'function', 'launchChromium must be a function');
  assert.strictEqual(chromium.name(), 'chromium', 'chromium browser type name must be chromium');
  assert.strictEqual(getBrowserName(), 'chromium', 'getBrowserName helper must return chromium');
}

// 2. chromium.executablePath returns the default browser executable path string
{
  const execPath = chromium.executablePath();
  assert.strictEqual(typeof execPath, 'string', 'executablePath must return a string');
  assert.ok(execPath.length > 0, 'executablePath string must not be empty');
  assert.strictEqual(getExecutablePath(), execPath, 'getExecutablePath helper must match chromium.executablePath');
}

// 3. chromium.launch rejects with an error when given an unsupported browser channel
{
  await assert.rejects(
    async () => {
      await chromium.launch({ channel: 'unsupported-test-channel' });
    },
    (err) => {
      assert(err instanceof Error, 'Expected error to be an instance of Error');
      assert.match(err.message, /Unsupported chromium channel "unsupported-test-channel"/, 'Expected unsupported channel error');
      return true;
    }
  );
}

// 4. chromium.launch rejects with an error when configured executablePath does not exist
{
  await assert.rejects(
    async () => {
      await chromium.launch({ executablePath: './nonexistent/mock/chromium-bin' });
    },
    (err) => {
      assert(err instanceof Error, 'Expected error to be an instance of Error');
      assert.match(err.message, /executable doesn't exist at/i, 'Expected missing executable error');
      return true;
    }
  );
}

// 5. chromium.launch without an installed browser binary in offline environment rejects with an executable missing error
{
  await assert.rejects(
    async () => {
      await chromium.launch();
    },
    (err) => {
      assert(err instanceof Error, 'Expected error to be an instance of Error');
      assert.match(err.message, /executable doesn't exist at|playwright install/i, 'Expected offline missing browser error');
      return true;
    }
  );
}

console.log('All chromium.launch contract assertions passed.');