(ns metabase.db.custom-migrations.metrics-v2 (:require [metabase.util :as u] [metabase.util.json :as json] [toucan2.core :as t2]) (:import (java.time Instant))) | |
(set! *warn-on-reflection* true) | |
Get the collection used to store the questions created from the v1 metrics.
If and only if the collection doesn't exists and the option | (defn- get-or-create-metric-migration-collection-id!
([]
(get-or-create-metric-migration-collection-id! nil))
([{:keys [create?]}]
(let [coll-name "Migrated Metrics v1"
slug "migrated_metrics_v1"
desc "This collection and the metrics in it were automatically generated by the migration to v50."]
(or (t2/select-one-pk :collection :name coll-name :slug slug :description desc)
(when create?
(let [collection-id (t2/insert-returning-pk!
:collection
{:name coll-name, :slug slug, :description desc})]
(let [all-users-group-id (t2/select-one-fn :id :permissions_group :name "All Users")]
(t2/insert! :permissions {:object (format "/collection/%s/read/" collection-id)
:group_id all-users-group-id
:perm_type "perms/collection-access"
:perm_value "read"
:collection_id collection-id}))
collection-id)))))) |
Add | (defn- add-metric-id [description id] (str description " (Migrated from metric " id ".)")) |
Convert a metric v2 question from | (defn- convert-metric-v2
[metric-v1 db-id]
(let [definition (json/decode+kw (:definition metric-v1))
dataset-query {:type :query
:database db-id
:query definition}]
(-> metric-v1
(select-keys [:archived :created_at :creator_id :database_id
:description :name :table_id])
(update :description add-metric-id (:id metric-v1))
(assoc :dataset_query (json/encode dataset-query)
:enable_embedding false
:query_type "query"
:type "metric"
:parameters "[]"
:parameter_mappings "[]"
:visualization_settings "{}"
:display "scalar")))) |
Create and persist a metric v2 question from | (defn- create-metric-v2!
[metric-v1 metric-v2-coll-id]
(let [card (-> metric-v1
(convert-metric-v2 (:database_id metric-v1))
(assoc :collection_id metric-v2-coll-id
:updated_at (Instant/now)))]
(t2/insert-returning-pk! :report_card card))) |
If | (defn- metric-ref->id
[expr]
(when (and (vector? expr)
(= (u/lower-case-en (get expr 0)) "metric"))
(let [id (get expr 1)]
;; GA metrics with string references are ignored
(when (int? id)
id)))) |
Replaces the IDs in metric references contained in | (defn- replace-metric-refs
[expr id-mapping]
(if-not (vector? expr)
expr
(if-let [id (metric-ref->id expr)]
(assoc expr 1 (id-mapping id))
(mapv #(replace-metric-refs % id-mapping) expr)))) |
(defn- rewrite-metric-consuming-query
[query metric-id->metric-card-id]
(if (contains? query :source-query)
(update query :source-query rewrite-metric-consuming-query metric-id->metric-card-id)
(let [aggregation (:aggregation query)
rewritten (replace-metric-refs aggregation metric-id->metric-card-id)]
(cond-> query
(not= rewritten aggregation) (assoc :aggregation rewritten))))) | |
Rewrite | (defn- rewrite-metric-consuming-card
[outer-query metric-id->metric-card-id]
(let [dataset-query (json/decode+kw outer-query)
inner-query (:query dataset-query)
rewritten (rewrite-metric-consuming-query inner-query metric-id->metric-card-id)]
(when (not= rewritten inner-query)
(-> dataset-query
(assoc :query rewritten)
json/encode)))) |
Migrate metrics and the cards consuming them to metrics v2. This involves 1. creating the migration collection, 2. creating a v2 metric card for each v1 metric in the migration collection, 3. making a backup copy of the dataset_query of each metric consuming card, 4. rewriting the metric consuming cards to use the migrated v2 metric cards. | (defn migrate-up!
[]
(when (t2/exists? :metric)
(let [metric-v2-coll-id (get-or-create-metric-migration-collection-id! {:create? true})
metric-id->metric-card-id (into {}
(map (juxt :id #(create-metric-v2! % metric-v2-coll-id)))
(t2/reducible-query
{:select [:m.* [:t.db_id :database_id]]
:from [[:metric :m]]
:inner-join [[:metabase_table :t] [:= :t.id :m.table_id]]}))]
(run! (fn [card]
(let [dataset-query (:dataset_query card)]
(when-let [rewritten (rewrite-metric-consuming-card dataset-query metric-id->metric-card-id)]
(t2/update! :report_card (:id card) {:dataset_query rewritten
:dataset_query_metrics_v2_migration_backup dataset-query}))))
(t2/reducible-query {:select [:id :dataset_query]
:from [:report_card]
:where [:like [:lower :dataset_query] "%[\"metric\",%"]}))))) |
Revert the migration to v2 metrics. This involves 1. restoring the metric consuming cards from the backup, 2. deleting the (metric) cards in the migration collection, 3. deleting the metric migration collection. | (defn migrate-down!
[]
(when-let [metric-v2-coll-id (get-or-create-metric-migration-collection-id!)]
(t2/query [(str "UPDATE report_card"
" SET dataset_query = dataset_query_metrics_v2_migration_backup"
" WHERE dataset_query_metrics_v2_migration_backup IS NOT NULL")])
(t2/delete! :report_card :collection_id metric-v2-coll-id)
(t2/delete! :collection metric-v2-coll-id))) |