Improve Extract and Publish log readability
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- typescript
- 領域
- cli
調査の方向性
まず tests/integration/all-resource-types/basicv2-test.log から始め、次に src/cli/extract-command.ts、src/services/publish-service.ts、src/cli/publish-command.ts、src/clients/apim-client.ts 内の関連する出力パスを比較します。抽出、公開、リトライが現在どのように処理内容をログに記録しているかを追跡します。出力が、API を漏らすことなく、提案されたグループ化、タイミング、サマリー、リトライコンテキストの改善を網羅していれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Summary
Feedback on the integration test logs (tests/integration/all-resource-types/basicv2-test.log) identified several readability and usability improvements for the Extract and Publish command output.
Proposed Improvements
Extract Command (src/cli/extract-command.ts)
-
Group resources by dependency tier — The "Extracted N Type(s)" lines are a flat list with no visual hierarchy. Group by tier or add blank lines between categories.
-
List all APIs in the detail section — Currently only APIs with specs/operations are shown (7 of 12). APIs like
src-graphql-syntheticandsrc-a2a-weather-agentare silently omitted. List all APIs even if minimal. -
Add elapsed time to the Total line —
Total: 96 resources extracted, 0 errorsshould include duration (e.g.,in 12.3s).
Publish Command (src/services/publish-service.ts, src/cli/publish-command.ts)
-
Add tier/phase headers — All PUTs are a single flat stream. Since publish executes in dependency tiers, add headers:
── Tier 1: Independent resources (16) ── PUT namedvalue/src-nv-plain ... ── Tier 2: Resources with dependencies (2) ── PUT backend/src-backend-pool -
Add elapsed time — No indication of how long publish took or which resources were slow. Add per-tier or total timing.
-
Enrich the summary —
41 creates/updates, 0 deletes, 1 skippedcould also show total elapsed time and retry count (e.g., "6 retries across 2 resources").
Retry Logging (src/clients/apim-client.ts)
-
Round retry delay values —
retrying after 1175.1730686888397ms→retrying in 1.2s -
Include resource context in retry warnings — Currently no indication of which resource triggered the retry.
-
Include attempt number — e.g.,
(attempt 2/5)so readers know retry progress. -
Reduce retry noise in output — Retries interleave with PUT lines and break the flow. Consider grouping retries under their resource or suppressing intermediate retries (show only final outcome with retry count).
Files to Modify
src/cli/extract-command.ts— items 1–3src/services/publish-service.ts— items 4–6src/cli/publish-command.ts— items 5–6src/clients/apim-client.ts— items 7–10
Related
Based on review of tests/integration/all-resource-types/basicv2-test.log
- 主要言語
- TypeScript
- スター
- 29
- フォーク
- 10
- 平均マージ
- 1日 14時間
- マージ済み PR(30日)
- 22
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 ·
Azure/apiops-cli の issue をすべて見る
似ている issue
-
難易度 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 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
danielmiessler/LifeOS#2218 ·