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
Improve OSS include_editable_data_model logic (#82451)
Nathan Voxlande96a5d884d09
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.ednindex 87ddb095670..131fffd17a8 100644--- a/.clj-kondo/config/modules/config.edn+++ b/.clj-kondo/config/modules/config.edn@@ -3205,13 +3205,11 @@syncuploadutil- util.classloaderutil.configwarehouse-schema-overlaywarehouseswarehouses.schema- warehouses.secrets- enterprise/permissions}+ warehouses.secrets}:model-imports #{:model/Card:model/Collection:model/Database@@ -3254,11 +3252,8 @@settingssync.analyzeutil- util.classloader- util.configwarehouse-schema-overlay- warehouses- enterprise/permissions}+ warehouses}:model-exports #{:model/Dimension:model/Field:model/FieldUserSettingsdiff --git a/enterprise/backend/src/metabase_enterprise/advanced_permissions/common.clj b/enterprise/backend/src/metabase_enterprise/advanced_permissions/common.cljindex a4078988d73..047f5ce329d 100644--- a/enterprise/backend/src/metabase_enterprise/advanced_permissions/common.clj+++ b/enterprise/backend/src/metabase_enterprise/advanced_permissions/common.clj@@ -4,7 +4,7 @@[metabase.api.common :as api][metabase.audit-app.core :as audit][metabase.permissions.core :as perms]- [metabase.premium-features.core :as premium-features :refer [defenterprise]]+ [metabase.premium-features.core :refer [defenterprise]][metabase.remote-sync.core :as remote-sync][metabase.util :as u][metabase.warehouses.models.database :as database]))@@ -93,18 +93,12 @@[group-or-id](advanced-permissions.db/group-manager? api/*current-user-id* (u/the-id group-or-id)))-(defn filter-tables-by-data-model-perms+(defenterprise filter-tables-by-data-model-perms"Given a list of tables, removes the ones for which `*current-user*` does not have data model editing permissions."+ :feature :advanced-permissions[tables]- (cond- api/*is-superuser?*+ (if api/*is-superuser?*tables-- ;; If advanced-permissions is not enabled, no non-admins have any data-model editing perms, so return an empty list- (not (premium-features/enable-advanced-permissions?))- (empty tables)-- :else(do(perms/prime-table-perms-cache {:db-ids (into #{} (map :db_id) tables)})(filter@@ -117,18 +111,12 @@table-id))tables))))-(defn filter-schema-by-data-model-perms+(defenterprise filter-schema-by-data-model-perms"Given a list of schema, remove the ones for which `*current-user*` does not have data model editing permissions."+ :feature :advanced-permissions[schema]- (cond- api/*is-superuser?*+ (if api/*is-superuser?*schema-- ;; If advanced-permissions is not enabled, no non-admins have any data-model editing perms, so return an empty list- (not (premium-features/enable-advanced-permissions?))- (empty schema)-- :else(filter(fn [{db-id :db_id schema :schema}](perms/user-has-permission-for-schema?@@ -139,20 +127,14 @@schema))schema)))-(defn filter-databases-by-data-model-perms+(defenterprise filter-databases-by-data-model-perms"Given a list of databases, removes the ones for which `*current-user*` has no data model editing permissions.If databases are already hydrated with their tables, also removes tables for which `*current-user*` has no datamodel editing perms."+ :feature :advanced-permissions[dbs]- (cond- api/*is-superuser?*+ (if api/*is-superuser?*dbs-- ;; If advanced-permissions is not enabled, no non-admins have any data-model editing perms, so return an empty list- (not (premium-features/enable-advanced-permissions?))- (empty dbs)-- :else(reduce(fn [result {db-id :id tables :tables :as db}](if (= (perms/most-permissive-database-permission-for-user api/*current-user-id* :perms/manage-table-metadata db-id)diff --git a/src/metabase/warehouse_schema/table.clj b/src/metabase/warehouse_schema/table.cljindex b4c1da16f9e..7e3b16df833 100644--- a/src/metabase/warehouse_schema/table.clj+++ b/src/metabase/warehouse_schema/table.clj@@ -2,8 +2,6 @@(:require[medley.core :as m][metabase.api.common :as api]- [metabase.classloader.core :as classloader]- [metabase.config.core :as config][metabase.models.interface :as mi][metabase.permissions.core :as perms][metabase.premium-features.core :as premium-features :refer [defenterprise]]@@ -124,6 +122,37 @@[_db-id _schema-name](mi/superuser?))+(defn- admins-only+ "OSS fallback for the data-model-perms filters below: editing the data model is admin-only without the+ advanced-permissions feature (see [[current-user-can-manage-schema-metadata?]]), so a non-admin keeps nothing.++ These filters must fail closed. `include_editable_data_model=true` means \"skip my query-access check, run my+ data-model check instead\", and callers do skip `api/read-check` when it is set, so returning `xs` unfiltered+ would switch off the only check the request gets."+ [xs]+ (if (mi/superuser?) xs (empty xs)))++(defenterprise filter-tables-by-data-model-perms+ "Given a list of tables, removes the ones for which the current user does not have data model editing permissions.+ Admin-only on OSS."+ metabase-enterprise.advanced-permissions.common+ [tables]+ (admins-only tables))++(defenterprise filter-schema-by-data-model-perms+ "Given a list of `{:db_id ... :schema ...}` maps, removes the ones for which the current user does not have data+ model editing permissions. Admin-only on OSS."+ metabase-enterprise.advanced-permissions.common+ [schemas]+ (admins-only schemas))++(defenterprise filter-databases-by-data-model-perms+ "Given a list of databases, removes the ones for which the current user has no data model editing permissions. If+ the databases are hydrated with their tables, also removes the tables the user cannot edit. Admin-only on OSS."+ metabase-enterprise.advanced-permissions.common+ [dbs]+ (admins-only dbs))+(defn can-read-schema?"Does the current user have permissions to know the schema with `schema-name` exists? (Do they have permissions to seeat least some of its tables?)"@@ -162,11 +191,10 @@[id {:keys [include-editable-data-model? include-hidden? can-query? can-write-metadata?]}](let [filter-schemas (fn [schemas](if include-editable-data-model?- (if-let [f (u/ignore-exceptions- (classloader/require 'metabase-enterprise.advanced-permissions.common)- (resolve 'metabase-enterprise.advanced-permissions.common/filter-schema-by-data-model-perms))]- (map :schema (f (map (fn [s] {:db_id id :schema s}) schemas)))- schemas)+ (->> schemas+ (map (fn [s] {:db_id id :schema s}))+ filter-schema-by-data-model-perms+ (map :schema))(filter (partial can-read-schema? id) schemas)));; For can-query? and can-write-metadata?, we need to filter based on tables in each schemafilter-schemas-by-tables (fn [schemas]@@ -203,11 +231,7 @@(warehouse-schema.db/active-visible-tables-in-schema db-id schema))_ (perms/prime-table-perms-cache {:db-ids #{db-id}})filtered-tables (cond->> (if include-editable-data-model?- (if-let [f (when config/ee-available?- (classloader/require 'metabase-enterprise.advanced-permissions.common)- (resolve 'metabase-enterprise.advanced-permissions.common/filter-tables-by-data-model-perms))]- (f candidate-tables)- candidate-tables)+ (filter-tables-by-data-model-perms candidate-tables)(filter mi/can-read? candidate-tables))can-query? (filter mi/can-query?)can-write-metadata? (filter mi/can-write?))diff --git a/src/metabase/warehouses_rest/api.clj b/src/metabase/warehouses_rest/api.cljindex 703abb47885..63a42ade5f8 100644--- a/src/metabase/warehouses_rest/api.clj+++ b/src/metabase/warehouses_rest/api.clj@@ -6,7 +6,6 @@[metabase.analytics.core :as analytics][metabase.api.common :as api][metabase.api.macros :as api.macros]- [metabase.classloader.core :as classloader][metabase.config.core :as config][metabase.database-routing.core :as database-routing][metabase.driver :as driver]@@ -253,17 +252,11 @@can fully or partially edit the data model. If the user does not have data access for any databases, returns only thename and ID of these databases, removing all other fields."[dbs]- (let [filtered-dbs- (if-let [f (when config/ee-available?- (classloader/require 'metabase-enterprise.advanced-permissions.common)- (resolve 'metabase-enterprise.advanced-permissions.common/filter-databases-by-data-model-perms))]- (f dbs)- dbs)]- (map- (fn [db] (if (mi/can-read? db)- db- (select-keys db [:id :name :tables])))- filtered-dbs)))+ (map+ (fn [db] (if (mi/can-read? db)+ db+ (select-keys db [:id :name :tables])))+ (schema.table/filter-databases-by-data-model-perms dbs)))(defn- check-db-data-model-perms"Given a DB, checks that *current-user* has any data model editing perms for the DB. If yes, returns the DB,@@ -343,8 +336,9 @@* `saved` means we should include the saved questions virtual database. Default: `false`.* `include_editable_data_model` will only include DBs for which the current user has data model editing- permissions. (If `include=tables`, this also applies to the list of tables in each DB). Should only be used if- Enterprise Edition code is available the advanced-permissions feature is enabled.+ permissions. (If `include=tables`, this also applies to the list of tables in each DB). Granting those+ permissions to non-admins requires Enterprise Edition code and the advanced-permissions feature; without both,+ this is admin-only.* `exclude_uneditable_details` will only include DBs for which the current user can edit the DB details. Has noeffect unless Enterprise Edition code is available and the advanced-permissions feature is enabled.@@ -479,9 +473,9 @@returned details (see [[metabase.secrets.models.secret/expand-db-details-inferred-secret-values]] for full details).Passing include_editable_data_model will only return tables for which the current user has data model editing- permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.- In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID- and tables, with no additional metadata.+ permissions. Granting data model permissions to non-admins requires Enterprise Edition code and a token with the+ advanced-permissions feature; without both, this is admin-only. In addition, if the user has no data access for the+ DB (aka block permissions), it will return only the DB name, ID and tables, with no additional metadata.Independently of these flags, the implementation of [[metabase.models.interface/to-json]] for `:model/Database` in[[metabase.warehouses.models.database]] uses the implementation of [[metabase.models.interface/can-write?]] for `:model/Database`@@ -588,9 +582,9 @@By default only non-hidden tables and fields are returned. Passing include_hidden=true includes them.Passing include_editable_data_model will only return tables for which the current user has data model editing- permissions, if Enterprise Edition code is available and a token with the advanced-permissions feature is present.- In addition, if the user has no data access for the DB (aka block permissions), it will return only the DB name, ID- and tables, with no additional metadata."+ permissions. Granting data model permissions to non-admins requires Enterprise Edition code and a token with the+ advanced-permissions feature; without both, this is admin-only. In addition, if the user has no data access for the+ DB (aka block permissions), it will return only the DB name, ID and tables, with no additional metadata."[{:keys [id]} :- [:map {:closed true}[:id ms/PositiveInt]]{:keys [include_hidden include_editable_data_model remove_inactive skip_fields]}diff --git a/test/metabase/warehouses_rest/api_test.clj b/test/metabase/warehouses_rest/api_test.cljindex 268fabe5110..62c3286dcb8 100644--- a/test/metabase/warehouses_rest/api_test.clj+++ b/test/metabase/warehouses_rest/api_test.clj@@ -1006,6 +1006,52 @@first)](is (not (contains? table :fields))))))))+(deftest oss-include-editable-data-model-fails-closed-test+ (testing "without the advanced-permissions feature, include_editable_data_model must not bypass the read check"+ ;; `include_editable_data_model=true` tells the API to skip the query-access check and run the+ ;; data-model-perms check instead. Only EE with an advanced-permissions token grants non-admins any+ ;; data-model perms; every other build (OSS, or EE without the token) runs the OSS `defenterprise`+ ;; implementation, which has to fail closed -- admins only.+ (mt/with-premium-features #{}+ (mt/with-no-data-perms-for-all-users!+ (testing "non-admin"+ (testing "GET /api/database"+ (is (empty? (filter #(= (mt/id) (:id %))+ (:data (mt/user-http-request :rasta :get 200+ "database?include_editable_data_model=true"))))))+ (testing "GET /api/database/:id"+ (mt/user-http-request :rasta :get 403+ (format "database/%d?include_editable_data_model=true" (mt/id))))+ (testing "GET /api/database/:id/metadata"+ (mt/user-http-request :rasta :get 403+ (format "database/%d/metadata?include_editable_data_model=true&include_hidden=true"+ (mt/id))))+ (testing "GET /api/database/:id/schemas"+ (is (= [] (mt/user-http-request :rasta :get 200+ (format "database/%d/schemas?include_editable_data_model=true" (mt/id))))))+ (testing "GET /api/database/:id/schema/:schema"+ (mt/user-http-request :rasta :get 404+ (format "database/%d/schema/PUBLIC?include_editable_data_model=true" (mt/id))))+ (testing "GET /api/database/:id/idfields"+ (mt/user-http-request :rasta :get 403+ (format "database/%d/idfields?include_editable_data_model=true" (mt/id)))))+ (testing "admins are unaffected"+ (is (some #(= (mt/id) (:id %))+ (:data (mt/user-http-request :crowberto :get 200+ "database?include_editable_data_model=true"))))+ (is (seq (:tables (mt/user-http-request :crowberto :get 200+ (format "database/%d/metadata?include_editable_data_model=true"+ (mt/id))))))+ (is (= ["PUBLIC"] (mt/user-http-request :crowberto :get 200+ (format "database/%d/schemas?include_editable_data_model=true"+ (mt/id)))))+ (is (seq (mt/user-http-request :crowberto :get 200+ (format "database/%d/schema/PUBLIC?include_editable_data_model=true"+ (mt/id)))))+ (is (seq (mt/user-http-request :crowberto :get 200+ (format "database/%d/idfields?include_editable_data_model=true"+ (mt/id))))))))))+(deftest ^:parallel autocomplete-suggestions-test(let [prefix-fn (fn [db-id prefix](mt/user-http-request :rasta :get 200