Skip to content

Conversation

@jefft0
Copy link
Contributor

@jefft0 jefft0 commented Dec 2, 2025

Resolves the final feature from #522 (comment) to fetch from vm/qdoc on the remote of the package is not available locally.

  • In the Documentable struct, add optional field doc
  • Define the ABCIQueryClient interface which is also implemented by RPCClient but only has ABCIQuery. (This will allow us to make a mock for testing.)
  • In resolveDocumentable, if the package isn't found locally, call ABCIQuery in the queryClient to query the vm/qdoc endpoint and set the doc field in Documentable
  • In WriteDocumentation, check if the Documentable has doc and use it (instead of building a new JSONDocumentation)
  • In cmd/gno, add config options remote and remoteTimeout (like in gnoweb). Use these to make an RPCClient to pass to ResolveDocumentable
  • In doc_test, define mockQueryClient and use it to test calling the queryClient

@Gno2D2
Copy link
Collaborator

Gno2D2 commented Dec 2, 2025

🛠 PR Checks Summary

🔴 Pending initial approval by a review team member, or review from tech-staff

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)
🔴 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: jefft0/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🔴 Requirement not satisfied
└── 🔴 If
    ├── 🔴 Condition
    │   └── 🔴 Or
    │       ├── 🔴 At least one of these user(s) reviewed the pull request: [jefft0 leohhhn n0izn0iz notJoon omarsy x1unix] (with state "APPROVED")
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🔴 Else
        └── 🔴 And
            ├── 🟢 This label is applied to pull request: review/triage-pending
            └── 🔴 On no pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

@codecov
Copy link

codecov bot commented Dec 2, 2025

Codecov Report

❌ Patch coverage is 80.00000% with 11 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
gnovm/pkg/doc/doc.go 76.92% 5 Missing and 4 partials ⚠️
gnovm/cmd/gno/doc.go 87.50% 1 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

@jefft0 jefft0 force-pushed the chore/gno-doc-fetch-vm-qdoc branch 4 times, most recently from b05b323 to e469d51 Compare December 3, 2025 16:36
@jefft0 jefft0 marked this pull request as ready for review December 3, 2025 16:56
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Dec 3, 2025
@jefft0 jefft0 marked this pull request as draft December 9, 2025 13:32
@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Dec 9, 2025
@jefft0 jefft0 force-pushed the chore/gno-doc-fetch-vm-qdoc branch from 6bf5830 to 1df25c2 Compare December 10, 2025 08:20
@jefft0 jefft0 marked this pull request as ready for review December 10, 2025 08:30
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Dec 10, 2025
@thehowl thehowl self-requested a review December 11, 2025 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📦 🤖 gnovm Issues or PRs gnovm related review/triage-pending PRs opened by external contributors that are waiting for the 1st review

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

2 participants