Add options to graphql.compile()

The options are:

* resulting_object_cnt_max
* fetched_object_cnt_max
* timeout_ms

Fixes #63.

Author: Totktonada

graphql/accessor_general.lua

@@ -867,7 +867,7 @@ local function process_tuple(self, state, tuple, opts)
     if clock.monotonic64() > qcontext.deadline_clock then
         error(e.timeout_exceeded((
             'query execution timeout exceeded timeout_ms limit (%s ms)'):format(
-            tostring(self.settings.timeout_ms))))
+            tostring(state.qcontext.query_settings.timeout_ms))))
     end
     local collection_name = opts.collection_name
     local pcre = opts.pcre
@@ -1038,21 +1038,23 @@ local function select_internal(self, collection_name, from, filter, args, extra)
         collection_name))
 
     -- read-write variables for process_tuple
+    local qcontext = extra.qcontext
     local select_state = {
         count = 0,
         objs = {},
         pivot_found = false,
-        qcontext = extra.qcontext
+        qcontext = qcontext
     }
 
     -- read only process_tuple options
+    local query_settings = qcontext.query_settings
     local select_opts = {
         limit = args.limit,
         filter = filter,
         do_filter = not full_match,
         pivot_filter = nil, -- filled later if needed
-        resulting_object_cnt_max = self.settings.resulting_object_cnt_max,
-        fetched_object_cnt_max = self.settings.fetched_object_cnt_max,
+        resulting_object_cnt_max = query_settings.resulting_object_cnt_max,
+        fetched_object_cnt_max = query_settings.fetched_object_cnt_max,
         collection_name = collection_name,
         unflatten_tuple = self.funcs.unflatten_tuple,
         use_tomap = self.collection_use_tomap[collection_name] or false,
@@ -1079,10 +1081,10 @@ local function select_internal(self, collection_name, from, filter, args, extra)
             collection_name)
 
         -- count full scan select request
-        extra.qcontext.statistics.select_requests_cnt =
-            extra.qcontext.statistics.select_requests_cnt + 1
-        extra.qcontext.statistics.full_scan_select_requests_cnt =
-            extra.qcontext.statistics.full_scan_select_requests_cnt + 1
+        qcontext.statistics.select_requests_cnt =
+            qcontext.statistics.select_requests_cnt + 1
+        qcontext.statistics.full_scan_select_requests_cnt =
+            qcontext.statistics.full_scan_select_requests_cnt + 1
 
         for _, tuple in primary_index:pairs() do
             assert(pivot == nil,
@@ -1127,10 +1129,10 @@ local function select_internal(self, collection_name, from, filter, args, extra)
         local tuple_count = 0
 
         -- count index select request
-        extra.qcontext.statistics.select_requests_cnt =
-            extra.qcontext.statistics.select_requests_cnt + 1
-        extra.qcontext.statistics.index_select_requests_cnt =
-            extra.qcontext.statistics.index_select_requests_cnt + 1
+        qcontext.statistics.select_requests_cnt =
+            qcontext.statistics.select_requests_cnt + 1
+        qcontext.statistics.index_select_requests_cnt =
+            qcontext.statistics.index_select_requests_cnt + 1
 
         for _, tuple in index:pairs(index_value, iterator_opts) do
             tuple_count = tuple_count + 1
@@ -1307,23 +1309,58 @@ local function validate_funcs(funcs)
         type(funcs.delete_tuple))
 end
 
+local function validate_query_settings(query_settings, opts)
+    local opts = opts or {}
+    local allow_nil = opts.allow_nil or false
+
+    local resulting_object_cnt_max = query_settings.resulting_object_cnt_max
+    local fetched_object_cnt_max = query_settings.fetched_object_cnt_max
+    local timeout_ms = query_settings.timeout_ms
+
+    if not allow_nil or type(resulting_object_cnt_max) ~= 'nil' then
+        assert(type(resulting_object_cnt_max) == 'number' and
+            resulting_object_cnt_max > 0,
+            'resulting_object_cnt_max must be natural number')
+    end
+    if not allow_nil or type(fetched_object_cnt_max) ~= 'nil' then
+        assert(type(fetched_object_cnt_max) == 'number' and
+            fetched_object_cnt_max > 0,
+            'fetched_object_cnt_max must be natural number')
+    end
+    if not allow_nil or type(timeout_ms) ~= 'nil' then
+        assert(type(timeout_ms) == 'number' or (type(timeout_ms) == 'cdata' and
+            tostring(ffi.typeof(timeout_ms)) == 'ctype<uint64_t>'),
+            'timeout_ms must a number, got ' .. type(timeout_ms))
+        assert(timeout_ms <= TIMEOUT_INFINITY,
+            ('timeouts more then graphql.TIMEOUT_INFINITY (%s) ' ..
+            'do not supported'):format(tostring(TIMEOUT_INFINITY)))
+    end
+end
+
 --- This function is called on first select related to a query. Its purpose is
 --- to initialize qcontext table.
 --- @tparam table accessor
 --- @tparam table qcontext per-query table which stores query internal state;
 --- all neccessary initialization of this parameter should be performed by this
 --  function
 local function init_qcontext(accessor, qcontext)
-    local settings = accessor.settings
+    for k, v in pairs(accessor.query_settings_default) do
+        if qcontext.query_settings[k] == nil then
+            qcontext.query_settings[k] = v
+        end
+    end
+    validate_query_settings(qcontext.query_settings)
+
+    qcontext.deadline_clock = clock.monotonic64() +
+        qcontext.query_settings.timeout_ms * 1000 * 1000
+
     qcontext.statistics = {
         resulting_object_cnt = 0,
         fetched_object_cnt = 0,
         select_requests_cnt = 0,
         full_scan_select_requests_cnt = 0,
         index_select_requests_cnt = 0,
     }
-    qcontext.deadline_clock = clock.monotonic64() +
-        settings.timeout_ms * 1000 * 1000
 end
 
 --- Create default unflatten/flatten/xflatten functions, that can be called
@@ -1474,12 +1511,24 @@ function accessor_general.new(opts, funcs)
     local collections = opts.collections
     local service_fields = opts.service_fields
     local indexes = opts.indexes
+
+    check(schemas, 'schemas', 'table')
+    check(collections, 'collections', 'table')
+    check(service_fields, 'service_fields', 'table')
+    check(indexes, 'indexes', 'table')
+
     local resulting_object_cnt_max = opts.resulting_object_cnt_max or
-                                     DEF_RESULTING_OBJECT_CNT_MAX
+        DEF_RESULTING_OBJECT_CNT_MAX
     local fetched_object_cnt_max = opts.fetched_object_cnt_max or
-                                   DEF_FETCHED_OBJECT_CNT_MAX
-    -- TODO: move this setting to `tgql.compile` after #59
+        DEF_FETCHED_OBJECT_CNT_MAX
     local timeout_ms = opts.timeout_ms or DEF_TIMEOUT_MS
+    local query_settings_default = {
+        resulting_object_cnt_max = resulting_object_cnt_max,
+        fetched_object_cnt_max = fetched_object_cnt_max,
+        timeout_ms = timeout_ms,
+    }
+    validate_query_settings(query_settings_default)
+
     -- Mutations are disabled for avro-schema-2*, because it can work
     -- incorrectly for schemas with nullable types.
     local enable_mutations
@@ -1488,27 +1537,6 @@ function accessor_general.new(opts, funcs)
     else
         enable_mutations = opts.enable_mutations
     end
-
-    assert(type(schemas) == 'table',
-        'schemas must be a table, got ' .. type(schemas))
-    assert(type(collections) == 'table',
-        'collections must be a table, got ' .. type(collections))
-    assert(type(service_fields) == 'table',
-        'service_fields must be a table, got ' .. type(service_fields))
-    assert(type(indexes) == 'table',
-        'indexes must be a table, got ' .. type(indexes))
-    assert(type(resulting_object_cnt_max) == 'number' and
-                resulting_object_cnt_max > 0,
-        'resulting_object_cnt_max must be natural number')
-    assert(type(fetched_object_cnt_max) == 'number' and
-                fetched_object_cnt_max > 0,
-        'fetched_object_cnt_max must be natural number')
-    assert(type(timeout_ms) == 'number' or (type(timeout_ms) == 'cdata' and
-        tostring(ffi.typeof(timeout_ms)) == 'ctype<uint64_t>'),
-        'timeout_ms must a number, got ' .. type(timeout_ms))
-    assert(timeout_ms <= TIMEOUT_INFINITY,
-        ('timeouts more then graphql.TIMEOUT_INFINITY (%s) ' ..
-        'do not supported'):format(tostring(TIMEOUT_INFINITY)))
     check(enable_mutations, 'enable_mutations', 'boolean')
 
     local models, service_fields_defaults = compile_schemas(schemas,
@@ -1537,11 +1565,9 @@ function accessor_general.new(opts, funcs)
         index_cache = index_cache,
         funcs = funcs,
         settings = {
-            resulting_object_cnt_max = resulting_object_cnt_max,
-            fetched_object_cnt_max = fetched_object_cnt_max,
-            timeout_ms = timeout_ms,
             enable_mutations = enable_mutations,
-        }
+        },
+        query_settings_default = query_settings_default,
     }, {
         __index = {
             select = function(self, parent, collection_name, from,
@@ -1576,4 +1602,7 @@ function accessor_general.new(opts, funcs)
     })
 end
 
+-- export the function
+accessor_general.validate_query_settings = validate_query_settings
+
 return accessor_general

graphql/impl.lua

@@ -3,6 +3,7 @@
 
 local accessor_space = require('graphql.accessor_space')
 local accessor_shard = require('graphql.accessor_shard')
+local accessor_general = require('graphql.accessor_general')
 local parse = require('graphql.core.parse')
 local validate = require('graphql.core.validate')
 local execute = require('graphql.core.execute')
@@ -39,8 +40,11 @@ local function gql_execute(qstate, variables, operation_name)
     check(variables, 'variables', 'table')
     check(operation_name, 'operation_name', 'string', 'nil')
 
+    assert(qstate.query_settings)
     local root_value = {}
-    local qcontext = {}
+    local qcontext = {
+        query_settings = qstate.query_settings,
+    }
 
     local traceback
     local ok, data = xpcall(function()
@@ -67,15 +71,17 @@ end
 --- See @{gql_compile} and @{gql_execute} for parameters description.
 ---
 --- @treturn table result of the operation
-local function compile_and_execute(state, query, variables, operation_name)
+local function compile_and_execute(state, query, variables, operation_name,
+        opts)
     assert(type(state) == 'table', 'use :gql_execute(...) instead of ' ..
         '.execute(...)')
     assert(state.schema ~= nil, 'have not compiled schema')
     check(query, 'query', 'string')
     check(variables, 'variables', 'table', 'nil')
     check(operation_name, 'operation_name', 'string', 'nil')
+    check(opts, 'opts', 'table', 'nil')
 
-    local compiled_query = state:compile(query)
+    local compiled_query = state:compile(query, opts)
     return compiled_query:execute(variables, operation_name)
 end
 
@@ -87,21 +93,39 @@ end
 ---
 --- @tparam string query text of a GraphQL query
 ---
+--- @tparam[opt] table opts the following options (described in
+--- @{accessor_general.new}):
+---
+--- * resulting_object_cnt_max
+--- * fetched_object_cnt_max
+--- * timeout_ms
+---
 --- @treturn table compiled query with `execute` and `avro_schema` functions
-local function gql_compile(state, query)
+local function gql_compile(state, query, opts)
     assert(type(state) == 'table' and type(query) == 'string',
         'use :validate(...) instead of .validate(...)')
     assert(state.schema ~= nil, 'have not compiled schema')
     check(query, 'query', 'string')
+    check(opts, 'opts', 'table', 'nil')
+
+    local opts = opts or {}
 
     local ast = parse(query)
     validate(state.schema, ast)
 
     local qstate = {
         state = state,
         ast = ast,
+        query_settings = {
+            resulting_object_cnt_max = opts.resulting_object_cnt_max,
+            fetched_object_cnt_max = opts.fetched_object_cnt_max,
+            timeout_ms = opts.timeout_ms,
+        }
     }
 
+    accessor_general.validate_query_settings(qstate.query_settings,
+        {allow_nil = true})
+
     local gql_query = setmetatable(qstate, {
         __index = {
             execute = gql_execute,

test/common/limit_result.test.lua

@@ -10,9 +10,19 @@ local tap = require('tap')
 local test_utils = require('test.test_utils')
 local testdata = require('test.testdata.user_order_item_testdata')
 local graphql = require('graphql')
+local graphql_utils = require('graphql.utils')
+local test_run = graphql_utils.optional_require('test_run')
+test_run = test_run and test_run.new()
 
 local e = graphql.error_codes
 
+local apply_settings_to = test_run and test_run:get_cfg('apply_settings_to') or
+    'graphql'
+local settings = {
+    resulting_object_cnt_max = 3,
+    fetched_object_cnt_max = 5,
+}
+
 local function run_queries(gql_wrapper)
     local test = tap.test('result cnt')
     test:plan(2)
@@ -32,7 +42,8 @@ local function run_queries(gql_wrapper)
         }
     ]]
 
-    local gql_query = gql_wrapper:compile(query)
+    local query_opts = apply_settings_to == 'query' and settings or nil
+    local gql_query = gql_wrapper:compile(query, query_opts)
     local variables = {
         user_id = 5,
     }
@@ -65,12 +76,10 @@ end
 
 box.cfg({})
 
+local graphql_opts = apply_settings_to == 'graphql' and settings or nil
 test_utils.run_testdata(testdata, {
     run_queries = run_queries,
-    graphql_opts = {
-        resulting_object_cnt_max = 3,
-        fetched_object_cnt_max = 5,
-    }
+    graphql_opts = graphql_opts,
 })
 
 os.exit()

test/common/query_timeout.test.lua

@@ -10,9 +10,18 @@ local tap = require('tap')
 local test_utils = require('test.test_utils')
 local testdata = require('test.testdata.user_order_item_testdata')
 local graphql = require('graphql')
+local graphql_utils = require('graphql.utils')
+local test_run = graphql_utils.optional_require('test_run')
+test_run = test_run and test_run.new()
 
 local e = graphql.error_codes
 
+local apply_settings_to = test_run and test_run:get_cfg('apply_settings_to') or
+    'graphql'
+local settings = {
+    timeout_ms = 0.001,
+}
+
 local function run_queries(gql_wrapper)
     local test = tap.test('result cnt')
     test:plan(1)
@@ -32,7 +41,8 @@ local function run_queries(gql_wrapper)
         }
     ]]
 
-    local gql_query = gql_wrapper:compile(query)
+    local query_opts = apply_settings_to == 'query' and settings or nil
+    local gql_query = gql_wrapper:compile(query, query_opts)
     local variables = {}
     local result = gql_query:execute(variables)
     assert(result.data == nil, "this test should fail")
@@ -47,11 +57,10 @@ end
 
 box.cfg({})
 
+local graphql_opts = apply_settings_to == 'graphql' and settings or nil
 test_utils.run_testdata(testdata, {
     run_queries = run_queries,
-    graphql_opts = {
-        timeout_ms = 0.001,
-    }
+    graphql_opts = graphql_opts,
 })
 
 os.exit()

test/common/suite.cfg

@@ -1,6 +1,22 @@
 {
+    "query_timeout.test.lua": {
+        "space (g)":     {"conf": "space",     "apply_settings_to": "graphql"},
+        "shard_2x2 (g)": {"conf": "shard_2x2", "apply_settings_to": "graphql"},
+        "shard_4x1 (g)": {"conf": "shard_4x1", "apply_settings_to": "graphql"},
+        "space (q)":     {"conf": "space",     "apply_settings_to": "query"},
+        "shard_2x2 (q)": {"conf": "shard_2x2", "apply_settings_to": "query"},
+        "shard_4x1 (q)": {"conf": "shard_4x1", "apply_settings_to": "query"}
+    },
+    "limit_result.test.lua": {
+        "space (g)":     {"conf": "space",     "apply_settings_to": "graphql"},
+        "shard_2x2 (g)": {"conf": "shard_2x2", "apply_settings_to": "graphql"},
+        "shard_4x1 (g)": {"conf": "shard_4x1", "apply_settings_to": "graphql"},
+        "space (q)":     {"conf": "space",     "apply_settings_to": "query"},
+        "shard_2x2 (q)": {"conf": "shard_2x2", "apply_settings_to": "query"},
+        "shard_4x1 (q)": {"conf": "shard_4x1", "apply_settings_to": "query"}
+    },
     "*": {
-        "space": {"conf": "space"},
+        "space":     {"conf": "space"},
         "shard_2x2": {"conf": "shard_2x2"},
         "shard_4x1": {"conf": "shard_4x1"}
     }