From: Aurelien DARRAGON <adarragon@haproxy.com>
Date: Wed, 27 Nov 2024 16:06:58 +0000 (+0100)
Subject: MINOR: hlua_fcn: add Patref:event_sub()
X-Git-Tag: v3.2-dev1~67
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=7ff9a1c341c4d9754fd8eddfae926639ff65c760;p=thirdparty%2Fhaproxy.git

MINOR: hlua_fcn: add Patref:event_sub()

Just like we did for server events, in this patch we expose the PAT_REF
event family (see "MINOR: event_hdl: add PAT_REF events") in Lua.

Unlike server events, Patref events don't provide additional event data,
and the registration can only take place from a Patref object (ie: not
globally).

Thanks to this commit it now becomes possible to trigger actions when
updates are performed on a map (or acl list) being monitor, without
the need to loop or use inefficient workarounds.
---

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index 74953b8a49..6ca26c7373 100644
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -3542,6 +3542,58 @@ Patref class
      Affects the live pattern reference version, unless :js:func:`Patref.prepare()`
      was called and is still ongoing (waiting for commit or giveup)
 
+.. js:function:: Patref.event_sub(ref, event_types, func)
+
+  Register a function that will be called on specific PAT_REF events.
+  See :js:func:`core.event_sub()` for generalities. Please note however that
+  for performance reasons pattern reference events can only be subscribed
+  per pattern reference (not globally). What this means is that the provided
+  callback function will only be called for events affecting the pattern
+  reference pointed by the Patref object (ref) passed as parameter.
+
+  If you want to be notified for events on a given set of pattern references, it
+  is still possible to perform as many per-patref subscriptions as needed.
+
+  Also, for PAT_REF events, no event data is provided (known as "event_data" in
+  callback function's prototype from :js:func:`core.event_sub()`)
+
+  The list of the available event types for the PAT_REF family are:
+
+    * **PAT_REF_ADD**: element was added to the current version of the pattern
+      reference
+    * **PAT_REF_DEL**: element was deleted from the current version of the
+      pattern reference
+    * **PAT_REF_SET**: element was modified in the current version of the
+      pattern reference
+    * **PAT_REF_CLEAR**: all elements were cleared from the current version of
+      the pattern reference
+    * **PAT_REF_COMMIT**: pending element(s) was/were committed in the current
+      version of the pattern reference
+
+   .. Note::
+     Use **PAT_REF** in **event_types** to subscribe to all pattern reference
+     events types at once.
+
+  Here is a working example showing how to trigger a callback function for the
+  pattern reference associated to file "test.map":
+
+.. code-block:: lua
+
+  core.register_init(function()
+    -- We assume that "test.map" is a map file referenced in haproxy config
+    -- file, thus it is loaded during config parsing and is expected to be
+    -- available at init Lua stage. Indeed, the below code wouldn't work if
+    -- used directly within body context, as at that time the config is not
+    -- fully parsed.
+    local map_patref = core.get_patref("test.map")
+    map_patref:event_sub({"PAT_REF_ADD"}, function(event, data, sub)
+      -- in the patref event handler
+      print("entry added!")
+    end)
+  end)
+
+..
+
 .. _applethttp_class:
 
 AppletHTTP class
diff --git a/src/hlua_fcn.c b/src/hlua_fcn.c
index 9b82f29645..3118e40d56 100644
--- a/src/hlua_fcn.c
+++ b/src/hlua_fcn.c
@@ -2921,6 +2921,27 @@ int hlua_patref_set(lua_State *L)
 	return 1;
 }
 
+/* hlua_event_sub wrapper for per-patref subscription:
+ *
+ * hlua_event_sub() is called with ref->ptr->e_subs subscription list and
+ * lua arguments are passed as-is (skipping the first argument which
+ * is the hlua_patref)
+ */
+int hlua_patref_event_sub(lua_State *L)
+{
+	struct hlua_patref *ref;
+
+	ref = hlua_checkudata(L, 1, class_patref_ref);
+
+	BUG_ON(!ref);
+
+	/* remove first argument from the stack (hlua_patref) */
+	lua_remove(L, 1);
+
+	/* try to subscribe within patref's subscription list */
+	return hlua_event_sub(L, &ref->ptr->e_subs);
+}
+
 void hlua_fcn_new_patref(lua_State *L, struct pat_ref *ref)
 {
 	struct hlua_patref *_ref;
@@ -2956,6 +2977,7 @@ void hlua_fcn_new_patref(lua_State *L, struct pat_ref *ref)
 	hlua_class_function(L, "add_bulk", hlua_patref_add_bulk);
 	hlua_class_function(L, "del", hlua_patref_del);
 	hlua_class_function(L, "set", hlua_patref_set);
+	hlua_class_function(L, "event_sub", hlua_patref_event_sub);
 }
 
 int hlua_patref_gc(lua_State *L)