Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

BOT-2113: Copy metabot_permissions on every edition

Andrei Simionescu06d46ec0c2ce
diff --git a/src/metabase/cmd/copy.clj b/src/metabase/cmd/copy.clj
index 3e2f8bf52c4..498ad50ce9c 100644
--- a/src/metabase/cmd/copy.clj
+++ b/src/metabase/cmd/copy.clj
@@ -141,6 +141,8 @@
:model/MetabotUsedTable
:model/MetabotPrompt
:model/OsiAiContext
+ ;; 61+, by table name: migrations create and seed it on every edition, but its model is EE-only
+ :metabot_permissions
;; 62+
:model/Exploration
:model/ExplorationThread
@@ -152,8 +154,7 @@
;; 63+
:model/McpFeedback]
(when config/ee-available?
- [:model/MetabotPermissions
- :model/MetabotGroupLimit
+ [:model/MetabotGroupLimit
:model/MetabotInstanceLimit
:model/Sandbox
:model/Tenant
@@ -198,6 +199,9 @@
[model]
(case model
:model/Field {:order-by [[:id :asc]]}
+ ;; dumps made by an OSS build before this table was copied still hold the rows the target's own migrations seeded,
+ ;; which can point at group ids the source never had
+ :metabot_permissions {:where [:in :group_id {:select [:id] :from [:permissions_group]}]}
nil))
(defn- sql-for-selecting-instances-from-source-db [model]
@@ -446,6 +450,24 @@
table-name table-name)]]
(jdbc/execute! target-db-conn sql)))))
+(def ^:private metabot-permissions-seed-sql
+ "The seed of changeset v61.98kjjhf. Dumps made by an OSS build before this table was copied hold the dumping build's
+ seed rows under its own group ids, so the source's magic groups can arrive with none."
+ "INSERT INTO metabot_permissions (group_id, perm_type, perm_value)
+ SELECT pg.id, d.perm_type, d.perm_value
+ FROM permissions_group pg
+ CROSS JOIN (
+ SELECT 'permission/metabot' AS perm_type, 'yes' AS perm_value
+ UNION ALL SELECT 'permission/metabot-sql-generation', 'yes'
+ UNION ALL SELECT 'permission/metabot-nlq', 'yes'
+ UNION ALL SELECT 'permission/metabot-other-tools', 'yes'
+ ) AS d
+ WHERE pg.magic_group_type IN ('admin', 'all-internal-users', 'data-analyst', 'all-external-users')
+ AND NOT EXISTS (
+ SELECT 1 FROM metabot_permissions mp
+ WHERE mp.group_id = pg.id AND mp.perm_type = d.perm_type
+ )")
+
(mu/defn copy!
"Copy data from a source application database into an empty destination application database."
[source-db-type :- [:enum :h2 :postgres :mysql]
@@ -486,4 +508,6 @@
(with-disabled-db-constraints target-db-type target-conn-spec
(copy-data! source-data-source target-db-type target-conn-spec))))
;; finally, update sequence values (if needed)
- (update-sequence-values! target-db-type target-data-source))
+ (update-sequence-values! target-db-type target-data-source)
+ (step (trs "Seeding metabot permissions for magic groups without any...")
+ (jdbc/execute! {:datasource target-data-source} [metabot-permissions-seed-sql])))
diff --git a/test/metabase/cmd/copy_test.clj b/test/metabase/cmd/copy_test.clj
index 1afb23ff4eb..1514997631a 100644
--- a/test/metabase/cmd/copy_test.clj
+++ b/test/metabase/cmd/copy_test.clj
@@ -1,15 +1,21 @@
(ns metabase.cmd.copy-test
(:require
[clojure.java.classpath :as classpath]
+ [clojure.java.jdbc :as jdbc]
[clojure.string :as str]
[clojure.test :refer :all]
[clojure.tools.namespace.find :as ns.find]
+ [metabase.app-db.data-source :as mdb.data-source]
+ [metabase.app-db.setup :as mdb.setup]
[metabase.classloader.core :as classloader]
- [metabase.cmd.copy :as copy]))
+ [metabase.cmd.copy :as copy]
+ [toucan2.core :as t2]))
(deftest ^:parallel sql-for-selecting-instances-from-source-db-test
(is (= "SELECT * FROM metabase_field ORDER BY id ASC"
- (#'copy/sql-for-selecting-instances-from-source-db :model/Field))))
+ (#'copy/sql-for-selecting-instances-from-source-db :model/Field)))
+ (is (= "SELECT * FROM metabot_permissions WHERE group_id IN (SELECT id FROM permissions_group)"
+ (#'copy/sql-for-selecting-instances-from-source-db :metabot_permissions))))
(deftest ^:parallel copy-h2-database-details-test
(doseq [copy-h2-database-details? [true false]]
@@ -23,6 +29,45 @@
[{:id 1, :engine "h2", :details "{:db \"metabase.db\"}"}
{:id 2, :engine "postgres", :details "{:db \"metabase\"}"}])))))))
+(defn- h2-data-source []
+ (mdb.data-source/raw-connection-string->DataSource
+ (format "jdbc:h2:mem:%s;DB_CLOSE_DELAY=-1" (random-uuid))))
+
+(defn- shutdown! [data-source]
+ (jdbc/execute! {:datasource data-source} ["SHUTDOWN"] {:transaction? false}))
+
+(defn- metabot-permissions-by-group-type
+ "{magic_group_type {perm_type perm_value}}, with rows of groups the target doesn't have under nil."
+ [data-source]
+ (reduce (fn [m {:keys [magic_group_type perm_type perm_value]}]
+ (assoc-in m [magic_group_type perm_type] perm_value))
+ {}
+ (jdbc/query {:datasource data-source}
+ ["SELECT pg.magic_group_type, mp.perm_type, mp.perm_value
+ FROM metabot_permissions mp
+ LEFT JOIN permissions_group pg ON pg.id = mp.group_id"])))
+
+(deftest copy-metabot-permissions-test
+ (testing "a dump made by an OSS build before metabot_permissions was copied restores like a fresh install (#78414)"
+ (let [source (h2-data-source)
+ target (h2-data-source)]
+ (try
+ (mdb.setup/setup-db! :h2 source {:manage-encryption-state? false})
+ (let [fresh (metabot-permissions-by-group-type source)]
+ ;; such a dump holds the dumping build's seed rows under its own group ids, while the source's magic groups
+ ;; sit elsewhere with none
+ (jdbc/execute! {:datasource source} ["SET REFERENTIAL_INTEGRITY FALSE"])
+ (jdbc/execute! {:datasource source} ["UPDATE permissions_group SET id = id + 10 WHERE id > 2"])
+ (doseq [table ["permissions" "data_permissions"]]
+ (jdbc/execute! {:datasource source} [(format "UPDATE %s SET group_id = group_id + 10 WHERE group_id > 2" table)]))
+ (jdbc/execute! {:datasource source} ["UPDATE metabot_permissions SET perm_value = 'no' WHERE group_id = 1 AND perm_type = 'permission/metabot'"])
+ (jdbc/execute! {:datasource source} ["SET REFERENTIAL_INTEGRITY TRUE"])
+ (copy/copy! :h2 source :h2 target)
+ (is (= (assoc-in fresh ["all-internal-users" "permission/metabot"] "no")
+ (metabot-permissions-by-group-type target))))
+ (finally
+ (run! shutdown! [source target]))))))
+
(def ^:private models-to-exclude
"Models that should *not* be migrated in `load-from-h2`."
#{:model/AgentApiCallLog
@@ -102,4 +147,5 @@
(doseq [model (all-model-names)
:let [copy-models (set copy/entities)]]
(is (contains? copy-models model)
- (format "%s should be added to %s, or to %s" model `copy/entities `models-to-exclude))))
+ (format "%s should be added to %s, or to %s" model `copy/entities `models-to-exclude)))
+ (is (apply distinct? (map t2/table-name copy/entities))))