@zeniai/client-epic-state 5.2.49 → 5.2.50-beta0ND

package/lib/esm/view/invoicing/editInvoicingCouponDetailView/seedInvoicingCouponFormDraftEpic.js

@@ -1,16 +1,35 @@
 import { EMPTY, of } from 'rxjs';
 import { filter, mergeMap, withLatestFrom } from 'rxjs/operators';
 import { getInvoicingCouponById } from '../../../entity/invoicing/coupon/couponSelector';
-import { seedInvoicingCouponFormDraft, updateInvoicingCouponDetail, } from './editInvoicingCouponDetailViewReducer';
+import { fetchInvoicingCouponDetailPage, seedInvoicingCouponFormDraft, updateInvoicingCouponDetail, } from './editInvoicingCouponDetailViewReducer';
 import { entityToInvoicingCouponFormLocalData } from './editInvoicingCouponDetailViewState';
 /**
- * Seeds the edit draft from the record the moment the detail fetch lands, so
- * the form has its values before it mounts. The reducer ignores the seed when a
- * draft already exists, which is what stops a background refetch from
- * overwriting edits in progress.
+ * Seeds the edit draft from the record, so the form has its values before it
+ * mounts. The reducer ignores a seed once the draft holds the record, which is
+ * what stops a background refetch from overwriting edits in progress.
+ *
+ * Opening the page counts as a trigger, not just the detail response: the page
+ * fetch is cache-guarded, so re-opening a form for a record already loaded this
+ * session issues no request at all — and a draft cleared in between (by a save
+ * or a cancel) would have nothing left to seed it.
  */
-export const seedInvoicingCouponFormDraftEpic = (actions$, state$) => actions$.pipe(filter(updateInvoicingCouponDetail.match), withLatestFrom(state$), mergeMap(([action, state]) => {
+export const seedInvoicingCouponFormDraftEpic = (actions$, state$) => actions$.pipe(filter((action) => updateInvoicingCouponDetail.match(action) ||
+    fetchInvoicingCouponDetailPage.match(action)), withLatestFrom(state$), mergeMap(([action, state]) => {
     const { id } = action.payload;
+    if (id == null) {
+        return EMPTY;
+    }
+    // The entity alone does not say the whole record is loaded — the list
+    // endpoints merge their own list-shaped rows into the same store. Only a
+    // completed detail load does, which is also exactly when the page's
+    // cache-guarded fetch issues no request and this is the sole seed.
+    if (fetchInvoicingCouponDetailPage.match(action) &&
+        state.editInvoicingCouponDetailViewState.recordStateById[id]
+            ?.fetchState !== 'Completed') {
+        return EMPTY;
+    }
+    // Nothing to seed from on a cold open; the detail response triggers this
+    // again once it lands.
     const coupon = getInvoicingCouponById(state.invoicingCouponState, id);
     if (coupon == null) {
         return EMPTY;

package/lib/esm/view/invoicing/editInvoicingCustomerDetailView/editInvoicingCustomerDetailViewReducer.js

@@ -1,5 +1,6 @@
 import { createSlice } from '@reduxjs/toolkit';
 import { clearAll } from '../../../rootActions';
+import { applyInvoicingFormDraftEdit, applyInvoicingFormDraftFailure, applyInvoicingFormDraftSeed, } from '../invoicingFormDraft';
 import { initialInvoicingCustomerFormLocalData } from './invoicingCustomerFormConfig';
 export const initialState = {
     emailPreviewFetchState: { fetchState: 'Not-Started', error: undefined },
@@ -123,20 +124,17 @@ const editInvoicingCustomerDetailView = createSlice({
                 fetchState: 'Error',
                 error: action.payload.status,
             };
+            applyInvoicingFormDraftFailure(draft.editDraftById, action.payload.id, initialInvoicingCustomerFormLocalData);
         },
-        /**
-         * Seed the draft from the loaded record, once. Skipped when a draft already
-         * exists so a late refetch cannot overwrite in-progress edits.
-         */
+        /** Fill the draft from the loaded record — see `applyInvoicingFormDraftSeed`. */
         seedInvoicingCustomerFormDraft(draft, action) {
-            if (draft.editDraftById[action.payload.id] == null) {
-                draft.editDraftById[action.payload.id] = action.payload.localData;
-            }
+            const { id, localData } = action.payload;
+            applyInvoicingFormDraftSeed(draft.editDraftById, id, localData);
         },
         updateInvoicingCustomerFormDraft(draft, action) {
             const { id, localData } = action.payload;
             if (id != null) {
-                draft.editDraftById[id] = localData;
+                applyInvoicingFormDraftEdit(draft.editDraftById, id, localData);
             }
             else {
                 draft.newCustomerDraft = localData;
@@ -161,12 +159,22 @@ const editInvoicingCustomerDetailView = createSlice({
             draft.fetchState = 'Error';
             draft.error = action.payload;
         },
-        resetEditInvoicingCustomerDetailView(draft) {
+        /**
+         * Discard a form's draft — the customer's own when `id` is given,
+         * the create draft otherwise. Scoped to the one form on purpose: another
+         * customer's half-finished edit is not this form's to throw away.
+         * Clearing every draft at once is what `clearAll` is for.
+         */
+        resetEditInvoicingCustomerDetailView(draft, action) {
             draft.fetchState = 'Not-Started';
             draft.error = undefined;
             draft.savedCustomerId = undefined;
-            draft.editDraftById = {};
-            draft.newCustomerDraft = { ...initialInvoicingCustomerFormLocalData };
+            const id = action.payload?.id;
+            if (id == null) {
+                draft.newCustomerDraft = { ...initialInvoicingCustomerFormLocalData };
+                return;
+            }
+            delete draft.editDraftById[id];
         },
         // Trigger only — handled by initializeInvoicingCustomerAddressEpic.
         initializeInvoicingCustomerAddress: {

package/lib/esm/view/invoicing/editInvoicingCustomerDetailView/editInvoicingCustomerDetailViewSelector.js

@@ -5,6 +5,7 @@ import { invoicingCustomerPaymentMethods } from '../../../entity/invoicing/invoi
 import { getFormattedAddress } from '../../addressView/addressViewSelector';
 import { getInvoicingPaymentLinkSendState, getInvoicingPaymentMethodSaveState, getInvoicingPlaidLinkToken, getInvoicingPlaidLinkTokenFetchState, getInvoicingSentPaymentLinkEmail, getInvoicingSentPaymentLinkMagicUrl, getInvoicingSetupIntent, getInvoicingSetupIntentFetchState, } from '../customerPaymentMethod/customerPaymentMethodSelector';
 import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingFormDraftLocalData, isInvoicingFormDraftPending, } from '../invoicingFormDraft';
 import { isStripeConnectedFromSettings } from '../settingsView/invoicingSettingsHelpers';
 import { getInvoicingSettings } from '../settingsView/settingsViewSelector';
 import { INVOICING_CUSTOMER_BILLING_ADDRESS_TYPE, initialInvoicingCustomerFormLocalData, } from './invoicingCustomerFormConfig';
@@ -59,8 +60,7 @@ export const getInvoicingCustomerFormView = (state, invoicingCustomerID) => {
     // `seedInvoicingCustomerFormDraftEpic` when the detail load lands. Until then
     // the page is showing its skeleton.
     const localData = invoicingCustomerID != null
-        ? (editDraftById[invoicingCustomerID] ??
-            initialInvoicingCustomerFormLocalData)
+        ? getInvoicingFormDraftLocalData(editDraftById, invoicingCustomerID, initialInvoicingCustomerFormLocalData)
         : newCustomerDraft;
     // Billing address is captured via the shared Address screen and seeded there
     // (from the address entity) on detail load, so the formatted label comes from
@@ -78,6 +78,7 @@ export const getInvoicingCustomerFormView = (state, invoicingCustomerID) => {
         ? { error: undefined, fetchState: 'Completed' }
         : (state.editInvoicingCustomerDetailViewState.recordStateById[invoicingCustomerID] ?? { error: undefined, fetchState: 'Not-Started' });
     const { emailPreview, emailPreviewCustomerId, emailPreviewFetchState } = state.editInvoicingCustomerDetailViewState;
+    const isFormLoading = isInvoicingFormDraftPending(editDraftById, invoicingCustomerID);
     return {
         // A preview cached for another customer is not this screen's.
         emailPreview: emailPreviewCustomerId === invoicingCustomerID ? emailPreview : undefined,
@@ -92,6 +93,7 @@ export const getInvoicingCustomerFormView = (state, invoicingCustomerID) => {
         promotionalCreditSubmitState: state.editInvoicingCustomerDetailViewState.promotionalCreditSubmitState,
         record: getInvoicingCustomerRecord(state, invoicingCustomerID),
         fieldHelp: invoicingFieldHelpForGroup(state, 'customer'),
+        isFormLoading,
         customerTypeOptions,
         localData,
         mode,

package/lib/esm/view/invoicing/editInvoicingCustomerDetailView/saveInvoicingCustomerEpic.js

@@ -16,7 +16,7 @@ export const saveInvoicingCustomerEpic = (actions$, state$, zeniAPI) => actions$
     const rootState = state$.value;
     const viewState = rootState.editInvoicingCustomerDetailViewState;
     const localData = (id != null
-        ? viewState.editDraftById[id]
+        ? viewState.editDraftById[id]?.localData
         : viewState.newCustomerDraft) ?? viewState.newCustomerDraft;
     // Billing address captured via the shared Address screen is sent as an
     // object in the payload; the backend creates it and returns its id

package/lib/esm/view/invoicing/editInvoicingCustomerDetailView/seedInvoicingCustomerFormDraftEpic.js

@@ -1,16 +1,35 @@
 import { EMPTY, of } from 'rxjs';
 import { filter, mergeMap, withLatestFrom } from 'rxjs/operators';
 import { getInvoicingCustomerById } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerSelector';
-import { seedInvoicingCustomerFormDraft, updateInvoicingCustomerDetail, } from './editInvoicingCustomerDetailViewReducer';
+import { fetchInvoicingCustomerDetailPage, seedInvoicingCustomerFormDraft, updateInvoicingCustomerDetail, } from './editInvoicingCustomerDetailViewReducer';
 import { entityToInvoicingCustomerFormLocalData } from './invoicingCustomerFormConfig';
 /**
- * Seeds the edit draft from the record the moment the detail fetch lands, so
- * the form has its values before it mounts. The reducer ignores the seed when a
- * draft already exists, which is what stops a background refetch from
- * overwriting edits in progress.
+ * Seeds the edit draft from the record, so the form has its values before it
+ * mounts. The reducer ignores a seed once the draft holds the record, which is
+ * what stops a background refetch from overwriting edits in progress.
+ *
+ * Opening the page counts as a trigger, not just the detail response: the page
+ * fetch is cache-guarded, so re-opening for a record already loaded this
+ * session issues no request at all — and a draft cleared in between (by a save
+ * or a cancel) would have nothing left to seed it.
  */
-export const seedInvoicingCustomerFormDraftEpic = (actions$, state$) => actions$.pipe(filter(updateInvoicingCustomerDetail.match), withLatestFrom(state$), mergeMap(([action, state]) => {
+export const seedInvoicingCustomerFormDraftEpic = (actions$, state$) => actions$.pipe(filter((action) => updateInvoicingCustomerDetail.match(action) ||
+    fetchInvoicingCustomerDetailPage.match(action)), withLatestFrom(state$), mergeMap(([action, state]) => {
     const { id } = action.payload;
+    if (id == null) {
+        return EMPTY;
+    }
+    // The entity alone does not say the whole record is loaded — the list
+    // endpoints merge their own list-shaped rows into the same store. Only a
+    // completed detail load does, which is also exactly when the page's
+    // cache-guarded fetch issues no request and this is the sole seed.
+    if (fetchInvoicingCustomerDetailPage.match(action) &&
+        state.editInvoicingCustomerDetailViewState.recordStateById[id]
+            ?.fetchState !== 'Completed') {
+        return EMPTY;
+    }
+    // Nothing to seed from on a cold open; the detail response triggers this
+    // again once it lands.
     const customer = getInvoicingCustomerById(state.invoicingCustomerState, id);
     if (customer == null) {
         return EMPTY;

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer.js

@@ -1,5 +1,6 @@
 import { createSlice } from '@reduxjs/toolkit';
 import { clearAll } from '../../../rootActions';
+import { applyInvoicingFormDraftEdit, applyInvoicingFormDraftFailure, applyInvoicingFormDraftSeed, } from '../invoicingFormDraft';
 import { initialInvoicingSubscriptionFormLocalData } from './invoicingSubscriptionFormConfig';
 export const initialState = {
     fetchState: 'Not-Started',
@@ -65,15 +66,12 @@ const editInvoicingSubscriptionDetailView = createSlice({
                 fetchState: 'Error',
                 error: action.payload.error,
             };
+            applyInvoicingFormDraftFailure(draft.editDraftById, action.payload.id, initialInvoicingSubscriptionFormLocalData);
         },
-        /**
-         * Seed the draft from the loaded record, once. Skipped when a draft already
-         * exists so a late refetch cannot overwrite in-progress edits.
-         */
+        /** Fill the draft from the loaded record — see `applyInvoicingFormDraftSeed`. */
         seedInvoicingSubscriptionFormDraft(draft, action) {
-            if (draft.editDraftById[action.payload.id] == null) {
-                draft.editDraftById[action.payload.id] = action.payload.localData;
-            }
+            const { id, localData } = action.payload;
+            applyInvoicingFormDraftSeed(draft.editDraftById, id, localData);
         },
         fetchInvoicingSubscriptionFormPage: {
             reducer() {
@@ -87,7 +85,7 @@ const editInvoicingSubscriptionDetailView = createSlice({
         updateInvoicingSubscriptionFormDraft(draft, action) {
             const { id, localData } = action.payload;
             if (id != null) {
-                draft.editDraftById[id] = localData;
+                applyInvoicingFormDraftEdit(draft.editDraftById, id, localData);
             }
             else {
                 draft.newSubscriptionDraft = localData;
@@ -112,14 +110,24 @@ const editInvoicingSubscriptionDetailView = createSlice({
             draft.fetchState = 'Error';
             draft.error = action.payload;
         },
-        resetEditInvoicingSubscriptionDetailView(draft) {
+        /**
+         * Discard a form's draft — the subscription's own when `id` is given,
+         * the create draft otherwise. Scoped to the one form on purpose: another
+         * subscription's half-finished edit is not this form's to throw away.
+         * Clearing every draft at once is what `clearAll` is for.
+         */
+        resetEditInvoicingSubscriptionDetailView(draft, action) {
             draft.fetchState = 'Not-Started';
             draft.error = undefined;
             draft.savedSubscriptionId = undefined;
-            draft.editDraftById = {};
-            draft.newSubscriptionDraft = {
-                ...initialInvoicingSubscriptionFormLocalData,
-            };
+            const id = action.payload?.id;
+            if (id == null) {
+                draft.newSubscriptionDraft = {
+                    ...initialInvoicingSubscriptionFormLocalData,
+                };
+                return;
+            }
+            delete draft.editDraftById[id];
         },
         // Trigger only — handled by initializeInvoicingSubscriptionAddressEpic.
         initializeInvoicingSubscriptionAddress: {

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.js

@@ -5,6 +5,7 @@ import { getInvoicingCouponListItems } from '../couponView/couponViewSelector';
 import { getInvoicingCatalogListView, getInvoicingCatalogPrices, } from '../invoicingCatalogListView/invoicingCatalogListViewSelector';
 import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingCustomerListView } from '../invoicingCustomerListView/invoicingCustomerListViewSelector';
+import { getInvoicingFormDraftLocalData, isInvoicingFormDraftPending, } from '../invoicingFormDraft';
 import { initialInvoicingSubscriptionFormLocalData } from './invoicingSubscriptionFormConfig';
 import { INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE } from './invoicingSubscriptionFormConfig';
 export const getEditInvoicingSubscriptionDetailViewState = (state, invoicingSubscriptionID) => {
@@ -33,8 +34,7 @@ export const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID)
     // `seedInvoicingSubscriptionFormDraftEpic` when the detail load lands. Until
     // then the page is showing its skeleton.
     const localData = invoicingSubscriptionID != null
-        ? (editDraftById[invoicingSubscriptionID] ??
-            initialInvoicingSubscriptionFormLocalData)
+        ? getInvoicingFormDraftLocalData(editDraftById, invoicingSubscriptionID, initialInvoicingSubscriptionFormLocalData)
         : newSubscriptionDraft;
     // Shipping address is captured via the shared Address screen and seeded there
     // (looked up in the shared address store by `shippingAddressId`) on detail
@@ -65,6 +65,7 @@ export const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID)
         subscriptionLifecycleActionOptions: configState.subscriptionLifecycleActionOptions,
         subscriptionMetadataEditAllowedFromStatuses: configState.subscriptionMetadataEditAllowedFromStatuses,
         recordState,
+        isFormLoading: isInvoicingFormDraftPending(editDraftById, invoicingSubscriptionID),
         fieldHelp: invoicingFieldHelpForGroup(state, 'subscription'),
         coupons: getInvoicingCouponListItems(state),
         customers: getInvoicingCustomerListView(state).customers,

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/fetchInvoicingSubscriptionFormPageEpic.js

@@ -16,8 +16,11 @@ export const fetchInvoicingSubscriptionFormPageEpic = (actions$) => actions$.pip
     const { subscriptionId } = action.payload;
     const pageActions = [
         fetchInvoicingCustomerList({ filters: {}, keepExistingListItems: false }),
+        // Plans only: the form's plan picker is the one consumer, and an
+        // unfiltered list would replace the store's plans with every catalog
+        // item.
         fetchInvoicingCatalogPlanList({
-            filters: {},
+            filters: { type: 'plan' },
             keepExistingListItems: false,
         }),
         fetchInvoicingCouponList({ filters: {}, keepExistingListItems: false }),

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/saveInvoicingSubscriptionEpic.js

@@ -17,7 +17,7 @@ export const saveInvoicingSubscriptionEpic = (actions$, state$, zeniAPI) => acti
     const rootState = state$.value;
     const viewState = rootState.editInvoicingSubscriptionDetailViewState;
     const localData = (id != null
-        ? viewState.editDraftById[id]
+        ? viewState.editDraftById[id]?.localData
         : viewState.newSubscriptionDraft) ?? viewState.newSubscriptionDraft;
     // Shipping address captured via the shared Address screen is sent as an
     // object in the payload (same pattern as the customer save flow).

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/seedInvoicingSubscriptionFormDraftEpic.js

@@ -1,17 +1,38 @@
 import { EMPTY, of } from 'rxjs';
 import { filter, mergeMap, withLatestFrom } from 'rxjs/operators';
-import { seedInvoicingSubscriptionFormDraft, updateInvoicingSubscriptionDetail, } from './editInvoicingSubscriptionDetailViewReducer';
+import { fetchInvoicingSubscriptionFormPage, seedInvoicingSubscriptionFormDraft, updateInvoicingSubscriptionDetail, } from './editInvoicingSubscriptionDetailViewReducer';
 import { getInvoicingSubscriptionById } from './invoicingSubscriptionDetailHelper';
 import { entityToInvoicingSubscriptionFormLocalData } from './invoicingSubscriptionFormConfig';
 /**
- * Seeds the edit draft from the record the moment the detail fetch lands, so
- * the form has its values before it mounts. The reducer ignores the seed when a
- * draft already exists, which is what stops a background refetch from
- * overwriting edits in progress.
+ * Seeds the edit draft from the record, so the form has its values before it
+ * mounts. The reducer ignores a seed once the draft holds the record, which is
+ * what stops a background refetch from overwriting edits in progress.
+ *
+ * Opening the page counts as a trigger, not just the detail response: the page
+ * fetch is cache-guarded, so re-opening a form for a record already loaded this
+ * session issues no request at all — and a draft cleared in between (by a save
+ * or a cancel) would have nothing left to seed it.
  */
-export const seedInvoicingSubscriptionFormDraftEpic = (actions$, state$) => actions$.pipe(filter(updateInvoicingSubscriptionDetail.match), withLatestFrom(state$), mergeMap(([action, state]) => {
-    const { id } = action.payload;
-    const subscription = getInvoicingSubscriptionById(state, id);
+export const seedInvoicingSubscriptionFormDraftEpic = (actions$, state$) => actions$.pipe(filter((action) => updateInvoicingSubscriptionDetail.match(action) ||
+    fetchInvoicingSubscriptionFormPage.match(action)), withLatestFrom(state$), mergeMap(([action, state]) => {
+    const id = updateInvoicingSubscriptionDetail.match(action)
+        ? action.payload.id
+        : action.payload.subscriptionId;
+    if (id == null) {
+        return EMPTY;
+    }
+    // The entity alone does not say the whole record is loaded — the list
+    // endpoints merge their own list-shaped rows into the same store. Only a
+    // completed detail load does, which is also exactly when the page's
+    // cache-guarded fetch issues no request and this is the sole seed.
+    if (fetchInvoicingSubscriptionFormPage.match(action) &&
+        state.editInvoicingSubscriptionDetailViewState.recordStateById[id]
+            ?.fetchState !== 'Completed') {
+        return EMPTY;
+    }
+    // Nothing to seed from on a cold open; the detail response triggers this
+    // again once it lands.
+    const subscription = id != null ? getInvoicingSubscriptionById(state, id) : undefined;
     if (subscription == null) {
         return EMPTY;
     }

package/lib/esm/view/invoicing/invoicingFormDraft.js

@@ -0,0 +1,65 @@
+/**
+ * The form's own write. Keeps the status: an edit on top of a seeded draft is
+ * still the record's draft, and an edit made before the record arrived must not
+ * pass for one.
+ */
+export function applyInvoicingFormDraftEdit(draftById, id, localData) {
+    draftById[id] = {
+        fetchState: draftById[id]?.fetchState ?? 'Not-Started',
+        localData,
+    };
+}
+/**
+ * Fill the draft from the loaded record, once. A second seed is ignored so a
+ * late refetch cannot overwrite edits in progress — but a draft the form wrote
+ * before the record landed is replaced, since it was never the record's.
+ */
+export function applyInvoicingFormDraftSeed(draftById, id, localData) {
+    if (draftById[id]?.fetchState === 'Completed') {
+        return;
+    }
+    draftById[id] = { fetchState: 'Completed', localData };
+}
+/**
+ * Record that the fetch failed, so the form renders instead of waiting behind a
+ * skeleton that will never resolve.
+ *
+ * Mirrors the seed: a draft holding the record is left alone, since a
+ * background refetch failing is no reason to discard it, and anything else is
+ * marked failed. A draft the form wrote before the record landed keeps its
+ * values — there is no reason to throw away what the user typed — but stops
+ * counting as still loading, and a later successful fetch can still seed it.
+ */
+export function applyInvoicingFormDraftFailure(draftById, id, blankLocalData) {
+    const existing = draftById[id];
+    if (existing == null) {
+        draftById[id] = { fetchState: 'Error', localData: blankLocalData };
+        return;
+    }
+    if (existing.fetchState === 'Completed') {
+        return;
+    }
+    existing.fetchState = 'Error';
+}
+/** The draft's values, or the blank form when nothing is drafted yet. */
+export function getInvoicingFormDraftLocalData(draftById, id, blankLocalData) {
+    if (id == null) {
+        return blankLocalData;
+    }
+    return draftById[id]?.localData ?? blankLocalData;
+}
+/**
+ * Whether the form should still be showing its skeleton — the record has
+ * neither reached the draft nor failed trying.
+ *
+ * Settles once and stays settled, which is what keeps a later refetch from
+ * swapping a form the user is typing into back for a skeleton. Create mode
+ * (no id) has no record to wait for.
+ */
+export function isInvoicingFormDraftPending(draftById, id) {
+    if (id == null) {
+        return false;
+    }
+    const fetchState = draftById[id]?.fetchState;
+    return fetchState !== 'Completed' && fetchState !== 'Error';
+}

package/lib/esm/view/notificationPreferencesView/epics/saveNotificationPreferencesEpic.js

@@ -1,11 +1,12 @@
 import { EMPTY, of } from 'rxjs';
 import { catchError, filter, finalize, mergeMap, switchMap, takeUntil, withLatestFrom, } from 'rxjs/operators';
+import { NOTIFICATION_DOMAINS } from '../../../entity/notificationRegistry/notificationRegistryState';
 import { openSnackbar } from '../../../entity/snackbar/snackbarReducer';
 import { createZeniAPIStatus, isSuccessResponse, } from '../../../responsePayload';
 import { notificationPreferencesUrl } from '../notificationPreferencesEndpoint';
 import { mapPreferencesToPayload, } from '../notificationPreferencesViewPayload';
 import { clearAllNotificationPreferencesView, clearNotificationPreferencesLocalOverrides, saveNotificationPreferences, saveNotificationPreferencesFailure, saveNotificationPreferencesSuccess, } from '../notificationPreferencesViewReducer';
-import { getNotificationLocalOverrides } from '../notificationPreferencesViewSelector';
+import { getNotificationLocalOverridesForDomain } from '../notificationPreferencesViewSelector';
 export const saveNotificationPreferencesEpic = (actions$, state$, zeniAPI) => actions$.pipe(filter((action) => saveNotificationPreferences.match(action)), withLatestFrom(state$), 
 // `switchMap` unsubscribes from any in-flight PUT observable when a newer
 // Save fires. The prior HTTP request has already left the
@@ -13,9 +14,19 @@ export const saveNotificationPreferencesEpic = (actions$, state$, zeniAPI) => ac
 // ignored, so stale success/failure actions cannot clobber the newer
 // batch's state. Server-side ordering is arrival-order LWW.
 switchMap(([, state]) => {
-    const overrides = getNotificationLocalOverrides(state);
-    const preferencesPatch = mapPreferencesToPayload(overrides);
-    if (Object.keys(preferencesPatch).length === 0) {
+    // A clean domain is omitted entirely: an empty patch is still a write against it.
+    const overridesByDomain = {};
+    const body = {};
+    NOTIFICATION_DOMAINS.forEach((domain) => {
+        const overrides = getNotificationLocalOverridesForDomain(state, domain);
+        const preferencesPatch = mapPreferencesToPayload(overrides);
+        if (Object.keys(preferencesPatch).length === 0) {
+            return;
+        }
+        overridesByDomain[domain] = overrides;
+        body[`${domain}_preferences`] = preferencesPatch;
+    });
+    if (Object.keys(body).length === 0) {
         // No diff → do not dispatch a synthetic success (that would wipe
         // stored preferences via the reducer). Simply no-op.
         return EMPTY;
@@ -28,7 +39,6 @@ switchMap(([, state]) => {
     // in-flight save's response (Success/Failure never dispatched, so
     // the counter never drained and future saves got their merge dropped).
     const cancelEpochAtDispatch = state.notificationPreferencesViewState.cancelEpoch;
-    const body = { task_checklist_preferences: preferencesPatch };
     // Suppress the error snackbar when the response lands AFTER the user
     // pressed Cancel — the Failure reducer already swallows the state
     // update, so the toast would be a stale error for a save the user
@@ -57,8 +67,11 @@ switchMap(([, state]) => {
         if (isSuccessResponse(response)) {
             return of(saveNotificationPreferencesSuccess({
                 cancelEpochAtDispatch,
-                savedOverrides: overrides,
-                serverEcho: response.data?.task_checklist_preferences,
+                savedOverridesByDomain: overridesByDomain,
+                serverEchoByDomain: {
+                    task_checklist: response.data?.task_checklist_preferences,
+                    commenting: response.data?.commenting_preferences,
+                },
             }));
         }
         const actions = [

package/lib/esm/view/notificationPreferencesView/notificationPreferencesViewReducer.js

@@ -1,14 +1,25 @@
 import { createSlice } from '@reduxjs/toolkit';
+import { DEFAULT_NOTIFICATION_DOMAIN, } from '../../entity/notificationRegistry/notificationRegistryState';
 import { clearAll } from '../../rootActions';
 import { mapPayloadToPreferences, } from './notificationPreferencesViewPayload';
 import { emptyNotificationPreferences, } from './notificationPreferencesViewState';
 export const initialState = {
     cancelEpoch: 0,
-    localOverrides: emptyNotificationPreferences(),
-    preferences: emptyNotificationPreferences(),
+    localOverridesByDomain: {},
+    preferencesByDomain: {},
     saveEpoch: 0,
     savePreferencesState: { fetchState: 'Not-Started' },
 };
+// Lazy: a gate-off tenant never receives that domain's key at all.
+const overridesFor = (byDomain, domain) => {
+    const existing = byDomain[domain];
+    if (existing != null) {
+        return existing;
+    }
+    const created = emptyNotificationPreferences();
+    byDomain[domain] = created;
+    return created;
+};
 const mergePreferences = (base, patch) => {
     const eventEnabledByChannel = {
         ...base.eventEnabledByChannel,
@@ -146,7 +157,8 @@ const notificationPreferencesView = createSlice({
             // Success/Failure never dispatches, subsequent legitimate saves
             // still work because their captured epoch matches the current one.
             draft.cancelEpoch += 1;
-            draft.localOverrides = emptyNotificationPreferences();
+            // One shared Save/Cancel footer, so Cancel discards every domain.
+            draft.localOverridesByDomain = {};
             // Also drop `savePreferencesState` back to Not-Started so any
             // "Saving…" affordance bound to `getNotificationPreferencesSaveState`
             // clears on Cancel. Without this, a Cancel-during-save whose stale
@@ -163,9 +175,6 @@ const notificationPreferencesView = createSlice({
             // them; the save-success path is the only clearer.
             // A `null`/`undefined` payload isn't a snapshot at all (e.g. the
             // envelope key was omitted); no-op instead of wiping preferences.
-            if (action.payload.preferences == null) {
-                return;
-            }
             // Stale-GET guard (Cursor Bugbot 3632510237): if the fetch epic
             // captured a `saveEpoch` lower than the current one, a save has
             // succeeded since this GET dispatched — the response is carrying
@@ -175,7 +184,13 @@ const notificationPreferencesView = createSlice({
             if (action.payload.saveEpochAtDispatch < draft.saveEpoch) {
                 return;
             }
-            draft.preferences = mapPayloadToPreferences(action.payload.preferences);
+            Object.entries(action.payload.preferencesByDomain).forEach(([domain, payload]) => {
+                if (payload == null) {
+                    return;
+                }
+                draft.preferencesByDomain[domain] =
+                    mapPayloadToPreferences(payload);
+            });
         },
         saveNotificationPreferences(draft) {
             draft.savePreferencesState = { fetchState: 'In-Progress' };
@@ -234,33 +249,44 @@ const notificationPreferencesView = createSlice({
             // skip the `preferences` replace. Cursor Bugbot 3632510237.
             draft.saveEpoch += 1;
             draft.savePreferencesState = { fetchState: 'Completed' };
-            const patch = action.payload.serverEcho == null
-                ? action.payload.savedOverrides
-                : mapPayloadToPreferences(action.payload.serverEcho);
-            draft.preferences = mergePreferences(draft.preferences, patch);
-            draft.localOverrides = subtractSavedOverrides(draft.localOverrides, action.payload.savedOverrides);
+            Object.entries(action.payload.savedOverridesByDomain).forEach(([rawDomain, savedOverrides]) => {
+                if (savedOverrides == null) {
+                    return;
+                }
+                const domain = rawDomain;
+                const serverEcho = action.payload.serverEchoByDomain[domain];
+                const patch = serverEcho == null
+                    ? savedOverrides
+                    : mapPayloadToPreferences(serverEcho);
+                draft.preferencesByDomain[domain] = mergePreferences(draft.preferencesByDomain[domain] ?? emptyNotificationPreferences(), patch);
+                draft.localOverridesByDomain[domain] = subtractSavedOverrides(draft.localOverridesByDomain[domain] ??
+                    emptyNotificationPreferences(), savedOverrides);
+            });
         },
         setGroupChannelMaster(draft, action) {
             // Mirror of `toggleEventChannel` but scoped to the group-channel master
             // held under `groupChannelEnabledByGroupId[groupId][channel]`.
             const { channel, enabled, groupId } = action.payload;
+            const overrides = overridesFor(draft.localOverridesByDomain, action.payload.domain ?? DEFAULT_NOTIFICATION_DOMAIN);
             const groupMap = {
-                ...(draft.localOverrides.groupChannelEnabledByGroupId[groupId] ?? {}),
+                ...(overrides.groupChannelEnabledByGroupId[groupId] ?? {}),
             };
             groupMap[channel] = enabled;
-            draft.localOverrides.groupChannelEnabledByGroupId[groupId] = groupMap;
+            overrides.groupChannelEnabledByGroupId[groupId] = groupMap;
         },
         setGroupFrequency(draft, action) {
-            draft.localOverrides.groupFrequencyByGroupId[action.payload.groupId] =
+            const overrides = overridesFor(draft.localOverridesByDomain, action.payload.domain ?? DEFAULT_NOTIFICATION_DOMAIN);
+            overrides.groupFrequencyByGroupId[action.payload.groupId] =
                 action.payload.frequency;
         },
         toggleEventChannel(draft, action) {
             const { channel, enabled, eventId } = action.payload;
+            const overrides = overridesFor(draft.localOverridesByDomain, action.payload.domain ?? DEFAULT_NOTIFICATION_DOMAIN);
             const eventMap = {
-                ...(draft.localOverrides.eventEnabledByChannel[eventId] ?? {}),
+                ...(overrides.eventEnabledByChannel[eventId] ?? {}),
             };
             eventMap[channel] = enabled;
-            draft.localOverrides.eventEnabledByChannel[eventId] = eventMap;
+            overrides.eventEnabledByChannel[eventId] = eventMap;
         },
     },
     extraReducers: (builder) => {