Skip to content

CHANGELOG.md

Latest commit

 

History

History
381 lines (277 loc) · 15.9 KB

CHANGELOG.md

File metadata and controls

381 lines (277 loc) · 15.9 KB
Raw

Changelog

All notable changes to this project are documented here.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

1.10.0 - 2026-07-30

Changed

  • Upgraded CloakBrowser to 0.5.3 and added the startup-only Stable/Preview release-channel control.
  • Inherited CloakBrowser's Windows font-profile argument alignment.

Fixed

  • Inherited CloakBrowser 0.5.3 authenticated-proxy GeoIP and per-launch proxy identity corrections.

1.9.0 - 2026-07-23

Changed

  • Updated CloakBrowser to 0.5.1 for GitHub free-tier sign-in, tier-aware diagnostics, authenticated HTTP proxy improvements, explicit GeoIP timezone/locale precedence, and the latest Chromium 150 Pro build.
  • Refreshed compatible root npm and Python documentation dependencies and all pinned GitHub Actions, including the Node 24-based setup actions, while retaining ESLint 9 compatibility with the current Vitest lint plugin.

Fixed

  • Preserved CloakBrowser-generated fingerprint and native proxy launch arguments, retained Playwright proxy fallback for older binaries, and forwarded only the resolved CloakBrowser license key to the browser child.

1.8.0 - 2026-07-11

Added

  • Forwarded Playwright MCP's browser_find tool unchanged as part of the upstream 0.0.78 tool surface.

Changed

  • Refreshed npm, demo, Docker, and GitHub Actions dependencies, including Playwright MCP 0.0.78 and CloakBrowser 0.4.10.
  • Updated supported development and CI Node.js versions to 22.13+ on the 22.x line and 24+.
  • Aligned the release Docker build with the Playwright MCP 0.0.78 base image used by the application and parity checks.

1.7.0 - 2026-07-07

Added

  • Added a Hadolint pull request check and Docker-backed npm run docker:lint command for Dockerfile linting.
  • Added ESLint plugin coverage for Node.js, import, Vitest, and regular expression checks.
  • Added comparison and recipe documentation that explains when to use CloakBrowser MCP instead of plain upstream @playwright/mcp.
  • Added README and docs homepage demo video coverage for npm startup, humanized prompt typing, web research, daily automation, and testing workflows.
  • Added an Animated WebP demo asset and npm commands for rendering the README and docs demo from the generated MP4.

Changed

  • Updated the CloakBrowser dependency to ^0.4.8 and forwarded CloakBrowser-generated default launch args such as --start-maximized.
  • Updated contributor and security policy documentation to reflect the current Node.js requirement and published release support policy.
  • Made bridge CLI boolean environment variables reject unknown string values instead of silently treating typos as false.

Fixed

  • Handled malformed Streamable HTTP Host or URL values without surfacing an internal routing error.

Security

  • Narrowed upstream child-process environment inheritance to an allowlist so unrelated tokens and CI secrets are not forwarded by default.
  • Added an advisory filesystem lock for persistent browser profiles across bridge processes.
  • Added a Streamable HTTP startup warning for non-loopback HTTP binds without built-in auth or TLS, and documented the Docker no-sandbox trade-off.

1.6.1 - 2026-07-05

Added

  • Added a bundled MCP server schema and automated schema update workflow so server.json validation no longer depends on fetching the schema at runtime.
  • Added CloakBrowser dependency metadata to the MkDocs project macros and generated llms.txt compatibility values from the same release metadata.

Changed

  • Updated the CloakBrowser dependency to ^0.4.7.
  • Updated npm dependencies and pinned Docker GitHub Actions used by CI and release workflows.

Fixed

  • Fixed duplicate Streamable HTTP request body reads.

1.6.0 - 2026-06-30

Added

  • Added persistent browser profile support through PLAYWRIGHT_MCP_USER_DATA_DIR and Streamable HTTP session metadata, including writable directory validation and in-process duplicate profile protection.
  • Added validated context option support through CLOAK_PLAYWRIGHT_MCP_CONTEXT_OPTIONS and Streamable HTTP session metadata.
  • Added extension path support through CLOAK_PLAYWRIGHT_MCP_EXTENSION_PATHS and Streamable HTTP session metadata, backed by CloakBrowser launch argument generation and persistent profile requirements.
  • Added a CloakBrowser upstream monitor job and helper script alongside the Playwright MCP upstream monitor.
  • Added Docker and extension documentation for persistent /data profiles, mounted extension directories, and cross-platform path handling.
  • Added code-assistant E2E runbook coverage for single-subagent full tool sweeps and parallel multisession checks against one shared Streamable HTTP MCP server.

Changed

  • Updated the upstream Playwright MCP dependency and Docker baseline to @playwright/mcp ^0.0.77 and mcr.microsoft.com/playwright/mcp:v0.0.77.
  • Updated the CloakBrowser dependency to ^0.4.5.
  • Switched the humanized input integration to CloakBrowser's public JavaScript helper surface while keeping the generated Playwright MCP config flow intact.
  • Derived the Playwright MCP package tag used by the Tools documentation from the MkDocs project macro metadata.
  • Simplified the release workflow so release publishing no longer repeats PR CI release checks or Docker smoke, and documentation deployment waits for npm, Docker, and MCP Registry publishing to succeed.

Fixed

  • Clarified Streamable HTTP metadata validation and normalized profile path assertions for cross-platform CI behavior.

1.5.0 - 2026-06-27

Added

  • Added a bridge option to match CloakBrowser timezone and locale fingerprint flags to the configured proxy's GeoIP location.
  • Added a bridge option for CloakBrowser human-like mouse, keyboard, and scroll behavior with global and per-session Streamable HTTP configuration, including default and careful human presets.
  • Auto-cleanup of stale Chromium SingletonLock files on stdio startup to prevent "Browser is already in use" errors after an unclean shutdown (SIGKILL/crash). Covers Linux, macOS, and Windows profile paths and lock formats, and skips locks whose owning process is still alive or whose status is indeterminate (EPERM / EACCES).

Changed

  • Extracted the singleton-lock cleanup logic into a new src/cli/singleton-lock-cleanup.ts module with platform-aware path resolution (POSIX XDG cache vs Windows %LOCALAPPDATA%) and a private process.kill(pid, 0) probe so the safety guarantees can be unit-tested with vi.spyOn(process, 'kill') instead of touching the global state.

1.4.0 - 2026-06-21

Added

  • Added pino-backed operational logging for Streamable HTTP startup and completed HTTP requests.
  • Added protocol-selectable Streamable HTTP HTTPS support with certificate, key, PFX, and passphrase configuration.
  • Added packaged CLI end-to-end coverage for stdio, Streamable HTTP, auth, HTTPS, CLI/env options, and doctor JSON output.
  • Added generated compatibility tables shared by the README and documentation.

Changed

  • Expanded supported npm validation to Node.js 22 through 26 across Linux x64/arm64, macOS arm64/x64, and Windows x64.
  • Expanded Docker release validation and publishing to linux/amd64 and linux/arm64.
  • Updated MCP client installation documentation for npm, Docker, Codex CLI, Claude Code, Claude Desktop, VS Code, Cursor, Continue, Windsurf/Cascade, Goose, Warp, and Streamable HTTP.
  • Updated @playwright/mcp dependency to ^0.0.76.
  • Updated Playwright MCP Docker base image to mcr.microsoft.com/playwright/mcp:v0.0.76.
  • Updated CloakBrowser dependency to ^0.3.32.

Fixed

  • Hardened internal Streamable HTTP error responses so server exception details are not exposed to clients.
  • Replaced global test TLS validation disabling with a scoped fixture certificate trust path.
  • Fixed cross-platform command, path, line-ending, and import resolution issues for Windows, macOS, and Linux CI.

1.3.0 - 2026-06-06

Added

  • Added a project release skill for AI agents to prepare, publish, verify, and recover releases.
  • Added a project Pull Request skill for AI agents to prepare, create, update, and report PRs consistently.
  • Added property-based tests for CLI and environment parsing.
  • Added agent instructions for supply-chain hardening and GitHub security changes.
  • Added Streamable HTTP GET /healthz and GET /readyz probes for health and readiness checks.
  • Added the cloakbrowser-mcp doctor diagnostics command with human and JSON output.
  • Added a stable upstream Playwright MCP tool list reference to the Tools documentation.

Changed

  • Added the Advanced SEO MkDocs plugin for generated documentation metadata.
  • Hardened GitHub workflow token permissions and pinned workflow actions.
  • Updated CloakBrowser dependency to ^0.3.31.
  • Updated documentation dependency minimums for MkDocs plugins.
  • Updated npm development dependency minimums to current compatible releases.
  • Expanded Node.js workflow check coverage across major versions 20 through 26.
  • Updated the project Pull Request skill to assign PRs to the authenticated GitHub user by default.

1.2.7 - 2026-06-04

Added

  • Added Docker Hub publication and MCP Registry metadata for docker.io/swimmwatch/cloakbrowser-mcp alongside GHCR.
  • Added automatic Docker Hub repository overview updates from a Docker-specific README.
  • Added a Docker Hub pulls badge to the README.

1.2.6 - 2026-05-31

Added

  • Added a registry verification script for official MCP Registry, npm package, GHCR image, and GitHub MCP Registry visibility checks.
  • Added documentation that distinguishes official MCP Registry publication from GitHub's curated github.com/mcp registry surface.

Changed

  • Refined registry-facing package and server metadata to describe the project as a Playwright MCP-compatible browser automation bridge.

1.2.5 - 2026-05-27

Changed

  • Replaced the separate npm, Docker, documentation, and MCP Registry release workflows with one unified Release workflow.
  • Simplified the local MCP Registry Publish composite action so npm and Docker publication ordering is handled by workflow job dependencies.
  • Added Glama ownership metadata, score badge, and release checklist documentation before the stable 1.2.5 release.

Fixed

  • Added retries with fresh GitHub OIDC login attempts around MCP Registry publishing to tolerate transient registry gateway timeouts.

1.2.3 - 2026-05-27

Changed

  • Refactored MCP Registry release publishing into a local MCP Registry Publish composite GitHub Action.
  • Added a dedicated README badge for the official MCP Registry listing.

1.2.2 - 2026-05-27

Fixed

  • Fixed MCP Registry release verification to use the official registry API response shape.
  • Made MCP Registry release reruns skip publishing when the target server version is already visible.

1.2.1 - 2026-05-27

Fixed

  • Removed the OCI package registryBaseUrl from server.json so official MCP Registry publishing accepts the GHCR image metadata.
  • Added local validation for the official MCP Registry OCI metadata rule.

1.2.0 - 2026-05-27

Added

  • Added official MCP Registry publishing through mcp-publisher and GitHub Actions OIDC.

1.1.0 - 2026-05-24

Added

  • Added optional Streamable HTTP transport with per-session bridge isolation, in-memory session metadata, Bearer token support, and HTTP configuration flags.
  • Added Codecov coverage upload and a README coverage badge.

Fixed

  • Streamable HTTP sessions now start upstream Playwright MCP with isolated browser profiles for concurrent users.
  • Generated CLI docs no longer trigger infinite rebuilds during mkdocs serve.
  • Hardened Streamable HTTP authorization parsing, IPv6 endpoint matching, and internal error responses.

Security

  • Updated the Vitest/Vite development test stack to patched transitive vite and esbuild versions.

1.0.2 - 2026-05-23

Changed

  • Migrated npm publishing from NPM_TOKEN authentication to npm Trusted Publishing with GitHub Actions OIDC.

1.0.1 - 2026-05-23

Fixed

  • Removed the direct push trigger from the main quality CI workflow while keeping pull request and manual runs.

1.0.0 - 2026-05-23

Changed

  • Rebuilt the runtime as a stdio bridge over upstream @playwright/mcp.
  • Replaced the native browser adapter, tool registry, capability model, artifact manager, origin policy, and custom browser tool implementations with upstream Playwright MCP forwarding.
  • Docker now uses mcr.microsoft.com/playwright/mcp:v0.0.75 as the runtime base.
  • npm publishing is now CLI-focused; no supported programmatic server API is exported.
  • Configuration now uses PLAYWRIGHT_MCP_* for upstream behavior and CLOAK_PLAYWRIGHT_MCP_* for Cloak-specific bridge toggles.
  • Documentation now leads with npm and Docker usage and groups development, testing, and architecture under contributor documentation.
  • The outer bridge supports stdio transport only; upstream HTTP/SSE transport is not proxied.
  • Upstream Playwright MCP contracts are authoritative and may change when the pinned upstream version changes.

Added

  • Generated Playwright MCP config that injects the CloakBrowser executable path into browser.launchOptions.executablePath.
  • MCP proxy that forwards upstream tool list and tool calls unchanged.
  • Local read-only introspection tools: cloakbrowser_binary_info and cloakbrowser_bridge_info.
  • Console message fallback patch promoted from the experiment into the bridge runtime.
  • Bridge-focused unit tests for environment parsing, config generation, launch args, and local tools.
  • Integration test that verifies forwarding through a fake upstream MCP child process.
  • Docker smoke and upstream parity comparison script.

Removed

  • Old CLOAKBROWSER_MCP_* environment aliases.
  • browser_get_config custom implementation, verify helpers, and capability-gated project extensions.
  • Native createServer, ToolRegistry, BrowserAdapter, MockBrowserAdapter, SessionManager, and related public exports.
  • Generated configuration documentation based on the removed native config schema.
  • Public SEO setup guide and stale roadmap page from the published documentation.