From: Vsevolod Stakhov <vsevolod@rspamd.com>
Date: Mon, 17 Nov 2025 15:29:36 +0000 (+0000)
Subject: [Minor] Migrate lua_aws.lua from tableshape to lua_shape
X-Git-Tag: 3.14.1~11^2~45
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=6a9e5004c7bbcc50082d3b4ef80ea70c9b66d8b8;p=thirdparty%2Frspamd.git

[Minor] Migrate lua_aws.lua from tableshape to lua_shape

Replace tableshape with lua_shape for AWS parameter validation:
- Convert ts.shape to T.table
- Replace ts.string + ts['nil'] / fn with T.transform + T.one_of
- Replace ts.map_of(ts.string, ts.string) with open table validation
- Update documentation comments to reflect new schema format

No functional changes, luacheck passes.
---

diff --git a/lualib/lua_aws.lua b/lualib/lua_aws.lua
index e6c4b29a24..7d81477ba0 100644
--- a/lualib/lua_aws.lua
+++ b/lualib/lua_aws.lua
@@ -22,7 +22,7 @@ limitations under the License.
 
 local N = "aws"
 --local rspamd_logger = require "rspamd_logger"
-local ts = (require "tableshape").types
+local T = require "lua_shape.core"
 local lua_util = require "lua_util"
 local fun = require "fun"
 local rspamd_crypto_hash = require "rspamd_cryptobox_hash"
@@ -169,39 +169,45 @@ end
 
 exports.aws_canon_request_hash = aws_canon_request_hash
 
-local aws_authorization_hdr_args_schema = ts.shape {
-  date = ts.string + ts['nil'] / today_canonical,
-  secret_key = ts.string,
-  method = ts.string + ts['nil'] / function()
-    return 'GET'
-  end,
-  uri = ts.string,
-  region = ts.string,
-  service = ts.string + ts['nil'] / function()
-    return 's3'
-  end,
-  req_type = ts.string + ts['nil'] / function()
-    return 'aws4_request'
-  end,
-  headers = ts.map_of(ts.string, ts.string),
-  key_id = ts.string,
-}
+local aws_authorization_hdr_args_schema = T.table({
+  date = T.transform(
+    T.one_of({T.string(), T.literal(nil)}),
+    function(v) return v or today_canonical() end
+  ),
+  secret_key = T.string(),
+  method = T.transform(
+    T.one_of({T.string(), T.literal(nil)}),
+    function(v) return v or 'GET' end
+  ),
+  uri = T.string(),
+  region = T.string(),
+  service = T.transform(
+    T.one_of({T.string(), T.literal(nil)}),
+    function(v) return v or 's3' end
+  ),
+  req_type = T.transform(
+    T.one_of({T.string(), T.literal(nil)}),
+    function(v) return v or 'aws4_request' end
+  ),
+  -- headers is a table with string keys and string values (map_of equivalent)
+  headers = T.table({}, { open = true, extra = T.string() }),
+  key_id = T.string(),
+})
 --[[[
 -- @function lua_aws.aws_authorization_hdr(params)
 -- Produces an authorization header as required by AWS
--- Parameters schema is the following:
-ts.shape{
-  date = ts.string + ts['nil'] / today_canonical,
-  secret_key = ts.string,
-  method = ts.string + ts['nil'] / function() return 'GET' end,
-  uri = ts.string,
-  region = ts.string,
-  service = ts.string + ts['nil'] / function() return 's3' end,
-  req_type = ts.string + ts['nil'] / function() return 'aws4_request' end,
-  headers = ts.map_of(ts.string, ts.string),
-  key_id = ts.string,
-}
---
+-- Parameters schema:
+-- {
+--   date = string or nil (default: today),
+--   secret_key = string,
+--   method = string or nil (default: 'GET'),
+--   uri = string,
+--   region = string,
+--   service = string or nil (default: 's3'),
+--   req_type = string or nil (default: 'aws4_request'),
+--   headers = table of string->string,
+--   key_id = string,
+-- }
 --]]
 local function aws_authorization_hdr(tbl, transformed)
   local res, err
@@ -244,20 +250,19 @@ exports.aws_authorization_hdr = aws_authorization_hdr
 --[[[
 -- @function lua_aws.aws_request_enrich(params, content)
 -- Produces an authorization header as required by AWS
--- Parameters schema is the following:
-ts.shape{
-  date = ts.string + ts['nil'] / today_canonical,
-  secret_key = ts.string,
-  method = ts.string + ts['nil'] / function() return 'GET' end,
-  uri = ts.string,
-  region = ts.string,
-  service = ts.string + ts['nil'] / function() return 's3' end,
-  req_type = ts.string + ts['nil'] / function() return 'aws4_request' end,
-  headers = ts.map_of(ts.string, ts.string),
-  key_id = ts.string,
-}
-This method returns new/modified in place table of the headers
---
+-- Parameters schema (same as aws_authorization_hdr):
+-- {
+--   date = string or nil (default: today),
+--   secret_key = string,
+--   method = string or nil (default: 'GET'),
+--   uri = string,
+--   region = string,
+--   service = string or nil (default: 's3'),
+--   req_type = string or nil (default: 'aws4_request'),
+--   headers = table of string->string,
+--   key_id = string,
+-- }
+-- This method returns new/modified in place table of the headers
 --]]
 local function aws_request_enrich(tbl, content)
   local res, err = aws_authorization_hdr_args_schema:transform(tbl)