Store API: Introduce API Versioning System (#5911)

* Fix missing dependency * Min version exceeds required 5.6 * Move exceptions * Move schemas under V1 namespace * Move routes to v1 * Move RouteException * Route versioning * Update route and schema identifiers/init * Rework route init to support multiple versions and multiple schema * Tests for cart routes * Cart coupons tests * Batch * extensions * Update docs * Update remaining tests * woocommerce_store_api_route_version was unused * Revert unrelated change * Fix phpcs * Update src/StoreApi/docs/guiding-principles.md Co-authored-by: Thomas Roberts <[email protected]> * Update src/StoreApi/docs/cart-items.md Co-authored-by: Thomas Roberts <[email protected]> * Update src/StoreApi/RoutesController.php Co-authored-by: Thomas Roberts <[email protected]> * Note about v1 unversioned endpoints * Remove unused get_route_version * 409 comment in tests * Remove copy pasted comments * Update all usage to v1 * Correct namespace * More v1 namespaces * More missing v1 * fix mocks Co-authored-by: Thomas Roberts <[email protected]>
woocommerce · Feb 26, 2022 · 5ce7558 · 5ce7558
1 parent 60dfe4b
commit 5ce7558
Show file tree

Hide file tree

Showing 130 changed files with 3,519 additions and 3,530 deletions.
diff --git a/assets/js/base/context/hooks/cart/use-store-cart.ts b/assets/js/base/context/hooks/cart/use-store-cart.ts
@@ -119,7 +119,7 @@ export const defaultCartData: StoreCart = {
 };
 
 /**
- * This is a custom hook that is wired up to the `wc/store/cart` data
+ * This is a custom hook that is wired up to the `wc/store/v1/cart` data
  * store.
  *
  * @param {Object} options                An object declaring the various

diff --git a/assets/js/base/context/hooks/collections/use-collection-data.js b/assets/js/base/context/hooks/collections/use-collection-data.js
@@ -125,7 +125,7 @@ export const useCollectionData = ( {
 	}, [ collectionDataQueryState ] );
 
 	return useCollection( {
-		namespace: '/wc/store',
+		namespace: '/wc/store/v1',
 		resourceName: 'products/collection-data',
 		query: {
 			...queryState,

diff --git a/assets/js/base/context/hooks/use-store-products.ts b/assets/js/base/context/hooks/use-store-products.ts
@@ -9,7 +9,7 @@ import { useCollectionHeader, useCollection } from './collections';
 
 /**
  * This is a custom hook that is wired up to the `wc/store/collections` data
- * store for the `wc/store/products` route. Given a query object, this
+ * store for the `wc/store/v1/products` route. Given a query object, this
  * will ensure a component is kept up to date with the products matching that
  * query in the store state.
  *
@@ -32,7 +32,7 @@ export const useStoreProducts = (
 	productsLoading: boolean;
 } => {
 	const collectionOptions = {
-		namespace: '/wc/store',
+		namespace: '/wc/store/v1',
 		resourceName: 'products',
 	};
 	const { results: products, isLoading: productsLoading } = useCollection( {

diff --git a/assets/js/base/context/providers/add-to-cart-form/form/submit/index.js b/assets/js/base/context/providers/add-to-cart-form/form/submit/index.js
@@ -72,7 +72,7 @@ const FormSubmit = () => {
 		};
 
 		triggerFetch( {
-			path: '/wc/store/cart/add-item',
+			path: '/wc/store/v1/cart/add-item',
 			method: 'POST',
 			data: fetchData,
 			cache: 'no-store',

diff --git a/assets/js/base/context/providers/cart-checkout/checkout-processor.js b/assets/js/base/context/providers/cart-checkout/checkout-processor.js
@@ -195,7 +195,7 @@ const CheckoutProcessor = () => {
 		};
 
 		triggerFetch( {
-			path: '/wc/store/checkout',
+			path: '/wc/store/v1/checkout',
 			method: 'POST',
 			data,
 			cache: 'no-store',

diff --git a/.../base/context/providers/cart-checkout/payment-methods/test/payment-method-data-context.js b/.../base/context/providers/cart-checkout/payment-methods/test/payment-method-data-context.js
@@ -130,7 +130,7 @@ describe( 'Testing Payment Method Data Context Provider', () => {
 			registerMockPaymentMethods( false );
 
 			fetchMock.mockResponse( ( req ) => {
-				if ( req.url.match( /wc\/store\/cart/ ) ) {
+				if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 					return Promise.resolve( JSON.stringify( previewCart ) );
 				}
 				return Promise.resolve( '' );
@@ -220,7 +220,7 @@ describe( 'Testing Payment Method Data Context Provider with saved cards turned
 			registerMockPaymentMethods( true );
 
 			fetchMock.mockResponse( ( req ) => {
-				if ( req.url.match( /wc\/store\/cart/ ) ) {
+				if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 					return Promise.resolve( JSON.stringify( previewCart ) );
 				}
 				return Promise.resolve( '' );

diff --git a/assets/js/blocks/active-filters/active-attribute-filters.js b/assets/js/blocks/active-filters/active-attribute-filters.js
@@ -30,7 +30,7 @@ const ActiveAttributeFilters = ( {
 	displayStyle,
 } ) => {
 	const { results, isLoading } = useCollection( {
-		namespace: '/wc/store',
+		namespace: '/wc/store/v1',
 		resourceName: 'products/attributes/terms',
 		resourceValues: [ attributeObject.id ],
 	} );

diff --git a/assets/js/blocks/attribute-filter/block.js b/assets/js/blocks/attribute-filter/block.js
@@ -64,7 +64,7 @@ const AttributeFilterBlock = ( {
 		results: attributeTerms,
 		isLoading: attributeTermsLoading,
 	} = useCollection( {
-		namespace: '/wc/store',
+		namespace: '/wc/store/v1',
 		resourceName: 'products/attributes/terms',
 		resourceValues: [ attributeObject?.id || 0 ],
 		shouldSelect: blockAttributes.attributeId > 0,

diff --git a/assets/js/blocks/cart-checkout/cart/test/block.js b/assets/js/blocks/cart-checkout/cart/test/block.js
@@ -67,7 +67,7 @@ describe( 'Testing cart', () => {
 	beforeEach( () => {
 		act( () => {
 			fetchMock.mockResponse( ( req ) => {
-				if ( req.url.match( /wc\/store\/cart/ ) ) {
+				if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 					return Promise.resolve( JSON.stringify( previewCart ) );
 				}
 				return Promise.resolve( '' );
@@ -134,7 +134,7 @@ describe( 'Testing cart', () => {
 
 	it( 'renders empty cart if there are no items in the cart', async () => {
 		fetchMock.mockResponse( ( req ) => {
-			if ( req.url.match( /wc\/store\/cart/ ) ) {
+			if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 				return Promise.resolve(
 					JSON.stringify( defaultCartState.cartData )
 				);
@@ -150,7 +150,7 @@ describe( 'Testing cart', () => {
 
 	it( 'renders correct cart line subtotal when currency has 0 decimals', async () => {
 		fetchMock.mockResponse( ( req ) => {
-			if ( req.url.match( /wc\/store\/cart/ ) ) {
+			if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 				const cart = {
 					...previewCart,
 					// Make it so there is only one item to simplify things.

diff --git a/assets/js/blocks/cart-checkout/mini-cart/test/block.js b/assets/js/blocks/cart-checkout/mini-cart/test/block.js
@@ -32,7 +32,7 @@ const MiniCartBlock = ( props ) => (
 
 const mockEmptyCart = () => {
 	fetchMock.mockResponse( ( req ) => {
-		if ( req.url.match( /wc\/store\/cart/ ) ) {
+		if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 			return Promise.resolve(
 				JSON.stringify( defaultCartState.cartData )
 			);
@@ -43,7 +43,7 @@ const mockEmptyCart = () => {
 
 const mockFullCart = () => {
 	fetchMock.mockResponse( ( req ) => {
-		if ( req.url.match( /wc\/store\/cart/ ) ) {
+		if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 			return Promise.resolve( JSON.stringify( previewCart ) );
 		}
 		return Promise.resolve( '' );

diff --git a/assets/js/blocks/cart-checkout/payment-methods/test/payment-methods.js b/assets/js/blocks/cart-checkout/payment-methods/test/payment-methods.js
@@ -70,7 +70,7 @@ const resetMockPaymentMethods = () => {
 describe( 'PaymentMethods', () => {
 	beforeEach( () => {
 		fetchMock.mockResponse( ( req ) => {
-			if ( req.url.match( /wc\/store\/cart/ ) ) {
+			if ( req.url.match( /wc\/store\/v1\/cart/ ) ) {
 				return Promise.resolve( JSON.stringify( previewCart ) );
 			}
 			return Promise.resolve( '' );

diff --git a/assets/js/blocks/reviews/utils.js b/assets/js/blocks/reviews/utils.js
@@ -32,7 +32,7 @@ export const getSortArgs = ( sortValue ) => {
 export const getReviews = ( args ) => {
 	return apiFetch( {
 		path:
-			'/wc/store/products/reviews?' +
+			'/wc/store/v1/products/reviews?' +
 			Object.entries( args )
 				.map( ( arg ) => arg.join( '=' ) )
 				.join( '&' ),

diff --git a/assets/js/data/cart/actions.ts b/assets/js/data/cart/actions.ts
@@ -221,7 +221,7 @@ export function* applyExtensionCartUpdate(
 ): Generator< unknown, CartResponse, { response: CartResponse } > {
 	try {
 		const { response } = yield apiFetchWithHeaders( {
-			path: '/wc/store/cart/extensions',
+			path: '/wc/store/v1/cart/extensions',
 			method: 'POST',
 			data: { namespace: args.namespace, data: args.data },
 			cache: 'no-store',
@@ -255,7 +255,7 @@ export function* applyCoupon(
 
 	try {
 		const { response } = yield apiFetchWithHeaders( {
-			path: '/wc/store/cart/apply-coupon',
+			path: '/wc/store/v1/cart/apply-coupon',
 			method: 'POST',
 			data: {
 				code: couponCode,
@@ -296,7 +296,7 @@ export function* removeCoupon(
 
 	try {
 		const { response } = yield apiFetchWithHeaders( {
-			path: '/wc/store/cart/remove-coupon',
+			path: '/wc/store/v1/cart/remove-coupon',
 			method: 'POST',
 			data: {
 				code: couponCode,
@@ -340,7 +340,7 @@ export function* addItemToCart(
 	try {
 		yield triggerAddingToCartEvent();
 		const { response } = yield apiFetchWithHeaders( {
-			path: `/wc/store/cart/add-item`,
+			path: `/wc/store/v1/cart/add-item`,
 			method: 'POST',
 			data: {
 				id: productId,
@@ -381,7 +381,7 @@ export function* removeItemFromCart(
 
 	try {
 		const { response } = yield apiFetchWithHeaders( {
-			path: `/wc/store/cart/remove-item`,
+			path: `/wc/store/v1/cart/remove-item`,
 			data: {
 				key: cartItemKey,
 			},
@@ -423,7 +423,7 @@ export function* changeCartItemQuantity(
 	yield itemIsPendingQuantity( cartItemKey );
 	try {
 		const { response } = yield apiFetchWithHeaders( {
-			path: '/wc/store/cart/update-item',
+			path: '/wc/store/v1/cart/update-item',
 			method: 'POST',
 			data: {
 				key: cartItemKey,
@@ -459,7 +459,7 @@ export function* selectShippingRate(
 	try {
 		yield shippingRatesBeingSelected( true );
 		const { response } = yield apiFetchWithHeaders( {
-			path: `/wc/store/cart/select-shipping-rate`,
+			path: `/wc/store/v1/cart/select-shipping-rate`,
 			method: 'POST',
 			data: {
 				package_id: packageId,
@@ -512,7 +512,7 @@ export function* updateCustomerData(
 
 	try {
 		const { response } = yield apiFetchWithHeaders( {
-			path: '/wc/store/cart/update-customer',
+			path: '/wc/store/v1/cart/update-customer',
 			method: 'POST',
 			data: customerData,
 			cache: 'no-store',

diff --git a/assets/js/data/cart/constants.ts b/assets/js/data/cart/constants.ts
@@ -3,7 +3,7 @@
  */
 import { __ } from '@wordpress/i18n';
 
-export const STORE_KEY = 'wc/store/cart';
+export const STORE_KEY = 'wc/store/v1/cart';
 export const CART_API_ERROR = {
 	code: 'cart_api_error',
 	message: __(

diff --git a/assets/js/data/cart/resolvers.ts b/assets/js/data/cart/resolvers.ts
@@ -15,7 +15,7 @@ import { STORE_KEY, CART_API_ERROR } from './constants';
  */
 export function* getCartData(): Generator< unknown, void, CartResponse > {
 	const cartData = yield apiFetch( {
-		path: '/wc/store/cart',
+		path: '/wc/store/v1/cart',
 		method: 'GET',
 		cache: 'no-store',
 	} );

diff --git a/assets/js/data/collections/constants.js b/assets/js/data/collections/constants.js
@@ -1,2 +1,2 @@
-export const STORE_KEY = 'wc/store/collections';
+export const STORE_KEY = 'wc/store/v1/collections';
 export const DEFAULT_EMPTY_ARRAY = [];
diff --git a/assets/js/data/query-state/constants.js b/assets/js/data/query-state/constants.js
@@ -1 +1 @@
-export const STORE_KEY = 'wc/store/query-state';
+export const STORE_KEY = 'wc/store/v1/query-state';
diff --git a/assets/js/data/schema/constants.js b/assets/js/data/schema/constants.js
@@ -3,4 +3,4 @@
  *
  * @type {string}
  */
-export const STORE_KEY = 'wc/store/schema';
+export const STORE_KEY = 'wc/store/v1/schema';
diff --git a/assets/js/data/shared-controls.ts b/assets/js/data/shared-controls.ts
@@ -68,7 +68,7 @@ const setNonceOnFetch = ( headers: Headers ): void => {
  */
 const triggerBatchFetch = ( keys: readonly APIFetchOptions[] ) => {
 	return triggerFetch( {
-		path: `/wc/store/batch`,
+		path: `/wc/store/v1/batch`,
 		method: 'POST',
 		data: {
 			requests: keys.map( ( request: APIFetchOptions ) => {

diff --git a/assets/js/editor-components/utils/index.js b/assets/js/editor-components/utils/index.js
@@ -30,13 +30,16 @@ const getProductsRequests = ( {
 		order: 'asc',
 	};
 	const requests = [
-		addQueryArgs( '/wc/store/products', { ...defaultArgs, ...queryArgs } ),
+		addQueryArgs( '/wc/store/v1/products', {
+			...defaultArgs,
+			...queryArgs,
+		} ),
 	];
 
 	// If we have a large catalog, we might not get all selected products in the first page.
 	if ( isLargeCatalog && selected.length ) {
 		requests.push(
-			addQueryArgs( '/wc/store/products', {
+			addQueryArgs( '/wc/store/v1/products', {
 				catalog_visibility: 'any',
 				include: selected,
 				per_page: 0,
@@ -85,7 +88,7 @@ export const getProducts = ( {
  */
 export const getProduct = ( productId ) => {
 	return apiFetch( {
-		path: `/wc/store/products/${ productId }`,
+		path: `/wc/store/v1/products/${ productId }`,
 	} );
 };
 
@@ -94,7 +97,7 @@ export const getProduct = ( productId ) => {
  */
 export const getAttributes = () => {
 	return apiFetch( {
-		path: `wc/store/products/attributes`,
+		path: `wc/store/v1/products/attributes`,
 	} );
 };
 
@@ -105,7 +108,7 @@ export const getAttributes = () => {
  */
 export const getTerms = ( attribute ) => {
 	return apiFetch( {
-		path: `wc/store/products/attributes/${ attribute }/terms`,
+		path: `wc/store/v1/products/attributes/${ attribute }/terms`,
 	} );
 };
 
@@ -119,7 +122,7 @@ export const getTerms = ( attribute ) => {
 const getProductTagsRequests = ( { selected = [], search } ) => {
 	const limitTags = getSetting( 'limitTags', false );
 	const requests = [
-		addQueryArgs( `wc/store/products/tags`, {
+		addQueryArgs( `wc/store/v1/products/tags`, {
 			per_page: limitTags ? 100 : 0,
 			orderby: limitTags ? 'count' : 'name',
 			order: limitTags ? 'desc' : 'asc',
@@ -130,7 +133,7 @@ const getProductTagsRequests = ( { selected = [], search } ) => {
 	// If we have a large catalog, we might not get all selected products in the first page.
 	if ( limitTags && selected.length ) {
 		requests.push(
-			addQueryArgs( `wc/store/products/tags`, {
+			addQueryArgs( `wc/store/v1/products/tags`, {
 				include: selected,
 			} )
 		);
@@ -163,7 +166,7 @@ export const getProductTags = ( { selected = [], search } ) => {
  */
 export const getCategories = ( queryArgs ) => {
 	return apiFetch( {
-		path: addQueryArgs( `wc/store/products/categories`, {
+		path: addQueryArgs( `wc/store/v1/products/categories`, {
 			per_page: 0,
 			...queryArgs,
 		} ),
@@ -177,7 +180,7 @@ export const getCategories = ( queryArgs ) => {
  */
 export const getCategory = ( categoryId ) => {
 	return apiFetch( {
-		path: `wc/store/products/categories/${ categoryId }`,
+		path: `wc/store/v1/products/categories/${ categoryId }`,
 	} );
 };
 
@@ -188,7 +191,7 @@ export const getCategory = ( categoryId ) => {
  */
 export const getProductVariations = ( product ) => {
 	return apiFetch( {
-		path: addQueryArgs( `wc/store/products`, {
+		path: addQueryArgs( `wc/store/v1/products`, {
 			per_page: 0,
 			type: 'variation',
 			parent: product,

diff --git a/assets/js/middleware/store-api-nonce.js b/assets/js/middleware/store-api-nonce.js
@@ -28,7 +28,7 @@ const isStoreApiRequest = ( options ) => {
 	if ( ! url || ! options.method || options.method === 'GET' ) {
 		return false;
 	}
-	return /wc\/store\//.exec( url ) !== null;
+	return /wc\/store\/v1\//.exec( url ) !== null;
 };
 
 /**

diff --git a/assets/js/shared/hocs/with-product-data-context.js b/assets/js/shared/hocs/with-product-data-context.js
@@ -29,7 +29,7 @@ const OriginalComponentWithContext = ( props ) => {
 		if ( productId > 0 ) {
 			setIsLoading( true );
 			apiFetch( {
-				path: `/wc/store/products/${ productId }`,
+				path: `/wc/store/v1/products/${ productId }`,
 			} )
 				.then( ( receivedProduct ) => {
 					setProduct( receivedProduct );
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		export const STORE_KEY = 'wc/store/query-state';
		export const STORE_KEY = 'wc/store/v1/query-state';