Fetch Logpush dataset pages from middlecache - #33248
soheiokamoto wants to merge 1 commit into
Conversation
Review💡 2 suggestions found in commit 👉 Fix in your agent 👈Fix the following review findings in PR #33248 (https://github.com/cloudflare/cloudflare-docs/pull/33248).
Before making changes, review each finding and present a brief summary table:
- For each finding, state whether you agree, disagree, or need clarification
- If you disagree (e.g. the fix requires disproportionate effort for minimal benefit,
or the finding is factually incorrect), explain why
- If you need clarification before deciding, ask those questions
- Then share your plan for which issues to tackle and in what order
After triaging, follow this order:
1. Post a comment on this PR for any findings you are skipping, with the finding ID and your reasoning.
2. Then commit the fixes for the legitimate findings.
The comment must come before the commit — the bot reads PR comments when a new
push triggers a review, so skip comments posted after the push will be missed.
---
## Code Review
### Suggestions (2)
#### CR-f7b9071876b4 · Redundant archive listing / pointless async
- **File:** `bin/fetch-logpush-datasets.ts` line 127
- **Issue:** `validateArchive` is declared `async` but contains no awaited operation (only synchronous `spawnSync`), and the identical `tar -tzf` member listing is performed again inside `extractTarGz` at line 180, so every archive is fully listed twice per run.
- **Fix:** Drop the `async` modifier (or actually await something), and consider whether the duplicate `tar -tzf` pass in `extractTarGz` makes the pre-download validation redundant — at minimum note that the listing runs twice.
#### CR-0c78590fe25a · Silently ignored archive files
- **File:** `bin/fetch-logpush-datasets.ts` line 190
- **Issue:** Only flat `scope/page.md` paths in unseeded scopes produce the `skippedArchiveScopes` warning. Top-level `.md` files and `.md` files nested inside unseeded scopes (e.g. `newscope/sub/page.md`) are filtered out with no warning at all, so an unexpected change to the archive layout can silently drop content from the sync.
- **Fix:** Extend the warning to cover all ignored archive `.md` files (or fail loudly for unexpected top-level/nested entries), so a layout change in the middlecache archive is visible instead of silent.
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. Suggestions (2)
ConventionsNo convention issues found. Style Guide ReviewNo style-guide issues found. CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
7a8435c to
84de696
Compare
🚀 Deploying Preview to Cloudflare 🚀Preview URL: https://sohei-ds-17240-fetch-logpush-docs.previews.developers.cloudflare.com (commit dab4ffd)This URL reflects your latest Preview deploymentPreview Deployments by commit
View all previews: View all previews ↗ |
|
Preview URL: https://e131148c.preview.developers.cloudflare.com |
84de696 to
b02f2bd
Compare
|
Review triage before the next push:
|
c8a3704 to
198984b
Compare
|
Review triage:
No changes are planned for these findings. |
198984b to
6c13530
Compare
|
Review triage for commit
|
6c13530 to
830c0fb
Compare
|
Skipping |
830c0fb to
4059864
Compare
|
Skipping Skipping |
4059864 to
ecd3f45
Compare
|
Skipping Skipping Skipping |
e131148 to
944ea8a
Compare
|
CI run failed: build logs |
|
Skipping Skipping Skipping |
8bc2048 to
4d030a2
Compare
|
Skipping Skipping |
|
Review disposition for commit
Please treat the two documented design decisions as acknowledged, not as warnings or blockers in subsequent reviews. |
1f8a233 to
c58ab5a
Compare
|
Review disposition for commit
Please treat the two intentional wiring decisions as acknowledged rather than warnings or blockers in subsequent reviews. |
5e9a1e4 to
5c30d11
Compare
|
Review disposition for commit
Please preserve these two recurring design decisions as acknowledged in subsequent reviews rather than raising new equivalent findings. |
5c30d11 to
d8c053e
Compare
|
Review disposition for commit
|
d8c053e to
cbe1049
Compare
|
Skipping
Please treat this safety behavior as acknowledged and do not raise missing-target or missing-route soft-mode success as a blocker in subsequent reviews. |
|
/review |
|
Review disposition for commit
Please treat the concurrency scope and build-only wiring as acknowledged design constraints in subsequent reviews. |
cbe1049 to
86ce2a6
Compare
|
Pre-push simplification note:
This is a reduction-only pass. It does not change the acknowledged build-only wiring or strict managed-layout policy. |
86ce2a6 to
2188729
Compare
|
/review |
2188729 to
2c15d32
Compare
|
/review |
|
Skipping
Please treat rollback after any pre-success failure as an acknowledged transaction boundary rather than limiting restoration to transport failures. |
|
/review |
|
Skipping Logpush synchronization updates tracked documentation pages, unlike the gitignored assets refreshed by the existing soft This behavior was previously documented for equivalent findings |
|
/review |
|
Superseding my earlier disposition for The next push resolves the suggestion by removing |
Fetch validated Logpush dataset pages from middlecache during docs builds while retaining checked-in pages as a safe fallback. - Verify archive downloads before replacing pages - Sync generated Markdown into existing dataset scopes and remove stale pages - Abort replacements that would remove all managed pages - Refresh the archive on every development and build run - Correct the documented product metadata directory - Require a separate manual changelog when a dataset change needs a customer-facing announcement
2c15d32 to
dab4ffd
Compare
|
/review |
|
Closing this PR in favor of the already merged one: #33401 This PR had some prevention of stale or malformed generated documentation during future archive changes or partial failures, but will create a follow-up PR if needed. |
Summary
Fetch and validate generated Logpush dataset pages from middlecache during docs builds without affecting development startup.
Screenshots (optional)
Not applicable.
Documentation checklist