迁移到Rover

从Apollo CLI迁移到Rover CLI

关于Apollo CLI是Apollo之前的CLI工具，用于管理图形，与GraphOS结合使用。

本指南帮助您迁移到Rover，通过突出显示工具之间的关键差异，并提供使用Rover执行常见Apollo CLI工作流的示例。

先决条件

建议您首先阅读Rover约定，因为本指南是在此基础上构建的。

在阅读此指南之前，安装并配置Rover也是很实用的。

配置

Rover对于配置的方法比Apollo CLI更加明确和具体。在Rover中，大多数配置选项都是通过特定命令的标志来指定的，而不是在配置文件中。

除了config auth命令创建的隐藏配置文件外，Rover还使用了特定的YAML文件来为config auth命令和supergraph compose命令指定配置。

使用工作室进行身份验证

Apollo CLI通过读取环境变量来确定要使用的API密钥，与GraphOS Studio进行认证。使用Rover，设置API密钥的推荐方法是使用config auth命令。不过该命令是交互式的，因此你仍然可以在CI/CD环境中使用环境变量。

如果你不确定你的API密钥从哪里读取，或者你在密钥上遇到问题，可以使用config whoami命令进行调试。

替换 `apollo.config.js`

Apollo CLI会读取apollo.config.js文件来加载某些配置选项。以下表格列出了apollo.config.js中最常见的字段以及它们如何转换到Rover（也可查看示例）选项：

apollo.config.js 字段	Rover 选项
`name`/`service.name`	`GRAPH_REF`位置符。这是任何使用Apollo 图形注册表的命令的第一个位置符。
`service.localSchemaFile`	`--schema`标志。注意：此标志不支持多个文件。
`service.endpoint.url`	`URL`位置符。这是`introspect`命令的第一个位置符。
`service.endpoint.headers`	`--header`/`-H`标志在`introspect`命令中。注意：使用此标志多次以指定多个头。

使用代理服务器

使用Apollo CLI时，您必须配置global-agent才能使您的流量通过HTTP代理路由：

1
GLOBAL_AGENT_HTTP_PROXY=http://proxy-hostname:proxy-port \
2
  npx -n '-r global-agent/bootstrap' \
3
    apollo client:download-schema …

使用Rover，您可以设置HTTP_PROXY和/或HTTPS_PROXY环境变量，所有Rover的流量都将通过指定的代理路由：

1
HTTP_PROXY=http://proxy-hostname:proxy-port rover graph fetch mygraph

有关Rover使用代理服务器信息的更多信息，请在此处

Inspector

在Apollo CLI中，当您将--endpoint选项传递给service:push、service:check和service:download等命令时，会幕后进行正在运行服务的审查。在Rover中，您将运行graph introspect命令，并将其结果传递到类似的graph/subgraph push和graph/subgraph check命令。

这种步骤分离使Rover的审查使用更加灵活和透明。此外，将审查分离成自己的步骤，如果你遇到错误，会使调试更加容易。

如果您目的是从一个运行端点下载模式，您可以将graph introspect的结果直接输出到一个文件中。有关Rover中stdin/stdout如何工作的更多信息，请点击这里。

单体与联邦图

Apollo CLI的API使用apollo service:*命令集来处理单体和联邦图。而Rover将图和联邦图视为不同的对象。

在Rover中处理联邦图时，您通常会使用subgraph命令集，因为大多数针对联邦图的操作都涉及到其中一个子图（例如检查单个子图的变化）。Rover还提供了一个supergraph命令集，用于组合和使用supergraph模式。

有关graph、subgraph和supergraph之间区别的更多信息，请查看约定。

1
## Apollo CLI ##
2
# automatically outputs to schema.graphql
3
apollo client:download-schema --graph my-graph --variant prod
4

5
## Rover ##
6
# automatically outputs to stdout. Can redirect to schema.graphql with the `--output <OUTPUT_FILE>` argument
7
rover graph fetch my-graph@prod --output schema.graphql

从内省中检索图谱的模式

1
## Apollo CLI ##
2
# automatically outputs to schema.graphql
3
# can ONLY output introspection results in JSON
4
apollo service:download --endpoint https://127.0.0.1:4000
5

6
## Rover ##
7
# automatically outputs to stdout. Can redirect to schema.graphql with the `--output <OUTPUT_FILE>` argument
8
# can ONLY output SDL
9
rover graph introspect https://127.0.0.1:4000 --output schema.graphql

将单体模式发布到 Apollo 图谱注册表

1
## Apollo CLI ##
2
apollo service:push --graph my-graph --variant prod --endpoint https://127.0.0.1:4000
3

4
## Rover ##
5
rover graph introspect https://127.0.0.1:4000 | rover graph publish my-graph@prod --schema -

检查单体图谱的变化

1
## Apollo CLI ##
2
apollo service:check --graph my-graph --variant prod --localSchemaFile ./schema.graphql
3

4
## Rover ##
5
rover graph check my-graph@prod --schema ./schema.graphql

发布联合子图谱

子图谱曾被称为 Apollo CLI 中的 "实施服务" 或仅仅是 "服务"（一个多义词）。

1
## Apollo CLI ##
2
apollo service:push \
3
  --graph my-graph \
4
  --variant prod \
5
  --serviceName users \
6
  --localSchemaFile ./users.graphql
7

8
## Rover ##
9
rover subgraph publish my-graph@prod \
10
  --schema ./users.graphql \
11
  --name users

检查子图谱的变化

1
## Apollo CLI ##
2
apollo service:check \
3
  --graph my-graph \
4
  --variant prod \
5
  --serviceName users \
6
  --localSchemaFile ./users.graphql
7

8
## Rover ##
9
rover subgraph check my-graph@prod \
10
  --schema ./users.graphql \
11
  --name users

检查图谱的变化（使用配置文件）

在 Apollo CLI 中，配置文件原本意在替代命令使用中的标志，但往往这使得正在运行的命令细节过于抽象和难以跟踪。Rover 更详细的使用方法旨在更直接和明确。

1
// apollo.config.js
2
module.exports = {
3
    // this is the GRAPH_REF positional arg in Rover
4
    name: 'my-graph@prod',
5
    endpoint: {
6
      url: 'https://127.0.0.1:4001',
7
      headers: {
8
        // passed with the --header flag in Rover
9
        authorization: 'Bearer wxyz',
10
      },
11
    },
12
};

1
## Apollo CLI ##
2
apollo service:check
3

4
## Rover ##
5
# (no config file needed)
6
rover graph introspect https://127.0.0.1:4001 --header "authorization: Bearer wxyz" \
7
| rover graph check my-graph@prod --schema -

使用配置文件推送子图变更

1
// apollo.config.js
2
module.exports = {
3
    service: {
4
      // this is the GRAPH_REF positional arg in Rover
5
      name: 'my-graph@prod',
6
      // multiple schema files that can be concatenated
7
      localSchemaFile: './*.graphql'
8
    }
9
};

1
## Apollo CLI ##
2
apollo service:push --serviceName users
3

4
## Rover ##
5
# (no config file needed)
6
# globs don't work natively with Rover, so you can use a command like `awk 1`
7
# to combine multiple files on *nix machines
8
awk 1 *.graphql | rover subgraph publish my-graph@prod --name users --schema -

验证客户端操作

迁移到Rover

从Apollo CLI迁移到Rover CLI

先决条件

配置

使用工作室进行身份验证

替换 `apollo.config.js`

`name`/`service.name`

`service.localSchemaFile`

`service.endpoint.url`

`service.endpoint.headers`