Adopt graphql_client codegen for typed GraphQL queries #196
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,27 @@ | ||||||||
| # GraphQL schema and query documents | ||||||||
|
|
||||||||
| This directory holds the vendored GitHub GraphQL schema and the query documents | ||||||||
| that `graphql_client` codegen validates against it at compile time (see | ||||||||
| [ADR 001](../docs/adr-001-github-api-client-modernisation.md)). | ||||||||
|
|
||||||||
| ## Contents | ||||||||
|
|
||||||||
| - `schema.docs.graphql` — GitHub's published public schema (free, pro, | ||||||||
| and team plans). This is third-party generated data, not project source; do | ||||||||
| not edit it by hand. | ||||||||
| - `*.graphql` — one document per operation group. Each document is named | ||||||||
| after the operation(s) it contains and is referenced by a | ||||||||
| `#[derive(GraphQLQuery)]` item in `src/`. | ||||||||
|
|
||||||||
| ## Refreshing the schema | ||||||||
|
|
||||||||
| Download the current published schema and re-run the test suite; any query the | ||||||||
| new schema no longer satisfies fails the build: | ||||||||
|
|
||||||||
| curl -L https://docs.github.com/public/fpt/schema.docs.graphql \ | ||||||||
| -o graphql/schema.docs.graphql | ||||||||
| make lint test | ||||||||
|
Comment on lines
+21
to
+23
There was a problem hiding this comment. 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win Replace the indented code block with a fenced block that carries a language identifier. The refresh commands use a four-space indented block. Markdown code blocks must be fenced and must declare a language identifier. Triage: 📝 Proposed fix- curl -L https://docs.github.com/public/fpt/schema.docs.graphql \
- -o graphql/schema.docs.graphql
- make lint test
+```bash
+curl -L https://docs.github.com/public/fpt/schema.docs.graphql \
+ -o graphql/schema.docs.graphql
+make lint test
+```As per coding guidelines: "Follow markdownlint recommendations in documentation" and "Always provide a language identifier for fenced code blocks". 📝 Committable suggestion
Suggested change
🤖 Prompt for AI AgentsSource: Coding guidelines |
||||||||
|
|
||||||||
| Record the refresh (date and reason) in the commit message. GitHub evolves the | ||||||||
| schema additively, so refreshes are expected to be safe; a build failure after | ||||||||
| a refresh means GitHub removed or renamed something a query relies on. | ||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| query IssueQuery($owner: String!, $name: String!, $number: Int!) { | ||
| repository(owner: $owner, name: $name) { | ||
| issue(number: $number) { | ||
| title | ||
| body | ||
| } | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| query PrForBranchQuery($owner: String!, $name: String!, $headRef: String!) { | ||
| repository(owner: $owner, name: $name) { | ||
| pullRequests(headRefName: $headRef, first: 10, states: [OPEN, MERGED]) { | ||
|
There was a problem hiding this comment. 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Description: Inspect the branch pull-request selection logic.
fd -t f 'mod.rs' -p 'branch_pr' --exec cat -n {}
rg -n -C5 'PrForBranchQuery|pr_for_branch_query' --type=rustRepository: leynos/vk Length of output: 244 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- candidate files ---'
git ls-files | rg '(^|/)(graphql|.*branch.*pr|.*pr.*branch).*' | head -200
printf '%s\n' '--- query references ---'
rg -n -C6 'PrForBranchQuery|pr_for_branch|pullRequests\(headRefName|headRefName' --glob '*.rs' --glob '*.graphql' .Repository: leynos/vk Length of output: 21112 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- consumer ---'
cat -n src/branch_pr/mod.rs | sed -n '111,160p'
printf '%s\n' '--- connection arguments ---'
cat -n graphql/schema.docs.graphql | sed -n '4425,4485p'
printf '%s\n' '--- query and related tests ---'
cat -n graphql/pr_for_branch.graphql
cat -n src/branch_pr/tests.rs | sed -n '320,390p'
printf '%s\n' '--- pagination conventions ---'
rg -n -C4 'orderBy:|pageInfo|hasNextPage|first: 10|pullRequests' graphql src tests --glob '*.graphql' --glob '*.rs' | head -240Repository: leynos/vk Length of output: 19128 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- pullRequests field definitions ---'
rg -n -B18 -A25 '^ pullRequests\(' graphql/schema.docs.graphql
printf '%s\n' '--- IssueOrder definition ---'
rg -n -B8 -A35 '^input IssueOrder|^enum IssueOrderField|^enum OrderDirection' graphql/schema.docs.graphql
printf '%s\n' '--- branch lookup documentation and tests ---'
rg -n -C5 'head_owner|head owner|cross-repository|first PR|first.*PR|branch.*PR' src/branch_pr tests graphql/README.mdRepository: leynos/vk Length of output: 21794 🏁 Script executed: #!/bin/bash
set -eu
printf '%s\n' '--- repository pullRequests arguments ---'
cat -n graphql/schema.docs.graphql | sed -n '53870,53945p'
printf '%s\n' '--- operation schema compatibility probe ---'
python3 - <<'PY'
from pathlib import Path
schema = Path("graphql/schema.docs.graphql").read_text()
query = Path("graphql/pr_for_branch.graphql").read_text()
start = schema.index(" pullRequests(", schema.index("type Repository"))
end = schema.index(" ): PullRequestConnection", start) + len(" ): PullRequestConnection")
field = schema[start:end]
print("query_has_orderBy =", "orderBy:" in query)
print("repository_field_has_orderBy =", "orderBy:" in field)
print("repository_field_has_headRefName =", "headRefName:" in field)
print("repository_field_has_first =", "first:" in field)
print(field)
PYRepository: leynos/vk Length of output: 3425 🌐 Web query:
💡 Result: The GitHub GraphQL API handles repository pull requests through the PullRequestConnection object, which supports ordering and pagination [1]. Ordering: You can specify the ordering of pull requests using the orderBy argument on the pullRequests field [2][3]. This argument accepts an object of type PullRequestOrder [4], which requires a field (e.g., CREATED_AT, UPDATED_AT) and a direction (ASC or DESC) [5][3]. While specific documentation on the absolute default ordering may vary, it is standard practice in GitHub's API to explicitly define your orderBy object to ensure consistent results [5][2][6]. Pagination: GitHub's GraphQL API uses cursor-based pagination for connections [7][8]. 1. Arguments: You must provide either first or last (with a maximum value of 100 per request) [8][9]. 2. Cursor Navigation: To fetch subsequent pages, use the after argument with the endCursor from the current page's pageInfo object [7][8]. If using last, use the before argument with the startCursor to navigate backwards [7][8]. 3. Metadata: The pageInfo object provides the necessary cursors (endCursor, startCursor) and booleans (hasNextPage, hasPreviousPage) to track your position in the collection [7][8]. Regarding headRefName: The headRefName field is a property of the PullRequest object itself [10][2]. It represents the name of the branch where the changes were implemented and is returned as part of the pull request data nodes [10][5][2]. It is not used as an argument for the pullRequests connection and cannot be used to filter or order the pull requests collection [10][1]. Citations:
Order and paginate the branch pull-request lookup.
🤖 Prompt for AI Agents |
||
| nodes { | ||
| number | ||
| headRepository { | ||
| owner { | ||
| __typename | ||
| login | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,26 @@ | ||||||||||||||||||||||||||||
| query ThreadForCommentQuery($owner: String!, $name: String!, $number: Int!, $after: String) { | ||||||||||||||||||||||||||||
| repository(owner: $owner, name: $name) { | ||||||||||||||||||||||||||||
| pullRequest(number: $number) { | ||||||||||||||||||||||||||||
| reviewThreads(first: 100, after: $after) { | ||||||||||||||||||||||||||||
| pageInfo { | ||||||||||||||||||||||||||||
| endCursor | ||||||||||||||||||||||||||||
| hasNextPage | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| nodes { | ||||||||||||||||||||||||||||
| id | ||||||||||||||||||||||||||||
| comments(first: 100) { | ||||||||||||||||||||||||||||
| nodes { | ||||||||||||||||||||||||||||
| fullDatabaseId | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
Comment on lines
+11
to
+15
There was a problem hiding this comment. 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win Detect truncated comment pages instead of reporting
Select the nested 🐛 Proposed selection change comments(first: 100) {
+ pageInfo {
+ hasNextPage
+ }
nodes {
fullDatabaseId
}
}📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||
| mutation ResolveReviewThreadMutation($id: ID!) { | ||||||||||||||||||||||||||||
| resolveReviewThread(input: { threadId: $id }) { | ||||||||||||||||||||||||||||
| clientMutationId | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
| } | ||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Order the progress entries by date.
The changed entries dated 2026-07-09 at Lines 207-224 appear after entries dated 2026-07-28 and 2026-08-03 at Lines 195-199. Move the 2026-07-09 entries before those later follow-ups, or record the actual completion dates. Keep the handoff timeline chronological.
As per path instructions, maintain
docs/execplans/as a living location for implementation plans that survive context handoffs.🤖 Prompt for AI Agents
Source: Path instructions