WIP: Implement update mutation

Part of #142.

Author: Totktonada

README.md

@@ -126,6 +126,8 @@ local result = compiled_query:execute(variables)
 
 ### Mutations
 
+#### Insert
+
 Example with an object passed from a variable:
 
 ```
@@ -184,6 +186,19 @@ Consider the following details:
   inserted.
 * Of course `insert` argument is forbidden in `query` requests.
 
+#### Update
+
+TBD
+
+Points:
+
+* Objects selected by filters first, then updated using a statement in the
+  `update` argument.
+
+#### Delete
+
+TBD
+
 ## GraphiQL
 ```
 local graphql = require('graphql').new({

graphql/accessor_general.lua

@@ -1147,6 +1147,50 @@ local function insert_internal(self, collection_name, from, filter, args, extra)
     return {new_object}
 end
 
+--- XXX
+local function update_internal(self, collection_name, from, filter, args,
+        extra, selected)
+    local xobject = extra.extra_args.update
+    if xobject == nil then return nil end
+
+    -- convert xobject -> update statements
+    local collection = self.collections[collection_name]
+    assert(collection ~= nil,
+        ('cannot find the collection "%s"'):format(collection_name))
+    local schema_name = collection.schema_name
+    assert(type(schema_name) == 'string',
+        'schema_name must be a string, got ' .. type(schema_name))
+
+    local default_xflatten = self.default_xflatten[schema_name]
+    assert(default_xflatten ~= nil,
+        ('cannot find default_xflatten ' ..
+        'for collection "%s"'):format(collection_name))
+
+    local statements = self.funcs.xflatten(collection_name, xobject, {
+        service_fields_defaults =
+            self.service_fields_defaults[schema_name],
+    }, default_xflatten)
+
+    -- XXX: remove connection fields from the selected objects in process_tuple
+    -- apply update statements & tuples -> objects
+    local _, primary_index_meta = get_primary_index_meta(self, collection_name)
+    local new_objects = {}
+    for _, object in ipairs(selected) do
+        local key = {}
+        for _, field_name in ipairs(primary_index_meta.fields) do
+            table.insert(key, object[field_name])
+        end
+        local new_tuple = self.funcs.update_tuple(collection_name, key,
+            statements)
+        local new_object = self.funcs.unflatten_tuple(collection_name,
+            new_tuple, {use_tomap = self.collection_use_tomap[collection_name]},
+            self.default_unflatten_tuple[schema_name])
+        table.insert(new_objects, new_object)
+    end
+
+    return new_objects
+end
+
 --- Set of asserts to check the `funcs` argument of the @{accessor_general.new}
 --- function.
 --- @tparam table funcs set of function as defined in the
@@ -1170,9 +1214,15 @@ local function validate_funcs(funcs)
     assert(type(funcs.flatten_object) == 'function',
         'funcs.flatten_object must be a function, got ' ..
         type(funcs.flatten_object))
+    assert(type(funcs.xflatten) == 'function',
+        'funcs.xflatten must be a function, got ' ..
+        type(funcs.xflatten))
     assert(type(funcs.insert_tuple) == 'function',
         'funcs.insert_tuple must be a function, got ' ..
         type(funcs.insert_tuple))
+    assert(type(funcs.update_tuple) == 'function',
+        'funcs.update_tuple must be a function, got ' ..
+        type(funcs.update_tuple))
 end
 
 --- This function is called on first select related to a query. Its purpose is
@@ -1292,6 +1342,60 @@ local function get_pcre_argument_type(self, collection_name)
     return pcre_type
 end
 
+--- Create default unflatten/flatten/xflatten functions, that can be called
+--- from funcs.unflatten_tuple/funcs.flatten_object/funcs.xflatten when an
+--- additional pre/postprocessing is not needed.
+---
+--- @tparam table models list of compiled schemas
+---
+--- @treturn table table with default_* fields with maps from schema name to
+--- the corresponding default *flatten function
+local function gen_default_object_tuple_map_funcs(models)
+    local default_unflatten_tuple = {}
+    local default_flatten_object = {}
+    local default_xflatten = {}
+    for schema_name, model in pairs(models) do
+        default_unflatten_tuple[schema_name] = function(_, tuple, opts)
+            local opts = opts or {}
+            check(opts, 'opts', 'table')
+
+            local ok, obj = model.unflatten(tuple)
+            assert(ok, ('cannot unflat tuple of schema "%s": %s'):format(
+                schema_name, tostring(obj)))
+            return obj
+        end
+        default_flatten_object[schema_name] = function(_, obj, opts)
+            local opts = opts or {}
+            check(opts, 'opts', 'table')
+            local sf_defaults = opts.service_fields_defaults or {}
+            check(sf_defaults, 'service_fields_defaults', 'table')
+
+            local ok, tuple = model.flatten(obj, unpack(sf_defaults))
+            assert(ok, ('cannot flat object of schema "%s": %s'):format(
+                schema_name, tostring(tuple)))
+            return tuple
+        end
+        default_xflatten[schema_name] = function(_, xobject, opts)
+            local opts = opts or {}
+            check(opts, 'opts', 'table')
+
+            -- it is not needed now, but maybe needed in custom xflatten
+            local sf_defaults = opts.service_fields_defaults or {}
+            check(sf_defaults, 'service_fields_defaults', 'table')
+
+            local ok, statements = model.xflatten(xobject)
+            assert(ok, ('cannot xflat xobject of schema "%s": %s'):format(
+                schema_name, tostring(xobject)))
+            return statements
+        end
+    end
+    return {
+        default_unflatten_tuple = default_unflatten_tuple,
+        default_flatten_object = default_flatten_object,
+        default_xflatten = default_xflatten,
+    }
+end
+
 --- Create a new data accessor.
 ---
 --- Provided `funcs` argument determines certain functions for retrieving
@@ -1391,39 +1495,8 @@ function accessor_general.new(opts, funcs)
         service_fields)
     validate_collections(collections, schemas, indexes)
     local index_cache = build_index_cache(indexes, collections)
-
-    -- create default unflatten/flatten functions, that can be called from
-    -- funcs.unflatten_tuple/funcs.flatten_object when an additional
-    -- pre/postprocessing is not needed
-    local default_unflatten_tuple = {}
-    local default_flatten_object = {}
-    for schema_name, model in pairs(models) do
-        default_unflatten_tuple[schema_name] =
-            function(_, tuple, opts)
-                local opts = opts or {}
-                check(opts, 'opts', 'table')
-
-                local ok, obj = model.unflatten(tuple)
-                assert(ok, ('cannot unflat tuple of schema "%s": %s'):format(
-                    schema_name, tostring(obj)))
-                return obj
-            end
-        default_flatten_object[schema_name] =
-            function(_, obj, opts)
-                local opts = opts or {}
-                check(opts, 'opts', 'table')
-                local service_fields_defaults = opts.service_fields_defaults or
-                    {}
-                check(service_fields_defaults, 'service_fields_defaults',
-                    'table')
-
-                local ok, tuple = model.flatten(obj,
-                    unpack(service_fields_defaults))
-                assert(ok, ('cannot flat object of schema "%s": %s'):format(
-                    schema_name, tostring(tuple)))
-                return tuple
-            end
-    end
+    local default_object_tuple_map_funcs =
+        gen_default_object_tuple_map_funcs(models)
 
     validate_funcs(funcs)
 
@@ -1433,8 +1506,12 @@ function accessor_general.new(opts, funcs)
         service_fields = service_fields,
         indexes = indexes,
         models = models,
-        default_unflatten_tuple = default_unflatten_tuple,
-        default_flatten_object = default_flatten_object,
+        default_unflatten_tuple =
+            default_object_tuple_map_funcs.default_unflatten_tuple,
+        default_flatten_object =
+            default_object_tuple_map_funcs.default_flatten_object,
+        default_xflatten =
+            default_object_tuple_map_funcs.default_xflatten,
         service_fields_defaults = service_fields_defaults,
         collection_use_tomap = opts.collection_use_tomap or {},
         index_cache = index_cache,
@@ -1461,8 +1538,14 @@ function accessor_general.new(opts, funcs)
                     filter, args, extra)
                 if inserted ~= nil then return inserted end
 
-                return select_internal(self, collection_name, from, filter,
+                local selected = select_internal(self, collection_name, from, filter,
                     args, extra)
+
+                local updated = update_internal(self, collection_name, from,
+                    filter, args, extra, selected)
+                if updated ~= nil then return updated end
+
+                return selected
             end,
             list_args = function(self, collection_name)
                 local offset_type = get_primary_key_type(self, collection_name)

graphql/accessor_shard.lua

@@ -136,6 +136,26 @@ local function flatten_object(collection_name, obj, opts, default)
     return default(collection_name, obj, opts)
 end
 
+--- Generate update statements for tarantool from xflatten input.
+---
+--- @tparam string collection_name
+--- @tparam table xobject xflatten input
+--- @tparam table opts
+--- * `service_fields_defaults` (list (Lua table), default: empty list; list of
+---   values to set service fields)
+--- @tparam function default xflatten action, call it in the following way:
+---
+---    return default(collection_name, xobject, opts)
+---
+--- @treturn cdata/table `tuple`
+local function xflatten(collection_name, xobject, opts, default)
+    local opts = opts or {}
+    check(opts, 'opts', 'table')
+    local service_fields_defaults = opts.service_fields_defaults or {}
+    check(service_fields_defaults, 'service_fields_defaults', 'table')
+    return default(collection_name, xobject, opts)
+end
+
 --- Insert a tuple into a collection.
 ---
 --- @tparam string collection_name
@@ -151,6 +171,20 @@ local function insert_tuple(collection_name, tuple)
     return tuples[1]
 end
 
+--- Update a tuple with an update statements.
+---
+--- @tparam string collection_name
+---
+--- @param key primary key
+---
+--- @tparam table statements
+---
+--- @treturn cdata/table `tuple`
+local function update_tuple(collection_name, key, statements)
+    -- XXX
+    error('NIY')
+end
+
 --- Create a new shard data accessor instance.
 function accessor_shard.new(opts, funcs)
     local funcs = funcs or {}
@@ -173,7 +207,9 @@ function accessor_shard.new(opts, funcs)
         get_primary_index = funcs.get_primary_index or get_primary_index,
         unflatten_tuple = funcs.unflatten_tuple or unflatten_tuple,
         flatten_object = funcs.flatten_object or flatten_object,
+        xflatten = funcs.xflatten or xflatten,
         insert_tuple = funcs.insert_tuple or insert_tuple,
+        update_tuple = funcs.update_tuple or update_tuple,
     }
 
     return accessor_general.new(opts, res_funcs)

graphql/accessor_space.lua

@@ -67,6 +67,26 @@ local function flatten_object(collection_name, obj, opts, default)
     return default(collection_name, obj, opts)
 end
 
+--- Generate update statements for tarantool from xflatten input.
+---
+--- @tparam string collection_name
+--- @tparam table xobject xflatten input
+--- @tparam table opts
+--- * `service_fields_defaults` (list (Lua table), default: empty list; list of
+---   values to set service fields)
+--- @tparam function default xflatten action, call it in the following way:
+---
+---    return default(collection_name, xobject, opts)
+---
+--- @treturn cdata/table `tuple`
+local function xflatten(collection_name, xobject, opts, default)
+    local opts = opts or {}
+    check(opts, 'opts', 'table')
+    local service_fields_defaults = opts.service_fields_defaults or {}
+    check(service_fields_defaults, 'service_fields_defaults', 'table')
+    return default(collection_name, xobject, opts)
+end
+
 --- Insert a tuple into a collection.
 ---
 --- @tparam string collection_name
@@ -78,6 +98,19 @@ local function insert_tuple(collection_name, tuple)
     return box.space[collection_name]:insert(tuple)
 end
 
+--- Update a tuple with an update statements.
+---
+--- @tparam string collection_name
+---
+--- @param key primary key
+---
+--- @tparam table statements
+---
+--- @treturn cdata/table `tuple`
+local function update_tuple(collection_name, key, statements)
+    return box.space[collection_name]:update(key, statements)
+end
+
 --- Create a new space data accessor instance.
 function accessor_space.new(opts, funcs)
     local funcs = funcs or {}
@@ -98,7 +131,9 @@ function accessor_space.new(opts, funcs)
         get_primary_index = funcs.get_primary_index or get_primary_index,
         unflatten_tuple = funcs.unflatten_tuple or unflatten_tuple,
         flatten_object = funcs.flatten_object or flatten_object,
+        xflatten = funcs.xflatten or xflatten,
         insert_tuple = funcs.insert_tuple or insert_tuple,
+        update_tuple = funcs.update_tuple or update_tuple,
     }
 
     return accessor_general.new(opts, res_funcs)