Merge pull request #10470 from terry-xiaoyu/improve_template_syntax

Improve template syntax
2023-04-21 18:19:52 +08:00 · 2023-04-21 18:19:52 +08:00 · 2ad297ae19
parent daa2088b94 7836eb44d4
commit 2ad297ae19
9 changed files with 86 additions and 32 deletions
--- a/apps/emqx_rule_engine/src/emqx_rule_engine.app.src
+++ b/apps/emqx_rule_engine/src/emqx_rule_engine.app.src
@ -1,6 +1,6 @@
 {application, emqx_rule_engine,
 [{description, "EMQX Rule Engine"},
-  {vsn, "4.4.17"}, % strict semver, bump manually!
+  {vsn, "4.4.18"}, % strict semver, bump manually!
  {modules, []},
  {registered, [emqx_rule_engine_sup, emqx_rule_registry, emqx_rule_engine_jwt_sup]},
  {applications, [kernel,stdlib,rulesql,getopt,jose]},
--- a/apps/emqx_rule_engine/src/emqx_rule_engine.appup.src
+++ b/apps/emqx_rule_engine/src/emqx_rule_engine.appup.src
@ -1,27 +1,30 @@
 %% -*- mode: erlang -*-
 %% Unless you know what you are doing, DO NOT edit manually!!
 {VSN,
-  [{"4.4.16",
-    [{load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
+  [{"4.4.17",[{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]}]},
+   {"4.4.16",
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
-     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}
-    ]},
+     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}]},
   {"4.4.15",
-    [{load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]},
-     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}
-    ]},
+     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}]},
   {<<"4\\.4\\.1[3-4]">>,
-    [{load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_monitor,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]}]},
   {"4.4.12",
-    [{load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
@ -31,7 +34,8 @@
     {update,emqx_rule_engine_jwt_sup,supervisor},
     {load_module,emqx_rule_engine_jwt,brutal_purge,soft_purge,[]}]},
   {"4.4.11",
-    [{load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine_jwt_worker,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
@ -60,8 +64,7 @@
     {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_metrics,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_funcs,brutal_purge,soft_purge,[]},
-     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}
-    ]},
+     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}]},
   {"4.4.9",
    [{load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {add_module,emqx_rule_engine_jwt},
@ -118,8 +121,7 @@
     {load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_actions,brutal_purge,soft_purge,[]},
-     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}
-    ]},
+     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}]},
   {"4.4.5",
    [{add_module,emqx_rule_engine_jwt},
     {add_module,emqx_rule_engine_jwt_worker},
@ -227,8 +229,7 @@
     {load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_funcs,brutal_purge,soft_purge,[]},
     {add_module,emqx_rule_date},
-     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}
-    ]},
+     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}]},
   {"4.4.0",
    [{add_module,emqx_rule_engine_jwt},
     {add_module,emqx_rule_engine_jwt_worker},
@ -253,27 +254,30 @@
     {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]}]},
   {<<".*">>,[]}],
-  [{"4.4.16",
-    [{load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
+  [{"4.4.17",[{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]}]},
+   {"4.4.16",
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
-     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}
-     ]},
+     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}]},
   {"4.4.15",
-    [{load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]},
-     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}
-    ]},
+     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]}]},
   {<<"4\\.4\\.1[3-4]">>,
-    [{load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_monitor,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine,brutal_purge,soft_purge,[]}]},
   {"4.4.12",
-    [{load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_registry,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
@ -283,7 +287,8 @@
     {update,emqx_rule_engine_jwt_sup,supervisor},
     {load_module,emqx_rule_engine_jwt,brutal_purge,soft_purge,[]}]},
   {"4.4.11",
-    [{load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
+    [{load_module,emqx_rule_utils,brutal_purge,soft_purge,[]},
+     {load_module,emqx_rule_engine_app,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_runtime,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_engine_jwt_worker,brutal_purge,soft_purge,[]},
     {load_module,emqx_rule_events,brutal_purge,soft_purge,[]},
--- a/apps/emqx_rule_engine/src/emqx_rule_utils.erl
+++ b/apps/emqx_rule_engine/src/emqx_rule_utils.erl
@ -71,7 +71,10 @@
          [ float/1
          ]}).

-define(EX_PLACE_HOLDER, "(\\$\\{[a-zA-Z0-9\\._]+\\})").
+%% To match any pattern starts with '$' and followed by '{', and closed by a '}' char:
+%% e.g. for string "a${abc}bb", "${abc}" will be matched.
+%% Note that if "${{abc}}" is given, the "${{abc}" should be matched, NOT "${{abc}}".
+-define(EX_PLACE_HOLDER, "(\\$\\{.*?\\})").
 -define(EX_WITHE_CHARS, "\\s"). %% Space and CRLF
 -define(FLOAT_PRECISION, 17).

--- a/apps/emqx_rule_engine/test/emqx_rule_utils_SUITE.erl
+++ b/apps/emqx_rule_engine/test/emqx_rule_utils_SUITE.erl
@ -76,6 +76,25 @@ t_proc_tmpl(_) ->
    Selected = #{a => <<"1">>, b => 1, c => 1.0, d => #{d1 => <<"hi">>}},
    Tks = emqx_rule_utils:preproc_tmpl(<<"a:${a},b:${b},c:${c},d:${d}">>),
    ?assertEqual(<<"a:1,b:1,c:1.0,d:{\"d1\":\"hi\"}">>,
+                 emqx_rule_utils:proc_tmpl(Tks, Selected)),
+    Tks1 = emqx_rule_utils:preproc_tmpl(<<"a:${a},b:${b},c:${c},d:${d.d1}">>),
+    ?assertEqual(<<"a:1,b:1,c:1.0,d:hi">>,
+                 emqx_rule_utils:proc_tmpl(Tks1, Selected)).
+
+t_proc_tmpl_arbitrary_var_name(_) ->
+    Selected = #{<<"中"/utf8>> => <<"1">>,
+                 <<"中-1"/utf8>> => <<"1-1">>,
+                 <<"-_+=<>,/?:;\"'\\[]|">> => 1,
+                 <<"-_+=<>,">> => #{<<"/?:;\"'\\[]|">> => 2},
+                 <<"!@#$%^&*()">> => 1.0,
+                 <<"d">> => #{
+                    <<"$ff">> => <<"oo">>,
+                    <<"${f">> => <<"hi">>,
+                    <<"${f}">> => <<"qq">>
+                }},
+    Tks = emqx_rule_utils:preproc_tmpl(
+        <<"a:${中},a:${中-1},b:${-_+=<>,/?:;\"'\\[]|},b:${-_+=<>,./?:;\"'\\[]|},c:${!@#$%^&*()},d:${d.$ff},d1:${d.${f}}"/utf8>>),
+    ?assertEqual(<<"a:1,a:1-1,b:1,b:2,c:1.0,d:oo,d1:hi}">>,
                 emqx_rule_utils:proc_tmpl(Tks, Selected)).

 t_proc_tmpl1(_) ->
--- a/changes/v4.4.18-en.md
+++ b/changes/v4.4.18-en.md
@ -0,0 +1,10 @@
+# v4.4.18
+
+## Enhancements
+
+- Improved the placeholder syntax of the rule engine [#10470](https://github.com/emqx/emqx/pull/10470).
+
+  The parameters of certain actions support using placeholder syntax to dynamically fill in the content of strings. The format of the placeholder syntax is `${key}`.
+  Prior to the improvement, the `key` in `${key}` could only contain letters, numbers, and underscores. Now the `key` supports any UTF8 character after the improvement.
+
+## Bug fixes
--- a/changes/v4.4.18-zh.md
+++ b/changes/v4.4.18-zh.md
@ -0,0 +1,11 @@
+# v4.4.18
+
+## 增强
+
+- 改进规则引擎的占位符语法 [#10470](https://github.com/emqx/emqx/pull/10470)。
+
+  某些动作的参数支持使用占位符语法，来动态的填充字符串的内容，占位符语法的格式为 `${key}`。
+  改进前，`${key}` 中的 `key` 只能包含字母、数字和下划线。改进后 `key` 支持任意的 UTF8 字符了。
+
+## 修复
+
--- a/lib-ce/emqx_dashboard/src/emqx_dashboard.app.src
+++ b/lib-ce/emqx_dashboard/src/emqx_dashboard.app.src
@ -1,6 +1,6 @@
 {application, emqx_dashboard,
 [{description, "EMQX Web Dashboard"},
-  {vsn, "4.4.16"}, % strict semver, bump manually!
+  {vsn, "4.4.17"}, % strict semver, bump manually!
  {modules, []},
  {registered, [emqx_dashboard_sup]},
  {applications, [kernel,stdlib,mnesia,minirest]},
--- a/src/emqx.app.src
+++ b/src/emqx.app.src
@ -6,7 +6,7 @@
  %% the emqx `release' version, which in turn is comprised of several
  %% apps, one of which is this.  See `emqx_release.hrl' for more
  %% info.
-  {vsn, "4.4.17"}, % strict semver, bump manually!
+  {vsn, "4.4.18"}, % strict semver, bump manually!
  {modules, []},
  {registered, []},
  {applications, [ kernel
--- a/src/emqx.appup.src
+++ b/src/emqx.appup.src
@ -1,7 +1,10 @@
 %% -*- mode: erlang -*-
 %% Unless you know what you are doing, DO NOT edit manually!!
 {VSN,
-  [{"4.4.16",
+  [{"4.4.17",
+    [{load_module,emqx_relup,brutal_purge,soft_purge,[]},
+     {load_module,emqx_app,brutal_purge,soft_purge,[]}]},
+   {"4.4.16",
    [{load_module,emqx_channel,brutal_purge,soft_purge,[]},
     {load_module,emqx_pool,brutal_purge,soft_purge,[]},
     {load_module,emqx_misc,brutal_purge,soft_purge,[]},
@ -526,7 +529,10 @@
     {apply,{application,set_env,
                         [gen_rpc,insecure_auth_fallback_allowed,true]}}]},
   {<<".*">>,[]}],
-  [{"4.4.16",
+  [{"4.4.17",
+    [{load_module,emqx_relup,brutal_purge,soft_purge,[]},
+     {load_module,emqx_app,brutal_purge,soft_purge,[]}]},
+   {"4.4.16",
    [{load_module,emqx_channel,brutal_purge,soft_purge,[]},
     {load_module,emqx_pool,brutal_purge,soft_purge,[]},
     {load_module,emqx_misc,brutal_purge,soft_purge,[]},