You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
feat(platform-app): convert App Registry GraphQL client to a spec-generated client - #282
Every ApplicationClient method and its callers across the platform app command tree (including import, native Android extensions, and redirectUris) now use typed request/response structs end to end. The one remaining untyped field is presentation/metadata, which the schema itself types as an opaque JSONObject scalar.
Mutations that return no data (enable/disable/archive/update/create-release/activate-release) now fail with an error instead of reporting success.
App Registry traffic is registered with --debug transport, including the add native-extension path.
Unset optional inputs stay out of update/create requests (wire-shape test), so an omitted manifest key still leaves remote values unchanged.
Closes DEVEX-1173.
Third of three PRs for DEVEX-1173, stacked on #326 (which is stacked on #325). This PR's own diff is the migration only.
The reason will be displayed to describe this comment to others. Learn more.
Copilot review overview
🟡 Changes recommended
Several commands treat None mutation results as success (serializing to null), and the API catalog generator’s new multi-org support can clobber clones when repo names collide across orgs.
Get a fresh assessment by requesting another Copilot review.
This PR migrates the gddy platform app command tree from a hand-written, serde_json::Value-based App Registry GraphQL client to a typed, graphql_client-generated client (platform-app-client), and adds a generate-api-catalog refresh step to vendor the schema from the App Registry service repo.
Changes:
Introduces platform-app-client (build-time generated GraphQL operations + vendored schema) and updates the workspace to include it.
Refactors platform app commands and ApplicationClient to use typed request/response structs end-to-end (with serde_json conversion at CommandResult boundaries).
Extends the API catalog generator to support non-default GitHub orgs and explicit specPath sources, adding an App Registry schema refresh path.
…lti-org clone path collision
Addresses Copilot review feedback on #282:
- enable/disable/archiveApplication, updateApplication, and createRelease
now error instead of silently reporting success when the mutation
returns no data, matching the pattern already used for
createApplication/generateReleaseUploadUrl.
- generate-api-catalog: nest cloned repos under their org, not just repo
name, so two catalog sources with the same repo name in different orgs
don't clobber each other's temp clone.
- Corrected a stale build.rs comment about why variables derive Deserialize.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The reason will be displayed to describe this comment to others. Learn more.
Copilot review overview
🟡 Changes recommended
The new org-nested temp clone path needs parent-directory creation, and App Registry GraphQL transport debug logging is not registered so --debug transport loses visibility for these requests.
Get a fresh assessment by requesting another Copilot review.
Register TransportObserver for App Registry GraphQL debug logging
rust/src/platform/app/client.rs:129
GraphQL requests now rely on generated-client-support’s TransportObserver for --debug transport logging (via notify_request/notify_response_result), but platform app doesn’t register that observer anywhere. As a result, App Registry GraphQL traffic won’t appear in transport debug logs unless some other generated client happened to be initialized earlier in the same process. Register the shared observer before constructing the GraphQL client.
…istry GraphQL calls
Addresses Copilot review feedback on #282: platform app's make_client
(and deploy's direct ApplicationClient::new, which bypasses make_client)
never called ensure_generated_client_transport_observer_registered, so
App Registry GraphQL traffic was invisible to --debug transport unless
some other generated client happened to register the observer first in
the same process. Both call sites now register it, matching
domain/email/shopping's make_client.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Re: the "Previously missed" finding on registering the TransportObserver for App Registry GraphQL debug logging (client.rs:129, in this round's review body — not a resolvable thread since Copilot didn't post it as one).
Fixed in ae07c49: platform app's make_client now calls crate::http::ensure_generated_client_transport_observer_registered(), matching what domain/email/shopping's own make_client already do. Also caught that deploy's streaming command constructs ApplicationClient::new directly rather than going through make_client, so it needed the same call added separately.
The reason will be displayed to describe this comment to others. Learn more.
Copilot review overview
🔵 Needs a closer look
It introduces a new generated client crate and refactors a wide surface area of platform-app commands and tooling, which warrants final human review of behavior parity and long-term maintenance implications.
Watch GraphQL directory for newly added operation files
rust/platform-app-client/build.rs:23
The build script only emits rerun-if-changed for files that exist at the time it runs; adding a new graphql/*.graphql operation document won’t trigger a rebuild/codegen until some already-tracked file changes. Add a directory-level rerun-if-changed so new operation files are picked up automatically.
Support org/repo keys for unambiguous API catalog overrides
API_CATALOG_REPO_REFS overrides are looked up by repo_name only. Now that sources can come from multiple orgs, two sources with the same repo name in different orgs can't be overridden independently. Consider checking for an org/repo key first (with a fallback to the legacy repo key) so overrides remain unambiguous.
Format GraphQL errors using concise message fields
rust/platform-app-client/src/lib.rs:127
ClientError::GraphQL currently formats the errors array with Debug ({errors:?}), which tends to produce noisy, unstable output for end users. Consider extracting and joining the message fields (and optionally adding location/path info later) so the CLI’s surfaced error string stays concise and predictable.
…verrides, concise GraphQL error text
Addresses Copilot review feedback on #282 (prose-only "previously missed"
findings, not resolvable threads):
- platform-app-client/build.rs: cargo:rerun-if-changed the graphql/
directory itself, not just the files present when the script last ran —
a newly added *.graphql operation doc wouldn't otherwise trigger codegen
until some other watched file changed.
- generate-api-catalog: API_CATALOG_REPO_REFS overrides are now looked up
by "org/repo" first, falling back to the legacy bare "repo" key, so two
sources sharing a repo name across orgs can be overridden independently.
- platform-app-client: ClientError::GraphQL now joins graphql_client::
Error's own Display (path:line:col: message) instead of Debug-formatting
the whole error struct.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Watch GraphQL directory for newly added operation files — build.rs now does cargo:rerun-if-changed=graphql (the directory itself) in addition to the individual files, so a newly added .graphql doc triggers codegen.
Support org/repo keys for unambiguous API catalog overrides — API_CATALOG_REPO_REFS lookups now try org/repo first, falling back to the legacy bare repo key.
Format GraphQL errors using concise message fields — turns out graphql_client::Error already implements Display as path:line:col: message; ClientError::GraphQL now joins that instead of Debug-formatting the whole struct.
The reason will be displayed to describe this comment to others. Learn more.
Copilot review overview
🔵 Needs a closer look
It introduces a new generated client crate plus multi-file refactors across the platform app command tree and build tooling, warranting final human review for API/CLI output compatibility and long-term maintenance risk.
…#325)
`gddy api` now lists the App Registry GraphQL API: its operations, types
and schema are browsable and callable like the other catalog domains.
The schema is pinned in the repo, vendored from gdcorp-commerce/app-registry-api
(the service's own repo) rather than the stale gdcorp-platform specification
repo, and refreshed by generate-api-catalog.
Catalog sources can now name their own GitHub org and an explicit spec path.
A GraphQL schema carries no server URL, so GraphQL sources must declare
`baseUrl` and `endpointPath`; App Registry is served from
https://api.godaddy.com/v1/apps/app-registry-subgraph. `API_CATALOG_REPOS`
and `API_CATALOG_REPO_REFS` accept `org/repository`, and a bare repository
name that more than one source shares is rejected (repos) or ignored (refs)
instead of silently picking one.
A test now fails if a committed catalog file is not embedded in the CLI, and
another if a GraphQL catalog entry drifts from its declared endpoint.
Co-authored-by: Claude Sonnet 5.5 <noreply@anthropic.com>
…ate [DEVEX-1173]
Adds platform-app-client, a typed client for the App Registry subgraph
generated at build time by graphql_client from the pinned schema and one
.graphql document per operation, matching the generated-client pattern used
for domains/hosting/shopping/email. It is not used by the CLI yet.
Unset optional mutation inputs are omitted from the request rather than sent
as explicit nulls, since the service treats an omitted field as "leave
unchanged" and a null as "clear". Responses to credential-bearing operations
(CreateApplication's secrets, GenerateReleaseUploadUrl's pre-signed URL) are
never shown to the transport observer, and a response that fails to decode is
reported without its contents, so `--debug transport` and error output cannot
expose them.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
…erated client [DEVEX-1173]
Replaces the hand-written GraphQL client in src/platform/app/client.rs with
the typed platform-app-client crate, generated from the pinned App Registry
subgraph schema.
Every ApplicationClient method and its callers across the platform app
command tree now use typed request/response structs end to end; the only
remaining untyped fields are `presentation`/`metadata`, which the schema
itself types as an opaque JSONObject scalar.
Mutations that return no data (enable/disable/archive/update/create-release/
activate-release) now fail with an error instead of reporting success, and
App Registry traffic is registered with `--debug transport`, including the
`add native-extension` path.
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
src/platform/app/client.rswith the typedplatform-app-clientcrate (chore(platform-app): add the generated App Registry GraphQL client crate [DEVEX-1173] #326), generated from the pinned App Registry schema (feat(api): add App Registry to the browsable API catalog [DEVEX-1173] #325).ApplicationClientmethod and its callers across the platform app command tree (includingimport, native Android extensions, andredirectUris) now use typed request/response structs end to end. The one remaining untyped field ispresentation/metadata, which the schema itself types as an opaqueJSONObjectscalar.--debug transport, including theadd native-extensionpath.Third of three PRs for DEVEX-1173, stacked on #326 (which is stacked on #325). This PR's own diff is the migration only.
Test plan
cargo check --workspacecargo clippy --workspace --all-targets -- -D warningscargo test --workspacecargo fmt --check./rust/scripts/check-module-size.sh./rust/scripts/smoke-test.sh(mocked App Registry server)🤖 Generated with Claude Code