refactor(config): lazy lookup interface for @elastic/config-resolver
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- typescript
调研方向
Start with the suggested TDD order: inspect the @elastic/config-resolver entry point and its tests, then review loader.ts, schema.ts, factory.ts, and extension/context.ts. Run the existing config tests to identify eager-resolution assumptions, including the skipContextResolve and resolveHelpConfig paths. Done means lazy memoized access, preserved validation and error codes, updated clients and tests, and passing npm test and lint.
由索引模型根据 Issue 内容生成。
描述
Summary
Refactor @elastic/config-resolver to expose a lazy, memoized lookup interface, and move the CLI's resolve-then-validate logic (resolveExpressions + post-resolution ContextSchema validation + the skipContextResolve special case) behind it. This is a standalone refactor of that library and the CLI code that consumes it; it is not tied to any feature work.
Motivation
Today loadConfig resolves every expression in the active context up front (resolveExpressions deep-walks the whole context and commands), then validates the resolved result with ContextSchema. That is all-or-nothing, and it has accumulated workarounds:
elastic es searchstill runs every$(cmd:...)/$(pass:...)in thekibanaandcloudblocks, even though onlyelasticsearchis used.- Command registration and
--helponly needelasticsearch.version/kibana.versionand the command policy. To avoid resolving secrets there (#706) we addedskipContextResolve, a cache exception, and a separate fast path inloader.ts(resolveHelpConfig) that reads raw YAML and skips validation. - That fast path reads
versionunresolved, soversion: $(env:ES_VERSION)is silently ignored when filtering help. - The
preActionhook resolves secrets before--dry-runis considered, so a dry run still spawns secret subprocesses.
Lazy per-field lookup removes the need for the special case and fixes the above.
Proposal
Add a lazy accessor to @elastic/config-resolver:
createLazyConfig(raw: object, opts?: {
leafValidators?: Record<string, (value: string) => string | undefined>
}): {
get(path: readonly string[]): string | undefined // resolve + validate leaf + memoize
peek(path: readonly string[]): unknown // raw, unresolved
}
- Array paths, not dotted strings (context names can contain dots).
- Memoized per path; concurrent
gets of the same path share one resolution. - Keep the existing
__proto__/constructorguard. - Errors keep the field path in the message, and the CLI maps them to the existing
config_unresolvederror.code(the code catalog is frozen).
CLI side:
loadConfigkeeps file discovery, YAML parsing, structural validation, context selection, profile precedence and the inline-secret permission warning. Only the resolve + validate steps and the result cache move behind the lazy accessor.ResolvedConfigbecomes a thin facade overget.- Delete
skipContextResolve,resolveHelpConfigand the associated cache exception.
Design decisions to settle
- Post-resolution validation.
ContextSchemacurrently validates the resolved context (e.g. URL scheme), sourl: $(cmd:...)could not pass it unresolved. This needs two layers: a raw-shape check that accepts expression strings, plus per-field leaf validators applied when a value is read (the URL scheme and non-empty rules currently inschema.ts). This is the largest piece of work. - Sync vs async. All seven built-in resolvers are synchronous (
execSync/readFileSync), butResolverFnallows promises. An asyncget()would makegetEsClient,getCloudClientandgetKbClientasync and ripple intofactory.ts. NarrowingResolverFnto sync would letResolvedConfigkeep its current shape with memoized lazy getters on secret-bearing leaves, so consumers would not change. The package isprivateat 0.1.2, so that break is cheap, but it drops async custom resolvers. Proposal: start sync. - Failure timing. A bad expression currently fails the command up front. Lazily it fails when the value is first read, inside the handler. Existing tests pin the old timing (e.g. "still fails when the active context has an unresolvable expression" in
test/config/loader.test.ts) and would need rewriting, each change called out explicitly. - Enumeration safety. A lazy config object must not fire every resolver (or leak values) when serialized or spread. Audit
status, theconfigcommands, andextension/context.ts(which referencesResolvedConfig; changing its shape may be an extension-facing API change). commandspolicy. Currently resolved like everything else; becomes a lazyget(['commands']).
Out of scope
- Moving file discovery, YAML/JSON parsing, structural validation, profile precedence or the permission warning out of the CLI. Only about a third of
loader.tsis affected. - Any startup-performance claim. The help-path ajv/YAML cost is already addressed separately; this refactor simplifies that code but is not expected to make it faster.
Suggested order of work (TDD)
- Lazy accessor in
config-resolverwith tests for memoization, concurrent access, error paths (field path preserved), and the prototype guard. - Leaf validators covering the rules
ContextSchemaenforces after resolution. - Switch
loadConfigand the three clients over; deleteskipContextResolveandresolveHelpConfig. - Rewrite tests that pin eager semantics, listing each change with justification.
Acceptance
- Reading
elasticsearch.*never runs resolvers forkibana.*orcloud.*. --helpand--dry-runnever run a secret resolver.version: $(env:...)is honoured for availability filtering.config_unresolvedis still emitted for unresolvable expressions, and no newerror.codestrings are introduced.npm testand lint pass; startup perf baselines are not regressed.
authored by Pi Coding Agent (Claude Opus 4.8)
- 主要语言
- TypeScript
- 星标
- 49
- 派生
- 27
- 平均合并
- 1 天 23 小时
- 30 天内合并 PR
- 67
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
elastic/cli 的其他 Issue
-
feat: ship skills/elastic/SKILL.md for agent invocation可能已有人在做 @onatozmenn 于 19 天前认领。 未关闭enhancement
难度 2/5 1-3 小时 新手友好度 88/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 3/5 1-2 天 新手友好度 38/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 58/100
维护者通常 1 天内回复
-
refactor(config): drop unused safeParse wrappers and stale Zod comments in config/schema.ts可能已有人在做 @JoshMock 于 1 天前认领。 未关闭
难度 3/5 半天 新手友好度 62/100
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
polarsource/polar#15580 ·
维护者通常 1 天内回复
-
accepted bug via-triage
难度 2/5 1-3 小时 新手友好度 69/100
pingdotgg/t3code#20931 · 1 条评论 ·
维护者通常 1 天内回复
-
bug/1-unconfirmed kind/bug
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 83/100
-
难度 2/5 1-3 小时 新手友好度 72/100
ranxianglei/billion-context#3583 ·
维护者通常 1 天内回复