Deprecate prePrompt and postPrompt in favor of preRequest and prePrompt.

Author: ericdallo

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- Deprecate prePrompt and postPrompt in favor of preRequest and prePrompt.
+
 ## 0.70.2
 
 - Fix model capabilities for models with custom names.

docs/configuration.md

@@ -359,8 +359,8 @@ Hooks are actions that can run before or after an specific event, useful to noti
 
 Allowed hook types:
 
-- `prePrompt`: Run before prompt is sent to LLM, if a hook output is provided, append to user prompt.
-- `postPrompt`: Run after prompt is finished, when chat come back to idle state.
+- `preRequest`: Run before prompt is sent to LLM, if a hook output is provided, append to user prompt.
+- `postRequest`: Run after prompt is finished, when chat come back to idle state.
 - `preToolCall`: Run before a tool is called, if a hook exit with status `2`, reject the tool call.
 - `postToolCall`: Run after a tool was called.
 
@@ -378,7 +378,7 @@ Examples:
     {
       "hooks": {
         "notify-me": {
-          "type": "postPrompt", 
+          "type": "postRequest",
           "actions": [
             {
               "type": "shell",
@@ -444,7 +444,7 @@ To configure, add your OTLP collector config via `:otlp` map following [otlp aut
         }};
         defaultModel?: string;
         hooks?: {[key: string]: {
-                type: 'preToolCall' | 'postToolCall' | 'preToolCallApproval' | 'prePrompt' | 'postPrompt';
+                type: 'preToolCall' | 'postToolCall' | 'preRequest' | 'postRequest';
                 matcher: string;
                 actions: {
                     type: 'shell';

src/eca/features/chat.clj

@@ -53,7 +53,7 @@
 
 (defn finish-chat-prompt! [status {:keys [message chat-id db* metrics config on-finished-side-effect] :as chat-ctx}]
   (swap! db* assoc-in [:chats chat-id :status] status)
-  (f.hooks/trigger-if-matches! :postPrompt
+  (f.hooks/trigger-if-matches! :postRequest
                                {:chat-id chat-id
                                 :prompt message}
                                {:on-before-action (partial notify-before-hook-action! chat-ctx)
@@ -962,7 +962,7 @@
                   :messenger messenger}
         decision (message->decision message)
         hook-outputs* (atom [])
-        _ (f.hooks/trigger-if-matches! :prePrompt
+        _ (f.hooks/trigger-if-matches! :preRequest
                                        {:chat-id chat-id
                                         :prompt message}
                                        {:on-before-action (partial notify-before-hook-action! chat-ctx)

src/eca/features/hooks.clj

@@ -8,12 +8,21 @@
 (def ^:private logger-tag "[HOOK]")
 
 (defn ^:private hook-matches? [type data hook]
-  (case type
-    (:preToolCall :postToolCall)
-    (re-matches (re-pattern (or (:matcher hook) ".*"))
-                (str (:server data) "__" (:tool-name data)))
+  (let [hook-config-type (keyword (:type hook))
+        hook-config-type (cond ;; legacy values
+                           (= :prePrompt hook-config-type) :preRequest
+                           (= :postPrompt hook-config-type) :postRequest
+                           :else hook-config-type)]
+    (cond
+      (not= type hook-config-type)
+      false
 
-    true))
+      (contains? #{:preToolCall :postToolCall} type)
+      (re-matches (re-pattern (or (:matcher hook) ".*"))
+                  (str (:server data) "__" (:tool-name data)))
+
+      :else
+      true)))
 
 (defn ^:private run-hook-action! [action name data db]
   (case (:type action)
@@ -39,26 +48,25 @@
    db
    config]
   (doseq [[name hook] (:hooks config)]
-    (when (= type (keyword (:type hook)))
-      (when (hook-matches? type data hook)
-        (vec
-         (map-indexed (fn [i action]
-                        (let [id (str (random-uuid))
-                              type (:type action)
-                              name (if (> 1 (count (:actions hook)))
-                                     (str name "-" (inc i))
-                                     name)]
-                          (on-before-action {:id id
-                                             :name name})
-                          (if-let [[status output error] (run-hook-action! action name data db)]
-                            (on-after-action {:id id
-                                              :name name
-                                              :type type
-                                              :status status
-                                              :output output
-                                              :error error})
-                            (on-after-action {:id id
-                                              :name name
-                                              :type type
-                                              :status -1}))))
-                      (:actions hook)))))))
+    (when (hook-matches? type data hook)
+      (vec
+       (map-indexed (fn [i action]
+                      (let [id (str (random-uuid))
+                            type (:type action)
+                            name (if (> 1 (count (:actions hook)))
+                                   (str name "-" (inc i))
+                                   name)]
+                        (on-before-action {:id id
+                                           :name name})
+                        (if-let [[status output error] (run-hook-action! action name data db)]
+                          (on-after-action {:id id
+                                            :name name
+                                            :type type
+                                            :status status
+                                            :output output
+                                            :error error})
+                          (on-after-action {:id id
+                                            :name name
+                                            :type type
+                                            :status -1}))))
+                    (:actions hook))))))

test/eca/features/hooks_test.clj

@@ -13,7 +13,7 @@
     (reset! a* p)))
 
 (deftest trigger-if-matches!-test
-  (testing "prePrompt"
+  (testing "legacy prePrompt"
     (h/reset-components!)
     (h/config! {:hooks {"my-hook" {:type "prePrompt"
                                    :actions [{:type "shell"
@@ -22,7 +22,33 @@
           on-after-action* (atom nil)]
       (with-redefs [p/sh (constantly {:exit 0 :out "hey" :err nil})]
         (f.hooks/trigger-if-matches!
-         :prePrompt
+         :preRequest
+         {:foo "1"}
+         {:on-before-action (set-action-payload on-before-action*)
+          :on-after-action (set-action-payload on-after-action*)}
+         (h/db)
+         (h/config)))
+      (is (match?
+           {:id string?
+            :name "my-hook"}
+           @on-before-action*))
+      (is (match?
+           {:id string?
+            :name "my-hook"
+            :status 0
+            :output "hey"
+            :error nil}
+           @on-after-action*))))
+  (testing "preRequest"
+    (h/reset-components!)
+    (h/config! {:hooks {"my-hook" {:type "preRequest"
+                                   :actions [{:type "shell"
+                                              :shell "echo hey"}]}}})
+    (let [on-before-action* (atom nil)
+          on-after-action* (atom nil)]
+      (with-redefs [p/sh (constantly {:exit 0 :out "hey" :err nil})]
+        (f.hooks/trigger-if-matches!
+         :preRequest
          {:foo "1"}
          {:on-before-action (set-action-payload on-before-action*)
           :on-after-action (set-action-payload on-after-action*)}