Add new `rover cloud` command #2008

loshz · 2024-07-29T14:01:04Z

Description

This PR adds the ability to fetch and update config for a Cloud Router. The new commands are as follows:

$ rover cloud config fetch
Usage: rover cloud config fetch [OPTIONS] <GRAPH_REF>

Arguments:
  <GRAPH_REF>
          <NAME>@<VARIANT> of graph in Apollo Studio. @<VARIANT> may be left off, defaulting to @current
...

$ rover cloud config update --help
Update current config for a given graph ref

Usage: rover cloud config update [OPTIONS] --file <FILE> <GRAPH_REF>

Arguments:
  <GRAPH_REF>
          <NAME>@<VARIANT> of graph in Apollo Studio. @<VARIANT> may be left off, defaulting to @current

Options:
  -f, --file <FILE>
          Path of local file to read. You can pass `-` to use stdin instead of a file
...

Notes

The following updates have been made to the Platform API:

Mutations added to Platform API in staging:
- https://github.com/mdg-private/monorepo/pull/15689
- https://github.com/mdg-private/monorepo/pull/15775
Mutations added to Platform API in prod:
- https://github.com/mdg-private/apollo-argo/pull/2185
- https://github.com/mdg-private/apollo-argo/pull/2277

crates/rover-client/src/operations/cloud/config/fetch.rs

crates/rover-client/src/operations/cloud/config/update.rs

src/command/cloud/mod.rs

src/command/cloud/config.rs

jonathanrainer

Couple of tiny things but otherwise looks good to me :)

jonathanrainer · 2024-08-12T12:54:48Z

crates/rover-client/src/operations/cloud/config/fetch.rs

+    fn mock_graph_ref() -> GraphRef {
+        GraphRef {
+            name: "mygraph".to_string(),
+            variant: "current".to_string(),
+        }
+    }


Can we use rstest here instead and turn this into a fixture?

I tried rtest and it made it more fiddly. I've added assertions for the error types 👍

crates/rover-client/src/operations/cloud/config/update.rs

src/options/file.rs

crates/rover-client/src/operations/cloud/config/fetch.rs

crates/rover-client/src/operations/cloud/config/update.rs

jonathanrainer

LGTM

@current

## Description This PR follows on from #2008 and adds the ability to validate config for a Cloud Router. The new subcommands is as follows: ``` $ rover cloud config validate --help Validate a cloud router config for a given graph ref Usage: rover cloud config validate [OPTIONS] --file <FILE> <GRAPH_REF> Arguments: <GRAPH_REF> <NAME>@<VARIANT> of graph in Apollo Studio. @<VARIANT> may be left off, defaulting to @current Options: --profile <PROFILE_NAME> Name of configuration profile to use [default: default] -f, --file <FILE> Path of local file to read. You can pass `-` to use stdin instead of a file ... ```

## Description Increases the test coverage of the code added in #2008

@aaronArinder

> Important: 1 potentially breaking changes below, indicated by **❗ BREAKING ❗** ## ❗ BREAKING ❗ - **The --client-timeout flag now represents the period over which we allow retries - @aaronArinder PR #2019** The documentation for this flag indicated that this was the period over which Rover would retry a command if there were retryable HTTP errors. However this was not the case due to complexities in how the client was instantiated. This has now been corrected, so the documented behaviour matches the actual behaviour. ## 🚀 Features - **Make `rover` operate asynchronously - @aaronArinder @Geal PR #2035** Removes the use of the `reqwest` blocking client allowing `rover` to operate using an asynchronous `tokio` runtime. This will bring performance improvements, particularly where working with large sets of subgraphs. - **Add `--graph-ref` to `supergraph compose` - @jonathanrainer PR #2001** Adds the same capabilities to `supergraph compose` as were added to `rover dev` in 0.25.0. You can now specify an existing Studio graphref and the command will run composition over the subgraphs specified in the graphref, as well as any overrides specified in a given supergraph config. - **Add new `rover cloud` command - @loshz PR #2008** Adds a new command to allow you to push or pull the Router config to a Cloud Router that is running in Studio - **Add new `rover cloud config validate` subcommand - @loshz PR #2055** Adds a new command enabling you to validate the Router config for a Cloud Router ## 🐛 Fixes - **Don't run IsFederatedGraph before running SubgraphFetchQuery - @glasser PR #2004** Previously we were checking IsFederatedGraph before running SubgraphFetch, but the same check is actually performed in SubgraphFetch anyway so the first call to IsFederatedSubgraph is unnecessary. - **Allow `--graph-ref` to support contract variants - @jonathanrainer PR #2036** There was a bug where using the graphref of a contract variant would cause an error about non-federated graphs. This has been resolved and now contract variant graphrefs can also be used. - **Remove last reference to blocking `reqwest` client - @loshz PR #2050** One reference to the blocking `reqwest` client had been leftover from the move to `async` operation in #2035, this was removed. - **Ensure NPM installer on Windows works correctly - @jonathanrainer PR #2059** The NPM installer on Windows had been broken because it was attempt to rename a binary from `rover` to its correct name, rather than from `rover.exe` to its correct name. This has been corrected and extra CI and unit tests added to prevent a recurrence. - **Make sure a message is returned to the user when cloud config is updated correctly - @loshz PR #2063** - **Fix a regression in `rover dev` where it would no longer watch subgraphs correctly - @jonathanrainer PR #2065** ## 🛠 Maintenance - **Integrate the Smoke Tests Into Integration Test Framework To Allow Easier Extension - @jonathanrainer PR #1999** - **Add nicer names to GitHub actions workflow - @jonathanrainer PR #2002** - **Add test for subgraph introspect - @jonathanrainer PR #2003** - **Update node.js packages - @jonathanrainer PR #2006** Includes `eslint` to v9.8.0 and `node` to v20.16.0 - **Update Rust to v1.80.0 - @jonathanrainer PR #2007** - **Fix up CODEOWNERS to bring us inline with standard - @jonathanrainer PR #2016** - **Add E2E test for `supergraph compose` - @aaronArinder PR #2005** - **Add E2E test for `subgraph fetch` - @jonathanrainer PR #2015** - **Update Rust crates - @aaronArinder PR #2011** Includes `apollo-parser` to v0.8 and `octocrab` to v0.39.0 - **Update apollographql/router to v1.52.0 - @aaronArinder PR #2010** - **Add E2E test for `supergraph compose` - @aaronArinder PR #2005** - **Rename a test and add a `#[once]` macro to a fixture - @aaronArinder PR #2017** - **Add E2E tests for `graph introspect` - @jonathanrainer PR #2020** - **Add missing inherit for secrets - @jonathanrainer PR #2021** - **Add E2E tests for `whoami` - @jonathanrainer PR #2022** - **Update rstest to v0.22.0 - @jonathanrainer PR #2030** - **Add E2E tests for `config clear` - @aaronArinder PR #2029** - **Add E2E tests for `subgraph lint` - @aaronArinder PR #2023** - **Add E2E tests for `subgraph publish` - @jonathanrainer PR #2031** - **Add E2E tests for `graph fetch` - @aaronArinder PR #2026** - **Add E2E tests for `supergraph fetch` - @aaronArinder PR #2024** - **Add E2E tests for `subgraph list` - @aaronArinder PR #2027** - **Add E2E tests for `graph check` and `subgraph check` - @aaronArinder PR #2025** - **Add E2E tests for `install plugin` - @aaronArinder PR #2028** - **Make E2E tests account for changes in #2019 - @jonathanrainer PR #2032** - **Deprecate the use of Emoji - @loshz PR #2034** - **Let E2E tests message Slack if there are nightly failures - @jonathanrainer PR #2033** - **Tighten up Slack Messaging for E2E tests - @jonathanrainer PR #2039** - **Update `axios-mock-adapter` to v2.0.0 - @jonathanrainer PR #2043** - **Update `derive-getters` to v0.5.0 - @jonathanrainer PR #2042** - **Update `eslient` to v9.9.0 - @jonathanrainer PR #2041** - **Update Rust to v1.80.1 - @jonathanrainer PR #2040** - **Update axios to v1.7.4 - @jonathanrainer PR #2048** - **Update CODEONWERS - @aaronArinder PR #2052** - **Update termimad to v0.30.0 - @jonathanrainer PR #2054** - **Add step to fail workflow if matrix branch fails - @jonathanrainer PR #2044** - **Increase test coverage for operations/cloud/config - @loshz PR #2057** - **Update `gh` CircleCI Orb to v2.4.0 - @jonathanrainer PR #2062** - **Update `mockito` to v1.5.0 - @jonathanrainer PR #2061** - **Update `dircpy` to v0.3.19 - @jonathanrainer PR #2060** ## 📚 Documentation - **Document E2E test gotchas - @aaronArinder PR #2018** - **Fix table to be compatible with new docs platform - @shorgi PR #2038** - **Remove unhelpful note - @Meschreiber PR #2053** - **Add Summit callout - @Meschreiber PR #2058** - **Adds `--graph-ref` to supergraph compose docs - @jackonawalk PR #2037**

## Description Documents the new `rover cloud` commands added in #2008 and #2055

loshz added 13 commits July 29, 2024 12:07

command: bootstrap new cloud command

9d575ed

add file option helper

82e2bbb

Merge branch 'main' into loshz/CR-420

781cc03

move profile option to parent command

9e924a5

Merge branch 'main' into loshz/CR-420

dbacef3

add rover-client implementations

c919857

Merge branch 'main' into loshz/CR-420

386493e

update supergraph schema

8adb0dc

Merge branch 'main' into loshz/CR-420

a90c097

Merge branch 'main' into loshz/CR-420

2adf943

fix query errors

4c9cbef

implement fetch command

731a236

implement update command

9882b3f

loshz marked this pull request as ready for review August 7, 2024 13:56

loshz requested a review from a team as a code owner August 7, 2024 13:56

loshz commented Aug 7, 2024

View reviewed changes

crates/rover-client/src/operations/cloud/config/fetch.rs Outdated Show resolved Hide resolved

loshz commented Aug 7, 2024

View reviewed changes

crates/rover-client/src/operations/cloud/config/update.rs Outdated Show resolved Hide resolved

loshz added 6 commits August 7, 2024 15:08

fix imports

6e3e258

Merge branch 'main' into loshz/CR-420

0fa2ba7

perform null check on router_config

b56ec97

remove debug line

37d116d

Merge branch 'main' into loshz/CR-420

66332b5

Merge branch 'main' into loshz/CR-420

a6ea258

loshz commented Aug 12, 2024

View reviewed changes

src/command/cloud/mod.rs Outdated Show resolved Hide resolved

loshz commented Aug 12, 2024

View reviewed changes

src/command/cloud/config.rs Outdated Show resolved Hide resolved

loshz added 3 commits August 12, 2024 11:07

catch errors due to invalid config

9d7306e

move profile flag to individual subcommand

fa96178

Merge branch 'main' into loshz/CR-420

08085a5

loshz requested review from jonathanrainer and nmoutschen August 12, 2024 10:20

fix update test

7dcf912

jonathanrainer requested changes Aug 12, 2024

View reviewed changes

nmoutschen approved these changes Aug 12, 2024

View reviewed changes

crates/rover-client/src/operations/cloud/config/fetch.rs Outdated Show resolved Hide resolved

crates/rover-client/src/operations/cloud/config/fetch.rs Outdated Show resolved Hide resolved

crates/rover-client/src/operations/cloud/config/update.rs Show resolved Hide resolved

loshz added 4 commits August 12, 2024 15:29

assert error types

2642d02

Merge branch 'main' into loshz/CR-420

310ae11

fix async errors

009cd2c

small perf improvements

1ecf46a

loshz requested review from jonathanrainer and nmoutschen August 13, 2024 11:25

fix test

580400e

loshz enabled auto-merge (squash) August 13, 2024 11:48

jonathanrainer approved these changes Aug 13, 2024

View reviewed changes

loshz merged commit 887ae72 into main Aug 13, 2024
19 checks passed

loshz deleted the loshz/CR-420 branch August 13, 2024 12:50

loshz mentioned this pull request Aug 15, 2024

Add new rover cloud config validate subcommand #2055

Merged

loshz mentioned this pull request Aug 15, 2024

operations/cloud/config: increase test coverage #2057

Merged

loshz added a commit that referenced this pull request Aug 15, 2024

operations/cloud/config: increase test coverage (#2057)

faec342

## Description Increases the test coverage of the code added in #2008

jonathanrainer added the feature 🎉 new commands, flags, functionality, and improved error messages label Aug 20, 2024

jonathanrainer added this to the v0.26.0 milestone Aug 20, 2024

jonathanrainer mentioned this pull request Aug 20, 2024

release: v0.26.0 #2064

Merged

loshz mentioned this pull request Aug 21, 2024

docs: add cloud config docs #2066

Merged

loshz added a commit that referenced this pull request Aug 21, 2024

docs: add cloud config docs (#2066)

39d7cd7

## Description Documents the new `rover cloud` commands added in #2008 and #2055

This was referenced Sep 27, 2024

[Snyk] Upgrade @apollo/rover from 0.14.2 to 0.26.1 WontonSam/apollo-federation-subgraph-compatibility#554

Open

[Snyk] Upgrade @apollo/rover from 0.14.2 to 0.26.2 WontonSam/apollo-federation-subgraph-compatibility#571

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new `rover cloud` command #2008

Add new `rover cloud` command #2008

loshz commented Jul 29, 2024 •

edited

Loading

jonathanrainer left a comment

jonathanrainer Aug 12, 2024

loshz Aug 12, 2024

jonathanrainer left a comment

Add new rover cloud command #2008

Add new rover cloud command #2008

Conversation

loshz commented Jul 29, 2024 • edited Loading

Description

Notes

jonathanrainer left a comment

Choose a reason for hiding this comment

jonathanrainer Aug 12, 2024

Choose a reason for hiding this comment

loshz Aug 12, 2024

Choose a reason for hiding this comment

jonathanrainer left a comment

Choose a reason for hiding this comment

Add new `rover cloud` command #2008

Add new `rover cloud` command #2008

loshz commented Jul 29, 2024 •

edited

Loading