Improve Extract and Publish log readability
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 45/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- typescript
- Domínio
- cli
Direção de pesquisa
Comece por tests/integration/all-resource-types/basicv2-test.log e, em seguida, compare os caminhos de saída relevantes em src/cli/extract-command.ts, src/services/publish-service.ts, src/cli/publish-command.ts e src/clients/apim-client.ts. Rastreie como a extração, a publicação e as tentativas de retry registram seu trabalho atualmente. Considera-se concluído quando a saída abranger as melhorias propostas de agrupamento, temporização, resumo e contexto de retry, sem omitir APIs.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- TypeScript
- Estrelas
- 29
- Forks
- 10
- Merge médio
- 1d 14h
- PRs com merge (30d)
- 22
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de Azure/apiops-cli
-
type:question
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
Azure/apiops-cli#277 ·
-
type:documentation
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 94/100
Azure/apiops-cli#250 ·
-
Documentation P2
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Azure/apiops-cli#24 · 1 comentário ·
-
type:bug
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 55/100
Azure/apiops-cli#291 ·
-
type:bug
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 58/100
Azure/apiops-cli#276 ·
Todas as issues de Azure/apiops-cli
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
copse-dev/agent-pane#2953 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
[Bug]: Matrix progress drafts fail with "Matrix runtime not initialized" during tool activity Abertabug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
calcite-components needs triage refactor
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Esri/calcite-design-system#15203 ·