Add Message to DB Sync Timeout Error

codecov.yml

@@ -7,4 +7,3 @@ comment:
   layout: "reach, diff, flags, files"
   behavior: default
   require_changes: false
-  after_n_builds: 19

modules/rest-api/src/blaze/rest_api/middleware/log.clj

@@ -4,11 +4,15 @@
     [taoensso.timbre :as log]))
 
 
+(defn- format-request-method [{:keys [request-method]}]
+  (str/upper-case (name request-method)))
+
+
 (defn wrap-log
   [handler]
-  (fn [{:keys [request-method uri query-string] :as request}]
+  (fn [{:keys [uri query-string] :as request}]
     (log/debug
       (if query-string
-        (format "%s [base]%s?%s" (str/upper-case (name request-method)) uri query-string)
-        (format "%s [base]%s" (str/upper-case (name request-method)) uri)))
+        (format "%s [base]%s?%s" (format-request-method request) uri query-string)
+        (format "%s [base]%s" (format-request-method request) uri)))
     (handler request)))

modules/rest-util/src/blaze/middleware/fhir/db.clj

@@ -6,7 +6,8 @@
   (:require
     [blaze.async.comp :as ac :refer [do-sync]]
     [blaze.db.api :as d]
-    [blaze.handler.fhir.util :as fhir-util])
+    [blaze.handler.fhir.util :as fhir-util]
+    [cognitect.anomalies :as anom])
   (:import
     [java.util.concurrent TimeUnit]))
 
@@ -15,13 +16,19 @@
   (and vid (re-matches #"\d+" vid) (Long/parseLong vid)))
 
 
+(defn- timeout-msg [timeout]
+  (format "Timeout while trying to acquire the latest known database state. At least one known transaction hasen't been completed yet. Please try to lower the transaction load or increase the timeout of %d ms by setting DB_SYNC_TIMEOUT to a higher value if you see this often.", timeout))
+
+
 (defn- db [node timeout {:keys [query-params] :as request}]
   (if-let [t (vid request)]
     (do-sync [db (d/sync node t)]
       (d/as-of db t))
     (if-let [t (fhir-util/t query-params)]
       (d/sync node t)
-      (ac/or-timeout! (d/sync node) timeout TimeUnit/MILLISECONDS))))
+      (-> (d/sync node)
+          (ac/or-timeout! timeout TimeUnit/MILLISECONDS)
+          (ac/exceptionally #(assoc % ::anom/message (timeout-msg timeout)))))))
 
 
 (defn wrap-db

modules/rest-util/test/blaze/middleware/fhir/db_test.clj

@@ -86,7 +86,8 @@
            (ac/supply-async (constantly ::db) (ac/delayed-executor 3 TimeUnit/SECONDS)))]
 
         (given-failed-future ((db/wrap-db handler ::node 2000) {})
-          ::anom/category := ::anom/busy)))
+          ::anom/category := ::anom/busy
+          ::anom/message := "Timeout while trying to acquire the latest known database state. At least one known transaction hasen't been completed yet. Please try to lower the transaction load or increase the timeout of 2000 ms by setting DB_SYNC_TIMEOUT to a higher value if you see this often.")))
 
     (testing "default timeout are 10 seconds"
       (with-redefs
@@ -96,4 +97,5 @@
            (ac/supply-async (constantly ::db) (ac/delayed-executor 11 TimeUnit/SECONDS)))]
 
         (given-failed-future ((db/wrap-db handler ::node) {})
-          ::anom/category := ::anom/busy)))))
+          ::anom/category := ::anom/busy
+          ::anom/message := "Timeout while trying to acquire the latest known database state. At least one known transaction hasen't been completed yet. Please try to lower the transaction load or increase the timeout of 10000 ms by setting DB_SYNC_TIMEOUT to a higher value if you see this often.")))))