Skip to content

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

Always invalidate remote sync on card, dashboard and document mutations (#80148)

Romeo Van Snick4711e0c8453e
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 7b921a4c255..22216561265 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
@@ -16,7 +16,7 @@ import { transformTagApi } from "metabase/api/transform-tag";
import type { State } from "metabase/redux/store";
import { pythonLibraryApi } from "metabase-enterprise/api/python-transform-library";
import { tableApi as enterpriseTableApi } from "metabase-enterprise/api/table";
-import type { CardId, CollectionId, DashboardId } from "metabase-types/api";
+import type { CollectionId } from "metabase-types/api";
import { getCollectionFromCollectionsTree } from "./collection";
import {
@@ -35,22 +35,6 @@ function getOriginalArgs<T>(action: UnknownAction): T | undefined {
return meta?.arg?.originalArgs as 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)?.data;
-}
-
-function getOriginalDashboard(originalState: State, id: DashboardId) {
- const selector = dashboardApi.endpoints.getDashboard.select({ id });
- return selector(originalState)?.data || originalState.entities.dashboards[id];
-}
-
-function getOriginalCard(originalState: State, id: CardId) {
- const selector = cardApi.endpoints.getCard.select({ id });
- return selector(originalState)?.data || originalState.entities.questions[id];
-}
-
function getOriginalCollection(originalState: State, id: CollectionId) {
return (
collectionApi.endpoints.getCollection.select({ id })(originalState)?.data ||
@@ -74,10 +58,8 @@ export const MODEL_MUTATION_CONFIGS: ModelMutationConfig[] = [
updateEndpoints: [cardApi.endpoints.updateCard.matchFulfilled],
deleteEndpoints: [cardApi.endpoints.deleteCard.matchFulfilled],
invalidation: {
- type: InvalidationType.RemoteSyncedChange,
- getOriginal: getOriginalCard,
+ type: InvalidationType.Always,
},
- getDeleteId: (action) => getOriginalArgs<number>(action),
},
{
modelType: "dashboard",
@@ -85,10 +67,8 @@ export const MODEL_MUTATION_CONFIGS: ModelMutationConfig[] = [
updateEndpoints: [dashboardApi.endpoints.updateDashboard.matchFulfilled],
deleteEndpoints: [dashboardApi.endpoints.deleteDashboard.matchFulfilled],
invalidation: {
- type: InvalidationType.RemoteSyncedChange,
- getOriginal: getOriginalDashboard,
+ type: InvalidationType.Always,
},
- getDeleteId: (action) => getOriginalArgs<number>(action),
},
{
modelType: "document",
@@ -96,10 +76,8 @@ export const MODEL_MUTATION_CONFIGS: ModelMutationConfig[] = [
updateEndpoints: [documentApi.endpoints.updateDocument.matchFulfilled],
deleteEndpoints: [documentApi.endpoints.deleteDocument.matchFulfilled],
invalidation: {
- type: InvalidationType.RemoteSyncedChange,
- getOriginal: getOriginalDocument,
+ type: InvalidationType.Always,
},
- getDeleteId: (action) => getOriginalArgs<number>(action),
},
// Collections have special handling
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-invalidation-config.ts b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-invalidation-config.ts
index 729bea0b2f4..829f7191f3a 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-invalidation-config.ts
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/model-invalidation-config.ts
@@ -1,15 +1,7 @@
import type { UnknownAction } from "@reduxjs/toolkit";
import type { State } from "metabase/redux/store";
-import type {
- Card,
- CardId,
- Collection,
- CollectionId,
- Dashboard,
- DashboardId,
- Document,
-} from "metabase-types/api";
+import type { Collection, CollectionId } from "metabase-types/api";
/**
* Invalidation strategies for remote sync model mutations.
@@ -17,21 +9,12 @@ import type {
export enum InvalidationType {
/** Always invalidate on create/update/delete (for table children like fields, segments, measures) */
Always = "always",
- /** Only invalidate if is_remote_synced changed or was already true */
- RemoteSyncedChange = "remote_synced_change",
/** Check collection's is_remote_synced status */
CollectionBased = "collection_based",
}
export type InvalidationStrategy =
| { type: InvalidationType.Always }
- | {
- type: InvalidationType.RemoteSyncedChange;
- getOriginal: (
- state: State,
- id: number,
- ) => Card | Dashboard | Document | undefined;
- }
| {
type: InvalidationType.CollectionBased;
getOriginalCollection: (
@@ -56,8 +39,3 @@ export type ModelMutationConfig = {
invalidation: InvalidationStrategy;
getDeleteId?: (action: UnknownAction) => number | { id: number } | undefined;
};
-
-export type ModelWithRemoteSynced = {
- id: number | CardId | DashboardId;
- is_remote_synced?: boolean;
-};
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/register-listeners.ts b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/register-listeners.ts
index 749cb2658cf..58a440deff1 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/register-listeners.ts
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/register-listeners.ts
@@ -10,7 +10,7 @@ import { isAnyOf } from "@reduxjs/toolkit";
import { Api } from "metabase/api";
import type { State } from "metabase/redux/store";
import { getSetting } from "metabase/settings";
-import type { Card, Collection, Dashboard, Document } from "metabase-types/api";
+import type { Collection } from "metabase-types/api";
import { REMOTE_SYNC_INVALIDATION_TAGS, TRANSFORMS_KEY } from "../constants";
@@ -19,7 +19,6 @@ import {
type EndpointMatcher,
InvalidationType,
type ModelMutationConfig,
- type ModelWithRemoteSynced,
} from "./model-invalidation-config";
type AppDispatch = ThunkDispatch<State, unknown, UnknownAction>;
@@ -39,16 +38,6 @@ function invalidateRemoteSyncTags(dispatch: AppDispatch) {
dispatch(Api.util.invalidateTags(REMOTE_SYNC_INVALIDATION_TAGS as never));
}
-function shouldInvalidateForRemoteSyncedModel(
- oldModel: Card | Dashboard | Document | undefined,
- newModel: Card | Dashboard | Document,
-): boolean {
- const oldSynced = oldModel?.is_remote_synced ?? false;
- const newSynced = newModel.is_remote_synced ?? false;
-
- return oldSynced !== newSynced || newSynced;
-}
-
function isTransformsSyncEnabled(state: State): boolean {
return !!getSetting(state, TRANSFORMS_KEY);
}
@@ -131,14 +120,6 @@ function registerCreateListeners(
invalidateRemoteSyncTags(dispatch);
break;
- case InvalidationType.RemoteSyncedChange: {
- const payload = getActionPayload<ModelWithRemoteSynced>(action);
- if (payload?.is_remote_synced) {
- invalidateRemoteSyncTags(dispatch);
- }
- break;
- }
-
case InvalidationType.CollectionBased: {
const collection = getActionPayload<Collection>(action);
if (
@@ -174,24 +155,6 @@ function registerUpdateListeners(
invalidateRemoteSyncTags(dispatch);
break;
- case InvalidationType.RemoteSyncedChange: {
- const newModel = getActionPayload<Card | Dashboard | Document>(
- action,
- );
- if (!newModel) {
- break;
- }
- const oldModel = invalidation.getOriginal(
- getOriginalState(),
- // Unjustified type cast. FIXME
- newModel.id as number,
- );
- if (shouldInvalidateForRemoteSyncedModel(oldModel, newModel)) {
- invalidateRemoteSyncTags(dispatch);
- }
- break;
- }
-
case InvalidationType.CollectionBased: {
const newCollection = getActionPayload<Collection>(action);
if (!newCollection) {
@@ -239,22 +202,6 @@ function registerDeleteListeners(
invalidateRemoteSyncTags(dispatch);
break;
- case InvalidationType.RemoteSyncedChange: {
- const id = getDeleteId?.(action);
- if (id == null) {
- break;
- }
- const model = invalidation.getOriginal(
- getOriginalState(),
- // Unjustified type cast. FIXME
- id as number,
- );
- if (model?.is_remote_synced) {
- invalidateRemoteSyncTags(dispatch);
- }
- break;
- }
-
case InvalidationType.CollectionBased: {
const deleteRequest = getDeleteId?.(action);
const id =
diff --git a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/remote-sync-listener-middleware.unit.spec.ts b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/remote-sync-listener-middleware.unit.spec.ts
index 0c50848d6ab..23cc07c6deb 100644
--- a/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/remote-sync-listener-middleware.unit.spec.ts
+++ b/enterprise/frontend/src/metabase-enterprise/remote_sync/middleware/remote-sync-listener-middleware.unit.spec.ts
@@ -10,7 +10,9 @@ import {
setupUpdateCollectionEndpoint,
} from "__support__/server-mocks";
import { Api } from "metabase/api";
+import { cardApi } from "metabase/api/card";
import { collectionApi } from "metabase/api/collection";
+import { dashboardApi } from "metabase/api/dashboard";
import { seedApiQueryCache } from "metabase/redux/store/mocks";
import { remoteSyncApi } from "metabase-enterprise/api/remote-sync";
import type { EnterpriseSettings } from "metabase-types/api";
@@ -599,4 +601,72 @@ describe("remote-sync-listener-middleware", () => {
});
});
});
+ describe("card, dashboard and document listeners", () => {
+ afterEach(() => {
+ fetchMock.clearHistory();
+ });
+
+ const subscribeAndSettle = async (
+ store: ReturnType<typeof createTestStore>,
+ ) => {
+ store.dispatch(
+ remoteSyncApi.endpoints.getRemoteSyncChanges.initiate(undefined),
+ );
+ await waitForCondition(() =>
+ fetchMock.callHistory.done("remote-sync-dirty"),
+ );
+ };
+
+ const dirtyCallCount = () =>
+ fetchMock.callHistory.calls("remote-sync-dirty").length;
+
+ it("invalidates when a card is updated, whatever its sync state was", async () => {
+ fetchMock.put("path:/api/card/1", { id: 1, is_remote_synced: false });
+ setupRemoteSyncDirtyEndpoint();
+
+ const store = createTestStore();
+ await subscribeAndSettle(store);
+
+ store.dispatch(
+ cardApi.endpoints.updateCard.initiate({ id: 1, name: "Renamed" }),
+ );
+
+ await waitForCondition(() => dirtyCallCount() > 1);
+ expect(dirtyCallCount()).toBeGreaterThan(1);
+ });
+
+ it("invalidates when a card is deleted, without needing its previous state", async () => {
+ fetchMock.delete("path:/api/card/1", 204);
+ setupRemoteSyncDirtyEndpoint();
+
+ const store = createTestStore();
+ await subscribeAndSettle(store);
+
+ store.dispatch(cardApi.endpoints.deleteCard.initiate(1));
+
+ await waitForCondition(() => dirtyCallCount() > 1);
+ expect(dirtyCallCount()).toBeGreaterThan(1);
+ });
+
+ it("invalidates when a dashboard is updated", async () => {
+ fetchMock.put("path:/api/dashboard/2", {
+ id: 2,
+ is_remote_synced: false,
+ });
+ setupRemoteSyncDirtyEndpoint();
+
+ const store = createTestStore();
+ await subscribeAndSettle(store);
+
+ store.dispatch(
+ dashboardApi.endpoints.updateDashboard.initiate({
+ id: 2,
+ name: "Renamed",
+ }),
+ );
+
+ await waitForCondition(() => dirtyCallCount() > 1);
+ expect(dirtyCallCount()).toBeGreaterThan(1);
+ });
+ });
});