2019-10-28 13:53:09 +00:00
|
|
|
/**
|
|
|
|
* External dependencies
|
|
|
|
*/
|
2022-03-10 13:22:05 +00:00
|
|
|
import { controls } from '@wordpress/data';
|
2019-10-28 13:53:09 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Internal dependencies
|
|
|
|
*/
|
|
|
|
import { getCollection, getCollectionHeader } from '../resolvers';
|
|
|
|
import { receiveCollection } from '../actions';
|
|
|
|
import { STORE_KEY as SCHEMA_STORE_KEY } from '../../schema/constants';
|
|
|
|
import { STORE_KEY } from '../constants';
|
Add notice on quantity change and update `wc/store/cart` to use thunks (https://github.com/woocommerce/woocommerce-blocks/pull/7938)
* Add receiveCart thunk
* Add mapCartResponseToCart helper
* Add getItemsPendingQuantityUpdate selector
* Update cart resolvers to be thunks
* Remove RECEIVE_CART action and replace with SET_CART_DATA
receiveCart will turn into a thunk.
* Add notifyQuantityChanges functions
* Remove receiveCart from action type definition, replace with setCartData
* Move apiFetchWithHeaders out of controls
This will just be a normal function since we'll be updating actions to thunks which will use this instead of a control.
* Include thunks in actions file
* Update receiveCart action to setCartData
* Update applyCoupon action to a thunk
* Update useStoreCartCoupons to get action from correct place
* Update StoreCartCoupon types
* Add types for Thunk and ThunkReturnType in mapped-types
* Change applyCoupon to a thunk
* Get applyCoupon, removeCoupon, receiveApplyingCoupon from useDispatch
This is to separate the concerns of actions vs. selectors. Previously the actions were fetched during useSelect which is not a pattern we use anywhere else in the codebase. Since we updated the MapToDispatch type, we can now get correctly typed thunks from the data store.
* Improve apiFetchWithHeaders typings
* Convert removeCoupon from generator to thunk
* Add applyCoupon and removeCoupon to CartAction type
* Remove unused old-style type-def
* Add receiveApplyingCoupon & receiveRemovingCoupon to StoreCartCoupon
* Correct issues with StoreCartCoupon type
These were not intended to reflect the actions in data store, rather the functions offered by the useStoreCartCoupons hook.
* Update applyExtensionCartUpdate to a thunk
* Update addItemToCart to thunk
* Add ResolveSelectFromMap type that works with thunks
* Add CartDispatchFromMap and CartResolveSelectFromMap types
We can add this to all data stores to get them working with thunks properly.
* Add docs and update generic name in ResolveSelectFromMap
* Add correct types for thunk resolvers in cart data store
* Update removeItemFromCart to thunk
* Update apiFetchWithHeaders to use generic
* Update selectShippingRate to thunk
* Update resolver tests to test correct thunk functionality
* Update updateCustomerData to thunk
* Update reducer test to reflect new action name
* Update comments on CartDispatchFromMap and CartResolveSelectFromMap
* Add quantity_limits to preview cart
* Make notices speak when shown
* Remove copilot comment
* Add isWithinQuantityLimits function
This is because we shouldn't show a notice if the quantity limits change, but the item's quantity is still OK.
* Add tests for notifyQuantityChanges
* Show notice when multiple_of is updated
* Update test to test for multiple_of changes
* Remove empty export
* Remove controls from cart data store
Not needed anymore since the exported value from the shared-controls file was empty.
* Export a control and async function for apiFetchWithHeaders
This is required because async functions cannot be called from sync generators.
* Use control version of apiFetchWithHeaders in the collections store
* Improve comments and remove incorrect TypeScript
* Update assets/js/data/cart/actions.ts
Co-authored-by: Mike Jolley <mike.jolley@me.com>
* Update ResolveSelectFromMap to include selectors too
* Update TS in actions
* Use finally to remove duplicate code
* remove item pending delete/qty update after action runs in all cases
This will also reset the state when the request to remove it/change quantity errors
* Remove unnecessary type from param.
Not needed because we have TS now. The description can stay though, it is useful.
* Update snackbar wording to use active voice
* Remove old WP version check
* Set max quantity to high number instead of null
This would only happen in a niche case, and would require several TS changes to fix, so it's better to set it as a number here. 9999 should be high enough, and is the default quantity limit set below in get_product_quantity_limit
* Set code on woocommerce_rest_cart_invalid_key to 409
This is so the cart is returned in the response, so the client can update.
* Fix typo in comment and add CartSelectFromMap
* Remove unnecessary docblock
* Add getItemsPendingDelete selector
This is needed so we can show a notice for items that are unexpectedly removed from the cart. We need to know which ones are pending delete so we can skip showing the notice for them.
* Add type for notifyQuantityChanges args and change args to object
* Add notifyIfRemoved function
This will check items that have been removed and show a notice for them.
* Fix TS in receiveCart & pass itemsPendingDelete to notifyQuantiyChanges
* Update wording on removal notice
* Update types for notifyQuantityChanges args
* Update tests to reflect new wording and args being an object
* Check item is truth before running comparison of keys
* Update tests for unexpectedly and expectedly removed items
* Ignore print_r to satisfy phpcs
* Update PHP tests to reflect correct response code when deleting items
* Remove unnecessary controls and dispatch events directly from thunk
Co-authored-by: Mike Jolley <mike.jolley@me.com>
2022-12-16 16:06:37 +00:00
|
|
|
import { apiFetchWithHeadersControl } from '../../shared-controls';
|
2019-10-28 13:53:09 +00:00
|
|
|
|
2022-03-10 13:22:05 +00:00
|
|
|
jest.mock( '@wordpress/data' );
|
2019-10-28 13:53:09 +00:00
|
|
|
|
|
|
|
describe( 'getCollection', () => {
|
|
|
|
describe( 'yields with expected responses', () => {
|
|
|
|
let fulfillment;
|
|
|
|
const testArgs = [
|
|
|
|
'wc/blocks',
|
|
|
|
'products',
|
|
|
|
{ foo: 'bar' },
|
|
|
|
[ 20, 30 ],
|
|
|
|
];
|
|
|
|
const rewind = () => ( fulfillment = getCollection( ...testArgs ) );
|
|
|
|
test( 'with getRoute call invoked to retrieve route', () => {
|
|
|
|
rewind();
|
|
|
|
fulfillment.next();
|
2022-03-10 13:22:05 +00:00
|
|
|
expect( controls.resolveSelect ).toHaveBeenCalledWith(
|
2019-10-28 13:53:09 +00:00
|
|
|
SCHEMA_STORE_KEY,
|
|
|
|
'getRoute',
|
|
|
|
testArgs[ 0 ],
|
|
|
|
testArgs[ 1 ],
|
|
|
|
testArgs[ 3 ]
|
|
|
|
);
|
|
|
|
} );
|
|
|
|
test(
|
|
|
|
'when no route is retrieved, yields receiveCollection and ' +
|
|
|
|
'returns',
|
|
|
|
() => {
|
|
|
|
const { value } = fulfillment.next();
|
|
|
|
const expected = receiveCollection(
|
|
|
|
'wc/blocks',
|
|
|
|
'products',
|
|
|
|
'?foo=bar',
|
|
|
|
[ 20, 30 ],
|
|
|
|
{
|
|
|
|
items: [],
|
|
|
|
headers: {
|
|
|
|
get: () => undefined,
|
|
|
|
has: () => undefined,
|
|
|
|
},
|
|
|
|
}
|
|
|
|
);
|
|
|
|
expect( value.type ).toBe( expected.type );
|
|
|
|
expect( value.namespace ).toBe( expected.namespace );
|
2019-11-14 16:10:50 +00:00
|
|
|
expect( value.resourceName ).toBe( expected.resourceName );
|
2019-10-28 13:53:09 +00:00
|
|
|
expect( value.queryString ).toBe( expected.queryString );
|
|
|
|
expect( value.ids ).toEqual( expected.ids );
|
|
|
|
expect( Object.keys( value.response ) ).toEqual(
|
|
|
|
Object.keys( expected.response )
|
|
|
|
);
|
|
|
|
const { done } = fulfillment.next();
|
|
|
|
expect( done ).toBe( true );
|
|
|
|
}
|
|
|
|
);
|
|
|
|
test(
|
|
|
|
'when route is retrieved, yields apiFetchWithHeaders control action with ' +
|
|
|
|
'expected route',
|
|
|
|
() => {
|
|
|
|
rewind();
|
|
|
|
fulfillment.next();
|
|
|
|
const { value } = fulfillment.next( 'https://example.org' );
|
|
|
|
expect( value ).toEqual(
|
Add notice on quantity change and update `wc/store/cart` to use thunks (https://github.com/woocommerce/woocommerce-blocks/pull/7938)
* Add receiveCart thunk
* Add mapCartResponseToCart helper
* Add getItemsPendingQuantityUpdate selector
* Update cart resolvers to be thunks
* Remove RECEIVE_CART action and replace with SET_CART_DATA
receiveCart will turn into a thunk.
* Add notifyQuantityChanges functions
* Remove receiveCart from action type definition, replace with setCartData
* Move apiFetchWithHeaders out of controls
This will just be a normal function since we'll be updating actions to thunks which will use this instead of a control.
* Include thunks in actions file
* Update receiveCart action to setCartData
* Update applyCoupon action to a thunk
* Update useStoreCartCoupons to get action from correct place
* Update StoreCartCoupon types
* Add types for Thunk and ThunkReturnType in mapped-types
* Change applyCoupon to a thunk
* Get applyCoupon, removeCoupon, receiveApplyingCoupon from useDispatch
This is to separate the concerns of actions vs. selectors. Previously the actions were fetched during useSelect which is not a pattern we use anywhere else in the codebase. Since we updated the MapToDispatch type, we can now get correctly typed thunks from the data store.
* Improve apiFetchWithHeaders typings
* Convert removeCoupon from generator to thunk
* Add applyCoupon and removeCoupon to CartAction type
* Remove unused old-style type-def
* Add receiveApplyingCoupon & receiveRemovingCoupon to StoreCartCoupon
* Correct issues with StoreCartCoupon type
These were not intended to reflect the actions in data store, rather the functions offered by the useStoreCartCoupons hook.
* Update applyExtensionCartUpdate to a thunk
* Update addItemToCart to thunk
* Add ResolveSelectFromMap type that works with thunks
* Add CartDispatchFromMap and CartResolveSelectFromMap types
We can add this to all data stores to get them working with thunks properly.
* Add docs and update generic name in ResolveSelectFromMap
* Add correct types for thunk resolvers in cart data store
* Update removeItemFromCart to thunk
* Update apiFetchWithHeaders to use generic
* Update selectShippingRate to thunk
* Update resolver tests to test correct thunk functionality
* Update updateCustomerData to thunk
* Update reducer test to reflect new action name
* Update comments on CartDispatchFromMap and CartResolveSelectFromMap
* Add quantity_limits to preview cart
* Make notices speak when shown
* Remove copilot comment
* Add isWithinQuantityLimits function
This is because we shouldn't show a notice if the quantity limits change, but the item's quantity is still OK.
* Add tests for notifyQuantityChanges
* Show notice when multiple_of is updated
* Update test to test for multiple_of changes
* Remove empty export
* Remove controls from cart data store
Not needed anymore since the exported value from the shared-controls file was empty.
* Export a control and async function for apiFetchWithHeaders
This is required because async functions cannot be called from sync generators.
* Use control version of apiFetchWithHeaders in the collections store
* Improve comments and remove incorrect TypeScript
* Update assets/js/data/cart/actions.ts
Co-authored-by: Mike Jolley <mike.jolley@me.com>
* Update ResolveSelectFromMap to include selectors too
* Update TS in actions
* Use finally to remove duplicate code
* remove item pending delete/qty update after action runs in all cases
This will also reset the state when the request to remove it/change quantity errors
* Remove unnecessary type from param.
Not needed because we have TS now. The description can stay though, it is useful.
* Update snackbar wording to use active voice
* Remove old WP version check
* Set max quantity to high number instead of null
This would only happen in a niche case, and would require several TS changes to fix, so it's better to set it as a number here. 9999 should be high enough, and is the default quantity limit set below in get_product_quantity_limit
* Set code on woocommerce_rest_cart_invalid_key to 409
This is so the cart is returned in the response, so the client can update.
* Fix typo in comment and add CartSelectFromMap
* Remove unnecessary docblock
* Add getItemsPendingDelete selector
This is needed so we can show a notice for items that are unexpectedly removed from the cart. We need to know which ones are pending delete so we can skip showing the notice for them.
* Add type for notifyQuantityChanges args and change args to object
* Add notifyIfRemoved function
This will check items that have been removed and show a notice for them.
* Fix TS in receiveCart & pass itemsPendingDelete to notifyQuantiyChanges
* Update wording on removal notice
* Update types for notifyQuantityChanges args
* Update tests to reflect new wording and args being an object
* Check item is truth before running comparison of keys
* Update tests for unexpectedly and expectedly removed items
* Ignore print_r to satisfy phpcs
* Update PHP tests to reflect correct response code when deleting items
* Remove unnecessary controls and dispatch events directly from thunk
Co-authored-by: Mike Jolley <mike.jolley@me.com>
2022-12-16 16:06:37 +00:00
|
|
|
apiFetchWithHeadersControl( {
|
2020-03-19 11:50:51 +00:00
|
|
|
path: 'https://example.org?foo=bar',
|
|
|
|
} )
|
2019-10-28 13:53:09 +00:00
|
|
|
);
|
|
|
|
}
|
|
|
|
);
|
|
|
|
test(
|
|
|
|
'when apiFetchWithHeaders does not return a valid response, ' +
|
|
|
|
'yields expected action',
|
|
|
|
() => {
|
|
|
|
const { value } = fulfillment.next( {} );
|
|
|
|
expect( value ).toEqual(
|
|
|
|
receiveCollection(
|
|
|
|
'wc/blocks',
|
|
|
|
'products',
|
|
|
|
'?foo=bar',
|
|
|
|
[ 20, 30 ],
|
2020-03-03 10:26:02 +00:00
|
|
|
{ items: [], headers: undefined }
|
2019-10-28 13:53:09 +00:00
|
|
|
)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
);
|
|
|
|
test(
|
|
|
|
'when apiFetch returns a valid response, yields expected ' +
|
|
|
|
'action',
|
|
|
|
() => {
|
|
|
|
rewind();
|
|
|
|
fulfillment.next();
|
|
|
|
fulfillment.next( 'https://example.org' );
|
|
|
|
const { value } = fulfillment.next( {
|
2020-03-19 11:50:51 +00:00
|
|
|
response: [ '42', 'cheeseburgers' ],
|
2019-10-28 13:53:09 +00:00
|
|
|
headers: { foo: 'bar' },
|
|
|
|
} );
|
|
|
|
expect( value ).toEqual(
|
|
|
|
receiveCollection(
|
|
|
|
'wc/blocks',
|
|
|
|
'products',
|
|
|
|
'?foo=bar',
|
|
|
|
[ 20, 30 ],
|
|
|
|
{
|
|
|
|
items: [ '42', 'cheeseburgers' ],
|
|
|
|
headers: { foo: 'bar' },
|
|
|
|
}
|
|
|
|
)
|
|
|
|
);
|
|
|
|
const { done } = fulfillment.next();
|
|
|
|
expect( done ).toBe( true );
|
|
|
|
}
|
|
|
|
);
|
|
|
|
} );
|
|
|
|
} );
|
|
|
|
|
|
|
|
describe( 'getCollectionHeader', () => {
|
|
|
|
let fulfillment;
|
|
|
|
const rewind = ( ...testArgs ) =>
|
|
|
|
( fulfillment = getCollectionHeader( ...testArgs ) );
|
|
|
|
it( 'yields expected select control when called with less args', () => {
|
|
|
|
rewind( 'x-wp-total', '/wc/blocks', 'products' );
|
|
|
|
const { value } = fulfillment.next();
|
|
|
|
expect( value ).toEqual(
|
2022-03-10 13:22:05 +00:00
|
|
|
controls.resolveSelect(
|
|
|
|
STORE_KEY,
|
|
|
|
'getCollection',
|
|
|
|
'/wc/blocks',
|
|
|
|
'products'
|
|
|
|
)
|
2019-10-28 13:53:09 +00:00
|
|
|
);
|
|
|
|
} );
|
|
|
|
it( 'yields expected select control when called with all args', () => {
|
|
|
|
const args = [
|
|
|
|
'x-wp-total',
|
|
|
|
'/wc/blocks',
|
|
|
|
'products/attributes',
|
|
|
|
{ sort: 'ASC' },
|
|
|
|
[ 10 ],
|
|
|
|
];
|
|
|
|
rewind( ...args );
|
|
|
|
const { value } = fulfillment.next();
|
|
|
|
expect( value ).toEqual(
|
2022-03-10 13:22:05 +00:00
|
|
|
controls.resolveSelect(
|
2019-10-28 13:53:09 +00:00
|
|
|
STORE_KEY,
|
|
|
|
'/wc/blocks',
|
|
|
|
'products/attributes',
|
|
|
|
{ sort: 'ASC' },
|
|
|
|
[ 10 ]
|
|
|
|
)
|
|
|
|
);
|
|
|
|
const { done } = fulfillment.next();
|
|
|
|
expect( done ).toBe( true );
|
|
|
|
} );
|
|
|
|
} );
|