5199459215

pending completion

Build # 5199459215

Build Type

push

github

Committed by

DifferentialOrange

Commit Message

Release 1.2.0

Overview

  This release add two new flags: `noreturn` to ignore return values
  excessive transfer and encoding/decoding for insert/replace/etc
  (performance improvement up to 10% for batch requests) and
  `fetch_latest_metadata` to force fetching latest space format metadata
  right after a live migration (performance overhead may be up to 15%).

New features
  * Add `noreturn` option for operations:
    `insert`, `insert_object`, `insert_many`, `insert_object_many`,
    `replace`, `replace_object`, `replace_many`, `insert_object_many`,
    `upsert`, `upsert_object`, `upsert_many`, `upsert_object_many`,
    `update`, `delete` (#267).

Bugfixes
  * Crud DML operations returning stale schema for metadata generation.
    Now you may use `fetch_latest_metadata` flag to work with latest
    schema (#236).

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

4549 of 4888 relevant lines covered (93.06%)

18261.17 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.77

/crud/replace.lua

local checks = require('checks')
local errors = require('errors')

local call = require('crud.common.call')
local const = require('crud.common.const')
local utils = require('crud.common.utils')
local sharding = require('crud.common.sharding')
local dev_checks = require('crud.common.dev_checks')
local schema = require('crud.common.schema')

local ReplaceError = errors.new_class('ReplaceError', { capture_stack = false })

local replace = {}

local REPLACE_FUNC_NAME = '_crud.replace_on_storage'

local function replace_on_storage(space_name, tuple, opts)
    dev_checks('string', 'table', {
        add_space_schema_hash = '?boolean',
        fields = '?table',
        sharding_key_hash = '?number',
        sharding_func_hash = '?number',
        skip_sharding_hash_check = '?boolean',
        noreturn = '?boolean',
        fetch_latest_metadata = '?boolean',
    })

    opts = opts or {}

    local space = box.space[space_name]
    if space == nil then
        return nil, ReplaceError:new("Space %q doesn't exist", space_name)
    end

    local _, err = sharding.check_sharding_hash(space_name,
                                                opts.sharding_func_hash,
                                                opts.sharding_key_hash,
                                                opts.skip_sharding_hash_check)

    if err ~= nil then
        return nil, err
    end

    -- add_space_schema_hash is true only in case of replace_object
    -- the only one case when reloading schema can avoid insert error
    -- is flattening object on router
    return schema.wrap_box_space_func_result(space, 'replace', {tuple}, {
        add_space_schema_hash = opts.add_space_schema_hash,
        field_names = opts.fields,
        noreturn = opts.noreturn,
        fetch_latest_metadata = opts.fetch_latest_metadata,
    })
end

function replace.init()
   _G._crud.replace_on_storage = replace_on_storage
end

-- returns result, err, need_reload
-- need_reload indicates if reloading schema could help
-- see crud.common.schema.wrap_func_reload()
local function call_replace_on_router(vshard_router, space_name, original_tuple, opts)
    dev_checks('table', 'string', 'table', {
        timeout = '?number',
        bucket_id = '?number|cdata',
        add_space_schema_hash = '?boolean',
        fields = '?table',
        vshard_router = '?string|table',
        skip_nullability_check_on_flatten = '?boolean',
        noreturn = '?boolean',
        fetch_latest_metadata = '?boolean',
    })

    local space, err, netbox_schema_version = utils.get_space(space_name, vshard_router, opts.timeout)
    if err ~= nil then
        return nil, ReplaceError:new("An error occurred during the operation: %s", err), const.NEED_SCHEMA_RELOAD
    end
    if space == nil then
        return nil, ReplaceError:new("Space %q doesn't exist", space_name), const.NEED_SCHEMA_RELOAD
    end

    local tuple = table.deepcopy(original_tuple)

    local sharding_data, err = sharding.tuple_set_and_return_bucket_id(vshard_router, tuple, space, opts.bucket_id)
    if err ~= nil then
        return nil, ReplaceError:new("Failed to get bucket ID: %s", err), const.NEED_SCHEMA_RELOAD
    end

    local replace_on_storage_opts = {
        add_space_schema_hash = opts.add_space_schema_hash,
        fields = opts.fields,
        sharding_func_hash = sharding_data.sharding_func_hash,
        sharding_key_hash = sharding_data.sharding_key_hash,
        skip_sharding_hash_check = sharding_data.skip_sharding_hash_check,
        noreturn = opts.noreturn,
        fetch_latest_metadata = opts.fetch_latest_metadata,
    }

    local call_opts = {
        mode = 'write',
        timeout = opts.timeout,
    }
    local storage_result, err = call.single(vshard_router,
        sharding_data.bucket_id, REPLACE_FUNC_NAME,
        {space_name, tuple, replace_on_storage_opts},
        call_opts
    )

    if err ~= nil then
        local err_wrapped = ReplaceError:new("Failed to call replace on storage-side: %s", err)

        if sharding.result_needs_sharding_reload(err) then
            return nil, err_wrapped, const.NEED_SHARDING_RELOAD
        end

        return nil, err_wrapped
    end

    if storage_result.err ~= nil then
        local err_wrapped = ReplaceError:new("Failed to replace: %s", storage_result.err)

        if schema.result_needs_reload(space, storage_result) then
            return nil, err_wrapped, const.NEED_SCHEMA_RELOAD
        end

        return nil, err_wrapped
    end

    if opts.noreturn == true then
        return nil
    end

    local tuple = storage_result.res

    if opts.fetch_latest_metadata == true then
        -- This option is temporary and is related to [1], [2].
        -- [1] https://github.com/tarantool/crud/issues/236
        -- [2] https://github.com/tarantool/crud/issues/361
        space = utils.fetch_latest_metadata_when_single_storage(space, space_name, netbox_schema_version,
                                                                vshard_router, opts, storage_result.storage_info)
    end

    return utils.format_result({tuple}, space, opts.fields)
end

--- Insert or replace a tuple in the specified space
--
-- @function tuple
--
-- @param string space_name
--  A space name
--
-- @param table tuple
--  Tuple
--
-- @tparam ?number opts.timeout
--  Function call timeout
--
-- @tparam ?number opts.bucket_id
--  Bucket ID
--  (by default, it's vshard.router.bucket_id_strcrc32 of primary key)
--
-- @tparam ?string|table opts.vshard_router
--  Cartridge vshard group name or vshard router instance.
--  Set this parameter if your space is not a part of the
--  default vshard cluster.
--
-- @tparam ?boolean opts.noreturn
--  Suppress returning successfully processed tuple.
--
-- @return[1] object
-- @treturn[2] nil
-- @treturn[2] table Error description
--
function replace.tuple(space_name, tuple, opts)
    checks('string', 'table', {
        timeout = '?number',
        bucket_id = '?number|cdata',
        add_space_schema_hash = '?boolean',
        fields = '?table',
        vshard_router = '?string|table',
        noreturn = '?boolean',
        fetch_latest_metadata = '?boolean',
    })

    opts = opts or {}

    local vshard_router, err = utils.get_vshard_router_instance(opts.vshard_router)
    if err ~= nil then
        return nil, ReplaceError:new(err)
    end

    return schema.wrap_func_reload(vshard_router, sharding.wrap_method, call_replace_on_router,
                                   space_name, tuple, opts)
end

--- Insert or replace an object in the specified space
--
-- @function object
--
-- @param string space_name
--  A space name
--
-- @param table obj
--  Object
--
-- @tparam ?table opts
--  Options of replace.tuple
--
-- @return[1] object
-- @treturn[2] nil
-- @treturn[2] table Error description
--
function replace.object(space_name, obj, opts)
    checks('string', 'table', {
        timeout = '?number',
        bucket_id = '?number|cdata',
        add_space_schema_hash = '?boolean',
        fields = '?table',
        vshard_router = '?string|table',
        skip_nullability_check_on_flatten = '?boolean',
        noreturn = '?boolean',
        fetch_latest_metadata = '?boolean',
    })

    opts = opts or {}

    local vshard_router, err = utils.get_vshard_router_instance(opts.vshard_router)
    if err ~= nil then
        return nil, ReplaceError:new(err)
    end

    -- replace can fail if router uses outdated schema to flatten object
    opts = utils.merge_options(opts, {add_space_schema_hash = true})

    local tuple, err = utils.flatten_obj_reload(vshard_router, space_name, obj,
                                                opts.skip_nullability_check_on_flatten)
    if err ~= nil then
        return nil, ReplaceError:new("Failed to flatten object: %s", err)
    end

    return schema.wrap_func_reload(vshard_router, sharding.wrap_method, call_replace_on_router,
                                   space_name, tuple, opts)
end

return replace

1	local checks = require('checks')	404✔
2	local errors = require('errors')	404✔
3
4	local call = require('crud.common.call')	404✔
5	local const = require('crud.common.const')	404✔
6	local utils = require('crud.common.utils')	404✔
7	local sharding = require('crud.common.sharding')	404✔
8	local dev_checks = require('crud.common.dev_checks')	404✔
9	local schema = require('crud.common.schema')	404✔
10
11	local ReplaceError = errors.new_class('ReplaceError', { capture_stack = false })	404✔
12
13	local replace = {}	404✔
14
15	local REPLACE_FUNC_NAME = '_crud.replace_on_storage'	404✔
16
17	local function replace_on_storage(space_name, tuple, opts)
18	dev_checks('string', 'table', {	240✔
19	add_space_schema_hash = '?boolean',
20	fields = '?table',
21	sharding_key_hash = '?number',
22	sharding_func_hash = '?number',
23	skip_sharding_hash_check = '?boolean',
24	noreturn = '?boolean',
25	fetch_latest_metadata = '?boolean',
26	})
27
28	opts = opts or {}	240✔
29
30	local space = box.space[space_name]	240✔
31	if space == nil then	240✔
32	return nil, ReplaceError:new("Space %q doesn't exist", space_name)	×
33	end
34
35	local _, err = sharding.check_sharding_hash(space_name,	480✔
36	opts.sharding_func_hash,	240✔
37	opts.sharding_key_hash,	240✔
38	opts.skip_sharding_hash_check)	240✔
39
40	if err ~= nil then	240✔
41	return nil, err	8✔
42	end
43
44	-- add_space_schema_hash is true only in case of replace_object
45	-- the only one case when reloading schema can avoid insert error
46	-- is flattening object on router
47	return schema.wrap_box_space_func_result(space, 'replace', {tuple}, {	232✔
48	add_space_schema_hash = opts.add_space_schema_hash,	232✔
49	field_names = opts.fields,	232✔
50	noreturn = opts.noreturn,	232✔
51	fetch_latest_metadata = opts.fetch_latest_metadata,	232✔
52	})	232✔
53	end
54
55	function replace.init()	404✔
56	_G._crud.replace_on_storage = replace_on_storage	302✔
57	end
58
59	-- returns result, err, need_reload
60	-- need_reload indicates if reloading schema could help
61	-- see crud.common.schema.wrap_func_reload()
62	local function call_replace_on_router(vshard_router, space_name, original_tuple, opts)
63	dev_checks('table', 'string', 'table', {	280✔
64	timeout = '?number',
65	bucket_id = '?number\|cdata',
66	add_space_schema_hash = '?boolean',
67	fields = '?table',
68	vshard_router = '?string\|table',
69	skip_nullability_check_on_flatten = '?boolean',
70	noreturn = '?boolean',
71	fetch_latest_metadata = '?boolean',
72	})
73
74	local space, err, netbox_schema_version = utils.get_space(space_name, vshard_router, opts.timeout)	280✔
75	if err ~= nil then	280✔
76	return nil, ReplaceError:new("An error occurred during the operation: %s", err), const.NEED_SCHEMA_RELOAD	×
77	end
78	if space == nil then	280✔
79	return nil, ReplaceError:new("Space %q doesn't exist", space_name), const.NEED_SCHEMA_RELOAD	56✔
80	end
81
82	local tuple = table.deepcopy(original_tuple)	252✔
83
84	local sharding_data, err = sharding.tuple_set_and_return_bucket_id(vshard_router, tuple, space, opts.bucket_id)	252✔
85	if err ~= nil then	252✔
86	return nil, ReplaceError:new("Failed to get bucket ID: %s", err), const.NEED_SCHEMA_RELOAD	24✔
87	end
88
89	local replace_on_storage_opts = {	240✔
90	add_space_schema_hash = opts.add_space_schema_hash,	240✔
91	fields = opts.fields,	240✔
92	sharding_func_hash = sharding_data.sharding_func_hash,	240✔
93	sharding_key_hash = sharding_data.sharding_key_hash,	240✔
94	skip_sharding_hash_check = sharding_data.skip_sharding_hash_check,	240✔
95	noreturn = opts.noreturn,	240✔
96	fetch_latest_metadata = opts.fetch_latest_metadata,	240✔
97	}
98
99	local call_opts = {	240✔
100	mode = 'write',
101	timeout = opts.timeout,	240✔
102	}
103	local storage_result, err = call.single(vshard_router,	480✔
104	sharding_data.bucket_id, REPLACE_FUNC_NAME,	240✔
105	{space_name, tuple, replace_on_storage_opts},	240✔
106	call_opts
107	)	240✔
108
109	if err ~= nil then	240✔
110	local err_wrapped = ReplaceError:new("Failed to call replace on storage-side: %s", err)	8✔
111
112	if sharding.result_needs_sharding_reload(err) then	16✔
113	return nil, err_wrapped, const.NEED_SHARDING_RELOAD	8✔
114	end
115
116	return nil, err_wrapped	×
117	end
118
119	if storage_result.err ~= nil then	232✔
120	local err_wrapped = ReplaceError:new("Failed to replace: %s", storage_result.err)	38✔
121
122	if schema.result_needs_reload(space, storage_result) then	76✔
123	return nil, err_wrapped, const.NEED_SCHEMA_RELOAD	4✔
124	end
125
126	return nil, err_wrapped	34✔
127	end
128
129	if opts.noreturn == true then	194✔
130	return nil	4✔
131	end
132
133	local tuple = storage_result.res	190✔
134
135	if opts.fetch_latest_metadata == true then	190✔
136	-- This option is temporary and is related to [1], [2].
137	-- [1] https://github.com/tarantool/crud/issues/236
138	-- [2] https://github.com/tarantool/crud/issues/361
139	space = utils.fetch_latest_metadata_when_single_storage(space, space_name, netbox_schema_version,	8✔
140	vshard_router, opts, storage_result.storage_info)	8✔
141	end
142
143	return utils.format_result({tuple}, space, opts.fields)	190✔
144	end
145
146	--- Insert or replace a tuple in the specified space
147	--
148	-- @function tuple
149	--
150	-- @param string space_name
151	-- A space name
152	--
153	-- @param table tuple
154	-- Tuple
155	--
156	-- @tparam ?number opts.timeout
157	-- Function call timeout
158	--
159	-- @tparam ?number opts.bucket_id
160	-- Bucket ID
161	-- (by default, it's vshard.router.bucket_id_strcrc32 of primary key)
162	--
163	-- @tparam ?string\|table opts.vshard_router
164	-- Cartridge vshard group name or vshard router instance.
165	-- Set this parameter if your space is not a part of the
166	-- default vshard cluster.
167	--
168	-- @tparam ?boolean opts.noreturn
169	-- Suppress returning successfully processed tuple.
170	--
171	-- @return[1] object
172	-- @treturn[2] nil
173	-- @treturn[2] table Error description
174	--
175	function replace.tuple(space_name, tuple, opts)	404✔
176	checks('string', 'table', {	164✔
177	timeout = '?number',
178	bucket_id = '?number\|cdata',
179	add_space_schema_hash = '?boolean',
180	fields = '?table',
181	vshard_router = '?string\|table',
182	noreturn = '?boolean',
183	fetch_latest_metadata = '?boolean',
184	})
185
186	opts = opts or {}	164✔
187
188	local vshard_router, err = utils.get_vshard_router_instance(opts.vshard_router)	164✔
189	if err ~= nil then	164✔
190	return nil, ReplaceError:new(err)	16✔
191	end
192
193	return schema.wrap_func_reload(vshard_router, sharding.wrap_method, call_replace_on_router,	156✔
194	space_name, tuple, opts)	156✔
195	end
196
197	--- Insert or replace an object in the specified space
198	--
199	-- @function object
200	--
201	-- @param string space_name
202	-- A space name
203	--
204	-- @param table obj
205	-- Object
206	--
207	-- @tparam ?table opts
208	-- Options of replace.tuple
209	--
210	-- @return[1] object
211	-- @treturn[2] nil
212	-- @treturn[2] table Error description
213	--
214	function replace.object(space_name, obj, opts)	404✔
215	checks('string', 'table', {	138✔
216	timeout = '?number',
217	bucket_id = '?number\|cdata',
218	add_space_schema_hash = '?boolean',
219	fields = '?table',
220	vshard_router = '?string\|table',
221	skip_nullability_check_on_flatten = '?boolean',
222	noreturn = '?boolean',
223	fetch_latest_metadata = '?boolean',
224	})
225
226	opts = opts or {}	138✔
227
228	local vshard_router, err = utils.get_vshard_router_instance(opts.vshard_router)	138✔
229	if err ~= nil then	138✔
230	return nil, ReplaceError:new(err)	16✔
231	end
232
233	-- replace can fail if router uses outdated schema to flatten object
234	opts = utils.merge_options(opts, {add_space_schema_hash = true})	260✔
235
236	local tuple, err = utils.flatten_obj_reload(vshard_router, space_name, obj,	260✔
237	opts.skip_nullability_check_on_flatten)	130✔
238	if err ~= nil then	130✔
239	return nil, ReplaceError:new("Failed to flatten object: %s", err)	80✔
240	end
241
242	return schema.wrap_func_reload(vshard_router, sharding.wrap_method, call_replace_on_router,	90✔
243	space_name, tuple, opts)	90✔
244	end
245
246	return replace	404✔

tarantool / crud / 5199459215

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous