Merge pull request #95 from tarantool/sb/simple_config

Provide list of usability features:
1. Zero config
2. Require('graphql').execute()/compile()
functionality
3. GraphiQL
4. Config complementation

Author: SudoBobo

graphql/accessor_general.lua

@@ -839,7 +839,7 @@ local function process_tuple(state, tuple, opts)
 
     -- convert tuple -> object
     local obj = opts.unflatten_tuple(collection_name, tuple,
-        opts.default_unflatten_tuple)
+        { use_tomap = opts.use_tomap }, opts.default_unflatten_tuple)
 
     -- skip all items before pivot (the item pointed by offset)
     if not state.pivot_found and pivot_filter then
@@ -987,6 +987,7 @@ local function select_internal(self, collection_name, from, filter, args, extra)
         fetched_object_cnt_max = self.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,
         default_unflatten_tuple = default_unflatten_tuple,
         pcre = args.pcre,
         resolveField = extra.resolveField,
@@ -1196,7 +1197,10 @@ end
 --- Provided `funcs` argument determines certain functions for retrieving
 --- tuples.
 ---
---- @tparam table opts `schemas`, `collections`, `service_fields` and `indexes`
+--- @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
@@ -1301,6 +1305,7 @@ function accessor_general.new(opts, funcs)
         indexes = indexes,
         models = models,
         default_unflatten_tuple = default_unflatten_tuple,
+        collection_use_tomap = opts.collection_use_tomap or {},
         index_cache = index_cache,
         funcs = funcs,
         settings = {

graphql/accessor_shard.lua

@@ -84,12 +84,20 @@ end
 ---
 --- @tparam string collection_name
 --- @tparam cdata/table tuple
+--- @tparam table opts
+--- * `use_tomap` (boolean, default: false; whether objects in collection
+--- collection_name intended to be unflattened using tuple:tomap({names_only = true})
+--- method instead of compiled_avro_schema.unflatten(tuple)
 --- @tparam function default unflatten action, call it in the following way:
 ---
---- ```
---- return default(collection_name, tuple)
---- ```
-local function unflatten_tuple(collection_name, tuple, default)
+---
+---     return default(collection_name, tuple)
+---
+local function unflatten_tuple(collection_name, tuple, opts, default)
+    if opts.use_tomap then
+        return tuple:tomap({ names_only = true })
+    end
+
     return default(collection_name, tuple)
 end
 

graphql/accessor_space.lua

@@ -26,12 +26,20 @@ end
 ---
 --- @tparam string collection_name
 --- @tparam cdata/table tuple
+--- @tparam table opts
+--- @tparam table opts
+--- * `use_tomap` (boolean, default: false; whether objects in collection
+--- collection_name intended to be unflattened using tuple:tomap({names_only = true})
+--- method instead of compiled_avro_schema.unflatten(tuple)
 --- @tparam function default unflatten action, call it in the following way:
 ---
---- ```
---- return default(collection_name, tuple)
---- ```
-local function unflatten_tuple(collection_name, tuple, default)
+---
+---     return default(collection_name, tuple)
+---
+local function unflatten_tuple(collection_name, tuple, opts, default)
+    if opts.use_tomap then
+        return tuple:tomap({ names_only = true })
+    end
     return default(collection_name, tuple)
 end
 

graphql/config_complement.lua

@@ -0,0 +1,255 @@
+--- Config complement module provides an ability to complement user-defined config
+--- (in a simplified format) to a fully specified format.
+---
+--- Notes:
+---
+--- * Currently the module complements only connections (cfg.connections),
+--- see @{complement_connections}.
+
+local json = require('json')
+local yaml = require('yaml')
+local log = require('log')
+local utils = require('graphql.utils')
+local check = utils.check
+local get_spaces_formats = require('graphql.simple_config').get_spaces_formats
+
+local config_complement = {}
+
+--- The function determines connection type by connection.parts
+--- and source collection space format.
+---
+--- XXX Currently there are two possible situations when connection_parts form
+--- unique index - all source_fields are nullable (1:1*) or all source_fields
+--- are non nullable (1:1). In case of partially nullable connection_parts (which
+--- form unique index) the error is raised. There is an alternative: relax
+--- this requirement and deduce non-null connection type in the case.
+local function determine_connection_type(connection_parts, index, source_space_format)
+    local type
+
+    if #connection_parts < #(index.fields) then
+        type = '1:N'
+    end
+
+    if #connection_parts == #(index.fields) then
+        if index.unique then
+            type = '1:1'
+        else
+            type = '1:N'
+        end
+    end
+
+    local is_all_nullable = true
+    local is_all_not_nullable = true
+
+    for _, connection_part in pairs(connection_parts) do
+        for _,field_format in ipairs(source_space_format) do
+            if connection_part.source_field == field_format.name then
+                if field_format.is_nullable == true then
+                    is_all_not_nullable = false
+                else
+                    is_all_nullable = false
+                end
+            end
+        end
+    end
+
+    if is_all_nullable == is_all_not_nullable and type == '1:1' then
+        error('source_fields in connection_parts must be all nullable or ' ..
+            'not nullable at the same time')
+    end
+
+    if is_all_nullable and type == '1:1' then
+        type = '1:1*'
+    end
+
+    return type
+end
+
+-- The function returns connection_parts sorted by destination_fields as
+-- index_fields prefix.
+local function sort_parts(connection_parts, index_fields)
+    local sorted_parts = {}
+
+    -- check if fields in connection_parts exist in index_fields
+    for _, part in ipairs(connection_parts) do
+        local is_found = false
+        for i, index_field in ipairs(index_fields) do
+            if part.destination_field == index_field then
+                is_found = true
+            end
+        end
+        assert(is_found, ('part.destination_field %s was not found in ' ..
+            'connection index %s'):format(part.destination_field,
+                json.encode(index_fields)))
+    end
+
+    -- sort parts and check that sorted_parts form index prefix
+    -- (including index itself)
+    for i = 1, utils.table_size(connection_parts) do
+        local index_field = index_fields[i]
+        for _, part in ipairs(connection_parts) do
+            if part.destination_field == index_field then
+                sorted_parts[i] = {destination_field = part.destination_field,
+                                   source_field = part.source_field}
+                break
+            end
+            -- no match found
+            error(('given parts %s does not form an index or an index ' ..
+                'prefix %s'):format(json.encode(connection_parts),
+                    json.encode(index_fields)))
+        end
+    end
+    return sorted_parts
+end
+
+local function is_order_different(connection_parts, index_fields)
+    for i, _ in ipairs(connection_parts) do
+        if connection_parts[i].destination_field ~= index_fields[i] then
+            return true
+        end
+    end
+    return false
+end
+
+--- The function complements partially defined (nil/number) connection parts
+--- or check and sort fully defined (table) connection parts.
+--- @tparam table parts partially defined connection's part given by user
+--- @tparam table index connection index (cfg.indexes[collection][index_name])
+--- index.fields will be used as the source of information about the index parts order.
+--- An error will be raised in cases when parts is a table and cannot form a
+--- prefix of index.fields. When parts can be resorted to fit right order, they
+--- will be resorted.
+local function determine_connection_parts(parts, index)
+    check(parts, 'parts', 'nil', 'number', 'table')
+    local result_parts = {}
+
+    -- User defined no parts of the connection. All connection's index fields
+    -- are taken as 'parts'
+    if type(parts) == 'nil' then
+        for i, v in ipairs(index.fields) do
+            result_parts[i] = {source_field = v, destination_field = v}
+        end
+    end
+
+    -- User defined a number of fields of index which must form index prefix.
+    -- First 'number' index fields are taken as 'parts'
+    if type(parts) == 'number' then
+        for i = 1, parts do
+            local v = index.fields[i]
+            result_parts[i] = {source_field = v, destination_field = v}
+        end
+    end
+
+    -- User defined parts as pairs of {source_field: foo_field,
+    -- destination_field: boo_field}. These 'parts' may correspond either to full
+    -- index or index prefix
+    if type(parts) == 'table' then
+        -- sorting parts is necessary to check if user defined part form an
+        -- index or an index prefix
+        if is_order_different(parts, index) then
+            log.warn(('Parts \n %s \n were given in the wrong order and ' ..
+                'sorted to match the right order of destination collection ' ..
+                'index fields \n %s \n'):format(yaml.encode(parts),
+                    yaml.encode(index.fields)))
+            result_parts = sort_parts(parts, index.fields)
+        else
+            result_parts = parts
+        end
+    end
+
+    return result_parts
+end
+
+--- The function complements collections' connections, described in simplified
+--- format, to connections in a fully specified format. Type determined on index type.
+--- Each connection will be added to a `source_collection' collection,
+--- because the format of a collection assumes inclusion of all outcoming connections.
+--- Notice an example:
+---
+---     "connections" : [
+---         {
+---             "name": "order_connection",
+---             "source_collection": "user_collection",
+---             "destination_collection": "order_collection"
+---             "index_name": "user_id_index",
+---             "parts" : nil | number | table (destination fields can be omitted)
+---                 in case of 'table' expected format is:
+---                 "parts": [
+---                     {"source_field": "user_id", "destination_field": "user_id"},
+---                     ...
+---                 ]
+---         },
+---         ...
+---     ]
+---
+--- will produce following complement in 'user_collection' :
+---
+---     "user_collection": {
+---         "schema_name": "user",
+---         "connections": [
+---             {
+---                 "type": "1:N",
+---                 "name": "order_connection",
+---                 "destination_collection":  "order_collection",
+---                 "parts": [
+---                     { "source_field": "user_id", "destination_field": "user_id" }
+---                 ],
+---                 "index_name": "user_id_index"
+---             },
+---         ]
+---     }
+---
+--- @tparam table collections cfg.collections (will be changed in place)
+--- @tparam table connections cfg.connections - user-defined collections
+--- @tparam table indexes cfg.indexes - {[collection_name] = collection_indexes, ...}
+--- @treturn table `collections` is complemented collections
+local function complement_connections(collections, connections, indexes, schemas)
+    if connections == nil then
+        return collections
+    end
+
+    check(collections, 'collections', 'table')
+    check(connections, 'connections', 'table')
+
+    local spaces_formats = get_spaces_formats()
+
+    for _, c in pairs(connections) do
+        check(c.name, 'connection.name', 'string')
+        check(c.source_collection, 'connection.source_collection', 'string')
+        check(c.destination_collection, 'connection.destination_collection',
+            'string')
+        check(c.index_name, 'connection.index_name', 'string')
+        check(c.parts, 'connection.parts', 'string', 'table', 'nil')
+
+        local index = indexes[c.source_collection][c.index_name]
+        assert(index.unique ~= nil, 'index.unique must not be nil ' ..
+            'during connections complementing')
+
+        local result_c = {}
+        result_c.source_collection = c.source_collection
+        result_c.destination_collection = c.destination_collection
+        result_c.parts = determine_connection_parts(c.parts, index)
+
+        local source_space_format = spaces_formats[result_c.source_collection]
+
+        result_c.type = determine_connection_type(result_c.parts, index,
+            source_space_format)
+        result_c.index_name = c.index_name
+        result_c.name = c.name
+
+        local collection_connections = collections[c.source_collection].
+            connections or {}
+        collection_connections[#collection_connections + 1] = result_c
+    end
+    return collections
+end
+
+--- The function complements cfg.collection.connections using given
+--- cfg.connections. See @{complement_connections} for details.
+function config_complement.complement_cfg(cfg)
+    cfg.collections = complement_connections(cfg.collections, cfg.connections,
+        cfg.indexes)
+    return cfg
+end
+
+return config_complement