Commit 11f85ae8 authored by Phil Hughes's avatar Phil Hughes Committed by Bob Van Landuyt

Enables GraphQL batch requests

Enabling GraphQL batch requests allows for multiple queries
to be sent in 1 request reducing the amount of requests
we send to the server.

Responses come come back in the same order as the queries were
provided.
parent 2cc6e6ff
...@@ -16,13 +16,8 @@ class GraphqlController < ApplicationController ...@@ -16,13 +16,8 @@ class GraphqlController < ApplicationController
before_action(only: [:execute]) { authenticate_sessionless_user!(:api) } before_action(only: [:execute]) { authenticate_sessionless_user!(:api) }
def execute def execute
variables = Gitlab::Graphql::Variables.new(params[:variables]).to_h result = multiplex? ? execute_multiplex : execute_query
query = params[:query]
operation_name = params[:operationName]
context = {
current_user: current_user
}
result = GitlabSchema.execute(query, variables: variables, context: context, operation_name: operation_name)
render json: result render json: result
end end
...@@ -38,6 +33,43 @@ class GraphqlController < ApplicationController ...@@ -38,6 +33,43 @@ class GraphqlController < ApplicationController
private private
def execute_multiplex
GitlabSchema.multiplex(multiplex_queries, context: context)
end
def execute_query
variables = build_variables(params[:variables])
operation_name = params[:operationName]
GitlabSchema.execute(query, variables: variables, context: context, operation_name: operation_name)
end
def query
params[:query]
end
def multiplex_queries
params[:_json].map do |single_query_info|
{
query: single_query_info[:query],
variables: build_variables(single_query_info[:variables]),
operation_name: single_query_info[:operationName]
}
end
end
def context
@context ||= { current_user: current_user }
end
def build_variables(variable_info)
Gitlab::Graphql::Variables.new(variable_info).to_h
end
def multiplex?
params[:_json].present?
end
def authorize_access_api! def authorize_access_api!
access_denied!("API not accessible for user.") unless can?(current_user, :access_api) access_denied!("API not accessible for user.") unless can?(current_user, :access_api)
end end
......
...@@ -7,7 +7,7 @@ class GitlabSchema < GraphQL::Schema ...@@ -7,7 +7,7 @@ class GitlabSchema < GraphQL::Schema
AUTHENTICATED_COMPLEXITY = 250 AUTHENTICATED_COMPLEXITY = 250
ADMIN_COMPLEXITY = 300 ADMIN_COMPLEXITY = 300
ANONYMOUS_MAX_DEPTH = 10 DEFAULT_MAX_DEPTH = 10
AUTHENTICATED_MAX_DEPTH = 15 AUTHENTICATED_MAX_DEPTH = 15
use BatchLoader::GraphQL use BatchLoader::GraphQL
...@@ -23,10 +23,21 @@ class GitlabSchema < GraphQL::Schema ...@@ -23,10 +23,21 @@ class GitlabSchema < GraphQL::Schema
default_max_page_size 100 default_max_page_size 100
max_complexity DEFAULT_MAX_COMPLEXITY max_complexity DEFAULT_MAX_COMPLEXITY
max_depth DEFAULT_MAX_DEPTH
mutation(Types::MutationType) mutation(Types::MutationType)
class << self class << self
def multiplex(queries, **kwargs)
kwargs[:max_complexity] ||= max_query_complexity(kwargs[:context])
queries.each do |query|
query[:max_depth] = max_query_depth(kwargs[:context])
end
super(queries, **kwargs)
end
def execute(query_str = nil, **kwargs) def execute(query_str = nil, **kwargs)
kwargs[:max_complexity] ||= max_query_complexity(kwargs[:context]) kwargs[:max_complexity] ||= max_query_complexity(kwargs[:context])
kwargs[:max_depth] ||= max_query_depth(kwargs[:context]) kwargs[:max_depth] ||= max_query_depth(kwargs[:context])
...@@ -54,7 +65,7 @@ class GitlabSchema < GraphQL::Schema ...@@ -54,7 +65,7 @@ class GitlabSchema < GraphQL::Schema
if current_user if current_user
AUTHENTICATED_MAX_DEPTH AUTHENTICATED_MAX_DEPTH
else else
ANONYMOUS_MAX_DEPTH DEFAULT_MAX_DEPTH
end end
end end
end end
......
---
title: Support multiplex GraphQL queries
merge_request: 28273
author:
type: added
...@@ -48,6 +48,14 @@ A first iteration of a GraphQL API includes the following queries ...@@ -48,6 +48,14 @@ A first iteration of a GraphQL API includes the following queries
1. `project` : Within a project it is also possible to fetch a `mergeRequest` by IID. 1. `project` : Within a project it is also possible to fetch a `mergeRequest` by IID.
1. `group` : Only basic group information is currently supported. 1. `group` : Only basic group information is currently supported.
### Multiplex queries
GitLab supports batching queries into a single request using
[apollo-link-batch-http](https://www.apollographql.com/docs/link/links/batch-http). More
info about multiplexed queries is also available for
[graphql-ruby](https://graphql-ruby.org/queries/multiplex.html) the
library GitLab uses on the backend.
## GraphiQL ## GraphiQL
The API can be explored by using the GraphiQL IDE, it is available on your The API can be explored by using the GraphiQL IDE, it is available on your
......
...@@ -56,10 +56,10 @@ describe GitlabSchema do ...@@ -56,10 +56,10 @@ describe GitlabSchema do
described_class.execute('query', context: {}) described_class.execute('query', context: {})
end end
it 'returns ANONYMOUS_MAX_DEPTH' do it 'returns DEFAULT_MAX_DEPTH' do
expect(GraphQL::Schema) expect(GraphQL::Schema)
.to receive(:execute) .to receive(:execute)
.with('query', hash_including(max_depth: GitlabSchema::ANONYMOUS_MAX_DEPTH)) .with('query', hash_including(max_depth: GitlabSchema::DEFAULT_MAX_DEPTH))
described_class.execute('query', context: {}) described_class.execute('query', context: {})
end end
......
...@@ -3,18 +3,17 @@ require 'spec_helper' ...@@ -3,18 +3,17 @@ require 'spec_helper'
describe 'GitlabSchema configurations' do describe 'GitlabSchema configurations' do
include GraphqlHelpers include GraphqlHelpers
let(:project) { create(:project, :repository) } let(:project) { create(:project) }
let(:query) { graphql_query_for('project', { 'fullPath' => project.full_path }, %w(id name description)) }
let(:current_user) { create(:user) }
shared_examples 'imposing query limits' do
describe '#max_complexity' do describe '#max_complexity' do
context 'when complexity is too high' do context 'when complexity is too high' do
it 'shows an error' do it 'shows an error' do
allow(GitlabSchema).to receive(:max_query_complexity).and_return 1 allow(GitlabSchema).to receive(:max_query_complexity).and_return 1
post_graphql(query, current_user: nil) subject
expect(graphql_errors.first['message']).to include('which exceeds max complexity of 1') expect(graphql_errors.flatten.first['message']).to include('which exceeds max complexity of 1')
end end
end end
end end
...@@ -22,12 +21,12 @@ describe 'GitlabSchema configurations' do ...@@ -22,12 +21,12 @@ describe 'GitlabSchema configurations' do
describe '#max_depth' do describe '#max_depth' do
context 'when query depth is too high' do context 'when query depth is too high' do
it 'shows error' do it 'shows error' do
errors = [{ "message" => "Query has depth of 2, which exceeds max depth of 1" }] errors = { "message" => "Query has depth of 2, which exceeds max depth of 1" }
allow(GitlabSchema).to receive(:max_query_depth).and_return 1 allow(GitlabSchema).to receive(:max_query_depth).and_return 1
post_graphql(query) subject
expect(graphql_errors).to eq(errors) expect(graphql_errors.flatten).to include(errors)
end end
end end
...@@ -35,9 +34,51 @@ describe 'GitlabSchema configurations' do ...@@ -35,9 +34,51 @@ describe 'GitlabSchema configurations' do
it 'has no error' do it 'has no error' do
allow(GitlabSchema).to receive(:max_query_depth).and_return 5 allow(GitlabSchema).to receive(:max_query_depth).and_return 5
subject
expect(Array.wrap(graphql_errors).compact).to be_empty
end
end
end
end
context 'regular queries' do
subject do
query = graphql_query_for('project', { 'fullPath' => project.full_path }, %w(id name description))
post_graphql(query) post_graphql(query)
end
expect(graphql_errors).to be_nil it_behaves_like 'imposing query limits'
end
context 'multiplexed queries' do
subject do
queries = [
{ query: graphql_query_for('project', { 'fullPath' => project.full_path }, %w(id name description)) },
{ query: graphql_query_for('echo', { 'text' => "$test" }, []), variables: { "test" => "Hello world" } }
]
post_multiplex(queries)
end
it_behaves_like 'imposing query limits' do
it "fails all queries when only one of the queries is too complex" do
# The `project` query above has a complexity of 5
allow(GitlabSchema).to receive(:max_query_complexity).and_return 4
subject
# Expect a response for each query, even though it will be empty
expect(json_response.size).to eq(2)
json_response.each do |single_query_response|
expect(single_query_response).not_to have_key('data')
end
# Expect errors for each query
expect(graphql_errors.size).to eq(2)
graphql_errors.each do |single_query_errors|
expect(single_query_errors.first['message']).to include('which exceeds max complexity of 4')
end
end end
end end
end end
......
# frozen_string_literal: true
require 'spec_helper'
describe 'Multiplexed queries' do
include GraphqlHelpers
it 'returns responses for multiple queries' do
queries = [
{ query: 'query($text: String) { echo(text: $text) }',
variables: { 'text' => 'Hello' } },
{ query: 'query($text: String) { echo(text: $text) }',
variables: { 'text' => 'World' } }
]
post_multiplex(queries)
first_response = json_response.first['data']['echo']
second_response = json_response.last['data']['echo']
expect(first_response).to eq('nil says: Hello')
expect(second_response).to eq('nil says: World')
end
it 'returns error and data combinations' do
queries = [
{ query: 'query($text: String) { broken query }' },
{ query: 'query working($text: String) { echo(text: $text) }',
variables: { 'text' => 'World' } }
]
post_multiplex(queries)
first_response = json_response.first['errors']
second_response = json_response.last['data']['echo']
expect(first_response).not_to be_empty
expect(second_response).to eq('nil says: World')
end
end
...@@ -134,6 +134,10 @@ module GraphqlHelpers ...@@ -134,6 +134,10 @@ module GraphqlHelpers
end.join(", ") end.join(", ")
end end
def post_multiplex(queries, current_user: nil, headers: {})
post api('/', current_user, version: 'graphql'), params: { _json: queries }, headers: headers
end
def post_graphql(query, current_user: nil, variables: nil, headers: {}) def post_graphql(query, current_user: nil, variables: nil, headers: {})
post api('/', current_user, version: 'graphql'), params: { query: query, variables: variables }, headers: headers post api('/', current_user, version: 'graphql'), params: { query: query, variables: variables }, headers: headers
end end
...@@ -147,7 +151,14 @@ module GraphqlHelpers ...@@ -147,7 +151,14 @@ module GraphqlHelpers
end end
def graphql_errors def graphql_errors
case json_response
when Hash # regular query
json_response['errors'] json_response['errors']
when Array # multiplexed queries
json_response.map { |response| response['errors'] }
else
raise "Unkown GraphQL response type #{json_response.class}"
end
end end
def graphql_mutation_response(mutation_name) def graphql_mutation_response(mutation_name)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment