@graphcommerce/magento-cart-payment-method 10.1.0-canary.7 → 11.0.0-canary.45

package/CHANGELOG.md

@@ -1,5 +1,87 @@
 # Change Log
 
+## 11.0.0-canary.45
+
+## 10.1.0-canary.44
+
+## 10.1.0-canary.43
+
+### Patch Changes
+
+- [#2667](https://github.com/graphcommerce-org/graphcommerce/pull/2667) [`6ee8488`](https://github.com/graphcommerce-org/graphcommerce/commit/6ee84883ece679b4fd4ed191ecd00a9ec39cc206) - Give `useClearCurrentCartId()` and `useCartLock()`'s `lock`/`unlock` a stable function identity, so consumers can list them in a `useEffect` dependency array without the effect re-running on every render.
+
+  `useClearCurrentCartId` returned a bare arrow function and `useCartLock` defined `lock`/`unlock` inline, while the neighbouring `useAssignCurrentCartId` already returned a `useCallback`. `useClearCurrentCartId` now uses `useCallback` with the Apollo `cache` as its only dependency (matching `useAssignCurrentCartId`), and `lock`/`unlock` use `useEventCallback` because they read values that legitimately change (`currentCartId`, the router query state and the Apollo client) — `useEventCallback` keeps the identity stable while always reading the latest values, so no stale closure is introduced. ([@paales](https://github.com/paales))
+
+## 10.1.0-canary.42
+
+## 10.1.0-canary.41
+
+## 10.1.0-canary.40
+
+## 10.1.0-canary.39
+
+## 10.1.0-canary.38
+
+## 10.1.0-canary.37
+
+## 10.1.0-canary.36
+
+## 10.1.0-canary.35
+
+## 10.1.0-canary.34
+
+## 10.1.0-canary.33
+
+## 10.1.0-canary.32
+
+## 10.1.0-canary.31
+
+## 10.1.0-canary.30
+
+## 10.1.0-canary.29
+
+## 10.1.0-canary.28
+
+## 10.1.0-canary.27
+
+## 10.1.0-canary.26
+
+## 10.1.0-canary.25
+
+## 10.1.0-canary.24
+
+## 10.1.0-canary.23
+
+## 10.1.0-canary.22
+
+## 10.1.0-canary.21
+
+## 10.1.0-canary.20
+
+## 10.1.0-canary.19
+
+## 10.1.0-canary.18
+
+## 10.1.0-canary.17
+
+## 10.1.0-canary.16
+
+## 10.1.0-canary.15
+
+## 10.1.0-canary.14
+
+## 10.1.0-canary.13
+
+## 10.1.0-canary.12
+
+## 10.1.0-canary.11
+
+## 10.1.0-canary.10
+
+## 10.1.0-canary.9
+
+## 10.1.0-canary.8
+
 ## 10.1.0-canary.7
 
 ## 10.1.0-canary.6

package/hooks/useCartLock.ts

@@ -1,6 +1,7 @@
 import { useApolloClient } from '@graphcommerce/graphql'
 import { cartLock, useCurrentCartId } from '@graphcommerce/magento-cart'
 import { useUrlQuery } from '@graphcommerce/next-ui'
+import { useEventCallback } from '@mui/material'
 import { useEffect, useState } from 'react'
 
 export type CartLockState = {
@@ -37,7 +38,13 @@ export function useCartLock<E extends CartLockState>() {
     }
   })
 
-  const lock = (params: Omit<E, 'locked' | 'cart_id'>) => {
+  /**
+   * `lock` and `unlock` are wrapped in `useEventCallback` so they keep a stable identity across
+   * renders while still reading the latest `currentCartId`, `queryState` and `client`. This allows
+   * consumers to add them to their `useEffect` dependency arrays without re-running the effect on
+   * every render.
+   */
+  const lock = useEventCallback((params: Omit<E, 'locked' | 'cart_id'>) => {
     if (!currentCartId) return undefined
     justLocked = true
     cartLock(client.cache, true)
@@ -46,13 +53,13 @@ export function useCartLock<E extends CartLockState>() {
       cart_id: currentCartId,
       ...params,
     } as unknown as E)
-  }
+  })
 
-  const unlock = async (params: Omit<E, 'locked' | 'cart_id' | 'method'>) => {
+  const unlock = useEventCallback(async (params: Omit<E, 'locked' | 'cart_id' | 'method'>) => {
     cartLock(client.cache, false)
     await setRouterQuery({ cart_id: null, locked: null, method: null, ...params } as E)
     return queryState
-  }
+  })
 
   const resulting: Omit<E, 'locked'> & { locked: boolean; justLocked: boolean } = {
     ...queryState,

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/magento-cart-payment-method",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "10.1.0-canary.7",
+  "version": "11.0.0-canary.45",
   "sideEffects": false,
   "prettier": "@graphcommerce/prettier-config-pwa",
   "eslintConfig": {
@@ -18,18 +18,18 @@
     "./PaymentMethodPlaceOrderNoop/PaymentMethodPlaceOrderNoop": "./PaymentMethodPlaceOrderNoop/PaymentMethodPlaceOrderNoop.tsx"
   },
   "peerDependencies": {
-    "@graphcommerce/ecommerce-ui": "^10.1.0-canary.7",
-    "@graphcommerce/eslint-config-pwa": "^10.1.0-canary.7",
-    "@graphcommerce/framer-scroller": "^10.1.0-canary.7",
-    "@graphcommerce/graphql": "^10.1.0-canary.7",
-    "@graphcommerce/image": "^10.1.0-canary.7",
-    "@graphcommerce/magento-cart": "^10.1.0-canary.7",
-    "@graphcommerce/magento-cart-shipping-address": "^10.1.0-canary.7",
-    "@graphcommerce/magento-store": "^10.1.0-canary.7",
-    "@graphcommerce/next-ui": "^10.1.0-canary.7",
-    "@graphcommerce/prettier-config-pwa": "^10.1.0-canary.7",
-    "@graphcommerce/react-hook-form": "^10.1.0-canary.7",
-    "@graphcommerce/typescript-config-pwa": "^10.1.0-canary.7",
+    "@graphcommerce/ecommerce-ui": "^11.0.0-canary.45",
+    "@graphcommerce/eslint-config-pwa": "^11.0.0-canary.45",
+    "@graphcommerce/framer-scroller": "^11.0.0-canary.45",
+    "@graphcommerce/graphql": "^11.0.0-canary.45",
+    "@graphcommerce/image": "^11.0.0-canary.45",
+    "@graphcommerce/magento-cart": "^11.0.0-canary.45",
+    "@graphcommerce/magento-cart-shipping-address": "^11.0.0-canary.45",
+    "@graphcommerce/magento-store": "^11.0.0-canary.45",
+    "@graphcommerce/next-ui": "^11.0.0-canary.45",
+    "@graphcommerce/prettier-config-pwa": "^11.0.0-canary.45",
+    "@graphcommerce/react-hook-form": "^11.0.0-canary.45",
+    "@graphcommerce/typescript-config-pwa": "^11.0.0-canary.45",
     "@lingui/core": "^5",
     "@lingui/macro": "^5",
     "@lingui/react": "^5",