Add StyLua and luacheck to precommit config file and apply it

Author: TheophileDiot

.luacheckrc

@@ -0,0 +1,2 @@
+globals = {"ngx", "delay", "unpack"}
+ignore = {"411"}

.pre-commit-config.yaml

@@ -26,6 +26,19 @@ repos:
       - id: prettier
         name: Prettier Code Formatter
 
+  - repo: https://github.com/JohnnyMorganz/StyLua
+    rev: 27e6b388796604181e810ef05c9fb15a9f7a7769 # frozen: v0.18.2
+    hooks:
+      - id: stylua-github
+        exclude: ^src/(bw/lua/middleclass.lua|common/core/antibot/captcha.lua)$
+
+  - repo: https://github.com/lunarmodules/luacheck
+    rev: ababb6d403d634eb74d2c541035e9ede966e710d # frozen: v1.1.1
+    hooks:
+      - id: luacheck
+        exclude: ^src/(bw/lua/middleclass.lua|common/core/antibot/captcha.lua)$
+        args: ["--std", "min", "--codes", "--ranges", "--no-cache"]
+
   - repo: https://github.com/pycqa/flake8
     rev: 10f4af6dbcf93456ba7df762278ae61ba3120dc6 # frozen: 6.1.0
     hooks:

src/bw/lua/bunkerweb/api.lua

@@ -1,15 +1,15 @@
-local class     = require "middleclass"
+local cjson = require "cjson"
+local class = require "middleclass"
 local datastore = require "bunkerweb.datastore"
-local utils     = require "bunkerweb.utils"
-local logger    = require "bunkerweb.logger"
-local cjson     = require "cjson"
-local upload    = require "resty.upload"
-local rsignal   = require "resty.signal"
-local process   = require "ngx.process"
+local logger = require "bunkerweb.logger"
+local process = require "ngx.process"
+local rsignal = require "resty.signal"
+local upload = require "resty.upload"
+local utils = require "bunkerweb.utils"
 
-local api       = class("api")
+local api = class("api")
 
-api.global      = { GET = {}, POST = {}, PUT = {}, DELETE = {} }
+api.global = { GET = {}, POST = {}, PUT = {}, DELETE = {} }
 
 function api:initialize()
 	self.datastore = datastore:new()
@@ -26,21 +26,23 @@ function api:initialize()
 	end
 end
 
+-- luacheck: ignore 212
 function api:log_cmd(cmd, status, stdout, stderr)
 	local level = ngx.NOTICE
 	local prefix = "success"
 	if status ~= 0 then
 		level = ngx.ERR
 		prefix = "error"
 	end
-	self.logger:log(level, prefix .. " while running command " .. command)
+	self.logger:log(level, prefix .. " while running command " .. cmd)
 	self.logger:log(level, "stdout = " .. stdout)
 	self.logger:log(level, "stdout = " .. stderr)
 end
 
 -- TODO : use this if we switch to OpenResty
 function api:cmd(cmd)
 	-- Non-blocking command
+	-- luacheck: ignore 113
 	local ok, stdout, stderr, reason, status = shell.run(cmd, nil, 10000)
 	self.logger:log_cmd(cmd, status, stdout, stderr)
 	-- Timeout
@@ -51,6 +53,7 @@ function api:cmd(cmd)
 	return status == 0, reason, status
 end
 
+-- luacheck: ignore 212
 function api:response(http_status, api_status, msg)
 	local resp = {}
 	resp["status"] = api_status
@@ -101,6 +104,7 @@ api.global.POST["^/confs$"] = function(self)
 	form:set_timeout(1000)
 	local file = io.open(tmp, "w+")
 	while true do
+		-- luacheck: ignore 421
 		local typ, res, err = form:read()
 		if not typ then
 			file:close()
@@ -117,9 +121,9 @@ api.global.POST["^/confs$"] = function(self)
 	file:close()
 	local cmds = {
 		"rm -rf " .. destination .. "/*",
-		"tar xzf " .. tmp .. " -C " .. destination
+		"tar xzf " .. tmp .. " -C " .. destination,
 	}
-	for i, cmd in ipairs(cmds) do
+	for _, cmd in ipairs(cmds) do
 		local status = os.execute(cmd)
 		if status ~= 0 then
 			return self:response(ngx.HTTP_INTERNAL_SERVER_ERROR, "error", "exit status = " .. tostring(status))
@@ -176,17 +180,23 @@ end
 
 api.global.GET["^/bans$"] = function(self)
 	local data = {}
-	for i, k in ipairs(self.datastore:keys()) do
+	for _, k in ipairs(self.datastore:keys()) do
 		if k:find("^bans_ip_") then
 			local reason, err = self.datastore:get(k)
 			if err then
-				return self:response(ngx.HTTP_INTERNAL_SERVER_ERROR, "error",
-					"can't access " .. k .. " from datastore : " .. reason)
+				return self:response(
+					ngx.HTTP_INTERNAL_SERVER_ERROR,
+					"error",
+					"can't access " .. k .. " from datastore : " .. reason
+				)
 			end
 			local ok, ttl = self.datastore:ttl(k)
 			if not ok then
-				return self:response(ngx.HTTP_INTERNAL_SERVER_ERROR, "error",
-					"can't access ttl " .. k .. " from datastore : " .. ttl)
+				return self:response(
+					ngx.HTTP_INTERNAL_SERVER_ERROR,
+					"error",
+					"can't access ttl " .. k .. " from datastore : " .. ttl
+				)
 			end
 			local ban = { ip = k:sub(9, #k), reason = reason, exp = math.floor(ttl) }
 			table.insert(data, ban)
@@ -196,7 +206,7 @@ api.global.GET["^/bans$"] = function(self)
 end
 
 api.global.GET["^/variables$"] = function(self)
-	local variables, err = datastore:get('variables', true)
+	local variables, err = datastore:get("variables", true)
 	if not variables then
 		return self:response(ngx.HTTP_INTERNAL_SERVER_ERROR, "error", "can't access variables from datastore : " .. err)
 	end
@@ -219,9 +229,9 @@ function api:do_api_call()
 				if status ~= ngx.HTTP_OK then
 					ret = false
 				end
-				if (#resp["msg"] == 0) then
+				if #resp["msg"] == 0 then
 					resp["msg"] = ""
-				elseif (type(resp["msg"]) == "table") then
+				elseif type(resp["msg"]) == "table" then
 					resp["data"] = resp["msg"]
 					resp["msg"] = resp["status"]
 				end
@@ -231,10 +241,10 @@ function api:do_api_call()
 	end
 	local list, err = self.datastore:get("plugins", true)
 	if not list then
-		local status, resp = self:response(ngx.HTTP_INTERNAL_SERVER_ERROR, "error", "can't list loaded plugins : " .. err)
+		local _, resp = self:response(ngx.HTTP_INTERNAL_SERVER_ERROR, "error", "can't list loaded plugins : " .. err)
 		return false, resp["msg"], ngx.HTTP_INTERNAL_SERVER_ERROR, cjson.encode(resp)
 	end
-	for i, plugin in ipairs(list) do
+	for _, plugin in ipairs(list) do
 		if pcall(require, plugin.id .. "/" .. plugin.id) then
 			local plugin_lua = require(plugin.id .. "/" .. plugin.id)
 			if plugin_lua.api ~= nil then

src/bw/lua/bunkerweb/cachestore.lua

@@ -1,42 +1,38 @@
-local mlcache      = require "resty.mlcache"
+local class = require "middleclass"
 local clusterstore = require "bunkerweb.clusterstore"
-local logger       = require "bunkerweb.logger"
-local utils        = require "bunkerweb.utils"
-local class        = require "middleclass"
-local cachestore   = class("cachestore")
+local logger = require "bunkerweb.logger"
+local mlcache = require "resty.mlcache"
+local utils = require "bunkerweb.utils"
+local cachestore = class("cachestore")
 
 -- Instantiate mlcache object at module level (which will be cached when running init phase)
 -- TODO : custom settings
-local shm          = "cachestore"
-local ipc_shm      = "cachestore_ipc"
-local shm_miss     = "cachestore_miss"
-local shm_locks    = "cachestore_locks"
+local shm = "cachestore"
+local ipc_shm = "cachestore_ipc"
+local shm_miss = "cachestore_miss"
+local shm_locks = "cachestore_locks"
 if not ngx.shared.cachestore then
-	shm       = "cachestore_stream"
-	ipc_shm   = "cachestore_ipc_stream"
-	shm_miss  = "cachestore_miss_stream"
+	shm = "cachestore_stream"
+	ipc_shm = "cachestore_ipc_stream"
+	shm_miss = "cachestore_miss_stream"
 	shm_locks = "cachestore_locks_stream"
 end
-local cache, err = mlcache.new(
-	"cachestore",
-	shm,
-	{
-		lru_size = 100,
-		ttl = 30,
-		neg_ttl = 0.1,
-		shm_set_tries = 3,
-		shm_miss = shm_miss,
-		shm_locks = shm_locks,
-		resty_lock_opts = {
-			exptime = 30,
-			timeout = 5,
-			step = 0.001,
-			ratio = 2,
-			max_step = 0.5
-		},
-		ipc_shm = ipc_shm
-	}
-)
+local cache, err = mlcache.new("cachestore", shm, {
+	lru_size = 100,
+	ttl = 30,
+	neg_ttl = 0.1,
+	shm_set_tries = 3,
+	shm_miss = shm_miss,
+	shm_locks = shm_locks,
+	resty_lock_opts = {
+		exptime = 30,
+		timeout = 5,
+		step = 0.001,
+		ratio = 2,
+		max_step = 0.5,
+	},
+	ipc_shm = ipc_shm,
+})
 local module_logger = logger:new("CACHESTORE")
 if not cache then
 	module_logger:log(ngx.ERR, "can't instantiate mlcache : " .. err)
@@ -57,10 +53,12 @@ function cachestore:initialize(use_redis, new_cs, ctx)
 end
 
 function cachestore:get(key)
+	-- luacheck: ignore 432
 	local callback = function(key, cs)
 		-- Connect to redis
+		-- luacheck: ignore 431
 		local clusterstore = cs or require "bunkerweb.clusterstore":new(false)
-		local ok, err, reused = clusterstore:connect()
+		local ok, err, _ = clusterstore:connect()
 		if not ok then
 			return nil, "can't connect to redis : " .. err, nil
 		end
@@ -96,6 +94,7 @@ function cachestore:get(key)
 	local callback_no_miss = function()
 		return nil, nil, -1
 	end
+	-- luacheck: ignore 431
 	local value, err, hit_level
 	if self.use_redis and utils.is_cosocket_available() then
 		local cs = nil
@@ -114,13 +113,14 @@ function cachestore:get(key)
 end
 
 function cachestore:set(key, value, ex)
+	-- luacheck: ignore 431
+	local ok, err
 	if self.use_redis and utils.is_cosocket_available() then
-		local ok, err = self:set_redis(key, value, ex)
+		ok, err = self:set_redis(key, value, ex)
 		if not ok then
 			self.logger:log(ngx.ERR, err)
 		end
 	end
-	local ok, err
 	if ex then
 		ok, err = self.cache:set(key, { ttl = ex }, value)
 	else
@@ -134,13 +134,14 @@ end
 
 function cachestore:set_redis(key, value, ex)
 	-- Connect to redis
-	local ok, err, reused = self.clusterstore:connect()
+	-- luacheck: ignore 431
+	local ok, err, _ = self.clusterstore:connect()
 	if not ok then
 		return false, "can't connect to redis : " .. err
 	end
 	-- Set value with ttl
 	local default_ex = ex or 30
-	local ok, err = self.clusterstore:call("set", key, value, "EX", default_ex)
+	local _, err = self.clusterstore:call("set", key, value, "EX", default_ex)
 	if err then
 		self.clusterstore:close()
 		return false, "SET failed : " .. err
@@ -149,14 +150,16 @@ function cachestore:set_redis(key, value, ex)
 	return true
 end
 
-function cachestore:delete(key, value, ex)
+function cachestore:delete(key)
+	-- luacheck: ignore 431
+	local ok, err
 	if self.use_redis and utils.is_cosocket_available() then
-		local ok, err = self.del_redis(key)
+		ok, err = self:del_redis(key)
 		if not ok then
 			self.logger:log(ngx.ERR, err)
 		end
 	end
-	local ok, err = self.cache:delete(key)
+	ok, err = self.cache:delete(key)
 	if not ok then
 		return false, err
 	end
@@ -165,12 +168,13 @@ end
 
 function cachestore:del_redis(key)
 	-- Connect to redis
+	-- luacheck: ignore 431
 	local ok, err = self.clusterstore:connect()
 	if not ok then
 		return false, "can't connect to redis : " .. err
 	end
 	-- Set value with ttl
-	local ok, err = self.clusterstore:del(key)
+	local _, err = self.clusterstore:del(key)
 	if err then
 		self.clusterstore:close()
 		return false, "DEL failed : " .. err