Skip to content

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

Clean up two module violations in metabase api (#71786)

Nemanja Glumac43db728f713f
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsx
index 010ad9f7287..f148800d53b 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/CreateTenantsOnboardingStep.tsx
@@ -4,7 +4,6 @@ import { t } from "ttag";
import { getErrorMessage } from "metabase/api/utils";
import { useToast } from "metabase/common/hooks";
-import type { DataSegregationStrategy } from "metabase/embedding/embedding-hub";
import { createEmptyTenantDraft } from "metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/utils";
import { slugify } from "metabase/lib/formatting";
import type { CreatedTenantData } from "metabase/plugins/oss/tenants";
@@ -18,7 +17,7 @@ import {
Text,
TextInput,
} from "metabase/ui";
-import type { FieldId } from "metabase-types/api";
+import type { DataSegregationStrategy, FieldId } from "metabase-types/api";
import { useCreateTenantMutation } from "../../../api/tenants";
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/isolation-field-config.ts b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/isolation-field-config.ts
index 7b06539d541..e01f26aaab7 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/isolation-field-config.ts
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/CreateTenantsOnboardingStep/isolation-field-config.ts
@@ -1,7 +1,7 @@
import { match } from "ts-pattern";
import { t } from "ttag";
-import type { DataSegregationStrategy } from "metabase/embedding/embedding-hub";
+import type { DataSegregationStrategy } from "metabase-types/api";
export type IsolationFieldConfig = {
/** The attribute key sent to the API, e.g. organization_id */
diff --git a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx
index cd3157fc17e..9ab0fc806b4 100644
--- a/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/tenants/components/TenantsSummaryOnboardingStep/TenantsSummaryOnboardingStep.tsx
@@ -4,11 +4,11 @@ import { push } from "react-router-redux";
import { jt, msgid, ngettext, t } from "ttag";
import { RelatedSettingCard } from "metabase/admin/components/RelatedSettingsSection";
-import type { DataSegregationStrategy } from "metabase/embedding/embedding-hub";
import { conjunct } from "metabase/lib/formatting/strings";
import { useDispatch } from "metabase/lib/redux";
import type { CreatedTenantData } from "metabase/plugins/oss/tenants";
import { Button, Flex, SimpleGrid, Stack, Text, Title } from "metabase/ui";
+import type { DataSegregationStrategy } from "metabase-types/api";
import { useListTenantsQuery } from "../../../api/tenants";
import { getIsolationFieldConfig } from "../CreateTenantsOnboardingStep/isolation-field-config";
diff --git a/frontend/src/metabase-types/api/permissions.ts b/frontend/src/metabase-types/api/permissions.ts
index c774700bd81..413574e5c05 100644
--- a/frontend/src/metabase-types/api/permissions.ts
+++ b/frontend/src/metabase-types/api/permissions.ts
@@ -137,3 +137,8 @@ export type Impersonation = {
group_id: GroupId;
attribute: UserAttributeKey;
};
+
+export type DataSegregationStrategy =
+ | "row-column-level-security"
+ | "connection-impersonation"
+ | "database-routing";
diff --git a/frontend/src/metabase/api/embedding-hub.ts b/frontend/src/metabase/api/embedding-hub.ts
index a54d1024ce1..16ec51db170 100644
--- a/frontend/src/metabase/api/embedding-hub.ts
+++ b/frontend/src/metabase/api/embedding-hub.ts
@@ -1,5 +1,5 @@
import { Api } from "metabase/api";
-import type { DataSegregationStrategy } from "metabase/embedding/embedding-hub";
+import type { DataSegregationStrategy } from "metabase-types/api";
import { listTag } from "./tags";
diff --git a/frontend/src/metabase/api/search.ts b/frontend/src/metabase/api/search.ts
index 15eaea2f5f6..ee9322ffd18 100644
--- a/frontend/src/metabase/api/search.ts
+++ b/frontend/src/metabase/api/search.ts
@@ -1,10 +1,60 @@
-import { trackSearchRequest } from "metabase/search/analytics";
+import { trackSchemaEvent } from "metabase/lib/analytics";
+import { hashSearchTerm, shouldReportSearchTerm } from "metabase/lib/search";
import type { SearchRequest, SearchResponse } from "metabase-types/api";
import { Api } from "./api";
import { provideSearchItemListTags } from "./tags";
import { handleQueryFulfilled } from "./utils/lifecycle";
+type SearchRequestFilter = Pick<
+ SearchRequest,
+ | "created_by"
+ | "created_at"
+ | "last_edited_at"
+ | "last_edited_by"
+ | "verified"
+ | "search_native_query"
+ | "context"
+ | "models"
+ | "archived"
+ | "q"
+ | "offset"
+>;
+
+const trackSearchRequest = (
+ searchRequest: SearchRequestFilter,
+ searchResponse: SearchResponse,
+ duration: number,
+ requestId: string | null = null,
+) => {
+ const dispatchTrackSearchQuery = async () => {
+ trackSchemaEvent("search", {
+ event: "search_query",
+ search_term_hash: searchRequest.q
+ ? await hashSearchTerm(searchRequest.q)
+ : null,
+ search_term:
+ shouldReportSearchTerm() && searchRequest.q ? searchRequest.q : null,
+ content_type: searchRequest.models ?? null,
+ creator: !!searchRequest.created_by,
+ creation_date: !!searchRequest.created_at,
+ last_edit_date: !!searchRequest.last_edited_at,
+ last_editor: !!searchRequest.last_edited_by,
+ verified_items: !!searchRequest.verified,
+ search_native_queries: !!searchRequest.search_native_query,
+ search_archived: !!searchRequest.archived,
+ context: searchRequest.context ?? null,
+ runtime_milliseconds: duration,
+ total_results: searchResponse.total,
+ page_results: searchResponse.limit,
+ search_engine: searchResponse.engine,
+ request_id: requestId,
+ offset: searchRequest.offset ?? null,
+ });
+ };
+ dispatchTrackSearchQuery();
+};
+
export const searchApi = Api.injectEndpoints({
endpoints: (builder) => ({
search: builder.query<SearchResponse, SearchRequest>({
diff --git a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/DataSegregationStrategyPicker.tsx b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/DataSegregationStrategyPicker.tsx
index a8f58314d08..2ef67f823f4 100644
--- a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/DataSegregationStrategyPicker.tsx
+++ b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/DataSegregationStrategyPicker.tsx
@@ -4,13 +4,10 @@ import { t } from "ttag";
import type { IconName } from "metabase/ui";
import { Button, Flex, Group, Icon, Radio, Stack, Text } from "metabase/ui";
-
-import type { DataSegregationStrategy } from "../../types";
+import type { DataSegregationStrategy } from "metabase-types/api";
import S from "./DataSegregationStrategyPicker.module.css";
-export type { DataSegregationStrategy };
-
interface DataSegregationStrategyPickerProps {
value: DataSegregationStrategy | null;
onChange: (value: DataSegregationStrategy) => void;
diff --git a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsx b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsx
index 5fed606368f..f83b907cba3 100644
--- a/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsx
+++ b/frontend/src/metabase/embedding/embedding-hub/components/SetupPermissionsAndTenantsPage/SetupPermissionsAndTenantsPage.tsx
@@ -11,12 +11,10 @@ import {
PLUGIN_TENANTS,
} from "metabase/plugins/oss/tenants";
import { Group, Icon, Stack, Text, Title } from "metabase/ui";
+import type { DataSegregationStrategy } from "metabase-types/api";
import { ConnectionImpersonationStepContent } from "./ConnectionImpersonationStepContent";
-import {
- type DataSegregationStrategy,
- DataSegregationStrategyPicker,
-} from "./DataSegregationStrategyPicker";
+import { DataSegregationStrategyPicker } from "./DataSegregationStrategyPicker";
import { DatabaseRoutingStepContent } from "./DatabaseRoutingStepContent";
import { EnableTenantsStepContent } from "./EnableTenantsStepContent";
import { MoveDashboardStepContent } from "./MoveDashboardStepContent";
diff --git a/frontend/src/metabase/embedding/embedding-hub/types/embedding-checklist.ts b/frontend/src/metabase/embedding/embedding-hub/types/embedding-checklist.ts
index c97f85ad7e0..9b6521af21b 100644
--- a/frontend/src/metabase/embedding/embedding-hub/types/embedding-checklist.ts
+++ b/frontend/src/metabase/embedding/embedding-hub/types/embedding-checklist.ts
@@ -1,10 +1,5 @@
import type { AddDataTab } from "metabase/nav/containers/MainNavbar/MainNavbarContainer/AddDataModal/utils";
-export type DataSegregationStrategy =
- | "row-column-level-security"
- | "connection-impersonation"
- | "database-routing";
-
export type EmbeddingHubStepId =
| "create-test-embed"
| "add-data"
diff --git a/frontend/src/metabase/embedding/embedding-hub/types/index.ts b/frontend/src/metabase/embedding/embedding-hub/types/index.ts
index 2ec6a454d35..03b4c37eca3 100644
--- a/frontend/src/metabase/embedding/embedding-hub/types/index.ts
+++ b/frontend/src/metabase/embedding/embedding-hub/types/index.ts
@@ -1,5 +1,4 @@
export type {
- DataSegregationStrategy,
EmbeddingHubStep,
EmbeddingHubStepId,
EmbeddingHubAction,
diff --git a/frontend/src/metabase/lib/search.ts b/frontend/src/metabase/lib/search.ts
new file mode 100644
index 00000000000..9016c555501
--- /dev/null
+++ b/frontend/src/metabase/lib/search.ts
@@ -0,0 +1,22 @@
+import Settings from "metabase/lib/settings";
+
+const MB_STATS_ANALYTICS_UUID = "d97541bd-59b0-4656-b437-d659ac48eae1";
+
+export const shouldReportSearchTerm = () =>
+ Settings.get("analytics-uuid") === MB_STATS_ANALYTICS_UUID;
+
+export async function hashSearchTerm(searchTerm: string) {
+ try {
+ const analyticsUuid = Settings.get("analytics-uuid");
+ const saltedSearchTerm = searchTerm + "-salt-" + analyticsUuid;
+
+ const dataBuffer = new TextEncoder().encode(saltedSearchTerm);
+ const hashBuffer = await crypto.subtle.digest("SHA-256", dataBuffer);
+
+ const hashArray = Array.from(new Uint8Array(hashBuffer));
+ return hashArray.map((b) => b.toString(16).padStart(2, "0")).join("");
+ } catch (err) {
+ console.warn("Failed to hash search term", err);
+ return null;
+ }
+}
diff --git a/frontend/src/metabase/plugins/oss/tenants.ts b/frontend/src/metabase/plugins/oss/tenants.ts
index 3a3834a981a..6c430a22e30 100644
--- a/frontend/src/metabase/plugins/oss/tenants.ts
+++ b/frontend/src/metabase/plugins/oss/tenants.ts
@@ -5,13 +5,13 @@ import type {
OmniPickerCollectionItem,
OmniPickerItem,
} from "metabase/common/components/Pickers";
-import type { DataSegregationStrategy } from "metabase/embedding/embedding-hub";
import type { CollectionTreeItem } from "metabase/entities/collections/utils";
import type {
Collection,
CollectionId,
CollectionItemModel,
CollectionNamespace,
+ DataSegregationStrategy,
Group,
User,
} from "metabase-types/api";
diff --git a/frontend/src/metabase/search/analytics.ts b/frontend/src/metabase/search/analytics.ts
index cfc31dcf691..9932714871c 100644
--- a/frontend/src/metabase/search/analytics.ts
+++ b/frontend/src/metabase/search/analytics.ts
@@ -1,76 +1,6 @@
import { trackSchemaEvent } from "metabase/lib/analytics";
-import Settings from "metabase/lib/settings";
-import type { SearchRequest, SearchResponse } from "metabase-types/api";
-
-const MB_STATS_ANALYTICS_UUID = "d97541bd-59b0-4656-b437-d659ac48eae1";
-
-const shouldReportSearchTerm = () =>
- Settings.get("analytics-uuid") === MB_STATS_ANALYTICS_UUID;
-
-type SearchRequestFilter = Pick<
- SearchRequest,
- | "created_by"
- | "created_at"
- | "last_edited_at"
- | "last_edited_by"
- | "verified"
- | "search_native_query"
- | "context"
- | "models"
- | "archived"
- | "q"
- | "offset"
->;
-
-async function hashSearchTerm(searchTerm: string) {
- try {
- const analyticsUuid = Settings.get("analytics-uuid");
- const saltedSearchTerm = searchTerm + "-salt-" + analyticsUuid;
-
- const dataBuffer = new TextEncoder().encode(saltedSearchTerm);
- const hashBuffer = await crypto.subtle.digest("SHA-256", dataBuffer);
-
- const hashArray = Array.from(new Uint8Array(hashBuffer));
- return hashArray.map((b) => b.toString(16).padStart(2, "0")).join("");
- } catch (err) {
- console.warn("Failed to hash search term", err);
- return null;
- }
-}
-
-export const trackSearchRequest = (
- searchRequest: SearchRequestFilter,
- searchResponse: SearchResponse,
- duration: number,
- requestId: string | null = null,
-) => {
- const dispatchTrackSearchQuery = async () => {
- trackSchemaEvent("search", {
- event: "search_query",
- search_term_hash: searchRequest.q
- ? await hashSearchTerm(searchRequest.q)
- : null,
- search_term:
- shouldReportSearchTerm() && searchRequest.q ? searchRequest.q : null,
- content_type: searchRequest.models ?? null,
- creator: !!searchRequest.created_by,
- creation_date: !!searchRequest.created_at,
- last_edit_date: !!searchRequest.last_edited_at,
- last_editor: !!searchRequest.last_edited_by,
- verified_items: !!searchRequest.verified,
- search_native_queries: !!searchRequest.search_native_query,
- search_archived: !!searchRequest.archived,
- context: searchRequest.context ?? null,
- runtime_milliseconds: duration,
- total_results: searchResponse.total,
- page_results: searchResponse.limit,
- search_engine: searchResponse.engine,
- request_id: requestId,
- offset: searchRequest.offset ?? null,
- });
- };
- dispatchTrackSearchQuery();
-};
+import { hashSearchTerm, shouldReportSearchTerm } from "metabase/lib/search";
+import type { SearchRequest } from "metabase-types/api";
type TrackSearchClickParams = {
itemType: "item" | "view_more";