如何使用 graphql-ruby 测试 GraphQL 模式?

Question

我的目标是在 ruby 中测试我的 GraphQL 模式的类型，我使用的是 graphql-ruby gem。

我找不到任何最佳实践，所以我想知道测试架构的字段和类型的最佳方法是什么。

gem 建议不要直接 http://graphql-ruby.org/schema/testing.html 测试架构，但我仍然发现能够知道架构何时意外更改很有价值。

具有这样的类型：

module Types
class DeskType < GraphQL::Schema::Object
field :id, ID, 'Id of this Desk', null: false
field :location, String, 'Location of the Desk', null: false
field :custom_id, String, 'Human-readable unique identifier for this desk', null: false
end
end

我的第一个方法是在 GraphQL：：Schema：：Object 类型中使用fields哈希，例如：

Types::DeskType.fields['location'].type.to_s => 'String!'

创建一个 RSpec 匹配器，我可以提出如下所示的测试：

RSpec.describe Types::DeskType do
it 'has the expected schema fields' do
fields = {
'id': 'ID!',
'location': 'String!',
'customId': 'String!'
}
expect(described_class).to match_schema_fields(fields)
end
end

但是，这种方法有一些缺点：

• 匹配器中的代码取决于类 GraphQL：：Schema：：Object 的实现，任何重大更改都会在更新后破坏测试套件。
• 我们正在重复代码，测试断言类型中的相同字段。
编写
• 这些测试变得乏味，这使得开发人员不太可能编写它们。

Answer 1

看起来您想测试架构，因为您想知道它是否会破坏客户端。基本上你应该避免这种情况。

相反，您可以使用 gem：graphql-schema_comparator来打印重大更改。

1. 我建议有一个 rake 任务来转储您的架构(并将其提交到您的存储库中(。
2. 您可以编写一些规范来检查架构是否是转储 - 然后您将确保始终具有最新的模式转储。
3. 设置 CI 以将当前分支的架构与主分支上的架构进行比较。
4. 如果架构具有危险或中断性更改，则生成失败。
5. 您甚至可以使用模式比较器生成架构更改日志;)或者，您甚至可以使用 Slack 通知将任何架构更改发送到那里，以便您的团队可以轻松跟踪任何更改。

Answer 2

我觉得对我采取的第一种方法的改进是对 GraphQL 模式使用快照测试，而不是逐个测试每个类型/突变模式，我创建了一个测试：

RSpec.describe MySchema do
it 'renders the full schema' do
schema = GraphQL::Schema::Printer.print_schema(MySchema)
expect(schema).to match_snapshot('schema')
end
end

这种方法使用略微修改的 rspec-snapshot gem 版本，请在此处查看我的 PR。

gem 不允许你像在 Jest 中那样使用单个命令更新快照，所以我还创建了一个 rake 任务来删除当前快照：

namespace :tests do
desc 'Deletes the schema snapshot'
task delete_schema_snapshot: :environment do
snapshot_path = Rails.root.join('spec', 'fixtures', 'snapshots', 'schema.snap')
File.delete(snapshot_path) if File.exist?(snapshot_path)
end
end

有了这个，当架构被修改时，你会得到一个漂亮的 RSpec 差异。

Answer 3

顶级架构对象具有 #execute 方法。 您可以使用它来编写测试，例如

RSpec.describe MySchema do
it 'fetches an object' do
id = 'Zm9vOjE'
query = <<~GRAPHQL
query GetObject($id: ID!) {
node(id: $id) { __typename id }
}
GRAPHQL
res = described_class.execute(
query,
variables: { id: id }
)
expect(res['errors']).to be_nil
expect(res['data']['node']['__typename']).to eq('Foo')
expect(res['data']['node']['id']).to eq(id)
end
end

#execute 方法的返回值将是传统的 HTTP 样式响应，作为字符串键哈希。 (实际上它是一个 GraphQL：：Query：：Result，但它将大多数内容委托给嵌入式哈希。