Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Use proposalCoverage in addition to severityLevel to build correct proposal check messaging #1845

Conversation

swcollard
Copy link
Contributor

@swcollard swcollard commented Feb 8, 2024

We received a bug report of rover displaying the message, Your check failed because some or all of the diffs in this change are not in an approved Proposal. for a check response that in fact was passing because all the diffs in the Check were related to an approved Proposal.

Screenshot 2024-02-08 at 3 47 06 PM

This is because the messaging is keying off of solely the configured value, severityLevel and not the proposalCoverage field which indicates the detailed results of a check task.


Changes

This PR changes how we calculate that message to take proposalCoverage into account, and uses severityLevel to match the message in the failing case.


Testing Locally

Did some local testing and here are a few example scenarios

Severity level set to ERROR, missing approvals

Screenshot 2024-02-08 at 4 18 03 PM

Severity level set to WARN, missing approvals

Screenshot 2024-02-08 at 4 18 12 PM

Severity level set to WARN, only partial approval

Screenshot 2024-02-08 at 4 19 07 PM

Fully approved and passing

Screenshot 2024-02-08 at 4 20 46 PM

@swcollard swcollard requested a review from cy February 8, 2024 21:52
crates/rover-client/src/shared/check_response.rs Outdated Show resolved Hide resolved
crates/rover-client/src/shared/check_response.rs Outdated Show resolved Hide resolved
@o0Ignition0o o0Ignition0o enabled auto-merge (squash) February 20, 2024 11:32
@o0Ignition0o o0Ignition0o merged commit 3ac89b3 into main Feb 20, 2024
10 checks passed
@o0Ignition0o o0Ignition0o deleted the swcollard/proposal-checks/correct-messaging-to-use-proposalCoverage-field branch February 20, 2024 11:51
@Geal Geal mentioned this pull request Mar 26, 2024
Geal added a commit that referenced this pull request Mar 26, 2024
## 🚀 Features

- **Add `--no-url` shorthand to `subgraph publish` - @lennyburdette PR
#1809**

This is slightly more convenient and less awkward than `--routing-url ""
--allow-invalid-routing-url`

- **Support unix socket URLs - @Geal PR #1879**

Since its [1.43.0
release](https://github.com/apollographql/router/releases/tag/v1.43.0),
the Router can now connect to subgraph over unix sockets. This removes a
warning when publishing a schema with a `unix://` URL.

## 🐛 Fixes

- **Use task specific `rayon` threadpools and not the global threadpool
- @garypen PR #1872**

This increases rover's reliability by executing independent tasks in
different thread pools.

- **Prevent an infinite loop when restarting the router - @Geal PR
#1855**

When restarting a Router on schema updates, it could happen that an
internal task of Rover would go in an infinite loop and consume CPU
needlessly. This is now fixed and should make `rover dev` more reliable.

- **Use `proposalCoverage`` in addition to `severityLevel`` to build
correct proposal check messaging - @swcollard PR #1845**

This updates the message on proposal checks depending on the
`proposalCoverage` field


## 🛠 Maintenance

- **Upgrade axios to address a security warning - @goto-bus-stop PR
#1819**

The vulnerability didn't affect rover, but now you won't get a warning
for it!

- **Remove yanked online check - @dylan-apollo PR #1803**

## 📚 Documentation 

- **Update dev docs about which Router version is used - @smyrick PR
#1822**

- **Update warning about `federation_version` in `rover compose` -
@smyrick, @Meschreiber PR #1806**

- **Document how to use `subgraph fetch` with proposals - @Meschreiber
PR #1823**

---------

Co-authored-by: Geoffroy Couprie <apollo@geoffroycouprie.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants