apollographql / apollographql/apollo-tooling

client:check only prints the filename of the first merged definition

Open
#2,352 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
3k
Forks
460
PR merge metrics
No merged PRs in 30d

Description

**Intended outcome:**

We use the client:check utility in our pull requests to verify that the code in the pull request is compatible with the version of our graphql server that is currently deployed in different environments.
After running it, we check the list of failures against the files changed in the PR and only report a failure on that PR if one of the files changed in the PR was flagged as having an incompatibility.

When an operation that uses fragments has an incompatibility, it only prints the file path of the first included fragment.

**Actual outcome:**

The file names of all definitions that were merged to form the document are printed.

**How to reproduce the issue:**

Have an operation that uses at least 1 fragment. Introduce a change to the operation that is incompatible with a published service, run the client check. Observe that the fragment file path is printed

**Versions**

2.33.4

Contributor guide

Open the contributing guide

Research direction

Start at the client:check entry point and reproduce the fragment-based incompatibility described in the issue. Trace how merged definitions are associated with filenames, then verify the output against the issue's intended listing of definition files. Done means the reported filenames are consistent for operations that include fragments.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, typescript
Domain
cli
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.