Dry-run should perform client-side validation to catch failures that actual publish would hit

Đang mở
#147 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
api, cli

Hướng nghiên cứu

Bắt đầu bằng cách đọc src/services/dry-run-reporter.ts, src/services/override-merger.ts và src/lib/config-loader.ts, sau đó so sánh tests/test-overrides/extract-dryrun.log với extract.log. Theo dõi payload cuối cùng sau khi hợp nhất các override và xác định dry-run báo cáo các thao tác PUT như thế nào. Hoàn thành có nghĩa là các kiểm tra phía client phát ra các dòng [DRY RUN] WARN mang tính thông báo mà không chặn báo cáo hoặc thay đổi mã thoát của báo cáo.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Enhancement P2

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 --strict flag 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 logic
  • src/services/override-merger.ts — override merging
  • src/lib/config-loader.ts — override loading
Ngôn ngữ chính
TypeScript
Star
29
Fork
10
Merge trung bình
1 ngày 13 giờ
Pull request đã merge (30 ngày)
23

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/apiops-cli

Tất cả issue của Azure/apiops-cli

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.