fix(fs): harden guarded-create publication
This commit is contained in:
Tianyi Cui
@@ -2,5 +2,5 @@
|
||||
# side as of the last confirmed-consistent state. Both languages carry equal authority;
|
||||
# after editing either side, bring the other along and re-record with:
|
||||
# pnpm run verify-translation-pairing --write packages/e2b/fs-e2b/README.md
|
||||
README.md: 039ad72a9651a1e8907c2c63b8c83d113aedbb4e
|
||||
README.zh.md: be97bbd92edb528f9560518398a0cb70f36b992b
|
||||
README.md: 1b66e84defb56cbfaa4a91d6ba6b48377fb52ca9
|
||||
README.zh.md: d9cd3ce1e109bf6b0b7fae02157d1ec6be51e575
|
||||
|
||||
@@ -9,7 +9,7 @@ E2B implementation of the [`@deepseek-ai/dsh-fs`](../../fs/fs/README.md) provide
|
||||
- **Remote identity and metadata** — relative paths resolve as POSIX paths against the caller cwd or `ctx.e2b.cwd`; GNU `realpath -mz` supplies canonical target identity without requiring the final file to exist, and ASCII/base64 plus strict NUL framing preserves newline and multibyte paths across the decoded SDK transport. `stat`, no-follow `lstat`, and stable one-level directory listings project E2B metadata into the filesystem seam; listings reuse returned metadata and resolve symbolic-link entries sequentially. Versions are opaque hashes of E2B metadata plus a per-write extended attribute.
|
||||
- **Execution-world paths** — canonical targets expose absolute POSIX process paths, percent-encoded `file:` URIs, and provider-owned containment checks, so generic subprocess consumers never parse E2B target ids or apply host path rules.
|
||||
- **UTF-8 reads** — whole reads and streamed reads preserve cross-chunk decoding, reject invalid UTF-8, and use the seam's 8192-byte NUL sample for binary detection. The model-facing tool still owns size selection and line windowing.
|
||||
- **Atomic mutations** — writes create a random sibling staging directory, change it to mode `0700` before uploading content, and preserve an existing file's POSIX mode. Replacements publish through E2B's same-filesystem atomic rename. A guarded `createIfAbsent` publishes with remote `ln` instead, making the commit atomically no-replace; metadata read from the staged file before that commit is projected to the target path for the returned version, so no fallible metadata request follows either commit point. E2B creates missing parent directories. Literal edits LF-normalize for matching, restore dominant CRLF storage, and serialize mutations per canonical target within the host process.
|
||||
- **Atomic mutations** — writes create a random sibling staging directory, change it to mode `0700` before uploading content, and preserve an existing file's POSIX mode. Replacements publish through E2B's same-filesystem atomic rename. A guarded `createIfAbsent` publishes with remote `ln -T` instead, making the commit atomically no-replace even when a directory appears at the destination; metadata read from the staged file before that commit is projected to the target path for the returned version, so no fallible metadata request follows either commit point. E2B creates missing parent directories. Literal edits LF-normalize for matching, restore dominant CRLF storage, and serialize mutations per canonical target within the host process.
|
||||
- **Failures and cancellation** — E2B not-found, permission, abort, and other controller failures map to the existing `FsError` vocabulary. Cancellation is best-effort at earlier SDK request boundaries and checked immediately before publication. The signal is not forwarded into the rename or guarded-link commit, so cancellation cannot interrupt atomic publication or turn a committed write into a reported failure.
|
||||
|
||||
The provider does not copy, mount, or reconcile the host workspace. Giving it a host path as `cwd` creates a remote directory with the same spelling only.
|
||||
|
||||
@@ -9,7 +9,7 @@
|
||||
- **远程身份与元数据**：相对路径以调用方 cwd 或 `ctx.e2b.cwd` 为基准，按照 POSIX 路径解析；GNU `realpath -mz` 提供规范化目标身份，且不要求最终文件存在；ASCII/base64 加严格 NUL 分帧会在已解码的 SDK 传输中保留含换行符和多字节字符的路径。`stat`、不跟随链接的 `lstat` 和稳定的单层目录列表会把 E2B 元数据投影到文件系统 seam；目录列表会复用已返回的元数据，并依次解析符号链接条目。版本是 E2B 元数据与每次写入设置的扩展属性所组成的不透明哈希。
|
||||
- **执行世界路径**：规范化目标公开绝对 POSIX 进程路径、百分号编码的 `file:` URI，以及由提供方负责的包含关系检查，因此通用进程管理消费方无需解析 E2B 目标 ID，也不会套用宿主路径规则。
|
||||
- **UTF-8 读取**：完整读取和流式读取会保留跨分片解码、拒绝无效 UTF-8，并使用 seam 的 8192 字节 NUL 样本检测二进制内容。面向模型的工具仍负责选择大小和行窗口。
|
||||
- **原子变更**：写入会创建随机的同级暂存目录，在上传内容前将其 mode 改为 `0700`，并保留现有文件的 POSIX mode。替换操作通过 E2B 的同一文件系统原子重命名发布。带防护的 `createIfAbsent` 改用远程 `ln` 发布，使提交具备原子且不替换的语义；系统会把提交前从暂存文件读取的元数据投影到目标路径，以生成返回的版本，因此任何一类提交点之后都不会再进行可能失败的元数据请求。E2B 会创建缺失的父目录。字面量编辑匹配时会规范化为 LF，存储时恢复占主导的 CRLF，并在宿主进程内按规范化目标串行执行变更。
|
||||
- **原子变更**：写入会创建随机的同级暂存目录，在上传内容前将其 mode 改为 `0700`，并保留现有文件的 POSIX mode。替换操作通过 E2B 的同一文件系统原子重命名发布。带防护的 `createIfAbsent` 改用远程 `ln -T` 发布，即使目标位置出现目录，也能使提交具备原子且不替换的语义；系统会把提交前从暂存文件读取的元数据投影到目标路径，以生成返回的版本，因此任何一类提交点之后都不会再进行可能失败的元数据请求。E2B 会创建缺失的父目录。字面量编辑匹配时会规范化为 LF，存储时恢复占主导的 CRLF，并在宿主进程内按规范化目标串行执行变更。
|
||||
- **失败与取消**：E2B 的未找到、权限、中止及其他控制器故障会映射到现有 `FsError` 词汇。取消在更早的 SDK 请求边界上采用尽力而为语义，并在发布前立即检查。信号不会传入 rename 或防护链接提交，因此取消无法中断原子发布，也不会把已提交的写入报告为失败。
|
||||
|
||||
该提供方不会复制、挂载或协调宿主工作区。把宿主路径用作 `cwd`，只会在远程创建一个拼写相同的目录。
|
||||
|
||||
@@ -489,7 +489,7 @@ export class E2BFileSystem extends FileSystem {
|
||||
assertNotAborted(signal, 'write')
|
||||
const targetArg = quoteE2BShellArg(targetPath)
|
||||
const publication = await sandbox.commands.run(
|
||||
`if ln -- ${quoteE2BShellArg(temporary)} ${targetArg}; then printf created; elif test -e ${targetArg} || test -L ${targetArg}; then printf exists; else exit 1; fi`,
|
||||
`if ln -T -- ${quoteE2BShellArg(temporary)} ${targetArg}; then printf created; elif test -e ${targetArg} || test -L ${targetArg}; then printf exists; else exit 1; fi`,
|
||||
commandOpts(undefined),
|
||||
)
|
||||
if (publication.stdout === 'exists') {
|
||||
|
||||
@@ -52,7 +52,10 @@ class FakeRemote {
|
||||
nextRemoveError: unknown
|
||||
canonicalOutput: string | undefined
|
||||
abortAfterRename: AbortController | undefined
|
||||
competitorBeforeLink: { path: string; data: string } | undefined
|
||||
competitorBeforeLink:
|
||||
| { path: string; kind: 'file'; data: string }
|
||||
| { path: string; kind: 'directory' }
|
||||
| undefined
|
||||
guardedLinkOutput: string | undefined
|
||||
disappearOnInfo = new Set<string>()
|
||||
private clock = 1
|
||||
@@ -257,7 +260,7 @@ class FakeRemote {
|
||||
const chmod = /^chmod ([0-7]+) -- '([^']+)'$/.exec(command)
|
||||
if (chmod !== null) this.required(chmod[2]!).mode = Number.parseInt(chmod[1]!, 8)
|
||||
const guardedLink = new RegExp(
|
||||
"^if ln -- '([^']+)' '([^']+)'; then printf created; "
|
||||
"^if ln -T -- '([^']+)' '([^']+)'; then printf created; "
|
||||
+ "elif test -e '[^']+' \\|\\| test -L '[^']+'; then printf exists; else exit 1; fi$",
|
||||
).exec(command)
|
||||
if (guardedLink !== null) {
|
||||
@@ -269,7 +272,8 @@ class FakeRemote {
|
||||
return { exitCode: 0, stdout, stderr: '' }
|
||||
}
|
||||
if (this.competitorBeforeLink?.path === to) {
|
||||
this.file(to, this.competitorBeforeLink.data)
|
||||
if (this.competitorBeforeLink.kind === 'directory') this.dir(to)
|
||||
else this.file(to, this.competitorBeforeLink.data)
|
||||
this.competitorBeforeLink = undefined
|
||||
}
|
||||
if (this.nodes.has(to)) return { exitCode: 0, stdout: 'exists', stderr: '' }
|
||||
@@ -555,7 +559,7 @@ describe('E2BFileSystem atomic writes and edits', () => {
|
||||
|
||||
it('preserves a competitor created after the guarded-create probe', async () => {
|
||||
const remote = new FakeRemote()
|
||||
remote.competitorBeforeLink = { path: '/workspace/race.txt', data: 'competitor' }
|
||||
remote.competitorBeforeLink = { path: '/workspace/race.txt', kind: 'file', data: 'competitor' }
|
||||
const { fs } = await setup(remote)
|
||||
|
||||
await expectCode(
|
||||
@@ -567,6 +571,21 @@ describe('E2BFileSystem atomic writes and edits', () => {
|
||||
expect(remote.removals).toHaveLength(1)
|
||||
})
|
||||
|
||||
it('preserves a competing directory during guarded-create publication', async () => {
|
||||
const remote = new FakeRemote()
|
||||
remote.competitorBeforeLink = { path: '/workspace/race-dir', kind: 'directory' }
|
||||
const { fs } = await setup(remote)
|
||||
|
||||
await expectCode(
|
||||
fs.writeText(await fs.resolve('race-dir'), 'ours', { kind: 'createIfAbsent' }),
|
||||
'FS_NOT_OBSERVED',
|
||||
)
|
||||
expect(remote.nodes.get('/workspace/race-dir')?.type).toBe(FileType.DIR)
|
||||
expect(remote.nodes.has('/workspace/race-dir/content')).toBe(false)
|
||||
expect(remote.links).toHaveLength(0)
|
||||
expect(remote.removals).toHaveLength(1)
|
||||
})
|
||||
|
||||
it('rejects an invalid guarded-create publication response before claiming success', async () => {
|
||||
const remote = new FakeRemote()
|
||||
remote.guardedLinkOutput = 'unexpected'
|
||||
|
||||
Reference in New Issue
Block a user