Skip to content

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

Send the Field columns a parameter widget reads, and stop re-resolving them (#81936)

Romeo Van Snickad2d269251b9
diff --git a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/FieldValuesWidget.tsx b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/FieldValuesWidget.tsx
index 7558683dea9..05c30a1dd42 100644
--- a/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/FieldValuesWidget.tsx
+++ b/frontend/src/metabase/parameters/components/widgets/ParameterFieldWidget/FieldValuesWidget/FieldValuesWidget.tsx
@@ -23,14 +23,13 @@ import { useTranslateContent } from "metabase/content-translation/hooks";
import type { ContentTranslationFunction } from "metabase/content-translation/types";
import CS from "metabase/css/core/index.css";
import { useEmbeddingEntityContext } from "metabase/embedding/context";
-import { addRemappings, getMetadata } from "metabase/metadata-store";
+import { addRemappings } from "metabase/metadata-store";
import {
fetchCardParameterValues,
fetchDashboardParameterValues,
fetchParameterValues,
} from "metabase/parameters/actions";
-import { connect, useDispatch } from "metabase/redux";
-import type { State } from "metabase/redux/store";
+import { useDispatch } from "metabase/redux";
import {
Autocomplete,
Loader,
@@ -80,16 +79,6 @@ const MAX_SEARCH_RESULTS = 100;
const COMBOBOX_WIDTH = 364;
const DROPDOWN_WIDTH = 314;
-function mapStateToProps(
- state: State,
- { fields = [] }: { fields: ParameterField[] },
-) {
- const metadata = getMetadata(state);
- return {
- fields: fields.map((field) => metadata.field(field.id) || field),
- };
-}
-
export interface IFieldValuesWidgetProps {
maxResults?: number;
style?: StyleHTMLAttributes<HTMLDivElement>;
@@ -106,7 +95,9 @@ export interface IFieldValuesWidgetProps {
parameter: Parameter;
parameters?: Parameter[]; // linked parameters with values
- fields: ParameterField[];
+ // a field filter parameter that has no mapped fields still renders this
+ // widget, so that it can query values by parameter instead
+ fields?: ParameterField[];
dashboardId?: DashboardId;
cardId?: CardId;
@@ -138,7 +129,7 @@ export const FieldValuesWidgetInner = forwardRef<
disablePKRemappingForSearch,
parameter,
parameters,
- fields,
+ fields = [],
dashboardId,
cardId,
value,
@@ -475,9 +466,7 @@ export const FieldValuesWidget = ExplicitSize<IFieldValuesWidgetProps>()(
);
// eslint-disable-next-line import/no-default-export
-export default connect(mapStateToProps, null, null, { forwardRef: true })(
- FieldValuesWidget,
-);
+export default FieldValuesWidget;
const LoadingState = () => (
<div
diff --git a/src/metabase/parameters/params.clj b/src/metabase/parameters/params.clj
index 646dda69120..219757213af 100644
--- a/src/metabase/parameters/params.clj
+++ b/src/metabase/parameters/params.clj
@@ -113,8 +113,12 @@
(def param-field-columns
"The only Field columns appropriate for returning in public/embedded API endpoints, which make heavy use of the
functions in this namespace. Used to narrow the Fields selected here, and by the public/embed endpoints to strip
- every other column from the Fields (and their hydrated `:target`/`:name_field`) in `:param_fields`."
- [:id :table_id :display_name :base_type :name :semantic_type :has_field_values :fk_target_field_id])
+ every other column from the Fields (and their hydrated `:target`/`:name_field`) in `:param_fields`.
+
+ A parameter widget reads all of these. `:effective_type` decides which widget a coerced Field gets, and
+ `:settings` formats the values it shows."
+ [:id :table_id :display_name :base_type :effective_type :name :semantic_type :has_field_values
+ :fk_target_field_id :settings])
(defn- fields->table-id->name-field
"Given a sequence of `fields,` return a map of Table ID -> to a `:type/Name` Field in that Table, if one exists. In
diff --git a/test/metabase/embedding_rest/api/embed_test.clj b/test/metabase/embedding_rest/api/embed_test.clj
index e502ab7861e..2b65638ebb7 100644
--- a/test/metabase/embedding_rest/api/embed_test.clj
+++ b/test/metabase/embedding_rest/api/embed_test.clj
@@ -49,6 +49,12 @@
(defmacro with-new-secret-key! {:style/indent 0} [& body]
`(do-with-new-secret-key! (fn [] ~@body)))
+(defn- field-effective-type
+ "A Field's `:effective_type` as the API returns it. It varies with the driver,
+ so a `:param_fields` expectation reads it rather than naming a value."
+ [field-id]
+ (u/qualified-name (t2/select-one-fn :effective_type :model/Field :id field-id)))
+
(defn- categories-id-target
"The `:target` a `:param_fields` entry for `venues.category_id` carries: the
Categories primary key in public columns, with the `:name_field` that labels its
@@ -58,6 +64,8 @@
:table_id (mt/id :categories)
:display_name "ID"
:base_type "type/BigInteger"
+ :effective_type (field-effective-type (mt/id :categories :id))
+ :settings nil
:name "ID"
:semantic_type "type/PK"
:has_field_values "none"
@@ -66,6 +74,8 @@
:table_id (mt/id :categories)
:display_name "Name"
:base_type "type/Text"
+ :effective_type (field-effective-type (mt/id :categories :name))
+ :settings nil
:name "NAME"
:semantic_type "type/Name"
:has_field_values "list"
@@ -715,6 +725,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
@@ -738,6 +750,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
@@ -782,6 +796,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
@@ -811,6 +827,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
@@ -849,6 +867,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
diff --git a/test/metabase/parameters/params_test.clj b/test/metabase/parameters/params_test.clj
index aa30d5ec8e0..40c657f3e81 100644
--- a/test/metabase/parameters/params_test.clj
+++ b/test/metabase/parameters/params_test.clj
@@ -22,9 +22,11 @@
:name "NAME"
:display_name "Name"
:base_type :type/Text
+ :effective_type :type/Text
:semantic_type :type/Name
:has_field_values :list
- :fk_target_field_id nil}}
+ :fk_target_field_id nil
+ :settings nil}}
(-> (t2/select-one [:model/Field :name :table_id :semantic_type], :id (mt/id :venues :id))
(t2/hydrate :name_field)
mt/derecordize))))
@@ -98,18 +100,22 @@
:display_name "ID"
:name "ID"
:base_type :type/BigInteger
+ :effective_type :type/BigInteger
:semantic_type :type/PK
:has_field_values :none
:fk_target_field_id nil
+ :settings nil
:target nil
:name_field {:id (mt/id :venues :name)
:table_id (mt/id :venues)
:display_name "Name"
:name "NAME"
:base_type :type/Text
+ :effective_type :type/Text
:semantic_type :type/Name
:has_field_values :list
- :fk_target_field_id nil}
+ :fk_target_field_id nil
+ :settings nil}
:dimensions []}]}
(-> (t2/hydrate card :param_fields)
:param_fields
@@ -132,9 +138,11 @@
:display_name "Name"
:name "NAME"
:base_type :type/Text
+ :effective_type :type/Text
:semantic_type :type/Name
:has_field_values :list
- :fk_target_field_id nil}
+ :fk_target_field_id nil
+ :settings nil}
:dimensions []}]}
(-> (t2/hydrate dashboard :param_fields)
:param_fields
diff --git a/test/metabase/public_sharing_rest/api_test.clj b/test/metabase/public_sharing_rest/api_test.clj
index 018ac07be09..f36d21b06e8 100644
--- a/test/metabase/public_sharing_rest/api_test.clj
+++ b/test/metabase/public_sharing_rest/api_test.clj
@@ -42,6 +42,12 @@
;;; --------------------------------------------------- Helper Fns ---------------------------------------------------
+(defn- field-effective-type
+ "A Field's `:effective_type` as the API returns it. It varies with the driver,
+ so a `:param_fields` expectation reads it rather than naming a value."
+ [field-id]
+ (u/qualified-name (t2/select-one-fn :effective_type :model/Field :id field-id)))
+
(defn- categories-id-target
"The `:target` a `:param_fields` entry for `venues.category_id` carries: the
Categories primary key in public columns, with the `:name_field` that labels its
@@ -51,6 +57,8 @@
:table_id (mt/id :categories)
:display_name "ID"
:base_type "type/BigInteger"
+ :effective_type (field-effective-type (mt/id :categories :id))
+ :settings nil
:name "ID"
:semantic_type "type/PK"
:has_field_values "none"
@@ -59,6 +67,8 @@
:table_id (mt/id :categories)
:display_name "Name"
:base_type "type/Text"
+ :effective_type (field-effective-type (mt/id :categories :name))
+ :settings nil
:name "NAME"
:semantic_type "type/Name"
:has_field_values "list"
@@ -1533,6 +1543,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
@@ -1573,6 +1585,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
@@ -1589,6 +1603,8 @@
:table_id (mt/id :venues)
:display_name "ID"
:base_type "type/BigInteger"
+ :effective_type (field-effective-type (mt/id :venues :id))
+ :settings nil
:name "ID"
:semantic_type "type/PK"
:has_field_values "none"
@@ -1597,6 +1613,8 @@
:table_id (mt/id :venues)
:display_name "Name"
:base_type "type/Text"
+ :effective_type (field-effective-type (mt/id :venues :name))
+ :settings nil
:name "NAME"
:semantic_type "type/Name"
:has_field_values "list"
@@ -1605,6 +1623,8 @@
:table_id (mt/id :venues)
:display_name "Category ID"
:base_type "type/Integer"
+ :effective_type (field-effective-type (mt/id :venues :category_id))
+ :settings nil
:name "CATEGORY_ID"
:semantic_type "type/FK"
:has_field_values "none"
@@ -1614,6 +1634,8 @@
:table_id (mt/id :categories)
:display_name "Name"
:base_type "type/Text"
+ :effective_type (field-effective-type (mt/id :categories :name))
+ :settings nil
:name "NAME"
:semantic_type "type/Name"
:has_field_values "list"
diff --git a/test/metabase/warehouse_schema_rest/api/table_test.clj b/test/metabase/warehouse_schema_rest/api/table_test.clj
index c82e2c40554..486b2eb91ec 100644
--- a/test/metabase/warehouse_schema_rest/api/table_test.clj
+++ b/test/metabase/warehouse_schema_rest/api/table_test.clj
@@ -274,11 +274,13 @@
:database_is_auto_increment true
:name_field {:base_type "type/Text",
:display_name "Name",
+ :effective_type "type/Text",
:fk_target_field_id nil,
:has_field_values "list",
:id (mt/id :users :name),
:name "NAME",
:semantic_type "type/Name",
+ :settings nil,
:table_id (mt/id :users)})
(assoc (field-details (t2/select-one :model/Field :id (mt/id :users :name)))
:semantic_type "type/Name"
@@ -356,11 +358,13 @@
:database_is_auto_increment true
:name_field {:base_type "type/Text",
:display_name "Name",
+ :effective_type "type/Text",
:fk_target_field_id nil,
:has_field_values "list",
:id (mt/id :users :name),
:name "NAME",
:semantic_type "type/Name",
+ :settings nil,
:table_id (mt/id :users)})
(assoc (field-details (t2/select-one :model/Field :id (mt/id :users :name)))
:table_id (mt/id :users)
@@ -697,11 +701,13 @@
:database_is_auto_increment true
:name_field {:base_type "type/Text",
:display_name "Name",
+ :effective_type "type/Text",
:fk_target_field_id nil,
:has_field_values "list",
:id (mt/id :categories :name),
:name "NAME",
:semantic_type "type/Name",
+ :settings nil,
:table_id (mt/id :categories)}})
(merge
(field-details (t2/select-one :model/Field :id (mt/id :categories :name)))