refactor: fold cache revalidation into the event dispatcher

app/javascript/dashboard/store/modules/agents.js

@@ -1,7 +1,6 @@
 import * as MutationHelpers from 'shared/helpers/vuex/mutationHelpers';
 import * as types from '../mutation-types';
 import AgentAPI from '../../api/agents';
-import { createCacheRevalidateAction } from '../utils/cacheRevalidate';
 
 export const state = {
   records: [],
@@ -52,10 +51,6 @@ export const actions = {
       commit(types.default.SET_AGENT_FETCHING_STATUS, false);
     }
   },
-  revalidate: createCacheRevalidateAction({
-    api: AgentAPI,
-    mutation: types.default.SET_AGENTS,
-  }),
   create: async ({ commit }, agentInfo) => {
     commit(types.default.SET_AGENT_CREATING_STATUS, true);
     try {

app/javascript/dashboard/store/modules/attributes.js

@@ -2,7 +2,6 @@ import * as MutationHelpers from 'shared/helpers/vuex/mutationHelpers';
 import types from '../mutation-types';
 import AttributeAPI from '../../api/attributes';
 import camelcaseKeys from 'camelcase-keys';
-import { createCacheRevalidateAction } from '../utils/cacheRevalidate';
 
 export const state = {
   records: [],
@@ -55,10 +54,6 @@ export const actions = {
       commit(types.SET_CUSTOM_ATTRIBUTE_UI_FLAG, { isFetching: false });
     }
   },
-  revalidate: createCacheRevalidateAction({
-    api: AttributeAPI,
-    mutation: types.SET_CUSTOM_ATTRIBUTE,
-  }),
   create: async function createAttribute({ commit }, attributeObj) {
     commit(types.SET_CUSTOM_ATTRIBUTE_UI_FLAG, { isCreating: true });
     try {

app/javascript/dashboard/store/modules/cannedResponse.js

@@ -1,5 +1,4 @@
 import { throwErrorMessage } from 'dashboard/store/utils/api';
-import { createCacheRevalidateAction } from 'dashboard/store/utils/cacheRevalidate';
 import * as MutationHelpers from 'shared/helpers/vuex/mutationHelpers';
 import * as types from '../mutation-types';
 import CannedResponseAPI from '../../api/cannedResponse';
@@ -48,11 +47,6 @@ const actions = {
     }
   },
 
-  revalidateCannedResponses: createCacheRevalidateAction({
-    api: CannedResponseAPI,
-    mutation: types.default.SET_CANNED,
-  }),
-
   createCannedResponse: async function createCannedResponse(
     { commit },
     cannedObj

app/javascript/dashboard/store/modules/inboxes.js

@@ -7,7 +7,6 @@ import FBChannel from '../../api/channel/fbChannel';
 import TwilioChannel from '../../api/channel/twilioChannel';
 import WhatsappChannel from '../../api/channel/whatsappChannel';
 import { throwErrorMessage } from '../utils/api';
-import { createCacheRevalidateAction } from '../utils/cacheRevalidate';
 import AnalyticsHelper from '../../helper/AnalyticsHelper';
 import camelcaseKeys from 'camelcase-keys';
 import { ACCOUNT_EVENTS } from '../../helper/AnalyticsHelper/events';
@@ -190,11 +189,6 @@ const sendAnalyticsEvent = channelType => {
 };
 
 export const actions = {
-  revalidate: createCacheRevalidateAction({
-    api: InboxesAPI,
-    mutation: types.default.SET_INBOXES,
-    getData: response => response.data.payload,
-  }),
   get: async ({ commit }) => {
     commit(types.default.SET_INBOXES_UI_FLAG, { isFetching: true });
     try {

app/javascript/dashboard/store/modules/labels.js

@@ -3,7 +3,6 @@ import types from '../mutation-types';
 import LabelsAPI from '../../api/labels';
 import AnalyticsHelper from '../../helper/AnalyticsHelper';
 import { LABEL_EVENTS } from '../../helper/AnalyticsHelper/events';
-import { createCacheRevalidateAction } from '../utils/cacheRevalidate';
 
 export const state = {
   records: [],
@@ -33,12 +32,6 @@ export const getters = {
 };
 
 export const actions = {
-  revalidate: createCacheRevalidateAction({
-    api: LabelsAPI,
-    mutation: types.SET_LABELS,
-    getData: response => response.data.payload,
-  }),
-
   get: async function getLabels({ commit }) {
     commit(types.SET_LABEL_UI_FLAG, { isFetching: true });
     try {

app/javascript/dashboard/store/modules/teams/actions.js

@@ -6,7 +6,6 @@ import {
   DELETE_TEAM,
 } from './types';
 import TeamsAPI from '../../../api/teams';
-import { createCacheRevalidateAction } from '../../utils/cacheRevalidate';
 
 export const actions = {
   create: async ({ commit }, teamInfo) => {
@@ -22,10 +21,6 @@ export const actions = {
       commit(SET_TEAM_UI_FLAG, { isCreating: false });
     }
   },
-  revalidate: createCacheRevalidateAction({
-    api: TeamsAPI,
-    mutation: SET_TEAMS,
-  }),
   get: async ({ commit }) => {
     commit(SET_TEAM_UI_FLAG, { isFetching: true });
     try {

app/javascript/dashboard/store/utils/cacheRevalidate.js

@@ -1,14 +0,0 @@
-export const createCacheRevalidateAction =
-  ({ api, mutation, clearMutation, getData = response => response.data }) =>
-  async ({ commit }, { newKey }) => {
-    try {
-      const isExistingKeyValid = await api.validateCacheKey(newKey);
-      if (isExistingKeyValid) return;
-
-      const response = await api.refetchAndCommit(newKey);
-      if (clearMutation) commit(clearMutation);
-      commit(mutation, getData(response));
-    } catch (error) {
-      // Ignore error
-    }
-  };

app/javascript/dashboard/store/utils/specs/cacheRevalidate.spec.js

@@ -1,82 +0,0 @@
-import { createCacheRevalidateAction } from '../cacheRevalidate';
-
-describe('#createCacheRevalidateAction', () => {
-  const commit = vi.fn();
-
-  beforeEach(() => {
-    commit.mockReset();
-  });
-
-  it('refetches and commits data when the cache key is stale', async () => {
-    const api = {
-      validateCacheKey: vi.fn().mockResolvedValue(false),
-      refetchAndCommit: vi.fn().mockResolvedValue({ data: [{ id: 1 }] }),
-    };
-
-    const action = createCacheRevalidateAction({
-      api,
-      mutation: 'SET_RECORDS',
-    });
-
-    await action({ commit }, { newKey: 'new-key' });
-
-    expect(api.validateCacheKey).toHaveBeenCalledWith('new-key');
-    expect(api.refetchAndCommit).toHaveBeenCalledWith('new-key');
-    expect(commit).toHaveBeenCalledWith('SET_RECORDS', [{ id: 1 }]);
-  });
-
-  it('skips refetch when the cache key is current', async () => {
-    const api = {
-      validateCacheKey: vi.fn().mockResolvedValue(true),
-      refetchAndCommit: vi.fn(),
-    };
-
-    const action = createCacheRevalidateAction({
-      api,
-      mutation: 'SET_RECORDS',
-    });
-
-    await action({ commit }, { newKey: 'new-key' });
-
-    expect(api.refetchAndCommit).not.toHaveBeenCalled();
-    expect(commit).not.toHaveBeenCalled();
-  });
-
-  it('supports clear-before-set and custom response data extraction', async () => {
-    const api = {
-      validateCacheKey: vi.fn().mockResolvedValue(false),
-      refetchAndCommit: vi
-        .fn()
-        .mockResolvedValue({ data: { payload: [{ id: 1 }] } }),
-    };
-
-    const action = createCacheRevalidateAction({
-      api,
-      mutation: 'SET_RECORDS',
-      clearMutation: 'CLEAR_RECORDS',
-      getData: response => response.data.payload,
-    });
-
-    await action({ commit }, { newKey: 'new-key' });
-
-    expect(commit.mock.calls).toEqual([
-      ['CLEAR_RECORDS'],
-      ['SET_RECORDS', [{ id: 1 }]],
-    ]);
-  });
-
-  it('ignores revalidation errors', async () => {
-    const api = {
-      validateCacheKey: vi.fn().mockRejectedValue(new Error('boom')),
-      refetchAndCommit: vi.fn(),
-    };
-
-    const action = createCacheRevalidateAction({
-      api,
-      mutation: 'SET_RECORDS',
-    });
-
-    await expect(action({ commit }, { newKey: 'new-key' })).resolves.toBe();
-    expect(commit).not.toHaveBeenCalled();
-  });
-});