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

92.55

/crud/delete.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 sharding_key_module = require('crud.common.sharding.sharding_key')
local sharding_metadata_module = require('crud.common.sharding.sharding_metadata')
local dev_checks = require('crud.common.dev_checks')
local schema = require('crud.common.schema')

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

local delete = {}

local DELETE_FUNC_NAME = '_crud.delete_on_storage'

local function delete_on_storage(space_name, key, field_names, opts)
    dev_checks('string', '?', '?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, DeleteError: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 false because
    -- reloading space format on router can't avoid delete error on storage
    return schema.wrap_box_space_func_result(space, 'delete', {key}, {
        add_space_schema_hash = false,
        field_names = field_names,
        noreturn = opts.noreturn,
        fetch_latest_metadata = opts.fetch_latest_metadata,
    })
end

function delete.init()
   _G._crud.delete_on_storage = delete_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_delete_on_router(vshard_router, space_name, key, opts)
    dev_checks('table', 'string', '?', {
        timeout = '?number',
        bucket_id = '?number|cdata',
        fields = '?table',
        vshard_router = '?string|table',
        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, DeleteError:new("An error occurred during the operation: %s", err), const.NEED_SCHEMA_RELOAD
    end
    if space == nil then
        return nil, DeleteError:new("Space %q doesn't exist", space_name), const.NEED_SCHEMA_RELOAD
    end

    if box.tuple.is(key) then
        key = key:totable()
    end

    local sharding_key_hash = nil
    local skip_sharding_hash_check = nil

    local sharding_key = key
    if opts.bucket_id == nil then
        if space.index[0] == nil then
            return nil, DeleteError:new("Cannot fetch primary index parts"), const.NEED_SCHEMA_RELOAD
        end
        local primary_index_parts = space.index[0].parts

        local sharding_key_data, err = sharding_metadata_module.fetch_sharding_key_on_router(vshard_router, space_name)
        if err ~= nil then
            return nil, err
        end

        sharding_key, err = sharding_key_module.extract_from_pk(vshard_router,
                                                                space_name,
                                                                sharding_key_data.value,
                                                                primary_index_parts, key)
        if err ~= nil then
            return nil, err
        end

        sharding_key_hash = sharding_key_data.hash
    else
        skip_sharding_hash_check = true
    end

    local bucket_id_data, err = sharding.key_get_bucket_id(vshard_router, space_name, sharding_key, opts.bucket_id)
    if err ~= nil then
        return nil, err
    end

    local delete_on_storage_opts = {
        sharding_func_hash = bucket_id_data.sharding_func_hash,
        sharding_key_hash = sharding_key_hash,
        skip_sharding_hash_check = 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,
        bucket_id_data.bucket_id, DELETE_FUNC_NAME,
        {space_name, key, opts.fields, delete_on_storage_opts},
        call_opts
    )

    if err ~= nil then
        local err_wrapped = DeleteError:new("Failed to call delete 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
        return nil, DeleteError:new("Failed to delete: %s", storage_result.err)
    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

--- Deletes tuple from the specified space by key
--
-- @function call
--
-- @param string space_name
--  A space name
--
-- @param key
--  Primary key value
--
-- @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 delete.call(space_name, key, opts)
    checks('string', '?', {
        timeout = '?number',
        bucket_id = '?number|cdata',
        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, DeleteError:new(err)
    end

    return schema.wrap_func_reload(vshard_router, sharding.wrap_method, call_delete_on_router,
                                   space_name, key, opts)
end

return delete

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 sharding_key_module = require('crud.common.sharding.sharding_key')	404✔
9	local sharding_metadata_module = require('crud.common.sharding.sharding_metadata')	404✔
10	local dev_checks = require('crud.common.dev_checks')	404✔
11	local schema = require('crud.common.schema')	404✔
12
13	local DeleteError = errors.new_class('DeleteError', {capture_stack = false})	404✔
14
15	local delete = {}	404✔
16
17	local DELETE_FUNC_NAME = '_crud.delete_on_storage'	404✔
18
19	local function delete_on_storage(space_name, key, field_names, opts)
20	dev_checks('string', '?', '?table', {	148✔
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 {}	148✔
29
30	local space = box.space[space_name]	148✔
31	if space == nil then	148✔
32	return nil, DeleteError:new("Space %q doesn't exist", space_name)	×
33	end
34
35	local _, err = sharding.check_sharding_hash(space_name,	296✔
36	opts.sharding_func_hash,	148✔
37	opts.sharding_key_hash,	148✔
38	opts.skip_sharding_hash_check)	148✔
39
40	if err ~= nil then	148✔
41	return nil, err	2✔
42	end
43
44	-- add_space_schema_hash is false because
45	-- reloading space format on router can't avoid delete error on storage
46	return schema.wrap_box_space_func_result(space, 'delete', {key}, {	146✔
47	add_space_schema_hash = false,
48	field_names = field_names,	146✔
49	noreturn = opts.noreturn,	146✔
50	fetch_latest_metadata = opts.fetch_latest_metadata,	146✔
51	})	146✔
52	end
53
54	function delete.init()	404✔
55	_G._crud.delete_on_storage = delete_on_storage	302✔
56	end
57
58	-- returns result, err, need_reload
59	-- need_reload indicates if reloading schema could help
60	-- see crud.common.schema.wrap_func_reload()
61	local function call_delete_on_router(vshard_router, space_name, key, opts)
62	dev_checks('table', 'string', '?', {	172✔
63	timeout = '?number',
64	bucket_id = '?number\|cdata',
65	fields = '?table',
66	vshard_router = '?string\|table',
67	noreturn = '?boolean',
68	fetch_latest_metadata = '?boolean',
69	})
70
71	local space, err, netbox_schema_version = utils.get_space(space_name, vshard_router, opts.timeout)	172✔
72	if err ~= nil then	172✔
73	return nil, DeleteError:new("An error occurred during the operation: %s", err), const.NEED_SCHEMA_RELOAD	×
74	end
75	if space == nil then	172✔
76	return nil, DeleteError:new("Space %q doesn't exist", space_name), const.NEED_SCHEMA_RELOAD	40✔
77	end
78
79	if box.tuple.is(key) then	304✔
80	key = key:totable()	×
81	end
82
83	local sharding_key_hash = nil	152✔
84	local skip_sharding_hash_check = nil
85
86	local sharding_key = key	152✔
87	if opts.bucket_id == nil then	152✔
88	if space.index[0] == nil then	142✔
89	return nil, DeleteError:new("Cannot fetch primary index parts"), const.NEED_SCHEMA_RELOAD	×
90	end
91	local primary_index_parts = space.index[0].parts	142✔
92
93	local sharding_key_data, err = sharding_metadata_module.fetch_sharding_key_on_router(vshard_router, space_name)	142✔
94	if err ~= nil then	142✔
95	return nil, err	×
96	end
97
98	sharding_key, err = sharding_key_module.extract_from_pk(vshard_router,	284✔
99	space_name,	142✔
100	sharding_key_data.value,	142✔
101	primary_index_parts, key)	284✔
102	if err ~= nil then	142✔
103	return nil, err	4✔
104	end
105
106	sharding_key_hash = sharding_key_data.hash	138✔
107	else
108	skip_sharding_hash_check = true	10✔
109	end
110
111	local bucket_id_data, err = sharding.key_get_bucket_id(vshard_router, space_name, sharding_key, opts.bucket_id)	148✔
112	if err ~= nil then	148✔
113	return nil, err	×
114	end
115
116	local delete_on_storage_opts = {	148✔
117	sharding_func_hash = bucket_id_data.sharding_func_hash,	148✔
118	sharding_key_hash = sharding_key_hash,	148✔
119	skip_sharding_hash_check = skip_sharding_hash_check,	148✔
120	noreturn = opts.noreturn,	148✔
121	fetch_latest_metadata = opts.fetch_latest_metadata,	148✔
122	}
123
124	local call_opts = {	148✔
125	mode = 'write',
126	timeout = opts.timeout,	148✔
127	}
128
129	local storage_result, err = call.single(vshard_router,	296✔
130	bucket_id_data.bucket_id, DELETE_FUNC_NAME,	148✔
131	{space_name, key, opts.fields, delete_on_storage_opts},	148✔
132	call_opts
133	)	148✔
134
135	if err ~= nil then	148✔
136	local err_wrapped = DeleteError:new("Failed to call delete on storage-side: %s", err)	2✔
137
138	if sharding.result_needs_sharding_reload(err) then	4✔
139	return nil, err_wrapped, const.NEED_SHARDING_RELOAD	2✔
140	end
141
142	return nil, err_wrapped	×
143	end
144
145	if storage_result.err ~= nil then	146✔
146	return nil, DeleteError:new("Failed to delete: %s", storage_result.err)	68✔
147	end
148
149	if opts.noreturn == true then	112✔
150	return nil	2✔
151	end
152
153	local tuple = storage_result.res	110✔
154
155	if opts.fetch_latest_metadata == true then	110✔
156	-- This option is temporary and is related to [1], [2].
157	-- [1] https://github.com/tarantool/crud/issues/236
158	-- [2] https://github.com/tarantool/crud/issues/361
159	space = utils.fetch_latest_metadata_when_single_storage(space, space_name, netbox_schema_version,	4✔
160	vshard_router, opts, storage_result.storage_info)	4✔
161	end
162
163	return utils.format_result({tuple}, space, opts.fields)	110✔
164	end
165
166	--- Deletes tuple from the specified space by key
167	--
168	-- @function call
169	--
170	-- @param string space_name
171	-- A space name
172	--
173	-- @param key
174	-- Primary key value
175	--
176	-- @tparam ?number opts.timeout
177	-- Function call timeout
178	--
179	-- @tparam ?number opts.bucket_id
180	-- Bucket ID
181	-- (by default, it's vshard.router.bucket_id_strcrc32 of primary key)
182	--
183	-- @tparam ?string\|table opts.vshard_router
184	-- Cartridge vshard group name or vshard router instance.
185	-- Set this parameter if your space is not a part of the
186	-- default vshard cluster.
187	--
188	-- @tparam ?boolean opts.noreturn
189	-- Suppress returning successfully processed tuple.
190	--
191	-- @return[1] object
192	-- @treturn[2] nil
193	-- @treturn[2] table Error description
194	--
195	function delete.call(space_name, key, opts)	404✔
196	checks('string', '?', {	166✔
197	timeout = '?number',
198	bucket_id = '?number\|cdata',
199	fields = '?table',
200	vshard_router = '?string\|table',
201	noreturn = '?boolean',
202	fetch_latest_metadata = '?boolean',
203	})
204
205	opts = opts or {}	166✔
206
207	local vshard_router, err = utils.get_vshard_router_instance(opts.vshard_router)	166✔
208	if err ~= nil then	166✔
209	return nil, DeleteError:new(err)	16✔
210	end
211
212	return schema.wrap_func_reload(vshard_router, sharding.wrap_method, call_delete_on_router,	158✔
213	space_name, key, opts)	158✔
214	end
215
216	return delete	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