Refactor checks (#37)

Author: dokshina

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/checkers.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/dev_checks.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/heap.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/registry.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/common/utils.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/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 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