Disable mutations for avro-schema-2* by default

Added `enable_mutations` option to forcely enable it.

Author: Totktonada

README.md

@@ -126,6 +126,11 @@ local result = compiled_query:execute(variables)
 
 ### Mutations
 
+Mutations are disabled for avro-schema-2\*, because it can work incorrectly for
+schemas with nullable types (ones whose marked with asterisk). Mutations still
+can be enabled with the `enable_mutations = true` option, but use it with
+caution. Don't enable this option with schemas involve nullable types.
+
 #### Insert
 
 Example with an object passed from a variable:

graphql/accessor_general.lua

@@ -1458,6 +1458,10 @@ end
 ---        ...
 ---    }
 local function extra_args(self, collection_name)
+    if not self.settings.enable_mutations then
+        return {}, {}
+    end
+
     local collection = self.collections[collection_name]
     local schema_name = collection.schema_name
 
@@ -1519,29 +1523,23 @@ end
 --- Provided `funcs` argument determines certain functions for retrieving
 --- tuples.
 ---
---- @tparam table opts `schemas`, `collections`, `service_fields`, `indexes` and
---- `collection_use_tomap` ({[collection_name] = whether objects in collection
---- collection_name intended to be unflattened using tuple:tomap({names_only = true})
---- method instead of compiled_avro_schema.unflatten(tuple), ...})
---- to give the data accessor all needed meta-information re data; the format is
---- shown below; additional attributes `resulting_object_cnt_max` and
---- `fetched_object_cnt_max` are optional positive numbers which help to control
---- query behaviour in case it requires more resources than expected _(default
---- value is 10,000)_; `timeout_ms` _(default is 1000)_
----
---- @tparam table funcs set of functions:
----
---- * `is_collection_exists`,
---- * `get_index`,
---- * `get_primary_index`,
---- * `unflatten_tuple`,
---- * `flatten_object`,
---- * `insert_tuple`.
----
---- They allows this abstract data accessor behaves in the certain way (say,
---- like space data accessor or shard data accessor); consider the
---- `accessor_space` and the `accessor_shard` modules documentation for these
---- functions description.
+--- @tparam table opts set of options:
+---
+--- * `schemas`,
+--- * `collections`,
+--- * `service_fields`,
+--- * `indexes`,
+--- * `collection_use_tomap`: ({[collection_name] = whether objects in
+---    collection `collection_name` intended to be unflattened using
+---    `tuple:tomap({names_only = true}` method instead of
+---    `compiled_avro_schema.unflatten(tuple), ...}`),
+--- * `resulting_object_cnt_max` and `fetched_object_cnt_max` are optional
+---   positive numbers which help to control query behaviour in case it
+---   requires more resources than expected _(default value is 10,000 for
+---   both)_,
+--- * `timeout_ms` _(default is 1000)_,
+--- * `enable_mutations`: boolean flag _(default is `false` for avro-schema-2*
+---    and `true` for avro-schema-3*)_.
 ---
 --- For examples of `opts.schemas` and `opts.collections` consider the
 --- @{tarantool_graphql.new} function description.
@@ -1568,6 +1566,20 @@ end
 ---         ...
 ---     }
 ---
+--- @tparam table funcs set of functions:
+---
+--- * `is_collection_exists`,
+--- * `get_index`,
+--- * `get_primary_index`,
+--- * `unflatten_tuple`,
+--- * `flatten_object`,
+--- * `insert_tuple`.
+---
+--- They allows this abstract data accessor behaves in the certain way (say,
+--- like space data accessor or shard data accessor); consider the
+--- `accessor_space` and the `accessor_shard` modules documentation for these
+--- functions description.
+---
 --- @treturn table data accessor instance, a table with the two methods
 --- (`select` and `arguments`) as described in the @{tarantool_graphql.new}
 --- function description.
@@ -1587,6 +1599,14 @@ function accessor_general.new(opts, funcs)
                                    DEF_FETCHED_OBJECT_CNT_MAX
     -- TODO: move this setting to `tgql.compile` after #59
     local timeout_ms = opts.timeout_ms or DEF_TIMEOUT_MS
+    -- Mutations are disabled for avro-schema-2*, because it can work
+    -- incorrectly for schemas with nullable types.
+    local enable_mutations
+    if opts.enable_mutations == nil then
+        enable_mutations = avro_helpers.major_avro_schema_version() == 3
+    else
+        enable_mutations = opts.enable_mutations
+    end
 
     assert(type(schemas) == 'table',
         'schemas must be a table, got ' .. type(schemas))
@@ -1608,6 +1628,7 @@ function accessor_general.new(opts, funcs)
     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,
         service_fields)
@@ -1637,7 +1658,8 @@ function accessor_general.new(opts, funcs)
         settings = {
             resulting_object_cnt_max = resulting_object_cnt_max,
             fetched_object_cnt_max = fetched_object_cnt_max,
-            timeout_ms = timeout_ms
+            timeout_ms = timeout_ms,
+            enable_mutations = enable_mutations,
         }
     }, {
         __index = {

graphql/avro_helpers.lua

@@ -1,6 +1,7 @@
 --- The module us collection of helpers to simplify avro-schema related tasks.
 
 local json = require('json')
+local avro_schema = require('avro_schema')
 
 local avro_helpers = {}
 
@@ -71,4 +72,15 @@ function avro_helpers.make_avro_type_nullable(avro, opts)
     error("avro should be a string or a table, got " .. value_type)
 end
 
+--- Determines major version of the avro-schema module in use.
+---
+--- @treturn number 2 or 3
+function avro_helpers.major_avro_schema_version()
+    local ok, handle = avro_schema.create('boolean')
+    assert(ok, tostring(handle))
+    local ok, model = avro_schema.compile(handle)
+    assert(ok, tostring(model))
+    return model.get_types == nil and 2 or 3
+end
+
 return avro_helpers

graphql/tarantool_graphql.lua

@@ -1675,6 +1675,7 @@ local function create_default_accessor(cfg)
             resulting_object_cnt_max = cfg.resulting_object_cnt_max,
             fetched_object_cnt_max = cfg.fetched_object_cnt_max,
             timeout_ms = cfg.timeout_ms,
+            enable_mutations = cfg.enable_mutations,
         }, cfg.accessor_funcs)
     end
 
@@ -1688,6 +1689,7 @@ local function create_default_accessor(cfg)
             resulting_object_cnt_max = cfg.resulting_object_cnt_max,
             fetched_object_cnt_max = cfg.fetched_object_cnt_max,
             timeout_ms = cfg.timeout_ms,
+            enable_mutations = cfg.enable_mutations,
         }, cfg.accessor_funcs)
     end
 end

test/common/mutation.test.lua

@@ -787,8 +787,54 @@ local function run_queries(gql_wrapper, virtbox, meta)
     assert(test:check(), 'check plan')
 end
 
-test_utils.run_testdata(testdata, {
-    run_queries = run_queries,
-})
+-- Mutations are disabled for avro-schema-2* by default, but can be enabled by
+-- the option.
+local function run_queries_avro_schema_2(test, enable_mutations, gql_wrapper,
+        virtbox, meta)
+    local mutation_insert = [[
+        mutation insert_user($user: user_collection_insert) {
+            user_collection(insert: $user) {
+                user_id
+                first_name
+                last_name
+            }
+        }
+    ]]
+    local ok, err = pcall(gql_wrapper.compile, gql_wrapper, mutation_insert)
+
+    if enable_mutations then
+        test:ok(ok, 'mutations are enabled with the enable_mutations flag')
+    else
+        local err_exp = 'Variable specifies unknown type ' ..
+            '"user_collection_insert"'
+        test:is_deeply({ok, test_utils.strip_error(err)}, {false, err_exp},
+            'mutations are forbidden for avro-schema-2*')
+    end
+end
+
+if test_utils.major_avro_schema_version() == 3 then
+    test_utils.run_testdata(testdata, {
+        run_queries = run_queries,
+    })
+else
+    local test = tap.test('mutation')
+    test:plan(2)
+    local function workload(_, shard)
+        local virtbox = shard or box.space
+        local meta = testdata.meta or testdata.get_test_metadata()
+        testdata.fill_test_data(virtbox, meta)
+        -- test mutations are disabled on avro-schema-2* by default
+        local gql_wrapper = test_utils.graphql_from_testdata(testdata, shard)
+        run_queries_avro_schema_2(test, false, gql_wrapper, virtbox, meta)
+        -- test mutations can be enabled on avro-schema-2* by the option
+        local gql_wrapper = test_utils.graphql_from_testdata(testdata, shard,
+            {enable_mutations = true})
+        run_queries_avro_schema_2(test, true, gql_wrapper, virtbox, meta)
+    end
+    test_utils.run_testdata(testdata, {
+        workload = workload,
+    })
+    assert(test:check(), 'check plan')
+end
 
 os.exit()

test/utils.lua

@@ -64,6 +64,10 @@ local function get_model(meta, collection_name)
     return model
 end
 
+function utils.clear_models_cache()
+    models_cache = nil
+end
+
 function utils.flatten_object(meta, collection_name, object,
         service_field_values)
     local model = get_model(meta, collection_name)
@@ -121,6 +125,9 @@ end
 function utils.run_testdata(testdata, opts)
     local opts = opts or {}
     local run_queries = opts.run_queries or testdata.run_queries
+    -- custom workload for, say, test different options on several graphql
+    -- instances
+    local workload = opts.workload or nil
 
     -- allow to run under tarantool on 'space' configuration w/o test-run
     local conf_name = test_run and test_run:get_cfg('conf') or 'space'
@@ -130,14 +137,18 @@ function utils.run_testdata(testdata, opts)
         init_function = testdata.init_spaces,
         init_function_params = {utils.major_avro_schema_version()},
         cleanup_function = testdata.drop_spaces,
-        workload = function(_, shard)
-            local virtbox = shard or box.space
-            local meta = testdata.meta or testdata.get_test_metadata()
-            testdata.fill_test_data(virtbox, meta)
-            local gql_wrapper = utils.graphql_from_testdata(testdata, shard,
-                opts.graphql_opts)
-            run_queries(gql_wrapper, virtbox, meta)
-            models_cache = nil -- clear models cache
+        workload = function(conf_name, shard)
+            if workload then
+                workload(conf_name, shard)
+            else
+                local virtbox = shard or box.space
+                local meta = testdata.meta or testdata.get_test_metadata()
+                testdata.fill_test_data(virtbox, meta)
+                local gql_wrapper = utils.graphql_from_testdata(testdata, shard,
+                    opts.graphql_opts)
+                run_queries(gql_wrapper, virtbox, meta)
+            end
+            utils.clear_models_cache()
         end,
         servers = {'shard1', 'shard2', 'shard3', 'shard4'},
         use_tcp = false,