Dry-run should perform client-side validation to catch failures that actual publish would hit
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- typescript
调研方向
先阅读 src/services/dry-run-reporter.ts、src/services/override-merger.ts 和 src/lib/config-loader.ts,然后将 tests/test-overrides/extract-dryrun.log 与 extract.log 进行比较。跟踪 override 合并后的最终 payload,并确定 dry-run 如何报告 PUT 操作。完成标准是客户端检查输出提示性的 [DRY RUN] WARN 行,同时不阻止报告,也不改变其退出代码。
由索引模型根据 Issue 内容生成。
描述
Problem
The current --dry-run implementation only checks whether resources exist in the target APIM instance (GET to determine PUT vs create). It does not validate the merged payload, so dry-run reports success for resources that will fail during actual publish.
Evidence
Comparing tests/test-overrides/extract-dryrun.log (dry-run) vs tests/test-overrides/extract.log (actual publish), dry-run reported all resources as PUT while actual publish hit multiple HTTP 400 validation errors:
| Resource | Publish Error | Dry-run result |
|---|---|---|
namedvalue/src-nv-plain |
ValidationError — display name contains spaces/parens (invalid characters) |
✅ PUT |
namedvalue/src-nv-secret |
ValidationError — same display name issue |
✅ PUT |
namedvalue/src-nv-keyvault |
Managed identity clientId not found on target |
✅ PUT |
backend/src-backend-circuit-breaker |
failureCondition must not be empty |
✅ PUT |
backend/src-backend-function |
resourceId — "Value should represent absolute http URL" |
✅ PUT |
backend/src-backend-logicapp |
resourceId — same URL format issue |
✅ PUT |
logger/src-logger-appinsights |
Invalid instrumentation key | ✅ PUT |
logger/src-logger-eventhub |
HTTP 502/500 (connection string validation) | ✅ PUT |
diagnostic/applicationinsights |
Invalid loggerId reference |
✅ PUT |
diagnostic/azuremonitor |
Invalid loggerId reference |
✅ PUT |
Proposed Validations
The dry-run reporter should add client-side validation before reporting PUT. These checks should produce [DRY RUN] WARN lines without blocking the rest of the report. Suggested checks:
1. Named Value display name format
ARM rejects display names with spaces, parentheses, and other special characters. Validate against the pattern: ^[A-Za-z0-9._-]+$.
2. Resource ID format validation
resourceId fields on backends must be valid ARM resource IDs (starting with /subscriptions/). Currently, override values like bare paths pass through unchecked.
3. URL format validation
Backend url fields and API serviceUrl fields should be valid URLs with a scheme (https://, wss://, etc.).
4. Cross-resource reference validation (loggerId)
Diagnostics reference loggers by loggerId. Dry-run should verify the referenced logger exists either in the artifact set or in the target APIM instance. Same applies after override merging — if an override changes loggerId, validate the new value.
5. Circuit breaker rule completeness
ARM requires failureCondition when circuitBreaker.rules is specified. Validate that overrides don't produce partial circuit breaker configs.
6. Key Vault identity pre-check
When a named value references a Key Vault with identityClientId, verify that the identity is present on the target APIM service (the service's managed identities are available via the service resource GET).
7. Logger credential validation
Warn when logger credentials contain placeholder values (e.g., production-instrumentation-key-00000000) that are unlikely to be valid GUIDs or connection strings.
8. Override key validity
Warn when override properties don't match any known field in the resource's ARM schema (typo detection). For example, retryCondition vs the correct failureCondition nesting.
9. Dependency ordering warnings
When a resource depends on another resource that is itself invalid or skipped, warn that downstream resources will likely also fail.
Implementation Notes
- Validations should run after override merging, against the final payload that would be sent to ARM.
- Warnings should not change the exit code — they are advisory. Consider a
--strictflag that promotes warnings to errors. - These are client-side heuristics; ARM will always be the authoritative validator. The goal is to catch the most common mistakes early.
Related Files
src/services/dry-run-reporter.ts— main dry-run logicsrc/services/override-merger.ts— override mergingsrc/lib/config-loader.ts— override loading
- 主要语言
- TypeScript
- 星标
- 29
- 派生
- 10
- 平均合并
- 1 天 14 小时
- 30 天内合并 PR
- 22
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
Azure/apiops-cli 的其他 Issue
-
type:question
难度 2/5 1-3 小时 新手友好度 76/100
Azure/apiops-cli#277 ·
-
type:documentation
难度 1/5 1 小时以内 新手友好度 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
难度 2/5 1-3 小时 新手友好度 70/100
Azure/apiops-cli#24 · 1 条评论 ·
-
type:bug
难度 4/5 3-5 天 新手友好度 55/100
Azure/apiops-cli#291 ·
-
type:bug
难度 3/5 1-2 天 新手友好度 58/100
Azure/apiops-cli#276 ·
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
copse-dev/agent-pane#2953 ·
-
难度 2/5 1-3 小时 新手友好度 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
bug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
难度 2/5 1-3 小时 新手友好度 78/100
-
enhancement
难度 2/5 1-3 小时 新手友好度 68/100
-
calcite-components needs triage refactor
难度 2/5 1-3 小时 新手友好度 75/100
Esri/calcite-design-system#15203 ·