shuffle stuff around to appease the namespace linter

- we aren't reaching into the api API, so the linter is more of a formality here.
metabase · escherize · Oct 15, 2024 · Oct 8, 2024 · Oct 8, 2024 · Oct 8, 2024
commit a081ea4351c2b7ca41cc2b2e8249b98b9bb57e88
diff --git a/.clj-kondo/config.edn b/.clj-kondo/config.edn
@@ -595,6 +595,7 @@
     metabase.driver.sql-jdbc.test-util                            sql-jdbc.tu
     metabase.driver.sql.parameters.substitute                     sql.params.substitute
     metabase.driver.sql.parameters.substitution                   sql.params.substitution
+    metabase.eid-translation                                      eid-translation
     metabase.email-test                                           et
     metabase.email.messages                                       messages
     metabase.formatter                                            formatter

diff --git a/src/metabase/analytics/stats.clj b/src/metabase/analytics/stats.clj
@@ -10,12 +10,11 @@
    [java-time.api :as t]
    [medley.core :as m]
    [metabase.analytics.snowplow :as snowplow]
-   #_:clj-kondo/ignore
-   [metabase.api.embed.common :as embed.common]
    [metabase.config :as config]
    [metabase.db :as db]
    [metabase.db.query :as mdb.query]
    [metabase.driver :as driver]
+   [metabase.eid-translation :as eid-translation]
    [metabase.email :as email]
    [metabase.embed.settings :as embed.settings]
    [metabase.integrations.google :as google]
@@ -578,10 +577,25 @@
           :has_activation_signals_completed (completed-activation-signals?)})]
     (m->kv-vec instance-attributes)))
 
+
+(mu/defn- get-translation-count!
+  :- [:map [:ok :int] [:not-found :int] [:invalid-format :int] [:total :int]]
+  "Get and clear the entity-id translation counter. This is meant to be called during the daily stats collection process."
+  []
+  (let [counter (setting/get-value-of-type :json :entity-id-translation-counter)]
+    (merge counter {:total (apply + (vals counter))})))
+
+(mu/defn- clear-translation-count!
+  "We want to reset the eid translation count on every stat ping, so we do it here."
+  []
+  (setting/set-value-of-type! :json eid-translation/default-counter))
+
 (defn- ->snowplow-metric-info
   "Collects Snowplow metrics data that is not in the legacy stats format."
   []
-  (let [one-day-ago (t/minus (t/offset-date-time) (t/days 1))]
+  (let [one-day-ago (t/minus (t/offset-date-time) (t/days 1))
+        total-translation-count (:total (get-translation-count!))
+        _ (clear-translation-count!)]
     {:models                  (t2/count :model/Card :type :model :archived false)
      :new_embedded_dashboards (t2/count :model/Dashboard
                                         :enable_embedding true
@@ -592,7 +606,7 @@
                                           :date_joined [:>= one-day-ago])
      :pivot_tables              (t2/count :model/Card :display :pivot :archived false)
      :query_executions_last_24h (t2/count :model/QueryExecution :started_at [:>= one-day-ago])
-     :entity_id_translations_last_24h (:total (embed.common/get-and-clear-translation-count!))}))
+     :entity_id_translations_last_24h total-translation-count}))
 
 (mu/defn- snowplow-metrics
   [stats metric-info :- [:map

diff --git a/src/metabase/api/embed/common.clj b/src/metabase/api/embed/common.clj
@@ -12,6 +12,7 @@
    [metabase.api.dashboard :as api.dashboard]
    [metabase.api.public :as api.public]
    [metabase.driver.common.parameters.operators :as params.ops]
+   [metabase.eid-translation :as eid-translation]
    [metabase.models.card :as card]
    [metabase.models.params :as params]
    [metabase.models.setting :as setting :refer [defsetting]]
@@ -325,49 +326,29 @@
   "A Malli schema for a map of model names to a sequence of entity ids."
   (mc/schema [:map-of ApiName [:sequential :string]]))
 
-(def ^:private EidTranslationStatus
-  [:enum :ok :not-found :invalid-format])
-
 ;; -------------------- Entity Id Translation Analytics --------------------
 
-(def ^:private
-  default-eid-translation-counter
-  (zipmap (rest EidTranslationStatus) (repeat 0)))
-
 (defsetting entity-id-translation-counter
   (deferred-tru "A counter for tracking the number of entity_id -> id translations. Whenever we call [[model->entity-ids->ids]], we increment this counter by the number of translations.")
   :encryption :no
   :visibility :internal
   :export?    false
   :audit      :never
   :type       :json
-  :default    default-eid-translation-counter)
-
-(defn- compute-result [processed-result current-count]
-  (merge-with + processed-result current-count))
+  :default    eid-translation/default-counter)
 
 (mu/defn update-translation-count!
   "Update the entity-id translation counter with the results of a batch of entity-id translations."
-  [results :- [:sequential EidTranslationStatus]]
+  [results :- [:sequential eid-translation/Status]]
   (let [processed-result (frequencies results)]
     (entity-id-translation-counter!
-     (compute-result processed-result (entity-id-translation-counter)))))
-
-(defn- add-total [counter]
-  (merge counter {:total (apply + (vals counter))}))
-
-(mu/defn get-and-clear-translation-count!
-  :- [:map [:ok :int] [:not-found :int] [:invalid-format :int] [:total :int]]
-  "Get and clear the entity-id translation counter. This is meant to be called during the daily stats collection process."
-  []
-  (u/prog1 (add-total (entity-id-translation-counter))
-    (entity-id-translation-counter! default-eid-translation-counter)))
+     (merge-with + processed-result (entity-id-translation-counter)))))
 
 (mu/defn- entity-ids->id-for-model :- [:sequential [:tuple
                                                     ;; We want to pass incorrectly formatted entity-ids through here,
                                                     ;; but this is assumed to be an entity-id:
                                                     :string
-                                                    [:map [:status EidTranslationStatus]]]]
+                                                    [:map [:status eid-translation/Status]]]]
   "Given a model and a sequence of entity ids on that model, return a pairs of entity-id, id."
   [api-name eids]
   (let [model (->model api-name) ;; This lookup is safe because we've already validated the api-names

diff --git a/src/metabase/eid_translation.clj b/src/metabase/eid_translation.clj
@@ -0,0 +1,9 @@
+(ns metabase.eid-translation)
+
+(def Status
+  "Malli enum for possible statuses for entity_id -> id translations."
+  [:enum :ok :not-found :invalid-format])
+
+(def default-counter
+  "The empty counter for tracking the number of entity_id -> id translations."
+  (zipmap (rest Status) (repeat 0)))