@coboot/headless 0.2.2-rc.1 → 0.2.2-rc.2

package/README.md

@@ -1,31 +1,85 @@
 # Coboot Headless
 
-Node.js 20+ 的无浏览器后台运行包。首次启动只需一次性设备 token：
+Node.js 20+ 的无 GUI 后台运行包。本包不携带浏览器二进制，也不会自动下载浏览器。
+首次启动只需一次性设备 token：
 
 ```bash
-npx -y @coboot/headless@0.2.2-rc.1 '<device-token>'
+npx -y @coboot/headless@0.2.2-rc.2 '<device-token>'
 ```
 
 命令会把运行时安装到 `/data/coboot/.siboot`，在客户端鉴权和运行时初始化完成后启动
-detached daemon 并退出。不需要设置 `BACKEND_URL`、`CLIENT_UID`，也不需要安装 Chromium。
+detached daemon 并退出。不需要设置 `BACKEND_URL`、`CLIENT_UID`。终端、文件等非浏览器能力不要求
+目标机安装 Chromium。
 
 ```bash
-npx -y @coboot/headless@0.2.2-rc.1 status
-npx -y @coboot/headless@0.2.2-rc.1 logs
-npx -y @coboot/headless@0.2.2-rc.1 restart
-npx -y @coboot/headless@0.2.2-rc.1 stop
+npx -y @coboot/headless@0.2.2-rc.2 status
+npx -y @coboot/headless@0.2.2-rc.2 logs
+npx -y @coboot/headless@0.2.2-rc.2 restart
+npx -y @coboot/headless@0.2.2-rc.2 stop
 ```
 
-默认数据根目录可通过 `SIBOOT_DATA_ROOT` 修改。daemon 默认禁用 updater 和浏览器预热。
+默认数据根目录可通过 `SIBOOT_DATA_ROOT` 修改。该设置不会写入配置，首次安装以及后续的
+`status`、`logs`、`restart`、`stop` 都必须传入同一个值，否则 CLI 会操作 edition 默认目录。
+
+
+## Coboot 浏览器
+
+Coboot daemon 默认禁用 updater 和浏览器预热，第一次调用 `browser_*` 时才解析系统浏览器。
+没有可用浏览器时，浏览器工具会提醒 Agent 让用户手工安装；daemon、设备注册以及终端、文件等
+非浏览器能力继续正常工作。浏览器不在常见系统路径时，应在启动或重启 daemon 时显式指定：
+
+```bash
+HEADLESS_BROWSER_EXECUTABLE=/absolute/path/to/chrome \
+  npx -y @coboot/headless@0.2.2-rc.2 '<device-token>'
+```
+
+需要安装浏览器时，由用户执行：
+
+```bash
+npx -y @coboot/headless@0.2.2-rc.2 install-browser
+```
+
+该命令不需要设备 token，也不要求 root。它会先检查现有浏览器并执行启动验证；浏览器已经可用时
+不做任何安装。需要安装时：
+
+- **root**：先用系统包管理器把 Chromium 或 Chrome 及其系统依赖装到标准路径，对该机器上所有用户
+  生效。镜像没有可用包管理器、源里没有 Chromium 或机器离线时，自动回退到下面的下载安装。
+- **非 root**：直接下载安装，不需要 sudo。
+
+下载安装用包内 `playwright-core` 把 Chromium 取到 `/data/coboot/.siboot/browsers`，需要访问
+`cdn.playwright.dev`。这个目录不是用户 HOME，daemon 启动时会指向同一个路径，因此换一个账号跑
+daemon 也不会失配，也不需要设置任何环境变量。用 `PLAYWRIGHT_BROWSERS_PATH` 可以改写该路径，
+但改写后启动或重启 daemon 必须带上同一个值。
+
+两条路径最后都会用包内 `playwright-core` 按 daemon 的真实启动参数做一次启动检查，因此可以安全
+重复执行。如果检查报告缺少系统动态库（`libnss3.so`、`libgbm.so.1` 等），补齐系统依赖必须有 root
+权限，此时才需要用 `sudo` 重新执行同一条命令。
+
+如果执行时 daemon 正以另一个账号运行，命令会打印告警：下载目录归当前用户所有，daemon 可能无权
+读取。此时改用 daemon 所属账号重跑，或用 root 执行让浏览器落到系统路径。
+
+标准路径安装完成后可直接重试 `browser_*`，无需重启 daemon。如果通过
+`HEADLESS_BROWSER_EXECUTABLE` 指定非标准路径，则必须带该环境变量启动或重启 daemon。运行时会把
+浏览器缺失、可执行文件不存在以及各类系统动态库缺失转换为要求 Agent 提醒用户手工执行安装命令的
+指引，不允许 Agent 自动修改系统软件包。
+
+包名在各发行版并不统一，因此 root 路径按顺序尝试多个候选，任一成功即停止：Debian/Ubuntu 依次
+尝试 `chromium`、`chromium-browser`，x86_64 最后回退到 Google 官方 `google-chrome-stable`
+deb（Ubuntu 归档没有 `chromium` deb，只有指向 snap 的 `chromium-browser`，容器内不可用）；
+dnf/yum 先试仓库中的 `chromium`，x86_64 回退到官方 RPM 并关闭 weak dependencies；Alpine 使用
+仓库中的 `chromium`，必要时补 community 源。`apt-get update` 失败不会中断安装，本地 deb 回退
+仍会执行。目标网络需要能够访问对应发行版仓库或 `dl.google.com`。
+
 
 已有设备凭证无效或需要切换设备身份时，显式重新注册：
 
 ```bash
-npx -y @coboot/headless@0.2.2-rc.1 --force-enroll '<device-token>'
+npx -y @coboot/headless@0.2.2-rc.2 --force-enroll '<device-token>'
 ```
 
 命令会先停止 daemon 并临时备份旧凭证；新凭证和客户端均就绪后才完成替换，失败时恢复旧凭证。
 
+
 ## Linux 沙箱
 
 当 `package.json` 的 `headlessLinuxSandbox` 不为 `null` 时，包内已携带 Linux x64/arm64 的
@@ -33,21 +87,22 @@ bubblewrap、musl loader 和 libcap，不要求目标机器额外安装 `bwrap`
 包内运行时，失败后再探测系统 `$PATH` 中的 `bwrap`；两者都不可用或内核禁止 user/mount
 namespace 时，会记录原因并按兼容策略使用普通 Node 进程。
 
-日志中的 `source=bundled` 表示已经选择包内运行时。Linux Headless 的 Bash 使用当前会话
-`COBOOT_WORKSPACE/.home` 作为 `HOME`，并清理 `BASH_ENV` / `ENV`，不会读取宿主账号的 shell
-启动脚本。
+日志中的 `source=bundled` 表示已经选择包内运行时。Coboot Linux Headless 仅在当前命令已经解析出
+session 级 `COBOOT_WORKSPACE` 时，将 `COBOOT_WORKSPACE/.home` 作为 Bash 的 `HOME`；如果没有
+session workspace，则删除继承的 `HOME`。两种情况都会清理 `BASH_ENV` / `ENV`，不会读取宿主
+账号的 shell 启动脚本。
 
 Coboot Linux Headless 会把整个 `SIBOOT_DATA_ROOT`（默认 `/data/coboot`）作为可写根，其中
 `.siboot` 运行状态目录仍由 hard deny 遮蔽。这同时允许访问同机其他 team/agent/session 的数据，
 只适用于部署侧接受该权限边界的独占目标机；结构化文件工具仍继续执行自身的 ACL。
 
+
 ## 运行环境
 
 - Edition：`coboot`，在构建期写入，启动时不能切换。
 - 默认 HTTP 服务：`https://www.coboot.com`。
 - 默认 WebSocket 服务：`wss://www.coboot.com/wsschat`。
 - 默认数据根目录：`/data/coboot`。
-- 包不携带浏览器、Chromium、`playwright-core` 或 updater，不能用于浏览器工具。
 
 npm CLI 默认清理父进程遗留的 endpoint 环境变量。仅本地联调或自建环境可显式开启覆盖，且
 HTTP 与 WebSocket 必须同域并与设备 token 匹配：
@@ -56,10 +111,11 @@ HTTP 与 WebSocket 必须同域并与设备 token 匹配：
 HEADLESS_ALLOW_ENDPOINT_OVERRIDE=1 \
 BACKEND_URL=https://example.com \
 WS_URL=wss://example.com/wsschat \
-npx -y @coboot/headless@0.2.2-rc.1 '<device-token>'
+npx -y @coboot/headless@0.2.2-rc.2 '<device-token>'
 ```
 
 WebSocket 覆盖变量名是 `WS_URL`，不是 `WSS_URL`。
+endpoint 覆盖同样不会写入配置；后续执行 `restart` 时必须再次传入完整的覆盖变量。
 
 ## 维护者构建与发布
 
@@ -69,26 +125,45 @@ WebSocket 覆盖变量名是 `WS_URL`，不是 `WSS_URL`。
 CU_EDITION=coboot \
 PKG_NAME=@coboot/headless \
 PKG_BIN_NAME=coboot-headless \
-PKG_VERSION=0.2.2-rc.1 \
+PKG_VERSION=0.2.2-rc.2 \
 pnpm build:headless:npm
 ```
 
-发布前核对包内清单、元数据和哈希：
+构建完成后核对包内清单、元数据和哈希：
 
 ```bash
 npm pack --dry-run --json ./dist-headless
-tar -xOf dist-headless/coboot-headless-0.2.2-rc.1.tgz package/package.json
-sha256sum dist-headless/coboot-headless-0.2.2-rc.1.tgz
+tar -xOf dist-headless/coboot-headless-0.2.2-rc.2.tgz package/package.json
+sha256sum dist-headless/coboot-headless-0.2.2-rc.2.tgz
 ```
 
-确认后把 RC 发布到 `next` tag：
+
+Coboot 公网包通过仓库内发布脚本构建、扫描并发布。先执行 dry-run：
 
 ```bash
-npm publish ./dist-headless/coboot-headless-0.2.2-rc.1.tgz \
-  --registry=https://registry.npmjs.org/ \
-  --access public \
-  --tag next
+pnpm release:headless:npm:coboot -- \
+  --version <new-version> \
+  --tag next \
+  --dry-run
 ```
 
-`.tgz` 属于本地构建产物，不提交 Git；只发布已经完成上述核对的 tarball。`device-token` 是
-Coboot 生成的一次性设备注册 token，不是 npm token，也不要发送给其他人。
+确认 dry-run 的包清单、哈希和 `npm publish --dry-run` 均通过后，去掉 `--dry-run` 重新执行。
+脚本会再次构建和检查产物，并要求输入完整版本号后才进行真实发布。稳定版本应使用 `latest` tag。
+
+
+注意：
+
+- `package.json` 里的 `headlessBackendUrl` / `headlessWsUrl` 只是可核对的冗余标记；运行时
+  取值来自 `entry.mjs` 的编译期常量，改这两个字段不会改变客户端连接的服务端。
+- npm CLI 默认清理父进程遗留的 endpoint 环境变量，正式包始终使用 edition 对应地址。
+  本地联调或自建环境必须同时设置 `HEADLESS_ALLOW_ENDPOINT_OVERRIDE=1` 和匹配的
+  `BACKEND_URL` / `WS_URL`；HTTP 与 WebSocket 必须同域，否则 Access Token 会被
+  `isTrustedHeadlessAuthTarget` 拒绝。WebSocket 变量名是 `WS_URL`，不是 `WSS_URL`。
+- 切换 pre / test 环境需要重新构建或显式覆盖 `BACKEND_URL` / `WS_URL`；无论哪种方式都必须
+  确认 token 与地址匹配。
+- 同版本重新构建会复用文件名。分发前必须用 SHA-256 区分新旧包；安装流程会停止旧 daemon，
+  原子替换同版本 release 中的运行文件后重新启动。
+- `.tgz` 属于本地构建产物，不提交 Git；只从干净的 `dist-headless` 目录发布已经完成上述核对
+  的 tarball。
+- `device-token` 是 Coboot 生成的一次性设备注册 token，不是 npm token，也不要发送
+  给其他人。

package/browser-runtime/playwright-core/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Portions Copyright (c) Microsoft Corporation.
+   Portions Copyright 2017 Google Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/browser-runtime/playwright-core/NOTICE

@@ -0,0 +1,5 @@
+Playwright
+Copyright (c) Microsoft Corporation
+
+This software contains code derived from the Puppeteer project (https://github.com/puppeteer/puppeteer),
+available under the Apache 2.0 license (https://github.com/puppeteer/puppeteer/blob/master/LICENSE).

package/browser-runtime/playwright-core/README.md

@@ -0,0 +1,3 @@
+# playwright-core
+
+This package contains the no-browser flavor of [Playwright](http://github.com/microsoft/playwright).