@akinon/next 1.126.14-v1-rc.10 → 1.126.14

package/CHANGELOG.md

@@ -1,11 +1,10 @@
 # @akinon/next
 
-## 1.126.14-v1-rc.10
+## 1.126.14
 
 ### Patch Changes
 
-- d480941: ZERO-4399: add card rewards to pz-masterpass-rest
-- 182a639b: ZERO-4483: Verify v1-rc maintenance pipeline (no-op patch to confirm v1-rc dist-tag flow)
+- fb75f8e: ZERO-5168: Post the attribute-based shipping selection to the page name Commerce reports
 
 ## 1.126.13
 

package/__tests__/attribute-based-shipping-middleware.test.ts

@@ -0,0 +1,85 @@
+const mockInitiate = jest.fn((options: Record<string, number>) => ({
+  type: 'mock/setAttributeBasedShippingOptions',
+  payload: options
+}));
+
+jest.mock('../data/client/checkout', () => ({
+  checkoutApi: {
+    endpoints: {
+      setAttributeBasedShippingOptions: {
+        initiate: (options: Record<string, number>) => mockInitiate(options)
+      }
+    }
+  }
+}));
+
+import { attributeBasedShippingOptionMiddleware } from '../redux/middlewares/pre-order/attribute-based-shipping-option';
+
+const group = (...pks: number[]) => ({
+  attribute_based_shipping_options: pks.map((pk) => ({ pk })),
+  product_ids: [1]
+});
+
+const run = (attributeBasedShippingOptions: Record<string, unknown>) => {
+  const dispatch = jest.fn();
+  const action = { payload: { pre_order: {} } };
+  const next = jest.fn(() => action);
+
+  const result = (attributeBasedShippingOptionMiddleware as any)({
+    getState: () => ({ checkout: { attributeBasedShippingOptions } }),
+    dispatch
+  })(next)(action);
+
+  return { dispatch, result, action };
+};
+
+describe('attributeBasedShippingOptionMiddleware', () => {
+  beforeEach(() => {
+    mockInitiate.mockClear();
+  });
+
+  it('selects the first option of every group', () => {
+    const { dispatch, result } = run({
+      express: group(11, 12),
+      standart: group(21)
+    });
+
+    expect(mockInitiate).toHaveBeenCalledWith({ express: 11, standart: 21 });
+    expect(dispatch).toHaveBeenCalledTimes(1);
+    expect(result).toBeNull();
+  });
+
+  it('posts nothing when only some of the reported groups are selectable', () => {
+    // The backend rejects a selection that does not cover every group it
+    // reported, and that rejection leaves pre_order empty, which re-arms this
+    // middleware. Posting a partial map would loop.
+    const { dispatch, result, action } = run({
+      express: group(11),
+      None: group()
+    });
+
+    expect(mockInitiate).not.toHaveBeenCalled();
+    expect(dispatch).not.toHaveBeenCalled();
+    expect(result).toBe(action);
+  });
+
+  it('does not dispatch when no group has a selectable option at all', () => {
+    const { dispatch, result, action } = run({ None: group() });
+
+    expect(mockInitiate).not.toHaveBeenCalled();
+    expect(dispatch).not.toHaveBeenCalled();
+    expect(result).toBe(action);
+  });
+
+  it('leaves a malformed group alone instead of throwing', () => {
+    expect(() => run({ None: {} })).not.toThrow();
+    expect(mockInitiate).not.toHaveBeenCalled();
+  });
+
+  it('still posts when every reported group is selectable', () => {
+    const { dispatch } = run({ express: group(11), standart: group(21, 22) });
+
+    expect(mockInitiate).toHaveBeenCalledWith({ express: 11, standart: 21 });
+    expect(dispatch).toHaveBeenCalledTimes(1);
+  });
+});

package/__tests__/attribute-based-shipping-page.test.ts

@@ -0,0 +1,48 @@
+import {
+  getAttributeBasedShippingOptionUrl,
+  setAttributeBasedShippingPageName
+} from '../data/client/checkout';
+import { checkout } from '../data/urls';
+
+describe('attribute-based shipping option url', () => {
+  afterEach(() => {
+    setAttributeBasedShippingPageName(null);
+  });
+
+  it('falls back to the classic page when nothing has been reported', () => {
+    expect(getAttributeBasedShippingOptionUrl()).toBe(
+      checkout.setAttributeBasedShippingOption
+    );
+  });
+
+  it('posts to the page name the backend reported for the step', () => {
+    setAttributeBasedShippingPageName(
+      'RemoteAttributeBasedShippingOptionSelectionPage'
+    );
+
+    expect(getAttributeBasedShippingOptionUrl()).toBe(
+      '/orders/checkout/?page=RemoteAttributeBasedShippingOptionSelectionPage'
+    );
+  });
+
+  it('keeps the classic url when the reported name is the classic page', () => {
+    setAttributeBasedShippingPageName(
+      'AttributeBasedShippingOptionSelectionPage'
+    );
+
+    expect(getAttributeBasedShippingOptionUrl()).toBe(
+      checkout.setAttributeBasedShippingOption
+    );
+  });
+
+  it('returns to the fallback once the reported name is cleared', () => {
+    setAttributeBasedShippingPageName(
+      'RemoteAttributeBasedShippingOptionSelectionPage'
+    );
+    setAttributeBasedShippingPageName(undefined);
+
+    expect(getAttributeBasedShippingOptionUrl()).toBe(
+      checkout.setAttributeBasedShippingOption
+    );
+  });
+});

package/data/client/checkout.ts

@@ -145,6 +145,25 @@ const buildCheckoutRequestUrl = (
   return buildClientRequestUrl(effectivePath, options);
 };
 
+// Commerce serves the attribute-based shipping step under more than one page
+// name: the classic page and the remote variant, chosen by a dynamic setting we
+// cannot see from here. Remember the page name reported for that step so the
+// selection is posted back to the same page. contextListMiddleware is the only
+// place that sees context_list, so it writes the value here; an RTK Query
+// `query` callback is synchronous and cannot reach the store.
+let attributeBasedShippingPageName: string | null = null;
+
+export const setAttributeBasedShippingPageName = (pageName?: string | null) => {
+  attributeBasedShippingPageName = pageName ?? null;
+};
+
+export const getAttributeBasedShippingOptionUrl = () =>
+  attributeBasedShippingPageName
+    ? checkout.setAttributeBasedShippingOptionPage(
+        attributeBasedShippingPageName
+      )
+    : checkout.setAttributeBasedShippingOption;
+
 const completeMasterpassPayment = async (
   params: CompleteCreditCardParams,
   dispatch: AppDispatch,
@@ -1003,7 +1022,7 @@ export const checkoutApi = api.injectEndpoints({
       Record<string, number>
     >({
       query: (options) => ({
-        url: buildCheckoutRequestUrl(checkout.setAttributeBasedShippingOption, {
+        url: buildCheckoutRequestUrl(getAttributeBasedShippingOptionUrl(), {
           useFormData: true
         }),
         method: 'POST',
@@ -1013,8 +1032,11 @@ export const checkoutApi = api.injectEndpoints({
       }),
       async onQueryStarted(arg, { dispatch, queryFulfilled }) {
         dispatch(setShippingStepBusy(true));
-        await queryFulfilled;
-        dispatch(setShippingStepBusy(false));
+        try {
+          await queryFulfilled;
+        } finally {
+          dispatch(setShippingStepBusy(false));
+        }
       }
     }),
     setOrderSelectionPage: build.mutation<

package/data/urls.ts

@@ -139,6 +139,8 @@ export const checkout = {
   couponSelectionPage: '/orders/checkout/?page=CouponSelectionPage',
   setAttributeBasedShippingOption:
     '/orders/checkout/?page=AttributeBasedShippingOptionSelectionPage',
+  setAttributeBasedShippingOptionPage: (pageName: string) =>
+    `/orders/checkout/?page=${pageName}`,
   deliveryBagsPage: '/orders/checkout/?page=DeliveryBagsPage',
   setOrderSelectionPage: '/orders/checkout/?page=OrderSelectionPage',
   loyaltyCardPage: '/orders/checkout/?page=LoyaltyCardPage',

package/jest.config.js

@@ -12,7 +12,8 @@ module.exports = {
   roots: [path.resolve(__dirname)],
   transformIgnorePatterns: [],
   moduleNameMapper: {
-    '^settings$': path.resolve(baseDir, 'src/settings.js')
+    '^settings$': path.resolve(baseDir, 'src/settings.js'),
+    '^@theme/(.*)$': path.resolve(baseDir, 'src/$1')
   },
   transform: {
     '^.+\\.(tsx?|jsx?|mjs?)$': [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "1.126.14-v1-rc.10",
+  "version": "1.126.14",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -35,7 +35,7 @@
     "set-cookie-parser": "2.6.0"
   },
   "devDependencies": {
-    "@akinon/eslint-plugin-projectzero": "1.126.14-v1-rc.10",
+    "@akinon/eslint-plugin-projectzero": "1.126.14",
     "@babel/core": "7.26.10",
     "@babel/preset-env": "7.26.9",
     "@babel/preset-typescript": "7.27.0",

package/redux/middlewares/checkout.ts

@@ -25,7 +25,10 @@ import {
   setUnavailablePaymentOptions
 } from '../../redux/reducers/checkout';
 import { RootState, TypedDispatch } from 'redux/store';
-import { checkoutApi } from '../../data/client/checkout';
+import {
+  checkoutApi,
+  setAttributeBasedShippingPageName
+} from '../../data/client/checkout';
 import { CheckoutContext, PreOrder } from '../../types';
 import { getCookie } from '../../utils';
 import settings from 'settings';
@@ -171,6 +174,7 @@ export const contextListMiddleware: Middleware = ({
         }
 
         if (context.page_context.attribute_based_shipping_options) {
+          setAttributeBasedShippingPageName(context.page_name);
           dispatch(
             setAttributeBasedShippingOptions(
               context.page_context.attribute_based_shipping_options

package/redux/middlewares/pre-order/attribute-based-shipping-option.ts

@@ -21,12 +21,28 @@ export const attributeBasedShippingOptionMiddleware: Middleware = ({
       Object.keys(attributeBasedShippingOptions).length > 0 &&
       !preOrder.attribute_based_shipping_options
     ) {
-      const initialSelectedOptions: Record<string, number> = Object.fromEntries(
-        Object.entries(attributeBasedShippingOptions).map(([key, options]) => [
-          key,
-          options.attribute_based_shipping_options[0].pk
-        ])
-      );
+      // A group can come back without any option: the service logs it and still
+      // reports the group with an empty list, so indexing into it would throw
+      // inside the middleware chain and drop the whole checkout response.
+      const initialSelectedOptions: Record<string, number> = {};
+
+      Object.entries(attributeBasedShippingOptions).forEach(([key, group]) => {
+        const pk = group?.attribute_based_shipping_options?.[0]?.pk;
+
+        if (typeof pk === 'number') {
+          initialSelectedOptions[key] = pk;
+        }
+      });
+
+      // The backend rejects a selection that does not cover every group it
+      // reported, and the rejection leaves pre_order empty, which brings us
+      // straight back here. Post nothing rather than start that loop.
+      if (
+        Object.keys(initialSelectedOptions).length !==
+        Object.keys(attributeBasedShippingOptions).length
+      ) {
+        return result;
+      }
 
       dispatch(
         apiEndpoints.setAttributeBasedShippingOptions.initiate(