fix: adopt upstream mirror spec, break the format/drift loop, harden … - #119
Conversation
…the weekly canary Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
Coverage Report for core / integration (./packages/core)
File CoverageNo changed files found. |
Coverage Report for core / unit (./packages/core)
File CoverageNo changed files found. |
Coverage Report for mirror / unit (./packages/mirror)
File CoverageNo changed files found. |
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
|
Warning Review limit reached
Next review available in: 49 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughChangesThe PR improves topic message integration-test diagnostics and timeout handling, updates mirror specification metadata and example timeout configuration, and normalizes GitHub issue-template YAML formatting. Topic delivery integration tests
Mirror metadata and example configuration
Issue template formatting
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
This PR updates the repo’s mirror-node integration to align with the latest upstream OpenAPI snapshot, reduces recurring “spec drift” noise caused by formatting, and hardens CI-facing canaries/tests against transient mirror slowness.
Changes:
- Ignore the vendored mirror OpenAPI spec in Prettier to prevent format-induced spec drift, and update the tracked upstream snapshot reference.
- Increase the public-mainnet examples canary timeout to reduce false failures from slow mirror responses.
- Harden
TopicMessageQueryintegration tests with longer time budgets, extra subscription retries, and improved diagnostics.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| samples/examples/tsconfig.json | Prettier-style formatting only. |
| samples/examples/src/mirror/queries.ts | Increases mirror client timeout for the weekly public-mainnet canary example. |
| packages/mirror/spec/SNAPSHOT | Updates the recorded upstream spec snapshot identifier. |
| packages/core/test/integration/topic/queries/TopicMessageQuery.spec.ts | Adds longer test timeouts, increased subscribe retries, and new delivery-wait diagnostics. |
| .prettierignore | Ignores vendored packages/mirror/spec/openapi.yml to prevent format drift. |
| .github/ISSUE_TEMPLATE/feature.yml | Reformatting of issue template YAML. |
| .github/ISSUE_TEMPLATE/config.yml | Quotes emoji-like strings in YAML and reformats. |
| .github/ISSUE_TEMPLATE/bug.yml | Reformats YAML; also contains a few text issues (typos/URL) needing fixes. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 26489c8d-6a21-468e-b684-e5771a3951b8
⛔ Files ignored due to path filters (1)
packages/mirror/spec/openapi.ymlis excluded by!packages/mirror/spec/openapi.yml
📒 Files selected for processing (8)
.github/ISSUE_TEMPLATE/bug.yml.github/ISSUE_TEMPLATE/config.yml.github/ISSUE_TEMPLATE/feature.yml.prettierignorepackages/core/test/integration/topic/queries/TopicMessageQuery.spec.tspackages/mirror/spec/SNAPSHOTsamples/examples/src/mirror/queries.tssamples/examples/tsconfig.json
Signed-off-by: exploreriii <133720349+exploreriii@users.noreply.github.com>
8ef7e91 to
c6c8636
Compare
Fixes #117
Fixes #118
The spec api-line drift in #117 was 99% formatting noise: parsed and compared structurally, the real change is one new field (AccountInfo.delegation_address — already in our types) plus nullability corrections. Spec refreshed byte-for-byte with the new fields, SNAPSHOT → 1e188c0.
Root cause fixed: the drift watcher byte-diffs the vendored spec, but prettier wasn't ignoring it — every pnpm format manufactured fake drift. The vendored spec is now in .prettierignore.
Also: the weekly canary (#118) failed on a transient mirror slow spell, not drift — it now uses timeoutMs: 30_000 so it alerts on real problems, not one slow day. Plus pre-existing prettier debt cleaned (config.yml had unquoted :emoji: YAML, three files unformatted).