Skip to content

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

Remove documents entity (#73565)

Romeo Van Snick03a203c0809c
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-configs.ts b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-configs.ts
index ebb9cabf699..ef4c2ec67e6 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-configs.ts
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-configs.ts
@@ -36,10 +36,7 @@ function getOriginalArgs<T>(action: UnknownAction): T | undefined {
function getOriginalDocument(originalState: State, id: number) {
// RTK Query selector requires RootState type, but our State type is compatible
const selector = documentApi.endpoints.getDocument.select({ id });
- return (
- selector(originalState as Parameters<typeof selector>[0])?.data ||
- originalState.entities.documents[id]
- );
+ return selector(originalState as Parameters<typeof selector>[0])?.data;
}
function getOriginalDashboard(originalState: State, id: DashboardId) {
diff --git a/frontend/src/metabase/api/document.ts b/frontend/src/metabase/api/document.ts
index 77731b40322..ccccdb22f0c 100644
--- a/frontend/src/metabase/api/document.ts
+++ b/frontend/src/metabase/api/document.ts
@@ -1,7 +1,5 @@
import { Api } from "metabase/api/api";
import { idTag, listTag } from "metabase/api/tags";
-import { hydrateLegacyEntities } from "metabase/api/utils/hydrate-legacy-entities";
-import { DocumentSchema } from "metabase/schema";
import type {
CopyDocumentRequest,
CreateDocumentRequest,
@@ -21,7 +19,6 @@ export const documentApi = Api.injectEndpoints({
}),
providesTags: (result, error, { id }) =>
!error ? [idTag("document", id)] : [],
- onQueryStarted: hydrateLegacyEntities(DocumentSchema),
}),
createDocument: builder.mutation<Document, CreateDocumentRequest>({
query: (body) => ({
diff --git a/frontend/src/metabase/dashboard/actions/parameters.unit.spec.ts b/frontend/src/metabase/dashboard/actions/parameters.unit.spec.ts
index d1709f0de9d..388f730d8cc 100644
--- a/frontend/src/metabase/dashboard/actions/parameters.unit.spec.ts
+++ b/frontend/src/metabase/dashboard/actions/parameters.unit.spec.ts
@@ -258,7 +258,6 @@ describe("setParameterMapping", () => {
collections: {},
dashboards: {},
databases: {},
- documents: {},
schemas: {},
tables: {},
fields:
@@ -377,7 +376,6 @@ describe("setParameterMapping", () => {
collections: {},
dashboards: {},
databases: {},
- documents: {},
schemas: {},
tables: {},
fields: {
diff --git a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
index ca8a80fa69e..26380f216a0 100644
--- a/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
+++ b/frontend/src/metabase/documents/components/DocumentArchivedEntityBanner.tsx
@@ -1,11 +1,12 @@
+import { push } from "react-router-redux";
import { t } from "ttag";
-import { deletePermanently } from "metabase/archive/actions";
+import { useDeleteDocumentMutation } from "metabase/api";
import { ArchivedEntityBanner } from "metabase/archive/components/ArchivedEntityBanner/ArchivedEntityBanner";
import { useSetArchive, useSetCollection } from "metabase/common/hooks";
import { Bookmarks } from "metabase/entities/bookmarks";
-import { Documents } from "metabase/entities/documents";
import { useDispatch, useSelector } from "metabase/redux";
+import { addUndo } from "metabase/redux/undo";
import { getCurrentDocument } from "../selectors";
@@ -14,6 +15,7 @@ export const DocumentArchivedEntityBanner = () => {
const archive = useSetArchive();
const setCollection = useSetCollection();
const document = useSelector(getCurrentDocument);
+ const [deleteDocument] = useDeleteDocumentMutation();
if (!document) {
return null;
@@ -33,9 +35,12 @@ export const DocumentArchivedEntityBanner = () => {
onMove={({ id }) =>
setCollection({ model: "document", id: document.id }, { id })
}
- onDeletePermanently={() => {
- const deleteAction = Documents.actions.delete({ id: document.id });
- dispatch(deletePermanently(deleteAction));
+ onDeletePermanently={async () => {
+ await deleteDocument({ id: document.id }).unwrap();
+ dispatch(push("/trash"));
+ dispatch(
+ addUndo({ message: t`This item has been permanently deleted.` }),
+ );
}}
/>
);
diff --git a/frontend/src/metabase/entities/bookmarks.js b/frontend/src/metabase/entities/bookmarks.js
index ab4691e309e..16de92b546c 100644
--- a/frontend/src/metabase/entities/bookmarks.js
+++ b/frontend/src/metabase/entities/bookmarks.js
@@ -6,7 +6,6 @@ import _ from "underscore";
import { bookmarkApi, useListBookmarksQuery } from "metabase/api";
import { Collections } from "metabase/entities/collections";
import { Dashboards } from "metabase/entities/dashboards";
-import { Documents } from "metabase/entities/documents";
import { Questions } from "metabase/entities/questions";
import { addUndo } from "metabase/redux/undo";
import { BookmarkSchema } from "metabase/schema";
@@ -128,20 +127,6 @@ export const Bookmarks = createEntity({
}
}
- if (type === Documents.actionTypes.UPDATE && payload?.object) {
- const { id, archived, name } = payload.object;
- const key = `document-${id}`;
-
- if (!getIn(state, [key])) {
- return state;
- }
- if (archived) {
- return dissoc(state, key);
- } else {
- return updateIn(state, [key], (item) => ({ ...item, name }));
- }
- }
-
if (type === Bookmarks.actionTypes.REORDER) {
const indexes = payload.reduce((indexes, bookmark, index) => {
indexes[bookmark.id] = index;
diff --git a/frontend/src/metabase/entities/documents.ts b/frontend/src/metabase/entities/documents.ts
deleted file mode 100644
index 2292a7ebb05..00000000000
--- a/frontend/src/metabase/entities/documents.ts
+++ /dev/null
@@ -1,64 +0,0 @@
-import { t } from "ttag";
-
-import { documentApi, useGetDocumentQuery } from "metabase/api";
-import type { Dispatch } from "metabase/redux/store";
-import { DocumentSchema } from "metabase/schema";
-import type {
- CreateDocumentRequest,
- DeleteDocumentRequest,
- GetDocumentRequest,
- UpdateDocumentRequest,
-} from "metabase-types/api";
-
-import { createEntity, entityCompatibleQuery } from "./utils";
-/**
- * @deprecated use "metabase/api" instead
- */
-export const Documents = createEntity({
- name: "documents",
- nameOne: "document",
- path: "/api/document",
- schema: DocumentSchema,
-
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- displayNameOne: t`document`,
- // eslint-disable-next-line ttag/no-module-declaration -- see metabase#55045
- displayNameMany: t`documents`,
-
- rtk: () => ({
- getUseGetQuery: () => ({
- useGetQuery: useGetDocumentQuery,
- }),
- }),
-
- api: {
- get: (
- entityQuery: GetDocumentRequest,
- _options: unknown,
- dispatch: Dispatch,
- ) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- documentApi.endpoints.getDocument,
- ),
- create: (entityQuery: CreateDocumentRequest, dispatch: Dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- documentApi.endpoints.createDocument,
- ),
- update: (entityQuery: UpdateDocumentRequest, dispatch: Dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- documentApi.endpoints.updateDocument,
- ),
- delete: (entityQuery: DeleteDocumentRequest, dispatch: Dispatch) =>
- entityCompatibleQuery(
- entityQuery,
- dispatch,
- documentApi.endpoints.deleteDocument,
- ),
- },
-});
diff --git a/frontend/src/metabase/entities/index.ts b/frontend/src/metabase/entities/index.ts
index ac0e10c54eb..18c4f198faa 100644
--- a/frontend/src/metabase/entities/index.ts
+++ b/frontend/src/metabase/entities/index.ts
@@ -91,6 +91,5 @@ export { Groups as groups } from "./groups";
export { Search as search } from "./search";
export { PersistedModels as persistedModels } from "./persisted-models";
export { Snippets as snippets } from "./snippets";
-export { Documents as documents } from "./documents";
export { entityCompatibleQuery, combineEntities } from "./utils";
diff --git a/frontend/src/metabase/redux/store/entities.ts b/frontend/src/metabase/redux/store/entities.ts
index 1e46c040e95..3754533edfa 100644
--- a/frontend/src/metabase/redux/store/entities.ts
+++ b/frontend/src/metabase/redux/store/entities.ts
@@ -3,7 +3,6 @@ import type {
NormalizedCollection,
NormalizedDashboard,
NormalizedDatabase,
- NormalizedDocument,
NormalizedField,
NormalizedGroup,
NormalizedMeasure,
@@ -19,7 +18,6 @@ export interface EntitiesState {
actions: Record<string, NormalizedWritebackAction>;
collections: Record<string, NormalizedCollection>;
dashboards: Record<string, NormalizedDashboard>;
- documents: Record<string, NormalizedDocument>;
databases: Record<string, NormalizedDatabase>;
schemas: Record<string, NormalizedSchema>;
tables: Record<string, NormalizedTable>;
diff --git a/frontend/src/metabase/redux/store/mocks/entities.ts b/frontend/src/metabase/redux/store/mocks/entities.ts
index 7f54b20e0f5..8debc4e92a2 100644
--- a/frontend/src/metabase/redux/store/mocks/entities.ts
+++ b/frontend/src/metabase/redux/store/mocks/entities.ts
@@ -7,7 +7,6 @@ export const createMockNormalizedEntitiesState = (): EntitiesState => ({
collections: {},
dashboards: {},
databases: {},
- documents: {},
schemas: {},
tables: {},
fields: {},
diff --git a/frontend/src/metabase/schema.js b/frontend/src/metabase/schema.js
index d97649fb74c..d64d66785d0 100644
--- a/frontend/src/metabase/schema.js
+++ b/frontend/src/metabase/schema.js
@@ -11,7 +11,6 @@ export const ActionSchema = new schema.Entity("actions");
export const QuestionSchema = new schema.Entity("questions");
export const CacheConfigSchema = new schema.Entity("cacheConfigs");
export const BookmarkSchema = new schema.Entity("bookmarks");
-export const DocumentSchema = new schema.Entity("documents");
export const DashboardSchema = new schema.Entity("dashboards");
export const CollectionSchema = new schema.Entity("collections");
export const GroupSchema = new schema.Entity("groups");
@@ -137,7 +136,6 @@ export const ENTITIES_SCHEMA_MAP = {
metrics: MetricSchema,
snippets: SnippetSchema,
snippetCollections: SnippetCollectionSchema,
- documents: DocumentSchema,
};
export const ObjectUnionSchema = new schema.Union(
diff --git a/frontend/test/__support__/store.ts b/frontend/test/__support__/store.ts
index fa1d992f597..c3c09145e2c 100644
--- a/frontend/test/__support__/store.ts
+++ b/frontend/test/__support__/store.ts
@@ -8,7 +8,6 @@ import {
CollectionSchema,
DashboardSchema,
DatabaseSchema,
- DocumentSchema,
FieldSchema,
GroupSchema,
MeasureSchema,
@@ -55,7 +54,6 @@ const EntitiesSchema: Record<keyof EntitiesState, NormalizrSchema<any>> = {
collections: [CollectionSchema],
dashboards: [DashboardSchema],
databases: [DatabaseSchema],
- documents: [DocumentSchema],
schemas: [SchemaSchema],
tables: [TableSchema],
fields: [FieldSchema],