The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Limit settable properties with _metabase_metadata (#83886)
Nathan Voxland083daedfa7f8
diff --git a/src/metabase/sync/sync_metadata/metabase_metadata.clj b/src/metabase/sync/sync_metadata/metabase_metadata.cljindex f5146612321..fe196ad7d61 100644--- a/src/metabase/sync/sync_metadata/metabase_metadata.clj+++ b/src/metabase/sync/sync_metadata/metabase_metadata.clj@@ -37,14 +37,20 @@:field-name (when third-part second-part):k (keyword (or third-part second-part first-part))}))+(def ^:private settable-properties+ "The properties `_metabase_metadata` may set, by the kind of object the keypath names."+ {:database #{:description :caveats :points_of_interest}+ :table #{:description :caveats :points_of_interest :display_name}+ :field #{:description :caveats :points_of_interest :display_name :semantic_type}})+(mu/defn- set-property! :- :boolean"Set a property for a Field or Table in `database`. Returns `true` if a property was successfully set."[database :- i/DatabaseInstance{:keys [table-name field-name k]} :- KeypathComponentsvalue :- [:maybe :string]](boolean- ;; ignore legacy entries that try to set field_type since it's no longer part of Field- (when-not (= k :field_type)+ ;; properties outside the allowlist (including the legacy `field_type`) are ignored+ (when (contains? (settable-properties (cond field-name :field, table-name :table, :else :database)) k);; fetch the corresponding Table, then set the Table or Field property(if table-name;; TODO: this needs to support schemas@@ -67,8 +73,8 @@keypath | varchar | \"products.created_at.description\"value | varchar | \"The date the product was added to our catalog.\"- `keypath` is of the form `table-name.key` or `table-name.field-name.key`, where `key` is the name of some property- of `Table` or `Field`.+ `keypath` is of the form `key`, `table-name.key`, or `table-name.field-name.key`, where `key` is one of the+ descriptive properties in [[settable-properties]] for the Database, Table, or Field. Other keys are ignored.This functionality is currently only used by the Sample Database. In order to use this functionality, drivers *must*implement optional fn `:table-rows-seq`."@@ -78,7 +84,7 @@(doseq [{:keys [keypath value]} (driver/table-rows-seq driver database metabase-metadata-table)](sync-util/with-error-handling (format "Error handling metabase metadata entry: set %s -> %s" keypath value)(or (set-property! database (parse-keypath keypath) value)- (log/error (u/format-color 'red "Error syncing _metabase_metadata: no matching keypath: %s" keypath))))))+ (log/error (u/format-color 'red "Error syncing _metabase_metadata: no matching keypath, or property not settable: %s" keypath))))))(mu/defn is-metabase-metadata-table?"Is this TABLE the special `_metabase_metadata` table?"diff --git a/test/metabase/sync/sync_metadata/metabase_metadata_test.clj b/test/metabase/sync/sync_metadata/metabase_metadata_test.cljindex 62f24a70e17..93e39d6ba31 100644--- a/test/metabase/sync/sync_metadata/metabase_metadata_test.clj+++ b/test/metabase/sync/sync_metadata/metabase_metadata_test.clj@@ -42,3 +42,35 @@:fields [{:name "filming", :description "If the movie is currently being filmed."}]}(get-table-and-fields-descriptions table)))(is (= "Information about movies" (:description (t2/select-one :model/Database :id (u/the-id db)))))))))))++(deftest set-property-only-sets-descriptive-properties-test+ (testing "`_metabase_metadata` comes from the warehouse, so it can only set descriptive properties"+ (mt/with-temp [:model/Database db {:engine ::moviedb/moviedb}+ :model/Table table {:db_id (u/the-id db), :name "movies", :active true}+ :model/Field field {:table_id (u/the-id table), :name "filming", :base_type :type/Boolean}]+ (let [set-property! (fn [keypath value]+ (#'metabase-metadata/set-property! db (#'metabase-metadata/parse-keypath keypath) value))]+ (testing "descriptive properties are set"+ (is (true? (set-property! "caveats" "db caveat")))+ (is (true? (set-property! "movies.caveats" "table caveat")))+ (is (true? (set-property! "movies.filming.semantic_type" "type/Category")))+ (is (= "db caveat" (t2/select-one-fn :caveats :model/Database :id (u/the-id db))))+ (is (= "table caveat" (t2/select-one-fn :caveats :model/Table :id (u/the-id table))))+ (is (= :type/Category (t2/select-one-fn :semantic_type :model/Field :id (u/the-id field)))))+ (testing "admin-only properties are ignored"+ (are [keypath value] (false? (set-property! keypath value))+ "settings" "{\"database-enable-actions\":true}"+ "engine" "postgres"+ "details" "{}"+ "movies.db_id" "13371337"+ "movies.visibility_type" "hidden"+ "movies.filming.visibility_type" "sensitive"+ "movies.filming.table_id" "13371337"+ "movies.filming.field_type" "type/Category")+ (let [db (t2/select-one :model/Database :id (u/the-id db))]+ (is (= ::moviedb/moviedb (:engine db)))+ (is (nil? (get-in db [:settings :database-enable-actions]))))+ (is (=? {:db_id (u/the-id db), :visibility_type nil}+ (t2/select-one :model/Table :id (u/the-id table))))+ (is (=? {:table_id (u/the-id table), :visibility_type :normal}+ (t2/select-one :model/Field :id (u/the-id field)))))))))