Refactor checks

CHANGELOG.md

@@ -18,6 +18,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
  * replace
  * upsert
 
+### Changed
+
+* `checks` is disabled for internal functions by default
+
 ## [0.1.0] - 2020-09-23
 
 ### Added

crud-scm-1.rockspec

@@ -8,7 +8,7 @@ source  = {
 dependencies = {
     'tarantool',
     'lua >= 5.1',
-    'checks == 3.0.1-1',
+    'checks == 3.1.0-1',
     'errors == 2.1.3-1',
     'vshard == 0.1.16-1',
 }

crud/common/call.lua

@@ -1,8 +1,8 @@
-local checks = require('checks')
 local fiber = require('fiber')
 local vshard = require('vshard')
 local errors = require('errors')
 
+local dev_checks = require('crud.common.dev_checks')
 local registry = require('crud.common.registry')
 local utils = require('crud.common.utils')
 
@@ -23,7 +23,7 @@ local DEFAULT_VSHARD_CALL_TIMEOUT = 2
 --
 function call.init()
     local function call(opts)
-        checks({
+        dev_checks({
             func_name = 'string',
             func_args = '?table',
         })
@@ -63,7 +63,7 @@ local function call_on_replicaset(replicaset, channel, vshard_call, func_name, f
 end
 
 local function call_impl(vshard_call, func_name, func_args, opts)
-    checks('string', 'string', '?table', {
+    dev_checks('string', 'string', '?table', {
         timeout = '?number',
         replicasets = '?table',
     })

crud/common/dev_checks.lua

@@ -0,0 +1,9 @@
+local checks = require('checks')
+
+local dev_checks = function() end
+
+if os.getenv('DEV') == 'ON' then
+    dev_checks = checks
+end
+
+return dev_checks

crud/common/heap.lua

@@ -1,12 +1,10 @@
-local checks = require('checks')
-
-require('crud.common.checkers')
+local dev_checks = require('crud.common.dev_checks')
 
 local Heap = {}
 Heap.__index = Heap
 
 function Heap.new(opts)
-    checks({
+    dev_checks({
         comparator = 'function',
     })
 
@@ -45,7 +43,7 @@ function Heap:_ok(child_idx, parent_idx)
 end
 
 function Heap:add(obj, meta)
-    checks('table', '?', '?')
+    dev_checks('table', '?', '?')
 
     local node = {
         obj = obj,

crud/common/registry.lua

@@ -1,8 +1,5 @@
-local checks = require('checks')
 local errors = require('errors')
 
-require('crud.common.checkers')
-
 local registry = {}
 
 local registered_funcs = {}
@@ -17,8 +14,6 @@ local RegisterError = errors.new_class('Register')
 -- Should be passed as a {string: function} map.
 --
 function registry.add(funcs)
-    checks('funcs_map')
-
     for func_name in pairs(funcs) do
         if registry.is_registered(func_name) then
             return nil, RegisterError:new("Function %s is already registered", func_name)

crud/common/utils.lua

@@ -1,14 +1,15 @@
-local checks = require('checks')
 local errors = require('errors')
 
+local dev_checks = require('crud.common.dev_checks')
+
 local FlattenError = errors.new_class("FlattenError", {capture_stack = false})
 local UnflattenError = errors.new_class("UnflattenError", {capture_stack = false})
 local ParseOperationsError = errors.new_class('ParseOperationsError',  {capture_stack = false})
 
 local utils = {}
 
 function utils.table_count(table)
-    checks("table")
+    dev_checks("table")
 
     local cnt = 0
     for _, _ in pairs(table) do
@@ -19,7 +20,7 @@ function utils.table_count(table)
 end
 
 function utils.format_replicaset_error(replicaset_uuid, msg, ...)
-    checks("string", "string")
+    dev_checks("string", "string")
 
     return string.format(
         "Failed for %s: %s",

crud/delete.lua

@@ -5,6 +5,7 @@ local vshard = require('vshard')
 local call = require('crud.common.call')
 local registry = require('crud.common.registry')
 local utils = require('crud.common.utils')
+local dev_checks = require('crud.common.dev_checks')
 
 local DeleteError = errors.new_class('Delete',  {capture_stack = false})
 
@@ -13,7 +14,7 @@ local delete = {}
 local DELETE_FUNC_NAME = '__delete'
 
 local function call_delete_on_storage(space_name, key)
-    checks('string', '?')
+    dev_checks('string', '?')
 
     local space = box.space[space_name]
     if space == nil then

crud/get.lua

@@ -5,6 +5,7 @@ local vshard = require('vshard')
 local call = require('crud.common.call')
 local registry = require('crud.common.registry')
 local utils = require('crud.common.utils')
+local dev_checks = require('crud.common.dev_checks')
 
 local GetError = errors.new_class('Get',  {capture_stack = false})
 
@@ -13,7 +14,7 @@ local get = {}
 local GET_FUNC_NAME = '__get'
 
 local function call_get_on_storage(space_name, key)
-    checks('string', '?')
+    dev_checks('string', '?')
 
     local space = box.space[space_name]
     if space == nil then

crud/insert.lua

@@ -5,8 +5,7 @@ local vshard = require('vshard')
 local call = require('crud.common.call')
 local registry = require('crud.common.registry')
 local utils = require('crud.common.utils')
-
-require('crud.common.checkers')
+local dev_checks = require('crud.common.dev_checks')
 
 local InsertError = errors.new_class('Insert',  {capture_stack = false})
 
@@ -15,7 +14,7 @@ local insert = {}
 local INSERT_FUNC_NAME = '__insert'
 
 local function call_insert_on_storage(space_name, tuple)
-    checks('string', 'table')
+    dev_checks('string', 'table')
 
     local space = box.space[space_name]
     if space == nil then

crud/replace.lua

@@ -5,8 +5,7 @@ local vshard = require('vshard')
 local call = require('crud.common.call')
 local registry = require('crud.common.registry')
 local utils = require('crud.common.utils')
-
-require('crud.common.checkers')
+local dev_checks = require('crud.common.dev_checks')
 
 local ReplaceError = errors.new_class('Replace', { capture_stack = false })
 
@@ -15,7 +14,7 @@ local replace = {}
 local REPLACE_FUNC_NAME = '__replace'
 
 local function call_replace_on_storage(space_name, tuple)
-    checks('string', 'table')
+    dev_checks('string', 'table')
 
     local space = box.space[space_name]
     if space == nil then

crud/select.lua

@@ -5,6 +5,7 @@ local vshard = require('vshard')
 local call = require('crud.common.call')
 local registry = require('crud.common.registry')
 local utils = require('crud.common.utils')
+local dev_checks = require('crud.common.dev_checks')
 
 local select_conditions = require('crud.select.conditions')
 local select_plan = require('crud.select.plan')
@@ -14,8 +15,6 @@ local select_filters = require('crud.select.filters')
 
 local Iterator = require('crud.select.iterator')
 
-require('crud.common.checkers')
-
 local SelectError = errors.new_class('SelectError')
 local GetReplicasetsError = errors.new_class('GetReplicasetsError')
 
@@ -26,7 +25,7 @@ local SELECT_FUNC_NAME = '__select'
 local DEFAULT_BATCH_SIZE = 100
 
 local function call_select_on_storage(space_name, index_id, conditions, opts)
-    checks('string', 'number', '?table', {
+    dev_checks('string', 'number', '?table', {
         scan_value = 'table',
         after_tuple = '?table',
         iter = 'number',
@@ -73,7 +72,7 @@ function select_module.init()
 end
 
 local function select_iteration(space_name, plan, opts)
-    checks('string', '?table', {
+    dev_checks('string', '?table', {
         after_tuple = '?table',
         replicasets = 'table',
         timeout = '?number',
@@ -118,8 +117,8 @@ local function get_replicasets_by_sharding_key(sharding_key)
 end
 
 local function build_select_iterator(space_name, user_conditions, opts)
-    checks('string', '?table', {
-        after = '?',
+    dev_checks('string', '?table', {
+        after = '?table',
         limit = '?number',
         timeout = '?number',
         batch_size = '?number',
@@ -205,7 +204,7 @@ end
 
 function select_module.pairs(space_name, user_conditions, opts)
     checks('string', '?table', {
-        after = '?',
+        after = '?table',
         limit = '?number',
         timeout = '?number',
         batch_size = '?number',
@@ -242,7 +241,7 @@ end
 
 function select_module.call(space_name, user_conditions, opts)
     checks('string', '?table', {
-        after = '?',
+        after = '?table',
         limit = '?number',
         timeout = '?number',
         batch_size = '?number',

crud/select/conditions.lua

@@ -1,6 +1,7 @@
-local checks = require('checks')
 local errors = require('errors')
 
+local dev_checks = require('crud.common.dev_checks')
+
 local ParseConditionError = errors.new_class('ParseConditionError')
 
 local conditions = {}
@@ -22,19 +23,10 @@ local tarantool_iter_by_cond_operators = {
     [conditions.operators.GE] = box.index.GE,
 }
 
-function _G.checkers.condition_operator(p)
-    for _, op in pairs(conditions.operators) do
-        if op == p then
-            return true
-        end
-    end
-    return false
-end
-
 local function new_condition(opts)
-    checks({
-        operator = 'condition_operator',
-        operand = 'string|strings_array',
+    dev_checks({
+        operator = 'string',
+        operand = 'string|table',
         values = '?',
     })
 
@@ -67,7 +59,7 @@ local cond_operators_by_func_names = {
 for func_name, operator in pairs(cond_operators_by_func_names) do
     assert(operator ~= nil)
     conditions.funcs[func_name] = function(operand, values)
-        checks('string|strings_array', '?')
+        dev_checks('string|table', '?')
         return new_condition({
             operator = operator,
             operand = operand,

crud/select/executor.lua

@@ -1,7 +1,7 @@
-local checks = require('checks')
 local errors = require('errors')
 local log = require('log')
 
+local dev_checks = require('crud.common.dev_checks')
 local select_comparators = require('crud.select.comparators')
 
 local utils = require('crud.common.utils')
@@ -37,9 +37,9 @@ local function scroll_to_after_tuple(gen, space, scan_index, iter, after_tuple)
 end
 
 function executor.execute(space, index, filter_func, opts)
-    checks('table', 'table', 'function', {
+    dev_checks('table', 'table', 'function', {
         scan_value = 'table',
-        after_tuple = '?cdata|table',
+        after_tuple = '?table',
         iter = 'number',
         limit = '?number',
     })