manifest.json

manifest.json

manifest.json

功能

manifest.json 是扩展包的身份和运行声明。它告诉 BT:这个包是不是 .bts 扩展、扩展叫什么、用什么后端运行、入口文件在哪里、最低 BT 版本是多少、需要哪些权限、单次调用允许传输多大的参数和返回值,以及扩展运行时模式。

语法

纯 BT 扩展示例:

WASM 扩展只需要把后端相关字段改为:

WASM shared runtime 配置示例:

参数

字段类型说明
formatString固定为 bts
format_versionNumber包格式版本,使用 1
nameString扩展包名称,只能使用小写字母、数字和下划线,并以小写字母开头。
versionString扩展自身版本,使用三段式 SemVer,例如 1.0.0
descriptionString可选说明文本。
authorString可选作者文本。
kindString后端类型,只能是 btwasm
abiString后端 ABI,必须和 kind 匹配。
bt_min_versionString扩展要求的最低 BT 版本。
api_versionNumberbindings 语义版本,使用 1
entryString后端入口文件的包内相对路径。
bindingsStringbindings 描述文件的包内相对路径。
permissionsArray扩展声明的能力权限数组。只写需要的权限;不需要的权限不要写。
limitsObject单次调用的参数和返回值编码大小上限。
runtimeObject可选运行时模式配置;缺省等同 mode: "thread_local"

kind 与 abi

kindabi含义
btbts-bt-1入口文件是 BT 源码,函数和对象方法由纯 BT Runner 执行。
wasmbts-wasi-1入口文件是 WASM 模块,调用通过 WASI P1 和 BtValueBinary 完成。

如果 kindabi 不匹配,扩展会在加载阶段报错。

runtime 运行时配置

字段类型默认值说明
modeStringthread_local运行时模式,只能是 thread_localshared
workersNumber1shared 模式 worker 数量,范围 1..=64
queue_limitNumber1024shared 模式等待队列长度,范围 1..=65536
call_timeout_msNumber30000shared 模式单次调用超时,范围 1..=300000
idle_ttl_msNumber300000shared 模式空闲保留时间,范围 1..=3600000
max_objectsNumber65536shared 模式服务级对象数量上限,范围 1..=65536
max_worker_objectsNumber4096shared 模式单个 worker 内对象数量上限,范围 1..=4096,且不能大于 max_objects
max_inflight_callsNumber64shared 模式执行中调用数量上限,范围 1..=4096

runtime 缺失时,扩展继续使用当前线程本地 Runner 缓存,不改变现有扩展行为。mode=shared 第一版只允许 kind=wasm,纯 BT 扩展声明 shared 会在 manifest 校验阶段报错。

当前版本已经接入项目级 ExtensionService。声明 mode=shared 的 WASM 扩展会创建独立有界 worker 队列,入口函数可以通过 worker 返回原始值或扩展对象;返回扩展对象时宿主会分配 host_object_id,对象方法调用前再路由回创建该对象的 worker 本地对象 ID。队列满、服务关闭、执行中调用超过上限、服务级对象数或单 worker 对象数超过上限时会返回中文错误。

call_timeout_ms 不只是调用线程等待上限。shared worker 会启用 Wasmtime epoch interrupt,超时后宿主会标记目标 worker、触发 WASM trap,并在 worker 返回后重建 WASM Store/Instance,避免超时调用永久占用服务容量。服务统计会包含 workersqueuedrunningcompletedfailedtimed_outobjects 和每个 worker 的对象数量。

权限说明

权限说明
fs_read允许声明读取文件路径参数。
fs_write允许声明写入文件路径参数。
net预留给网络通信能力声明。
http预留给 HTTP 客户端能力声明。
process预留给进程能力声明。
env预留给环境变量能力声明。

permissions 只能使用字符串数组,例如 ["fs_read", "fs_write"]。权限必须和运行进程的权限配置同时允许。扩展声明了某项权限,但运行进程禁止该能力时,扩展会加载失败。

返回值

manifest.json 不是脚本函数,没有运行时返回值。校验成功时,BT 会继续读取 bindings 和入口文件;校验失败时,加载过程返回中文错误并停止加载该扩展。

代码示例

纯 BT 扩展入口和 manifest 的对应关系:

manifest.entry 指向包含这段源码的 src/lib.btmanifest.kindbtmanifest.abibts-bt-1

注意事项

  • entrybindings 必须是包内安全相对路径,不能使用绝对路径、反斜杠、空路径、... 或带盘符的路径。
  • entry 不能和 bindings 指向同一个文件。
  • limits.max_args_byteslimits.max_result_bytes 不能为 0,也不能超过宿主硬上限。
  • runtime 中不能出现未知字段,避免扩展作者误以为未实现的配置已经生效。
  • runtime.mode=shared 不改变 BT 请求变量生命周期,也不会让普通脚本全局变量跨请求共享。
  • runtime.mode=shared 已支持扩展对象宿主路由;close()dispose() 标记为 lifecycle: "dispose" 且调用成功后,宿主对象句柄会失效。
  • runtime.mode=sharedcall_timeout_ms 会触发目标 worker 的 WASM 中断和运行态重建,不能用于长期阻塞宿主 hostcall 的精确取消。
  • 扩展名、入口名、参数名和方法名都应遵守 BT 的 snake_case 命名风格。