From: Vsevolod Stakhov <vsevolod@rspamd.com>
Date: Tue, 18 Nov 2025 10:07:51 +0000 (+0000)
Subject: [Minor] Migrate src/plugins/lua/bimi.lua to lua_shape
X-Git-Tag: 3.14.1~11^2~30
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=29c49f69ff25b5bb2f4c500e7d368148c3dc7280;p=thirdparty%2Frspamd.git

[Minor] Migrate src/plugins/lua/bimi.lua to lua_shape

Replace tableshape with lua_shape in BIMI plugin.

Changes:
- Uses lua_redis.enrich_schema() which returns lua_shape with mixins
- ts.string, ts.boolean, ts.number → T.string(), T.boolean(), T.number()
- ts.number + ts.string / fn → T.one_of({T.number(), T.transform(T.string(), fn)})
- :is_optional() → :optional()
- Added comprehensive documentation to all fields

Schema: settings_schema with Redis common fields plus BIMI-specific
settings for helper service URL, timeouts, VMC-only mode, and staged
HTTP timeouts (connect, SSL, write, read).
---

diff --git a/src/plugins/lua/bimi.lua b/src/plugins/lua/bimi.lua
index 8f375c4da4..68d09349d2 100644
--- a/src/plugins/lua/bimi.lua
+++ b/src/plugins/lua/bimi.lua
@@ -17,7 +17,7 @@ limitations under the License.
 local N = "bimi"
 local lua_util = require "lua_util"
 local rspamd_logger = require "rspamd_logger"
-local ts = (require "tableshape").types
+local T = require "lua_shape.core"
 local lua_redis = require "lua_redis"
 local ucl = require "ucl"
 local lua_mime = require "lua_mime"
@@ -35,18 +35,36 @@ local settings = {
 local redis_params
 
 local settings_schema = lua_redis.enrich_schema({
-  helper_url = ts.string,
-  helper_timeout = ts.number + ts.string / lua_util.parse_time_interval,
-  helper_sync = ts.boolean,
-  vmc_only = ts.boolean,
-  redis_min_expiry = ts.number + ts.string / lua_util.parse_time_interval,
-  redis_prefix = ts.string,
-  enabled = ts.boolean:is_optional(),
-  -- New optional staged timeouts for HTTP helper
-  helper_connect_timeout = (ts.number + ts.string / lua_util.parse_time_interval):is_optional(),
-  helper_ssl_timeout = (ts.number + ts.string / lua_util.parse_time_interval):is_optional(),
-  helper_write_timeout = (ts.number + ts.string / lua_util.parse_time_interval):is_optional(),
-  helper_read_timeout = (ts.number + ts.string / lua_util.parse_time_interval):is_optional(),
+  helper_url = T.string():doc({ summary = "BIMI helper service URL" }),
+  helper_timeout = T.one_of({
+    T.number(),
+    T.transform(T.string(), lua_util.parse_time_interval)
+  }):doc({ summary = "BIMI helper timeout (seconds)" }),
+  helper_sync = T.boolean():doc({ summary = "Use synchronous helper requests" }),
+  vmc_only = T.boolean():doc({ summary = "Only accept VMC (Verified Mark Certificates)" }),
+  redis_min_expiry = T.one_of({
+    T.number(),
+    T.transform(T.string(), lua_util.parse_time_interval)
+  }):doc({ summary = "Minimum Redis cache expiry time (seconds)" }),
+  redis_prefix = T.string():doc({ summary = "Redis key prefix" }),
+  enabled = T.boolean():optional():doc({ summary = "Enable the plugin" }),
+  -- Optional staged timeouts for HTTP helper
+  helper_connect_timeout = T.one_of({
+    T.number(),
+    T.transform(T.string(), lua_util.parse_time_interval)
+  }):optional():doc({ summary = "Helper connection timeout (seconds)" }),
+  helper_ssl_timeout = T.one_of({
+    T.number(),
+    T.transform(T.string(), lua_util.parse_time_interval)
+  }):optional():doc({ summary = "Helper SSL timeout (seconds)" }),
+  helper_write_timeout = T.one_of({
+    T.number(),
+    T.transform(T.string(), lua_util.parse_time_interval)
+  }):optional():doc({ summary = "Helper write timeout (seconds)" }),
+  helper_read_timeout = T.one_of({
+    T.number(),
+    T.transform(T.string(), lua_util.parse_time_interval)
+  }):optional():doc({ summary = "Helper read timeout (seconds)" }),
 })
 
 local function check_dmarc_policy(task)