 抓取远程文件并可控落盘)
解析 Dagger TypeScript SDK 的 ClientHttpOpts 类型用 client.http() 抓取远程文件并可控落盘【免费下载链接】daggerAutomation engine to build, test and ship any codebase. Runs locally, in CI, or directly in the cloud项目地址: https://gitcode.com/GitHub_Trending/da/dagger本文围绕 Dagger v0.20 TypeScript SDK 参考文档中的ClientHttpOpts类型别名展开完整继承该参考页对authHeader、experimentalServiceHost、name、permissions四个可选属性的定义并结合仓库中引擎侧的 Go 源码core/schema/http.go、core/http.go剖析每个选项在 DAG 执行中的真实作用、默认值与版本边界读完即可理解client.http()如何把任意 URL 内容安全地转换为一个可挂载、可缓存的File对象。一、ClientHttpOpts 是什么ClientHttpOpts是 Dagger TypeScript SDK 中Client类方法http()的可选参数类型。官方 v0.20 参考文档将其定义为/** * ClientHttpOpts object */即一个纯对象类型别名其中所有属性均为optional可选。该类型由 SDK 的 codegen 流程从引擎的 GraphQL Schema 自动生成参考页位于 ClientHttpOpts 类型别名文档可在 api/client.gen 模块总览 的 Type Aliases 列表中找到它。对应地Client.http()的签名为见 Client 类参考文档http(url: string, opts?: ClientHttpOpts): File其语义是返回一个包含 HTTP 远程 URL 内容的File对象Returns a file containing an http remote url content。也就是说ClientHttpOpts控制的是下载回来的内容以什么文件名保存、什么权限落盘、用哪个 Secret 做鉴权、以及是否需要先启动一个 Service 才能访问该 URL这四件事。二、四个可选属性逐一解读v0.20 参考页完整定义了以下四个属性下面逐一继承原文档描述并结合源码展开。属性类型必填说明原文档描述authHeaderSecret否用于填充 Authorization HTTP 请求头的 SecretexperimentalServiceHostService否在抓取 URL 之前必须先启动的一个 Servicenamestring否文件使用的文件名默认为 URL 的最后一段permissionsnumber否设置到文件上的权限1.name文件名推导规则原文档说明File name to use for the file. Defaults to the last part of the URL.用于文件的文件名默认为 URL 的最后一段。引擎侧的推导逻辑在 httpPath 中实现可以确认具体行为若显式传了name直接使用该值否则用url.Parse解析 URL取filepath.Base(parsed.Path)作为文件名若解析结果为空、.或/例如 URL 以路径结尾则兜底使用index。这意味着对https://example.com/spec.json不传name时得到文件名为spec.json而对https://example.com/这样的裸 URL默认文件名会是index。需要稳定文件名例如后续用于.withNewFile挂载时建议显式指定name。2.permissions默认值 0600原文档仅说明Permissions to set on the file设置到文件上的权限。仓库源码给出了关键默认值在 httpSchema.http 中permissions : int(args.Permissions.GetOr(dagql.Int(0600)))即不传permissions时下载得到的File权限默认为0600仅属主可读写。这是一个偏保守的安全默认抓取到的远程内容默认不赋予执行位。若要产出可执行脚本如下载install.sh后直接运行应显式传入如0o755之类的权限值。3.authHeader以 Secret 形式注入 Authorization 头原文档说明Secret used to populate the Authorization HTTP header用于填充 Authorization HTTP 请求头的 Secret。注意其类型是 SDK 的Secret对象而非明文string这是 Dagger 的通用敏感信息处理约定凭证以不透明对象在 DAG 中传递落明文时才解密。从 resolveHTTPSessionContext 的源码可以看到引擎的处理方式先加载Secret再调用Plaintext(ctx)取出明文作为Authorization请求头的值。这使client.http()天然适配私有仓库、带 token 的制品下载等场景且凭证不会以字符串形式出现在 DAG 参数快照中。4.experimentalServiceHost先起服务再抓 URL原文档说明A service which must be started before the URL is fetched.在 URL 抓取前必须先启动的一个 Service。这个选项解决的是目标 URL 只存在于 Dagger 引擎内部网络的问题例如访问一个由 DAG 启动的本地 HTTP 服务。源码 resolveHTTPSessionContext 展示了完整机制加载传入的Service对象计算其ContentPreferredDigest通过svc.Hostname(ctx, svcDig)解析出该服务的内部主机名构造core.ServiceBinding{Service: svc, Hostname: host}调用svcs.StartBindings(...)启动绑定并返回一个detach函数用于请求结束后的资源清理。从源码结构看该绑定仅在单次请求生命周期内保持启动defer detach()不会污染会话中其他无关的网络命名空间。属性名带experimental前缀表示该能力在 v0.20 时代仍处于实验状态API 形态可能调整生产使用前应确认所用版本的稳定性。三、两条抓取路径有凭证走直连无凭证走惰性状态结合 core/schema/http.go 的实现client.http()在引擎侧并非总走同一条路径。在 http 解析函数 中可以清楚看到分支逻辑当authHeader或experimentalServiceHost任一被设置时引擎先解析会话上下文取 Secret 明文、启动服务绑定然后直接调用 core.FetchHTTPFile 完成一次同步抓取得到core.HTTPFetchResult定义见 core/http.go#L58两个选项都未设置时引擎改走_httpState内部对象路径——先构造一个仅记录url的HTTPState再在其上执行_resolve带checksum、permissions、name。从源码结构看这条路径是按会话解析一次resolve once per session的惰性/可持久化状态设计_httpState被标记为IsPersistable()使同一个 URL 的抓取结果可以在会话内被缓存复用而不是重复下载。两条路径最终都汇聚到newHTTPFileResult它用文件路径、权限、内容 digest、Last-Modified 与期望 checksum 做一次哈希得到该File的ContentDigest见 newHTTPFileResult。这解释了为什么改permissions、name或checksum会改变最终File的身份——它们都参与结果 digest 的计算。四、用法示例综合上述文档与源码事实ClientHttpOpts的典型用法如下基于 v0.20 API 面import { dag } from dagger.io/dagger // 1) 最简用法文件名取 URL 最后一段权限默认 0600 const readme dag.http(https://example.com/readme.txt) // 2) 显式控制文件名与权限下载可执行安装脚本 const installer dag.http(https://example.com/install.sh, { name: install.sh, permissions: 0o755, }) // 3) 带鉴权用 Secret 填充 Authorization 请求头 const token dag.setSecret(registry-token) const artifact dag.http(https://private.example.com/pkg.tar.gz, { authHeader: Bearer ${token.plaintext()}, name: pkg.tar.gz, }) // 4) 依赖 DAG 内启动的服务先起 Service再抓取其内部 URL const svc container.asService() const page dag.http(http://127.0.0.1:8080/health, { experimentalServiceHost: svc, })示例 3 中为保持简洁以plaintext()构造 Secret实际模块代码中更推荐直接用dag.setSecret(...)传入已知 Secret 对象避免明文流经函数参数。示例 4 的主机名解析由引擎依据 Service 内容 digest 自动完成svc.Hostname调用方无需手工绑定网络。五、版本边界v0.20 参考页与当前仓库源码的差异本文以 v0.20 的 ClientHttpOpts 参考页 为主体需向读者说明两处版本边界checksum属性的版本门控。v0.20 参考页只列出 4 个属性而当前仓库中生成的 TypeScript SDK 源文件 sdk/typescript/src/api/client.gen.ts#L2916-L2941 中同一类型多了一个可选的checksum?: stringExpected digest of the downloaded content (e.g., sha256:...)。对应地引擎 Schema 中该参数被注册为View(AfterVersion(v0.21.0))见 core/schema/http.go#L28-L29即 checksum 能力自 v0.21.0 起才对外可见。使用 v0.20 SDK 时不应依赖该字段在更新版本中checksum可强制校验下载内容 digest与newHTTPFileResult中的 digest 计算相配合构成供应链完整性校验的抓手。参考文档随版本归档。docs/versioned_docs/version-0.20/下的 API 参考是 v0.20 快照而仓库根部的 sdk/typescript 反映的是当前开发的 API 面。若以 v0.20 为基线做集成属性集合应以本文第二节的 4 属性表为准。六、小结ClientHttpOpts虽然只是一个四属性的对象类型别名但它完整表达了 Dagger 把网络抓取纳入不可变 DAG 的设计取向name与permissions决定落盘形态默认文件名取 URL 末段、默认权限 0600authHeader以Secret抽象承载凭证experimentalServiceHost则打通了引擎内服务 → HTTP 抓取的内部网络链路。理解了 core/schema/http.go 中直连/惰性双路径的分支与结果 digest 的构成你就能准确预测每次参数变化对缓存与File身份的影响并在 v0.20 及更新版本中稳妥地使用client.http()获取远程内容。【免费下载链接】daggerAutomation engine to build, test and ship any codebase. Runs locally, in CI, or directly in the cloud项目地址: https://gitcode.com/GitHub_Trending/da/dagger创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
