woocommerce/plugins/woocommerce-blocks/assets/js/middleware/cart-update.ts

46 lines
1.2 KiB
TypeScript
Raw Normal View History

Ensure cart changes remain after using back button to get back to the cart (https://github.com/woocommerce/woocommerce-blocks/pull/3960) * Add cartUpdate middleware * Include timestamp for when cart data was generated * Add getCartFromApi action * Check whether cart can be hydrated or needs to be fetched from API * Add cartDataIsStale action and remove getCartFromApi action * Add isCartDataStale selector * Don't load cart until staleness check is complete * Add comment to ease worry about locaStorage execution * Correct doc block and fix typographical error * Cater for lastCartUpdate or the timestamp being undefined * Include @woocommerce/api and @woocommerce/e2e-utils * Add getNormalPagePermalink test utility This will allow us to get the permalink of a "normal" page, i.e. one that is not using the block editor. * Add getBlockPagePermalink test utility This will get the permalink for a page using the Block editor. * Emit action to update cart staleness in all execution paths * Add visitPostOfType function This will allow us to visit the editor page for a post based on its name and post type. * Add functions to get permalinks from editor pages * Add front-end tests for cart * Update package-lock.json * Create local function to ensure the page permalink is visible * Change functions for getting permalinks They were often failing for unknown reasons, these _somehow_ make them more stable. * Add logging for GitHub actions * Add more logging for tests * Add more logging for tests * Add more logging for tests * Wait for networkidle on back * Remove logging except timestamp * Wait for timestamp to be added to localStorage * Split tests to make runs slightly shorter * Wait for add to cart request before continuing test * Fix formatting in cart.test.js * Rename cartDataStale to setIsCartDataStale * Create constant for localStorage timestamp name * Rename cartDataIsStale to isCartDataStale This is for consistency, the action to change this is called setIsCartDataStale - I think this reads better. * Use cleaner logic when determining if the cart should render or fetch * Change docblock for isCartDataStale selector * Remove boolean cast from SET_IS_CART_DATA_STALE reducer * Set longer timeouts for frontend cart tests * Enclose cart staleness checks in condition/prevent unnecessary execution * Remove unnecessary boolean cast from selector * Use constant for local storage key in tests * Use new localstorage key in tests. cant access constants in page context
2021-03-24 13:28:11 +00:00
/**
* External dependencies
*/
import apiFetch, { APIFetchOptions } from '@wordpress/api-fetch';
/**
* Internal dependencies
*/
import { LAST_CART_UPDATE_TIMESTAMP_KEY } from '../data/cart/constants';
/**
* Checks if this request is a POST to the wc/store/cart endpoint.
*/
const isCartUpdatePostRequest = ( options: APIFetchOptions ) => {
const url = options.url || options.path;
if ( ! url || ! options.method || options.method !== 'POST' ) {
return false;
}
return /wc\/store\/cart\//.exec( url ) !== null;
};
/**
* Middleware which saves the time that the cart was last modified in
* the browser's Local Storage
*
* @param {Object} options Fetch options.
* @param {Function} next The next middleware or fetchHandler to call.
*
* @return {*} The evaluated result of the remaining middleware chain.
*/
const cartUpdateMiddleware = (
options: APIFetchOptions,
/* eslint-disable @typescript-eslint/no-explicit-any */
next: ( arg0: APIFetchOptions, arg1: any ) => any
) => {
if ( isCartUpdatePostRequest( options ) ) {
window.localStorage.setItem(
LAST_CART_UPDATE_TIMESTAMP_KEY,
( Date.now() / 1000 ).toString()
);
}
return next( options, next );
};
apiFetch.use( cartUpdateMiddleware );