Skip to content

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

Fix plugins violations (#75076)

Fraser114d345f8640
diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.ts
index 1079e8dc77b..e61db9ce1d3 100644
--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.ts
+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/graph.ts
@@ -1,6 +1,5 @@
import _ from "underscore";
-import type { EntityId } from "metabase/admin/permissions/types";
import {
isSchemaEntityId,
isTableEntityId,
@@ -17,12 +16,13 @@ import {
DataPermissionValue,
type GroupsPermissions,
type NativePermissions,
+ type PermissionEntityId,
} from "metabase-types/api";
export function shouldRestrictNativeQueryPermissions(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
_permission: DataPermission,
value: DataPermissionValue,
_database: Database,
@@ -55,7 +55,7 @@ export function shouldRestrictNativeQueryPermissions(
export function upgradeViewPermissionsIfNeeded(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
value: NativePermissions,
database: Database,
) {
diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts
index 61a87184239..065cd005197 100644
--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts
+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/reducer.ts
@@ -7,7 +7,6 @@ import {
SAVE_DATA_PERMISSIONS,
UPDATE_DATA_PERMISSION,
} from "metabase/admin/permissions/permissions";
-import type { EntityId } from "metabase/admin/permissions/types";
import {
DATABASES_BASE_PATH,
GROUPS_BASE_PATH,
@@ -17,10 +16,11 @@ import {
DataPermissionValue,
type GroupId,
type Impersonation,
+ type PermissionEntityId,
} from "metabase-types/api";
export const getImpersonatedPostAction = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: GroupId,
view: "database" | "group",
) =>
diff --git a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/utils.ts b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/utils.ts
index a07a6949761..7169bf6b48f 100644
--- a/enterprise/frontend/src/metabase-enterprise/advanced_permissions/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/advanced_permissions/utils.ts
@@ -1,9 +1,8 @@
-import type { EntityId } from "metabase/admin/permissions/types";
import {
getDatabaseFocusPermissionsUrl,
getGroupFocusPermissionsUrl,
} from "metabase/admin/permissions/utils/urls";
-import type { GroupId } from "metabase-types/api";
+import type { GroupId, PermissionEntityId } from "metabase-types/api";
import type { ImpersonationModalParams } from "./types";
@@ -22,7 +21,7 @@ export const getImpersonatedDatabaseId = ({
};
const getDatabaseViewImpersonationModalUrl = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: GroupId,
) => {
const baseUrl = getDatabaseFocusPermissionsUrl(entityId);
@@ -30,7 +29,7 @@ const getDatabaseViewImpersonationModalUrl = (
};
const getGroupViewImpersonationModalUrl = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: GroupId,
) => {
const baseUrl = getGroupFocusPermissionsUrl(groupId);
@@ -39,7 +38,7 @@ const getGroupViewImpersonationModalUrl = (
};
export const getEditImpersonationUrl = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: GroupId,
view: "database" | "group",
) =>
diff --git a/enterprise/frontend/src/metabase-enterprise/caching/components/DashboardAndQuestionCachingTab.tsx b/enterprise/frontend/src/metabase-enterprise/caching/components/DashboardAndQuestionCachingTab.tsx
index 3a44c5b0810..8f83e0801d4 100644
--- a/enterprise/frontend/src/metabase-enterprise/caching/components/DashboardAndQuestionCachingTab.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/caching/components/DashboardAndQuestionCachingTab.tsx
@@ -1,6 +1,6 @@
import P from "metabase/admin/performance/components/PerformanceApp.module.css";
-import { PerformanceTabId } from "metabase/admin/performance/types";
import { getPerformanceTabName } from "metabase/admin/performance/utils";
+import { PerformanceTabId } from "metabase/plugins";
import { Tabs } from "metabase/ui";
export const DashboardAndQuestionCachingTab = () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/caching/components/InvalidateNowButton.tsx b/enterprise/frontend/src/metabase-enterprise/caching/components/InvalidateNowButton.tsx
index 1be2f8666f8..ae9dc496b21 100644
--- a/enterprise/frontend/src/metabase-enterprise/caching/components/InvalidateNowButton.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/caching/components/InvalidateNowButton.tsx
@@ -5,10 +5,12 @@ import { c, t } from "ttag";
import { useInvalidateTarget } from "metabase/admin/performance/hooks/useInvalidateTarget";
import { useIsFormPending } from "metabase/admin/performance/hooks/useIsFormPending";
-import type { ModelWithClearableCache } from "metabase/admin/performance/types";
import { useConfirmation } from "metabase/common/hooks/use-confirmation";
import { FormProvider, FormSubmitButton } from "metabase/forms";
-import type { InvalidateNowButtonProps } from "metabase/plugins";
+import type {
+ InvalidateNowButtonProps,
+ ModelWithClearableCache,
+} from "metabase/plugins";
import { Group, Icon, Loader, Text } from "metabase/ui";
/** Button that clears the cache of a particular object (the "target") */
diff --git a/enterprise/frontend/src/metabase-enterprise/caching/components/StrategyEditorForQuestionsAndDashboards/utils.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/caching/components/StrategyEditorForQuestionsAndDashboards/utils.unit.spec.tsx
index 1a204957b8c..0060e2f8c42 100644
--- a/enterprise/frontend/src/metabase-enterprise/caching/components/StrategyEditorForQuestionsAndDashboards/utils.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/caching/components/StrategyEditorForQuestionsAndDashboards/utils.unit.spec.tsx
@@ -1,7 +1,6 @@
-import { strategies } from "metabase/admin/performance/constants/complex";
import { getShortStrategyLabel } from "metabase/admin/performance/utils";
import { getCollectionPathAsString } from "metabase/collections/utils";
-import { PLUGIN_CACHING } from "metabase/plugins";
+import { PLUGIN_CACHING, strategies } from "metabase/plugins";
import { enterpriseOnlyCachingStrategies } from "metabase-enterprise/caching/constants";
import {
type AdaptiveStrategy,
diff --git a/enterprise/frontend/src/metabase-enterprise/caching/constants.ts b/enterprise/frontend/src/metabase-enterprise/caching/constants.ts
index 467a7808e90..ec9b4269d90 100644
--- a/enterprise/frontend/src/metabase-enterprise/caching/constants.ts
+++ b/enterprise/frontend/src/metabase-enterprise/caching/constants.ts
@@ -1,15 +1,13 @@
import { t } from "ttag";
import * as Yup from "yup";
-import {
- getPerformanceTabMetadata,
- getPositiveIntegerSchema,
-} from "metabase/admin/performance/constants/complex";
+import { defaultCron } from "metabase/common/components/Schedule/cron";
import {
PerformanceTabId,
type StrategyData,
-} from "metabase/admin/performance/types";
-import { defaultCron } from "metabase/common/components/Schedule/cron";
+ getPerformanceTabMetadata,
+ getPositiveIntegerSchema,
+} from "metabase/plugins";
import type { AdminPath } from "metabase/redux/store";
import { CacheDurationUnit } from "metabase-types/api";
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts
index c45cb31b90e..3c7f15aad77 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.ts
@@ -8,13 +8,8 @@ import {
} from "metabase/admin/permissions/selectors/confirmations";
import {
DataPermissionType,
- type EntityId,
type PermissionOption,
type PermissionSectionConfig,
- type PermissionSubject,
- type SchemaEntityId,
- type SpecialGroupType,
- type TableEntityId,
} from "metabase/admin/permissions/types";
import {
getFieldsPermission,
@@ -27,6 +22,11 @@ import {
DataPermissionValue,
type Group,
type GroupsPermissions,
+ type PermissionEntityId,
+ type PermissionSubject,
+ type SchemaEntityId,
+ type SpecialGroupType,
+ type TableEntityId,
} from "metabase-types/api";
export const DATA_MODEL_PERMISSION_OPTIONS: Record<string, PermissionOption> = {
@@ -62,7 +62,7 @@ const DATA_MODEL_PERMISSIONS_DESC = [
const getPermissionValue = (
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permissionSubject: PermissionSubject,
): DataPermissionValue => {
switch (permissionSubject) {
@@ -104,7 +104,7 @@ const getDisabledTooltip = (groupType: SpecialGroupType) => {
};
export const buildDataModelPermission = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: number,
groupType: SpecialGroupType,
permissions: GroupsPermissions,
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.unit.spec.ts
index 0817f50cdf0..222e7bcde0e 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.unit.spec.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/data-model-permission.unit.spec.ts
@@ -1,8 +1,8 @@
-import type { SpecialGroupType } from "metabase/admin/permissions/types";
import {
DataPermissionValue,
type Group,
type GroupsPermissions,
+ type SpecialGroupType,
} from "metabase-types/api";
import {
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/details-permission.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/details-permission.ts
index aadcd44f957..f27d78a2351 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/details-permission.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/details-permission.ts
@@ -8,16 +8,16 @@ import {
} from "metabase/admin/permissions/selectors/confirmations";
import {
DataPermissionType,
- type EntityId,
type PermissionOption,
type PermissionSectionConfig,
- type PermissionSubject,
} from "metabase/admin/permissions/types";
import {
DataPermission,
DataPermissionValue,
type Group,
type GroupsPermissions,
+ type PermissionEntityId,
+ type PermissionSubject,
} from "metabase-types/api";
export const DETAILS_PERMISSION_OPTIONS: Record<string, PermissionOption> = {
@@ -51,7 +51,7 @@ const getDetailsPermission = (
DETAILS_PERMISSION_OPTIONS.no.value;
export const buildDetailsPermission = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: number,
isAdmin: boolean,
isExternal: boolean,
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts
index 765568cf72b..f15951d9db0 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/download-permission.ts
@@ -8,12 +8,8 @@ import {
} from "metabase/admin/permissions/selectors/confirmations";
import {
DataPermissionType,
- type EntityId,
type PermissionOption,
type PermissionSectionConfig,
- type PermissionSubject,
- type SchemaEntityId,
- type TableEntityId,
} from "metabase/admin/permissions/types";
import {
getFieldsPermission,
@@ -26,6 +22,10 @@ import {
DataPermissionValue,
type Group,
type GroupsPermissions,
+ type PermissionEntityId,
+ type PermissionSubject,
+ type SchemaEntityId,
+ type TableEntityId,
} from "metabase-types/api";
const getTooltipMessage = (isAdmin: boolean, isBlockedAccess: boolean) => {
@@ -81,7 +81,7 @@ const DOWNLOAD_PERMISSIONS_DESC = [
const getPermissionValue = (
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permissionSubject: PermissionSubject,
) => {
switch (permissionSubject) {
@@ -110,7 +110,7 @@ const getPermissionValue = (
};
export const buildDownloadPermission = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: number,
isAdmin: boolean,
permissions: GroupsPermissions,
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/index.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/index.ts
index 954811cf4c8..775b699fee1 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/index.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/index.ts
@@ -1,14 +1,12 @@
-import type {
- EntityId,
- PermissionSectionConfig,
- PermissionSubject,
- SpecialGroupType,
-} from "metabase/admin/permissions/types";
+import type { PermissionSectionConfig } from "metabase/admin/permissions/types";
import { isNotNull } from "metabase/utils/types";
import type {
DataPermissionValue,
Group,
GroupsPermissions,
+ PermissionEntityId,
+ PermissionSubject,
+ SpecialGroupType,
} from "metabase-types/api";
import { buildDataModelPermission } from "./data-model-permission";
@@ -29,7 +27,7 @@ export const getFeatureLevelDataPermissions = ({
showTransformPermissions = false,
showWorkspacesPermissions = false,
}: {
- entityId: EntityId;
+ entityId: PermissionEntityId;
groupId: number;
groupType: SpecialGroupType;
permissions: GroupsPermissions;
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/transforms-permission.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/transforms-permission.ts
index aec2e3f6b8e..9b1c7550b33 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/transforms-permission.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/transforms-permission.ts
@@ -8,10 +8,8 @@ import {
} from "metabase/admin/permissions/selectors/confirmations";
import {
DataPermissionType,
- type EntityId,
type PermissionOption,
type PermissionSectionConfig,
- type PermissionSubject,
} from "metabase/admin/permissions/types";
import { getSchemasPermission } from "metabase/admin/permissions/utils/graph";
import {
@@ -19,6 +17,8 @@ import {
DataPermissionValue,
type Group,
type GroupsPermissions,
+ type PermissionEntityId,
+ type PermissionSubject,
} from "metabase-types/api";
export const TRANSFORMS_PERMISSION_OPTIONS: Record<string, PermissionOption> = {
@@ -79,7 +79,7 @@ const getTransformsDisabledTooltip = (
};
export const buildTransformsPermission = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: number,
isAdmin: boolean,
permissions: GroupsPermissions,
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/workspaces-permission.ts b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/workspaces-permission.ts
index 3b28e0c7de4..d1ec64cf779 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/workspaces-permission.ts
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/permission-management/workspaces-permission.ts
@@ -8,10 +8,8 @@ import {
} from "metabase/admin/permissions/selectors/confirmations";
import {
DataPermissionType,
- type EntityId,
type PermissionOption,
type PermissionSectionConfig,
- type PermissionSubject,
} from "metabase/admin/permissions/types";
import { getSchemasPermission } from "metabase/admin/permissions/utils/graph";
import {
@@ -19,6 +17,8 @@ import {
DataPermissionValue,
type Group,
type GroupsPermissions,
+ type PermissionEntityId,
+ type PermissionSubject,
} from "metabase-types/api";
export const WORKSPACES_PERMISSION_OPTIONS: Record<string, PermissionOption> = {
@@ -79,7 +79,7 @@ const getWorkspacesDisabledTooltip = (
};
export const buildWorkspacesPermission = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: number,
isAdmin: boolean,
permissions: GroupsPermissions,
diff --git a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/utils.tsx b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/utils.tsx
index 071b7e1b1ae..705731fce15 100644
--- a/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/utils.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/feature_level_permissions/utils.tsx
@@ -2,13 +2,13 @@ import type { ReactNode } from "react";
import { Link } from "react-router";
import { jt, t } from "ttag";
+import type { AdminPathKey, State } from "metabase/redux/store";
+import { getUser } from "metabase/selectors/user";
import type {
PermissionSubject,
SpecialGroupType,
-} from "metabase/admin/permissions/types";
-import type { AdminPathKey, State } from "metabase/redux/store";
-import { getUser } from "metabase/selectors/user";
-import type { User } from "metabase-types/api";
+ User,
+} from "metabase-types/api";
const canUserAccessDataModel = (user?: User) =>
user?.permissions?.can_access_data_model ?? false;
diff --git a/enterprise/frontend/src/metabase-enterprise/sandboxes/confirmations.ts b/enterprise/frontend/src/metabase-enterprise/sandboxes/confirmations.ts
index 5c77496a813..72f9fed8244 100644
--- a/enterprise/frontend/src/metabase-enterprise/sandboxes/confirmations.ts
+++ b/enterprise/frontend/src/metabase-enterprise/sandboxes/confirmations.ts
@@ -1,14 +1,14 @@
import { t } from "ttag";
-import type { EntityId } from "metabase/admin/permissions/types";
import { hasPermissionValueInGraph } from "metabase/admin/permissions/utils/graph";
+import type { PermissionEntityId } from "metabase-types/api";
import { DataPermissionValue } from "metabase-types/api";
import type { GroupsPermissions } from "metabase-types/api/permissions";
export function getSandboxedTableWarningModal(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
value: DataPermissionValue,
) {
// if the user is sandboxing the table while there is create-queries permissions set to
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 50f006e51bb..496642a84ad 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -102,6 +102,7 @@ const elements = [
createElement({ type: "shared", name: "notifications" }),
createElement({ type: "shared", name: "palette" }),
createElement({ type: "shared", name: "parameters" }),
+ createElement({ type: "shared", name: "plugins" }),
createElement({ type: "shared", name: "pulse" }),
createElement({ type: "shared", name: "querying", enforceOutgoing: false }),
createElement({ type: "shared", name: "questions" }),
diff --git a/frontend/src/metabase-types/api/permissions.ts b/frontend/src/metabase-types/api/permissions.ts
index 4f9b6ee397a..1be31ee2297 100644
--- a/frontend/src/metabase-types/api/permissions.ts
+++ b/frontend/src/metabase-types/api/permissions.ts
@@ -176,3 +176,24 @@ export type DataSegregationStrategy =
| "row-column-level-security"
| "connection-impersonation"
| "database-routing";
+
+export type DatabaseEntityId = {
+ databaseId: number;
+};
+
+export type SchemaEntityId = DatabaseEntityId & {
+ schemaName: string | undefined;
+};
+
+export type TableEntityId = SchemaEntityId & {
+ tableId: number;
+};
+
+export type PermissionEntityId = DatabaseEntityId &
+ Partial<Omit<TableEntityId, "databaseId">>;
+
+export type EntityWithGroupId = PermissionEntityId & { groupId: number };
+
+export type PermissionSubject = "schemas" | "tables" | "fields";
+
+export type SpecialGroupType = "admin" | "analyst" | "external" | null;
diff --git a/frontend/src/metabase/admin/performance/components/PerformanceApp.tsx b/frontend/src/metabase/admin/performance/components/PerformanceApp.tsx
index c1ef5d1b2c1..f40e4fc6a95 100644
--- a/frontend/src/metabase/admin/performance/components/PerformanceApp.tsx
+++ b/frontend/src/metabase/admin/performance/components/PerformanceApp.tsx
@@ -3,9 +3,8 @@ import {
AdminNavItem,
AdminNavWrapper,
} from "metabase/admin/components/AdminNav";
-import { PLUGIN_CACHING } from "metabase/plugins";
+import { PLUGIN_CACHING, PerformanceTabId } from "metabase/plugins";
-import { PerformanceTabId } from "../types";
import { getPerformanceTabName } from "../utils";
export const PerformanceApp = ({ children }: { children: React.ReactNode }) => (
diff --git a/frontend/src/metabase/admin/performance/components/StrategyForm.tsx b/frontend/src/metabase/admin/performance/components/StrategyForm.tsx
index 89e0c8e4402..fb9237c11a4 100644
--- a/frontend/src/metabase/admin/performance/components/StrategyForm.tsx
+++ b/frontend/src/metabase/admin/performance/components/StrategyForm.tsx
@@ -16,7 +16,7 @@ import {
FormTextInput,
useFormContext,
} from "metabase/forms";
-import { PLUGIN_CACHING } from "metabase/plugins";
+import { PLUGIN_CACHING, isModelWithClearableCache } from "metabase/plugins";
import { useSelector } from "metabase/redux";
import { getSetting } from "metabase/selectors/settings";
import {
@@ -43,7 +43,6 @@ import { CacheDurationUnit } from "metabase-types/api";
import { defaultCronSchedule, rootId } from "../constants/simple";
import { useIsFormPending } from "../hooks/useIsFormPending";
-import { isModelWithClearableCache } from "../types";
import {
getDefaultValueForField,
getLabelString,
diff --git a/frontend/src/metabase/admin/performance/constants/complex.ts b/frontend/src/metabase/admin/performance/constants/complex.ts
index da2fb1a94f4..161ec9894d5 100644
--- a/frontend/src/metabase/admin/performance/constants/complex.ts
+++ b/frontend/src/metabase/admin/performance/constants/complex.ts
@@ -1,90 +1,6 @@
import { t } from "ttag";
-import * as Yup from "yup";
import type { AdminPath } from "metabase/redux/store";
-import type { CacheableModel } from "metabase-types/api";
-
-import { PerformanceTabId, type StrategyData } from "../types";
-
-import { defaultMinDurationMs } from "./simple";
-
-/** Rather than a constant defined in the module scope, this is a function. This way, ttag.t runs *after* the locale is set */
-export const getPositiveIntegerSchema = () =>
- Yup.number()
- .positive(t`Enter a positive number.`)
- .integer(t`Enter an integer.`);
-
-export const inheritStrategyValidationSchema = Yup.object({
- type: Yup.string().equals(["inherit"]),
-});
-
-export const doNotCacheStrategyValidationSchema = Yup.object({
- type: Yup.string().equals(["nocache"]),
-});
-
-/** Rather than a constant defined in the module scope, this is a function. This way, ttag.t runs *after* the locale is set */
-export const getAdaptiveStrategyValidationSchema = () => {
- const positiveInteger = getPositiveIntegerSchema();
- return Yup.object({
- type: Yup.string().equals(["ttl"]),
- min_duration_ms: positiveInteger.default(defaultMinDurationMs),
- min_duration_seconds: positiveInteger.default(
- Math.ceil(defaultMinDurationMs / 1000),
- ),
- multiplier: positiveInteger.default(10),
- });
-};
-
-export const strategies = {
- inherit: {
- // NOTE: We use functions for labels because otherwise t doesn't work properly
- label: () => t`Default`,
- description: (model?: CacheableModel) => {
- switch (model) {
- case "database":
- return t`Use the default policy`;
- case "dashboard":
- return t`Each question will use its own policy or the database policy`;
- case "question":
- case "metric":
- return t`Use the database or dashboard policy`;
- default:
- return undefined;
- }
- },
- shortLabel: () => t`Default`,
- validationSchema: inheritStrategyValidationSchema,
- },
- // NOTE: The strategy is called 'ttl' in the BE, but we've renamed it 'Adaptive' in the FE
- ttl: {
- label: () => t`Adaptive`,
- description: () =>
- t`Use a query’s average execution time to determine how long to cache its results`,
- shortLabel: () => t`Adaptive`,
- validationSchema: getAdaptiveStrategyValidationSchema,
- },
- nocache: {
- label: () => t`Don’t cache results`,
- shortLabel: () => t`No caching`,
- validationSchema: doNotCacheStrategyValidationSchema,
- },
-} as Record<string, StrategyData>;
-
-export const getPerformanceTabMetadata = () =>
- [
- {
- name: t`Database caching`,
- path: "/admin/performance/databases",
- key: "performance-databases",
- tabId: PerformanceTabId.Databases,
- },
- {
- name: t`Model persistence`,
- path: "/admin/performance/models",
- key: "performance-models",
- tabId: PerformanceTabId.Models,
- },
- ] as (AdminPath & { tabId: string })[];
export const getPerformanceAdminPaths = (metadata: AdminPath[]) =>
metadata.map((tab) => ({ ...tab, name: `${t`Performance`} - ${tab.name}` }));
diff --git a/frontend/src/metabase/admin/performance/constants/simple.ts b/frontend/src/metabase/admin/performance/constants/simple.ts
index 4a180f2519e..bc7959e7ec6 100644
--- a/frontend/src/metabase/admin/performance/constants/simple.ts
+++ b/frontend/src/metabase/admin/performance/constants/simple.ts
@@ -1,3 +1,2 @@
export const rootId = 0;
-export const defaultMinDurationMs = 1000;
export const defaultCronSchedule = "0 0 * * * ? *";
diff --git a/frontend/src/metabase/admin/performance/types.ts b/frontend/src/metabase/admin/performance/types.ts
index 7b5648f411c..410329f493a 100644
--- a/frontend/src/metabase/admin/performance/types.ts
+++ b/frontend/src/metabase/admin/performance/types.ts
@@ -1,35 +1,4 @@
-import type { AnySchema } from "yup";
-
-import type { CacheableModel } from "metabase-types/api";
-
export type UpdateTargetId = (
newTargetId: number | null,
isFormDirty: boolean,
) => void;
-
-export type StrategyLabel =
- | string
- | ((model?: CacheableModel) => string | undefined);
-
-export type StrategyData = {
- label: StrategyLabel;
- description?: StrategyLabel;
- shortLabel?: StrategyLabel;
- /** Schema used to validate the value. This field can optionally be set to a function that returns a schema. This helps ensure that calls to ttag functions do not run until after the locale is set */
- validationSchema: AnySchema | (() => AnySchema);
-};
-
-export enum PerformanceTabId {
- Databases = "databases",
- Models = "models",
- DashboardsAndQuestions = "dashboards-and-questions",
-}
-
-export type ModelWithClearableCache = Exclude<CacheableModel, "root">;
-
-/** The default policy's cache cannot be cleared. But objects of other kinds,
- * such as dashboards, databases, and questions, can have their cache cleared
- * (if they have a cache) */
-export const isModelWithClearableCache = (
- model: CacheableModel,
-): model is ModelWithClearableCache => model !== "root";
diff --git a/frontend/src/metabase/admin/performance/utils.tsx b/frontend/src/metabase/admin/performance/utils.tsx
index d85b4a21df3..8b03c3f8aec 100644
--- a/frontend/src/metabase/admin/performance/utils.tsx
+++ b/frontend/src/metabase/admin/performance/utils.tsx
@@ -5,7 +5,14 @@ import type { SchemaObjectDescription } from "yup/lib/schema";
import { cronToScheduleSettings } from "metabase/common/components/Schedule/cron";
import { getScheduleStrings } from "metabase/common/components/Schedule/strings";
-import { PLUGIN_CACHING } from "metabase/plugins";
+import {
+ PLUGIN_CACHING,
+ type PerformanceTabId,
+ type StrategyData,
+ type StrategyLabel,
+ defaultMinDurationMs,
+ strategies,
+} from "metabase/plugins";
import { isNullOrUndefined } from "metabase/utils/types";
import type {
AdaptiveStrategy,
@@ -15,9 +22,7 @@ import type {
CacheableModel,
} from "metabase-types/api";
-import { strategies } from "./constants/complex";
-import { defaultMinDurationMs, rootId } from "./constants/simple";
-import type { PerformanceTabId, StrategyData, StrategyLabel } from "./types";
+import { rootId } from "./constants/simple";
type ErrorWithMessage = { data: { message: string } };
export const isErrorWithMessage = (error: unknown): error is ErrorWithMessage =>
diff --git a/frontend/src/metabase/admin/permissions/permissions.ts b/frontend/src/metabase/admin/permissions/permissions.ts
index 1be35967675..644ce43c223 100644
--- a/frontend/src/metabase/admin/permissions/permissions.ts
+++ b/frontend/src/metabase/admin/permissions/permissions.ts
@@ -40,6 +40,7 @@ import type {
CollectionPermissionsGraph,
GroupId,
GroupsPermissions,
+ PermissionEntityId,
PermissionsGraph,
} from "metabase-types/api";
@@ -48,7 +49,6 @@ import {
DataPermission,
DataPermissionType,
type DataPermissionValue,
- type EntityId,
type PermissionSectionConfig,
} from "./types";
import {
@@ -191,7 +191,7 @@ export interface UpdateDataPermissionParams {
"type" | "permission" | "postActions"
>;
value: DataPermissionValue;
- entityId: EntityId;
+ entityId: PermissionEntityId;
view: "database" | "group";
}
interface UpdateDataPermissionPayload {
@@ -202,7 +202,7 @@ interface UpdateDataPermissionPayload {
>;
value: DataPermissionValue;
metadata: Metadata;
- entityId: EntityId;
+ entityId: PermissionEntityId;
}
export const UPDATE_DATA_PERMISSION =
"metabase/admin/permissions/UPDATE_DATA_PERMISSION";
diff --git a/frontend/src/metabase/admin/permissions/selectors/collection-permissions.tsx b/frontend/src/metabase/admin/permissions/selectors/collection-permissions.tsx
index dde7bd50d38..78a2d09fa23 100644
--- a/frontend/src/metabase/admin/permissions/selectors/collection-permissions.tsx
+++ b/frontend/src/metabase/admin/permissions/selectors/collection-permissions.tsx
@@ -30,6 +30,7 @@ import type {
CollectionNamespace,
CollectionPermissions,
Group as GroupType,
+ SpecialGroupType,
} from "metabase-types/api";
import { COLLECTION_OPTIONS } from "../constants/collections-permissions";
@@ -39,7 +40,6 @@ import {
DataPermissionType,
type DataPermissionValue,
type PermissionEditorType,
- type SpecialGroupType,
} from "../types";
import { getPermissionWarningModal } from "./confirmations";
diff --git a/frontend/src/metabase/admin/permissions/selectors/confirmations.tsx b/frontend/src/metabase/admin/permissions/selectors/confirmations.tsx
index f5a88290499..b4a1e69ed14 100644
--- a/frontend/src/metabase/admin/permissions/selectors/confirmations.tsx
+++ b/frontend/src/metabase/admin/permissions/selectors/confirmations.tsx
@@ -16,11 +16,13 @@ import { Flex, Text } from "metabase/ui";
import type Database from "metabase-lib/v1/metadata/Database";
import type {
ConcreteTableId,
+ DatabaseEntityId,
Group,
GroupsPermissions,
+ PermissionEntityId,
+ SchemaEntityId,
} from "metabase-types/api";
-import type { DatabaseEntityId, EntityId, SchemaEntityId } from "../types";
import { DataPermission, DataPermissionValue } from "../types";
export const getDefaultGroupHasHigherAccessText = (defaultGroup: Group) =>
@@ -107,7 +109,7 @@ export function getBlockWarning(
}
}
-function getEntityTypeFromId(entityId: EntityId): [string, string] {
+function getEntityTypeFromId(entityId: PermissionEntityId): [string, string] {
return isTableEntityId(entityId)
? [t`table`, t`tables`]
: isSchemaEntityId(entityId)
@@ -150,7 +152,7 @@ export function getPermissionWarningModal(
export function getWillRevokeNativeAccessWarningModal(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
) {
// if the db is set to query builder and native for this group
// then warn the user that the change will downgrade native permissions
@@ -271,7 +273,7 @@ export function getRevokingAccessToAllTablesWarningModal(
database: Database,
permissions: GroupsPermissions,
groupId: Group["id"],
- entityId: EntityId,
+ entityId: PermissionEntityId,
value: DataPermissionValue,
) {
if (
diff --git a/frontend/src/metabase/admin/permissions/selectors/data-permissions/data-sidebar.ts b/frontend/src/metabase/admin/permissions/selectors/data-permissions/data-sidebar.ts
index 8f23b212a4d..c3d88a472a5 100644
--- a/frontend/src/metabase/admin/permissions/selectors/data-permissions/data-sidebar.ts
+++ b/frontend/src/metabase/admin/permissions/selectors/data-permissions/data-sidebar.ts
@@ -9,9 +9,12 @@ import { getMetadataWithHiddenTables } from "metabase/selectors/metadata";
import { isNotNull } from "metabase/utils/types";
import type Database from "metabase-lib/v1/metadata/Database";
import type Metadata from "metabase-lib/v1/metadata/Metadata";
-import type { Database as DatabaseType } from "metabase-types/api";
+import type {
+ Database as DatabaseType,
+ PermissionEntityId,
+} from "metabase-types/api";
-import type { EntityId, RawDataRouteParams } from "../../types";
+import type { RawDataRouteParams } from "../../types";
import {
getDatabaseEntityId,
getSchemaEntityId,
@@ -22,7 +25,7 @@ import { getDatabase } from "../../utils/metadata";
import { getIsLoadingDatabaseTables } from "./permission-editor";
export type DataTreeNodeItem = {
- entityId: EntityId;
+ entityId: PermissionEntityId;
children?: DataTreeNodeItem[];
} & ITreeNodeItem;
diff --git a/frontend/src/metabase/admin/permissions/selectors/data-permissions/fields.ts b/frontend/src/metabase/admin/permissions/selectors/data-permissions/fields.ts
index 7b6e7ea315f..6ff38b3ee82 100644
--- a/frontend/src/metabase/admin/permissions/selectors/data-permissions/fields.ts
+++ b/frontend/src/metabase/admin/permissions/selectors/data-permissions/fields.ts
@@ -15,15 +15,16 @@ import {
PLUGIN_FEATURE_LEVEL_PERMISSIONS,
} from "metabase/plugins";
import type Database from "metabase-lib/v1/metadata/Database";
-import type { Group, GroupsPermissions } from "metabase-types/api";
-
-import { DATA_PERMISSION_OPTIONS } from "../../constants/data-permissions";
-import { Messages } from "../../constants/messages";
import type {
- PermissionSectionConfig,
+ Group,
+ GroupsPermissions,
SpecialGroupType,
TableEntityId,
-} from "../../types";
+} from "metabase-types/api";
+
+import { DATA_PERMISSION_OPTIONS } from "../../constants/data-permissions";
+import { Messages } from "../../constants/messages";
+import type { PermissionSectionConfig } from "../../types";
import {
DataPermission,
DataPermissionType,
diff --git a/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx b/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx
index 9332387825a..2d89969c482 100644
--- a/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx
+++ b/frontend/src/metabase/admin/permissions/selectors/data-permissions/permission-editor.tsx
@@ -26,16 +26,16 @@ import type {
DatabaseId,
Group,
GroupsPermissions,
+ PermissionEntityId,
+ PermissionSubject,
+ SpecialGroupType,
} from "metabase-types/api";
import type {
DataRouteParams,
- EntityId,
PermissionEditorType,
PermissionSectionConfig,
- PermissionSubject,
RawGroupRouteParams,
- SpecialGroupType,
} from "../../types";
import { DataPermission, DataPermissionValue } from "../../types";
import {
@@ -183,7 +183,7 @@ const hasViewDataOptions = (entities: any[]) => {
type EntityWithPermissions = {
id: string | number;
name: string;
- entityId: EntityId;
+ entityId: PermissionEntityId;
canSelect?: boolean;
permissions: PermissionSectionConfig[];
callout?: string;
diff --git a/frontend/src/metabase/admin/permissions/selectors/data-permissions/schemas.ts b/frontend/src/metabase/admin/permissions/selectors/data-permissions/schemas.ts
index 2cea46a0ba4..6bdacda62fc 100644
--- a/frontend/src/metabase/admin/permissions/selectors/data-permissions/schemas.ts
+++ b/frontend/src/metabase/admin/permissions/selectors/data-permissions/schemas.ts
@@ -9,7 +9,12 @@ import {
PLUGIN_FEATURE_LEVEL_PERMISSIONS,
} from "metabase/plugins";
import type Database from "metabase-lib/v1/metadata/Database";
-import type { Group, GroupsPermissions } from "metabase-types/api";
+import type {
+ DatabaseEntityId,
+ Group,
+ GroupsPermissions,
+ SpecialGroupType,
+} from "metabase-types/api";
import { DATA_PERMISSION_OPTIONS } from "../../constants/data-permissions";
import { Messages } from "../../constants/messages";
@@ -17,12 +22,7 @@ import {
limitDatabasePermission,
navigateToGranularPermissions,
} from "../../permissions";
-import type {
- DataPermissionValue,
- DatabaseEntityId,
- PermissionSectionConfig,
- SpecialGroupType,
-} from "../../types";
+import type { DataPermissionValue, PermissionSectionConfig } from "../../types";
import { DataPermission, DataPermissionType } from "../../types";
import {
getPermissionWarning,
diff --git a/frontend/src/metabase/admin/permissions/selectors/data-permissions/tables.ts b/frontend/src/metabase/admin/permissions/selectors/data-permissions/tables.ts
index 6ee6e63a373..385da0075e9 100644
--- a/frontend/src/metabase/admin/permissions/selectors/data-permissions/tables.ts
+++ b/frontend/src/metabase/admin/permissions/selectors/data-permissions/tables.ts
@@ -11,16 +11,17 @@ import {
PLUGIN_FEATURE_LEVEL_PERMISSIONS,
} from "metabase/plugins";
import type Database from "metabase-lib/v1/metadata/Database";
-import type { Group, GroupsPermissions } from "metabase-types/api";
+import type {
+ Group,
+ GroupsPermissions,
+ SchemaEntityId,
+ SpecialGroupType,
+} from "metabase-types/api";
import { DATA_PERMISSION_OPTIONS } from "../../constants/data-permissions";
import { Messages } from "../../constants/messages";
import { navigateToGranularPermissions } from "../../permissions";
-import type {
- PermissionSectionConfig,
- SchemaEntityId,
- SpecialGroupType,
-} from "../../types";
+import type { PermissionSectionConfig } from "../../types";
import {
DataPermission,
DataPermissionType,
diff --git a/frontend/src/metabase/admin/permissions/types.ts b/frontend/src/metabase/admin/permissions/types.ts
index 86cd7d4d4ce..506bc1238d4 100644
--- a/frontend/src/metabase/admin/permissions/types.ts
+++ b/frontend/src/metabase/admin/permissions/types.ts
@@ -7,6 +7,7 @@ import type { GroupId, IconName } from "metabase-types/api";
import {
DataPermission,
DataPermissionValue,
+ type PermissionEntityId,
} from "metabase-types/api/permissions";
export { DataPermission, DataPermissionValue };
@@ -53,23 +54,6 @@ export function parseDataRouteParams(raw: RawDataRouteParams): DataRouteParams {
};
}
-export type DatabaseEntityId = {
- databaseId: number;
-};
-
-export type SchemaEntityId = DatabaseEntityId & {
- schemaName: string | undefined;
-};
-
-export type TableEntityId = SchemaEntityId & {
- tableId: number;
-};
-
-export type EntityId = DatabaseEntityId &
- Partial<Omit<TableEntityId, "databaseId">>;
-
-export type EntityWithGroupId = EntityId & { groupId: number };
-
export enum DataPermissionType {
ACCESS = "access",
NATIVE = "native",
@@ -97,10 +81,6 @@ export type PermissionsGraphDiff = {
groups: Record<number | string, GroupPermissionsDiff>;
};
-export type PermissionSubject = "schemas" | "tables" | "fields";
-
-export type SpecialGroupType = "admin" | "analyst" | "external" | null;
-
export interface PermissionOption {
label: string;
value: DataPermissionValue;
@@ -113,7 +93,7 @@ export interface PermissionAction {
icon: IconName;
iconColor: ColorName;
actionCreator: (
- entityId: EntityId | undefined,
+ entityId: PermissionEntityId | undefined,
id: number,
view: "database" | "group",
) => ThunkDispatch<State, unknown, UnknownAction>;
@@ -127,7 +107,7 @@ export interface PermissionConfirmationProps {
}
type PostActionFunction = (
- entityId: EntityId,
+ entityId: PermissionEntityId,
groupId: GroupId,
view: "database" | "group",
value: DataPermissionValue,
@@ -171,7 +151,7 @@ export interface PermissionEditorEntity {
name: string;
icon?: ReactElement;
hint?: ReactNode;
- entityId?: EntityId;
+ entityId?: PermissionEntityId;
permissions?: PermissionSectionConfig[];
canSelect?: boolean;
callout?: string;
diff --git a/frontend/src/metabase/admin/permissions/utils/data-entity-id.ts b/frontend/src/metabase/admin/permissions/utils/data-entity-id.ts
index 1636ce43717..cbb304a56b9 100644
--- a/frontend/src/metabase/admin/permissions/utils/data-entity-id.ts
+++ b/frontend/src/metabase/admin/permissions/utils/data-entity-id.ts
@@ -2,14 +2,13 @@ import { checkNotNull } from "metabase/utils/types";
import type Database from "metabase-lib/v1/metadata/Database";
import type Schema from "metabase-lib/v1/metadata/Schema";
import type Table from "metabase-lib/v1/metadata/Table";
-import type { ConcreteTableId } from "metabase-types/api";
-
import type {
+ ConcreteTableId,
DatabaseEntityId,
- EntityId,
+ PermissionEntityId,
SchemaEntityId,
TableEntityId,
-} from "../types";
+} from "metabase-types/api";
export const getDatabaseEntityId = (databaseEntity: Database) => ({
databaseId: databaseEntity.id,
@@ -27,11 +26,11 @@ export const getTableEntityId = (tableEntity: Table) => ({
});
export const isTableEntityId = (
- entityId: Partial<EntityId>,
+ entityId: Partial<PermissionEntityId>,
): entityId is TableEntityId => entityId.tableId != null;
export const isSchemaEntityId = (
- entityId: Partial<EntityId>,
+ entityId: Partial<PermissionEntityId>,
): entityId is SchemaEntityId & { schemaName: string } =>
// not sure why schemaName can be undefined on SchemaEntityId
entityId.schemaName != null &&
@@ -39,7 +38,7 @@ export const isSchemaEntityId = (
!isTableEntityId(entityId);
export const isDatabaseEntityId = (
- entityId: Partial<EntityId>,
+ entityId: Partial<PermissionEntityId>,
): entityId is DatabaseEntityId =>
entityId.databaseId != null &&
!isSchemaEntityId(entityId) &&
diff --git a/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/get.ts b/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/get.ts
index 0d030b717ce..c1b0dd59190 100644
--- a/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/get.ts
+++ b/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/get.ts
@@ -1,16 +1,14 @@
import { getIn } from "icepick";
-import type {
- DatabaseEntityId,
- EntityId,
- SchemaEntityId,
- TableEntityId,
-} from "metabase/admin/permissions/types";
import { PLUGIN_ADVANCED_PERMISSIONS } from "metabase/plugins";
import {
DataPermission,
DataPermissionValue,
+ type DatabaseEntityId,
type GroupsPermissions,
+ type PermissionEntityId,
+ type SchemaEntityId,
+ type TableEntityId,
} from "metabase-types/api";
// permission that do not have a nested schemas/native key
@@ -60,7 +58,7 @@ function getOmittedPermissionValue(
export function getRawPermissionsGraphValue(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permission: DataPermission,
) {
const nestedPath = [
@@ -176,7 +174,7 @@ export const getFieldsPermission = (
export const getEntityPermission = (
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permission: DataPermission,
): DataPermissionValue => {
if (entityId.tableId !== undefined) {
diff --git a/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/has.ts b/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/has.ts
index 3fb834cd096..8da75cf9d76 100644
--- a/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/has.ts
+++ b/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/has.ts
@@ -1,18 +1,16 @@
import _ from "underscore";
-import type {
- DatabaseEntityId,
- EntityWithGroupId,
- SchemaEntityId,
-} from "metabase/admin/permissions/types";
import { isSchemaEntityId } from "metabase/admin/permissions/utils/data-entity-id";
import type {
ConcreteTableId,
DataPermission,
DataPermissionValue,
+ DatabaseEntityId,
DatabasePermissions,
+ EntityWithGroupId,
GroupPermissions,
GroupsPermissions,
+ SchemaEntityId,
} from "metabase-types/api";
import {
diff --git a/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/update.ts b/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/update.ts
index ee004f31105..51a97fdb89e 100644
--- a/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/update.ts
+++ b/frontend/src/metabase/admin/permissions/utils/graph/data-permissions/update.ts
@@ -1,12 +1,6 @@
import { getIn, setIn } from "icepick";
import _ from "underscore";
-import type {
- DatabaseEntityId,
- EntityId,
- SchemaEntityId,
- TableEntityId,
-} from "metabase/admin/permissions/types";
import {
isSchemaEntityId,
isTableEntityId,
@@ -21,7 +15,11 @@ import type Table from "metabase-lib/v1/metadata/Table";
import {
DataPermission,
DataPermissionValue,
+ type DatabaseEntityId,
type GroupsPermissions,
+ type PermissionEntityId,
+ type SchemaEntityId,
+ type TableEntityId,
} from "metabase-types/api";
import {
@@ -162,7 +160,7 @@ export function updateSchemasPermission(
export function updateEntityPermission(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
value: DataPermissionValue,
database: Database,
permission: DataPermission,
@@ -200,7 +198,7 @@ export function updateEntityPermission(
export function restrictCreateQueriesPermissionsIfNeeded(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permission: DataPermission,
value: DataPermissionValue,
database: Database,
@@ -280,7 +278,7 @@ const hasFullCreateQueriesAccess = (
export function revokeTransformsPermissionIfNeeded(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permission: DataPermission,
value: DataPermissionValue,
): GroupsPermissions {
@@ -334,7 +332,7 @@ export function revokeTransformsPermissionIfNeeded(
export function revokeWorkspacesPermissionIfNeeded(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permission: DataPermission,
value: DataPermissionValue,
): GroupsPermissions {
@@ -388,7 +386,7 @@ export function revokeWorkspacesPermissionIfNeeded(
function inferEntityPermissionValueFromChildTables(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
database: Database,
permission: DataPermission,
): DataPermissionValue {
@@ -417,7 +415,7 @@ function inferEntityPermissionValueFromChildTables(
export function inferAndUpdateEntityPermissions(
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
database: Database,
permission: DataPermission,
) {
diff --git a/frontend/src/metabase/admin/permissions/utils/metadata.ts b/frontend/src/metabase/admin/permissions/utils/metadata.ts
index c098a09cfcb..66084b7e0e7 100644
--- a/frontend/src/metabase/admin/permissions/utils/metadata.ts
+++ b/frontend/src/metabase/admin/permissions/utils/metadata.ts
@@ -1,8 +1,6 @@
import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type Table from "metabase-lib/v1/metadata/Table";
-import type { ConcreteTableId } from "metabase-types/api";
-
-import type { TableEntityId } from "../types";
+import type { ConcreteTableId, TableEntityId } from "metabase-types/api";
export const getDatabase = (metadata: Metadata, databaseId: number) => {
const database = metadata.database(databaseId);
diff --git a/frontend/src/metabase/admin/permissions/utils/urls.ts b/frontend/src/metabase/admin/permissions/utils/urls.ts
index 95630481847..85331d29163 100644
--- a/frontend/src/metabase/admin/permissions/utils/urls.ts
+++ b/frontend/src/metabase/admin/permissions/utils/urls.ts
@@ -1,6 +1,4 @@
-import type { GroupId } from "metabase-types/api";
-
-import type { EntityId } from "../types";
+import type { GroupId, PermissionEntityId } from "metabase-types/api";
import {
isDatabaseEntityId,
@@ -11,7 +9,9 @@ import {
export const DATABASES_BASE_PATH = `/admin/permissions/data/database`;
export const GROUPS_BASE_PATH = `/admin/permissions/data/group`;
-export const getDatabaseFocusPermissionsUrl = (entityId?: EntityId) => {
+export const getDatabaseFocusPermissionsUrl = (
+ entityId?: PermissionEntityId,
+) => {
if (entityId == null) {
return DATABASES_BASE_PATH;
}
@@ -41,7 +41,7 @@ export const getDatabaseFocusPermissionsUrl = (entityId?: EntityId) => {
export const getGroupFocusPermissionsUrl = (
groupId?: GroupId,
- entityId?: EntityId,
+ entityId?: PermissionEntityId,
) => {
if (groupId == null) {
return GROUPS_BASE_PATH;
diff --git a/frontend/src/metabase/admin/routes.tsx b/frontend/src/metabase/admin/routes.tsx
index e70c9688058..2f7215e1793 100644
--- a/frontend/src/metabase/admin/routes.tsx
+++ b/frontend/src/metabase/admin/routes.tsx
@@ -63,6 +63,7 @@ import {
PLUGIN_TENANTS,
PLUGIN_WORKSPACES,
PLUGIN_WRITABLE_CONNECTION,
+ PerformanceTabId,
} from "metabase/plugins";
import type { State } from "metabase/redux/store";
import { getTokenFeature } from "metabase/setup";
@@ -71,7 +72,6 @@ import { AISettingsPage, McpSettingsPage } from "./ai/AISettingsPage";
import { MetabotAdminLayout } from "./ai/MetabotAdminLayout";
import { ModelPersistenceConfiguration } from "./performance/components/ModelPersistenceConfiguration";
import { StrategyEditorForDatabases } from "./performance/components/StrategyEditorForDatabases";
-import { PerformanceTabId } from "./performance/types";
import { getSettingsRoutes } from "./settingsRoutes";
import { ToolsApp } from "./tools/components/ToolsApp";
import { ToolsUpsell } from "./tools/components/ToolsUpsell";
diff --git a/frontend/src/metabase/admin/utils/groups.ts b/frontend/src/metabase/admin/utils/groups.ts
index c8bac05bc34..9a0e2f3d21f 100644
--- a/frontend/src/metabase/admin/utils/groups.ts
+++ b/frontend/src/metabase/admin/utils/groups.ts
@@ -1,8 +1,7 @@
import { t } from "ttag";
-import type { SpecialGroupType } from "metabase/admin/permissions/types";
import { PLUGIN_TENANTS } from "metabase/plugins";
-import type { GroupInfo } from "metabase-types/api";
+import type { GroupInfo, SpecialGroupType } from "metabase-types/api";
const SPECIAL_GROUP_NAMES: Record<string, () => string> = {
"All Users": () => t`All Users`,
diff --git a/frontend/src/metabase/plugins/index.ts b/frontend/src/metabase/plugins/index.ts
index 71abfd942c7..8521c80fdb3 100644
--- a/frontend/src/metabase/plugins/index.ts
+++ b/frontend/src/metabase/plugins/index.ts
@@ -15,11 +15,23 @@ export {
} from "./oss/auth";
export {
PLUGIN_CACHING,
+ PerformanceTabId,
+ defaultMinDurationMs,
+ doNotCacheStrategyValidationSchema,
+ getAdaptiveStrategyValidationSchema,
+ getPerformanceTabMetadata,
+ getPositiveIntegerSchema,
+ inheritStrategyValidationSchema,
+ isModelWithClearableCache,
+ strategies,
type InvalidateNowButtonProps,
type MetricCachingModalProps,
+ type ModelWithClearableCache,
type SidebarCacheSectionProps,
type SidebarCacheFormProps,
type PreemptiveCachingSwitchProps,
+ type StrategyData,
+ type StrategyLabel,
} from "./oss/caching";
export {
PLUGIN_COLLECTIONS,
diff --git a/frontend/src/metabase/plugins/oss/caching.ts b/frontend/src/metabase/plugins/oss/caching.ts
index 301030eb8bb..0c47f6c9694 100644
--- a/frontend/src/metabase/plugins/oss/caching.ts
+++ b/frontend/src/metabase/plugins/oss/caching.ts
@@ -1,11 +1,10 @@
import type { ComponentType, Dispatch, SetStateAction } from "react";
+import { t } from "ttag";
+import type { AnySchema } from "yup";
+import * as Yup from "yup";
-import {
- getPerformanceTabMetadata,
- strategies,
-} from "metabase/admin/performance/constants/complex";
-import type { ModelWithClearableCache } from "metabase/admin/performance/types";
import { PluginPlaceholder } from "metabase/plugins/components/PluginPlaceholder";
+import type { AdminPath } from "metabase/redux/store";
import type { ModalOverlayProps, StackProps } from "metabase/ui";
import type Question from "metabase-lib/v1/Question";
import type {
@@ -15,6 +14,34 @@ import type {
} from "metabase-types/api";
// Types
+
+export type StrategyLabel =
+ | string
+ | ((model?: CacheableModel) => string | undefined);
+
+export type StrategyData = {
+ label: StrategyLabel;
+ description?: StrategyLabel;
+ shortLabel?: StrategyLabel;
+ /** Schema used to validate the value. This field can optionally be set to a function that returns a schema. This helps ensure that calls to ttag functions do not run until after the locale is set */
+ validationSchema: AnySchema | (() => AnySchema);
+};
+
+export enum PerformanceTabId {
+ Databases = "databases",
+ Models = "models",
+ DashboardsAndQuestions = "dashboards-and-questions",
+}
+
+export type ModelWithClearableCache = Exclude<CacheableModel, "root">;
+
+/** The default policy's cache cannot be cleared. But objects of other kinds,
+ * such as dashboards, databases, and questions, can have their cache cleared
+ * (if they have a cache) */
+export const isModelWithClearableCache = (
+ model: CacheableModel,
+): model is ModelWithClearableCache => model !== "root";
+
export type InvalidateNowButtonProps = {
targetId: number;
targetModel: ModelWithClearableCache;
@@ -47,6 +74,92 @@ export interface MetricCachingModalProps {
onClose: () => void;
}
+// OSS caching strategies. These are the defaults for
+// PLUGIN_CACHING.strategies and the building blocks for their validation;
+// the enterprise caching plugin extends them with premium strategies.
+
+export const defaultMinDurationMs = 1000;
+
+/** Rather than a constant defined in the module scope, this is a function. This way, ttag.t runs *after* the locale is set */
+export const getPositiveIntegerSchema = () =>
+ Yup.number()
+ .positive(t`Enter a positive number.`)
+ .integer(t`Enter an integer.`);
+
+export const inheritStrategyValidationSchema = Yup.object({
+ type: Yup.string().equals(["inherit"]),
+});
+
+export const doNotCacheStrategyValidationSchema = Yup.object({
+ type: Yup.string().equals(["nocache"]),
+});
+
+/** Rather than a constant defined in the module scope, this is a function. This way, ttag.t runs *after* the locale is set */
+export const getAdaptiveStrategyValidationSchema = () => {
+ const positiveInteger = getPositiveIntegerSchema();
+ return Yup.object({
+ type: Yup.string().equals(["ttl"]),
+ min_duration_ms: positiveInteger.default(defaultMinDurationMs),
+ min_duration_seconds: positiveInteger.default(
+ Math.ceil(defaultMinDurationMs / 1000),
+ ),
+ multiplier: positiveInteger.default(10),
+ });
+};
+
+export const strategies = {
+ inherit: {
+ // NOTE: We use functions for labels because otherwise t doesn't work properly
+ label: () => t`Default`,
+ description: (model?: CacheableModel) => {
+ switch (model) {
+ case "database":
+ return t`Use the default policy`;
+ case "dashboard":
+ return t`Each question will use its own policy or the database policy`;
+ case "question":
+ case "metric":
+ return t`Use the database or dashboard policy`;
+ default:
+ return undefined;
+ }
+ },
+ shortLabel: () => t`Default`,
+ validationSchema: inheritStrategyValidationSchema,
+ },
+ // NOTE: The strategy is called 'ttl' in the BE, but we've renamed it 'Adaptive' in the FE
+ ttl: {
+ label: () => t`Adaptive`,
+ description: () =>
+ t`Use a query’s average execution time to determine how long to cache its results`,
+ shortLabel: () => t`Adaptive`,
+ validationSchema: getAdaptiveStrategyValidationSchema,
+ },
+ nocache: {
+ label: () => t`Don’t cache results`,
+ shortLabel: () => t`No caching`,
+ validationSchema: doNotCacheStrategyValidationSchema,
+ },
+} as Record<string, StrategyData>;
+
+export const getPerformanceTabMetadata = () =>
+ [
+ {
+ name: t`Database caching`,
+ path: "/admin/performance/databases",
+ key: "performance-databases",
+ tabId: PerformanceTabId.Databases,
+ },
+ {
+ name: t`Model persistence`,
+ path: "/admin/performance/models",
+ key: "performance-models",
+ tabId: PerformanceTabId.Models,
+ },
+ ] as (AdminPath & { tabId: string })[];
+
+// Plugin definition
+
const getDefaultPluginCaching = () => ({
isGranularCachingEnabled: () => false,
StrategyFormLauncherPanel: PluginPlaceholder as any,
diff --git a/frontend/src/metabase/plugins/oss/collections.ts b/frontend/src/metabase/plugins/oss/collections.ts
index c1ac520ae5a..4b0afe8dbec 100644
--- a/frontend/src/metabase/plugins/oss/collections.ts
+++ b/frontend/src/metabase/plugins/oss/collections.ts
@@ -2,7 +2,6 @@ import type React from "react";
import type { ComponentType } from "react";
import { t } from "ttag";
-import { Messages } from "metabase/admin/permissions/constants/messages";
import type {
CollectionAuthorityLevelConfig,
CollectionInstanceAnaltyicsConfig,
@@ -73,7 +72,8 @@ const getDefaultPluginCollections = () => ({
useGetDefaultCollectionId: null as GetCollectionIdType | null,
CUSTOM_INSTANCE_ANALYTICS_COLLECTION_ENTITY_ID: "" as BaseEntityId | "",
INSTANCE_ANALYTICS_ADMIN_READONLY_MESSAGE:
- Messages.UNABLE_TO_CHANGE_ADMIN_PERMISSIONS,
+ // eslint-disable-next-line metabase/no-literal-metabase-strings -- This string only shows for admins.
+ t`Administrators always have the highest level of access to everything in Metabase.`,
getAuthorityLevelMenuItems: (
_collection: Collection,
_onUpdate: (collection: Collection, values: Partial<Collection>) => void,
diff --git a/frontend/src/metabase/plugins/oss/permissions.ts b/frontend/src/metabase/plugins/oss/permissions.ts
index 50ba8f61969..30ed65d56c8 100644
--- a/frontend/src/metabase/plugins/oss/permissions.ts
+++ b/frontend/src/metabase/plugins/oss/permissions.ts
@@ -1,20 +1,18 @@
import type { ReactNode } from "react";
-import type {
- DatabaseEntityId,
- EntityId,
- PermissionSubject,
- SpecialGroupType,
-} from "metabase/admin/permissions/types";
import type { State } from "metabase/redux/store";
import { getUserIsAdmin } from "metabase/selectors/user";
import type Database from "metabase-lib/v1/metadata/Database";
import type {
DataPermission,
+ DatabaseEntityId,
Dataset,
Group,
GroupPermissions,
GroupsPermissions,
+ PermissionEntityId,
+ PermissionSubject,
+ SpecialGroupType,
User,
} from "metabase-types/api";
import { DataPermissionValue } from "metabase-types/api";
@@ -37,7 +35,7 @@ const getDefaultAdminPermissionsTableFieldsConfirmations = (): Array<
(
_permissions: GroupsPermissions,
_groupId: number,
- _entityId: EntityId,
+ _entityId: PermissionEntityId,
_value: DataPermissionValue,
) => any
> => [];
@@ -86,7 +84,7 @@ export const PLUGIN_DATA_PERMISSIONS: {
shouldRestrictNativeQueryPermissions: (
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
permission: DataPermission,
value: DataPermissionValue,
database: Database,
@@ -96,7 +94,7 @@ export const PLUGIN_DATA_PERMISSIONS: {
| ((
permissions: GroupsPermissions,
groupId: number,
- entityId: EntityId,
+ entityId: PermissionEntityId,
value: any,
database: Database,
permission: DataPermission,