debian-mirror-gitlab/spec/graphql/gitlab_schema_spec.rb

316 lines
9.2 KiB
Ruby
Raw Normal View History

2019-07-07 11:18:12 +05:30
# frozen_string_literal: true
2018-11-08 19:23:39 +05:30
require 'spec_helper'
2020-06-23 00:09:42 +05:30
RSpec.describe GitlabSchema do
2020-04-22 19:07:51 +05:30
let_it_be(:connections) { GitlabSchema.connections.all_wrappers }
2021-09-30 23:02:18 +05:30
2019-09-04 21:01:54 +05:30
let(:user) { build :user }
2018-11-08 19:23:39 +05:30
it 'uses batch loading' do
expect(field_instrumenters).to include(BatchLoader::GraphQL)
end
2020-04-22 19:07:51 +05:30
it 'enables the generic instrumenter' do
expect(field_instrumenters).to include(instance_of(::Gitlab::Graphql::GenericTracing))
2018-11-08 19:23:39 +05:30
end
it 'has the base mutation' do
2020-04-22 19:07:51 +05:30
expect(described_class.mutation).to eq(::Types::MutationType)
2018-11-08 19:23:39 +05:30
end
it 'has the base query' do
2020-04-22 19:07:51 +05:30
expect(described_class.query).to eq(::Types::QueryType)
2018-11-08 19:23:39 +05:30
end
2020-04-22 19:07:51 +05:30
it 'paginates active record relations using `Pagination::Keyset::Connection`' do
connection = connections[ActiveRecord::Relation]
2020-04-08 14:13:33 +05:30
2020-04-22 19:07:51 +05:30
expect(connection).to eq(Gitlab::Graphql::Pagination::Keyset::Connection)
2020-04-08 14:13:33 +05:30
end
2020-04-22 19:07:51 +05:30
it 'paginates ExternallyPaginatedArray using `Pagination::ExternallyPaginatedArrayConnection`' do
connection = connections[Gitlab::Graphql::ExternallyPaginatedArray]
2020-04-08 14:13:33 +05:30
2020-04-22 19:07:51 +05:30
expect(connection).to eq(Gitlab::Graphql::Pagination::ExternallyPaginatedArrayConnection)
2020-04-08 14:13:33 +05:30
end
2021-12-07 22:27:20 +05:30
it 'sets an appropriate validation timeout' do
expect(described_class.validate_timeout).to be <= 0.2.seconds
end
2019-09-04 21:01:54 +05:30
describe '.execute' do
2021-10-27 15:23:28 +05:30
describe 'setting query `max_complexity` and `max_depth`' do
subject(:result) { described_class.execute('query', **kwargs).query }
shared_examples 'sets default limits' do
specify do
expect(result).to have_attributes(
max_complexity: GitlabSchema::DEFAULT_MAX_COMPLEXITY,
max_depth: GitlabSchema::DEFAULT_MAX_DEPTH
)
2019-09-04 21:01:54 +05:30
end
end
2021-10-27 15:23:28 +05:30
context 'with no context' do
let(:kwargs) { {} }
2019-09-04 21:01:54 +05:30
2021-10-27 15:23:28 +05:30
include_examples 'sets default limits'
2019-09-04 21:01:54 +05:30
end
2021-10-27 15:23:28 +05:30
context 'with no :current_user' do
let(:kwargs) { { context: {} } }
2019-09-04 21:01:54 +05:30
2021-10-27 15:23:28 +05:30
include_examples 'sets default limits'
end
2019-09-04 21:01:54 +05:30
2021-10-27 15:23:28 +05:30
context 'with anonymous user' do
let(:kwargs) { { context: { current_user: nil } } }
2019-09-04 21:01:54 +05:30
2021-10-27 15:23:28 +05:30
include_examples 'sets default limits'
2019-09-04 21:01:54 +05:30
end
2021-10-27 15:23:28 +05:30
context 'with a logged in user' do
let(:kwargs) { { context: { current_user: user } } }
2019-07-07 11:18:12 +05:30
2021-10-27 15:23:28 +05:30
it 'sets authenticated user limits' do
expect(result).to have_attributes(
max_complexity: GitlabSchema::AUTHENTICATED_MAX_COMPLEXITY,
max_depth: GitlabSchema::AUTHENTICATED_MAX_DEPTH
)
2019-09-04 21:01:54 +05:30
end
end
2021-10-27 15:23:28 +05:30
context 'with an admin user' do
let(:kwargs) { { context: { current_user: build(:user, :admin) } } }
2019-09-04 21:01:54 +05:30
2021-10-27 15:23:28 +05:30
it 'sets admin/authenticated user limits' do
expect(result).to have_attributes(
max_complexity: GitlabSchema::ADMIN_MAX_COMPLEXITY,
max_depth: GitlabSchema::AUTHENTICATED_MAX_DEPTH
)
2019-09-04 21:01:54 +05:30
end
end
2021-10-27 15:23:28 +05:30
context 'when limits passed as kwargs' do
let(:kwargs) { { max_complexity: 1234, max_depth: 4321 } }
2019-09-04 21:01:54 +05:30
2021-10-27 15:23:28 +05:30
it 'sets limits from the kwargs' do
expect(result).to have_attributes(
max_complexity: 1234,
max_depth: 4321
)
2019-09-04 21:01:54 +05:30
end
end
2019-07-07 11:18:12 +05:30
end
2019-09-04 21:01:54 +05:30
end
2019-07-07 11:18:12 +05:30
2019-09-04 21:01:54 +05:30
describe '.id_from_object' do
it 'returns a global id' do
expect(described_class.id_from_object(build(:project, id: 1))).to be_a(GlobalID)
end
2019-07-07 11:18:12 +05:30
2019-09-04 21:01:54 +05:30
it "raises a meaningful error if a global id couldn't be generated" do
2019-09-30 21:07:59 +05:30
expect { described_class.id_from_object(build(:wiki_directory)) }
2019-09-04 21:01:54 +05:30
.to raise_error(RuntimeError, /include `GlobalID::Identification` into/i)
2019-07-07 11:18:12 +05:30
end
2019-09-04 21:01:54 +05:30
end
describe '.object_from_id' do
2021-04-17 20:07:23 +05:30
context 'with subclasses of `ApplicationRecord`' do
2020-03-13 15:44:24 +05:30
let_it_be(:user) { create(:user) }
2019-09-04 21:01:54 +05:30
2020-03-13 15:44:24 +05:30
it 'returns the correct record' do
2019-09-04 21:01:54 +05:30
result = described_class.object_from_id(user.to_global_id.to_s)
2019-07-07 11:18:12 +05:30
2019-12-04 20:38:33 +05:30
expect(result.sync).to eq(user)
2019-09-04 21:01:54 +05:30
end
2019-07-07 11:18:12 +05:30
2020-03-13 15:44:24 +05:30
it 'returns the correct record, of the expected type' do
result = described_class.object_from_id(user.to_global_id.to_s, expected_type: ::User)
expect(result.sync).to eq(user)
end
it 'fails if the type does not match' do
expect do
described_class.object_from_id(user.to_global_id.to_s, expected_type: ::Project)
end.to raise_error(Gitlab::Graphql::Errors::ArgumentError)
end
2019-09-04 21:01:54 +05:30
it 'batchloads the queries' do
user1 = create(:user)
user2 = create(:user)
2019-07-07 11:18:12 +05:30
2019-09-04 21:01:54 +05:30
expect do
[described_class.object_from_id(user1.to_global_id),
2019-12-04 20:38:33 +05:30
described_class.object_from_id(user2.to_global_id)].map(&:sync)
2019-09-04 21:01:54 +05:30
end.not_to exceed_query_limit(1)
end
2019-07-07 11:18:12 +05:30
end
2021-04-17 20:07:23 +05:30
context 'with classes that are not ActiveRecord subclasses and have implemented .lazy_find' do
2019-09-30 21:07:59 +05:30
it 'returns the correct record' do
note = create(:discussion_note_on_merge_request)
result = described_class.object_from_id(note.to_global_id)
2019-12-04 20:38:33 +05:30
expect(result.sync).to eq(note)
2019-09-30 21:07:59 +05:30
end
it 'batchloads the queries' do
note1 = create(:discussion_note_on_merge_request)
note2 = create(:discussion_note_on_merge_request)
expect do
[described_class.object_from_id(note1.to_global_id),
2019-12-04 20:38:33 +05:30
described_class.object_from_id(note2.to_global_id)].map(&:sync)
2019-09-30 21:07:59 +05:30
end.not_to exceed_query_limit(1)
end
end
2021-04-17 20:07:23 +05:30
context 'with other classes' do
2019-09-04 21:01:54 +05:30
# We cannot use an anonymous class here as `GlobalID` expects `.name` not
# to return `nil`
2020-05-24 23:13:21 +05:30
before do
test_global_id = Class.new do
include GlobalID::Identification
attr_accessor :id
def initialize(id)
@id = id
end
2019-09-04 21:01:54 +05:30
end
2020-05-24 23:13:21 +05:30
stub_const('TestGlobalId', test_global_id)
2019-09-04 21:01:54 +05:30
end
2019-07-07 11:18:12 +05:30
2019-09-04 21:01:54 +05:30
it 'falls back to a regular find' do
result = TestGlobalId.new(123)
expect(TestGlobalId).to receive(:find).with("123").and_return(result)
2019-07-07 11:18:12 +05:30
2019-09-04 21:01:54 +05:30
expect(described_class.object_from_id(result.to_global_id)).to eq(result)
end
end
2019-07-07 11:18:12 +05:30
2019-09-04 21:01:54 +05:30
it 'raises the correct error on invalid input' do
expect { described_class.object_from_id("bogus id") }.to raise_error(Gitlab::Graphql::Errors::ArgumentError)
2019-07-07 11:18:12 +05:30
end
end
2021-12-07 22:27:20 +05:30
describe 'validate_max_errors' do
it 'reports at most 5 errors' do
query = <<~GQL
query {
currentUser {
x: id
x: bot
x: username
x: state
x: name
x: id
x: bot
x: username
x: state
x: name
badField
veryBadField
alsoNotAGoodField
}
}
GQL
result = described_class.execute(query)
expect(result.to_h['errors'].count).to eq 5
end
end
2020-09-03 11:15:55 +05:30
describe '.parse_gid' do
let_it_be(:global_id) { 'gid://gitlab/TestOne/2147483647' }
2021-04-29 21:17:54 +05:30
subject(:parse_gid) { described_class.parse_gid(global_id) }
2020-09-03 11:15:55 +05:30
before do
test_base = Class.new
test_one = Class.new(test_base)
test_two = Class.new(test_base)
2021-04-29 21:17:54 +05:30
test_three = Class.new(test_base)
2020-09-03 11:15:55 +05:30
stub_const('TestBase', test_base)
stub_const('TestOne', test_one)
stub_const('TestTwo', test_two)
2021-04-29 21:17:54 +05:30
stub_const('TestThree', test_three)
2020-09-03 11:15:55 +05:30
end
it 'parses the gid' do
2021-04-29 21:17:54 +05:30
gid = parse_gid
2020-09-03 11:15:55 +05:30
expect(gid.model_id).to eq '2147483647'
expect(gid.model_class).to eq TestOne
end
context 'when gid is malformed' do
let_it_be(:global_id) { 'malformed://gitlab/TestOne/2147483647' }
it 'raises an error' do
2021-04-29 21:17:54 +05:30
expect { parse_gid }
2020-11-24 15:15:51 +05:30
.to raise_error(Gitlab::Graphql::Errors::ArgumentError, "#{global_id} is not a valid GitLab ID.")
2020-09-03 11:15:55 +05:30
end
end
context 'when using expected_type' do
it 'accepts a single type' do
gid = described_class.parse_gid(global_id, expected_type: TestOne)
expect(gid.model_class).to eq TestOne
end
it 'accepts an ancestor type' do
gid = described_class.parse_gid(global_id, expected_type: TestBase)
expect(gid.model_class).to eq TestOne
end
it 'rejects an unknown type' do
expect { described_class.parse_gid(global_id, expected_type: TestTwo) }
2020-11-24 15:15:51 +05:30
.to raise_error(Gitlab::Graphql::Errors::ArgumentError, "#{global_id} is not a valid ID for TestTwo.")
2020-09-03 11:15:55 +05:30
end
2021-04-29 21:17:54 +05:30
context 'when expected_type is an array' do
subject(:parse_gid) { described_class.parse_gid(global_id, expected_type: [TestOne, TestTwo]) }
context 'when global_id is of type TestOne' do
it 'returns an object of an expected type' do
expect(parse_gid.model_class).to eq TestOne
end
end
context 'when global_id is of type TestTwo' do
let_it_be(:global_id) { 'gid://gitlab/TestTwo/2147483647' }
it 'returns an object of an expected type' do
expect(parse_gid.model_class).to eq TestTwo
end
end
context 'when global_id is of type TestThree' do
let_it_be(:global_id) { 'gid://gitlab/TestThree/2147483647' }
it 'rejects an unknown type' do
expect { parse_gid }
.to raise_error(Gitlab::Graphql::Errors::ArgumentError, "#{global_id} is not a valid ID for TestOne, TestTwo.")
end
end
end
2020-09-03 11:15:55 +05:30
end
end
2018-11-08 19:23:39 +05:30
def field_instrumenters
2019-07-07 11:18:12 +05:30
described_class.instrumenters[:field] + described_class.instrumenters[:field_after_built_ins]
2018-11-08 19:23:39 +05:30
end
end