Add products data store #32964

louwie17 · 2022-05-11T15:17:44Z

All Submissions:

Have you followed the WooCommerce Contributing guideline?
Does your code follow the WordPress' coding standards?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?

Changes proposed in this Pull Request:

Adds a new products data store that makes use of the products API -> https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-products
For now this only allows for retrieving/search for products and getting the product count.

Partially addresses #32524

How to test the changes in this Pull Request:

Load this branch, create a couple products and go to WooCommerce > Home
Open your console and run wp.data.select('wc/admin/products').getProducts({ status: 'publish'}, undefined);
It should return undefined at first
Run it again, assuming the request finished, and it should return all the published products. You can try the above again with other items in the query, like _fields: ['id'] for example, which should only return the ids, any query param defined here should work: https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-products
Now do the same for the getProductsTotalCount function, by running: wp.data.select('wc/admin/products').getProductsTotalCount({ status: 'publish'}, undefined);, this might run the correct number right away if you recently ran getProducts with the same query params, otherwise it should return undefined intiially.
If you have the Redux Devtools extension, you can look for the wc/admin/products store and make sure the state is updated correctly and the actions are triggered correctly.
Run wp.data.select('wc/admin/items').getItems('categories', { }); in your console to see if the items store still works correctly, and wp.data.select('wc/admin/items').getItemsTotalCount('categories', { });.

Other information:

Have you added an explanation of what your changes do and why you'd like us to include them?
Have you written new tests for your changes, as applicable?
Have you successfully run tests with your changes locally?
Have you created a changelog file for each project being changed, ie pnpm nx changelog <project>?

FOR PR REVIEWER ONLY:

I have reviewed that everything is sanitized/escaped appropriately for any SQL or XSS injection possibilities. I made sure Linting is not ignored or disabled.

botwoo · 2022-05-17T12:50:17Z

📊 Test reports for this pull request have been published and are accessible through the following links:

REST API Test Report
E2E Test Report (TBC)

Latest commit referenced in the reports: Make sure we always use id for receiving products and update reducer … defc559
This comment will automatically be updated with the latest referenced commit when you push new changes to this pull request.

Visit the WooCommerce Test Reports homepage to view all published reports. See the FAQs page if you're having problems accessing them.

joshuatf

Great work, @louwie17!

Overall this looks very solid. Left a few minor comments, but let me know if you have any questions.

joshuatf · 2022-05-19T16:46:44Z

packages/js/data/src/products/types.ts

+	status: 'any' | 'draft' | 'pending' | 'private' | 'publish' | 'future';
+	type: 'simple' | 'grouped' | 'external' | 'variable';
+	sku: string;
+	featured: string;


Is this supposed to be a boolean?

Yup it should be, thanks

joshuatf · 2022-05-19T17:47:41Z

packages/js/data/src/onboarding/selectors.ts

 	ExtensionList,
 	ProfileItemsState,
-	Product,
+	OnboardingProductType,


Good call on this rename!

Yeah, Product seemed like a bad name.

joshuatf · 2022-05-19T17:52:22Z

packages/js/data/src/products/action-types.ts

@@ -0,0 +1,8 @@
+export enum TYPES {
+	SET_PRODUCT = 'SET_PRODUCT',


For all new data stores, I think we should be using the REQUEST|SUCCESS|ERROR patterns. For example - https://github.com/woocommerce/woocommerce/blob/trunk/packages/js/data/src/countries/action-types.ts

Yeah that makes sense, I debated on that, but didn't want to write all the extra actions haha
But it does seem like the best pattern.

I end up just sticking with SUCCESS and ERROR, as we don't really need REQUEST given we have the resolutions for that, and can use isResolutionFinished.

joshuatf · 2022-05-19T19:32:53Z

packages/js/data/src/products/resolvers.ts

+
+type ProductGetResponse = Product[] | ( { data: Product[] } & Response );
+
+function* request( query: Partial< ProductQuery > ) {


This looks very similar to the items data store request method. Any opportunities to dry up some of this logic or are they too unique?

They should be near identical aside from the types, but I can make use of a generic for that.

joshuatf · 2022-05-19T19:40:41Z

packages/js/data/src/products/types.ts

+	shipping_class: string;
+	attribute: string;
+	attribute_term: string;
+	tax_class: string;


This should be an enum, right?

I am not sure where I can find the enum values for this, the item schema has it listed as a string -> https://github.com/woocommerce/woocommerce/blob/trunk/plugins/woocommerce/includes/rest-api/Controllers/Version1/class-wc-rest-products-v1-controller.php#L1939-L1942

The REST API states it should be standard, reduced-rate or zero-rate.

https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-products

joshuatf · 2022-05-19T19:40:49Z

packages/js/data/src/products/types.ts

+	on_sale: boolean;
+	min_price: string;
+	max_price: string;
+	stock_status: string;


Also an enum I believe.

Yeah, I believe you are right, I think just instock or outofstock

joshuatf · 2022-05-19T19:41:14Z

packages/js/data/src/products/utils.ts

+ * @param {Object} query Query for product totals count.
+ * @return {string} Resource name for product totals.
+ */
+export function getTotalProductCountResourceName(


Nice method!

louwie17 · 2022-05-20T13:12:40Z

@joshuatf thanks for the review, I have addressed all your feedback in 9e316ab, if you have time for another review?

louwie17 · 2022-05-20T13:18:35Z

@joshuatf I did add one extra step to the testing instructions for double checking the items store.

joshuatf

Hey @louwie17, looks really great. Sorry, I missed a couple small items my first pass. I left a couple comments, but let me know if you have any questions.

joshuatf · 2022-05-24T15:17:28Z

packages/js/data/src/products/resolvers.ts

+		return items;
+	} catch ( error ) {
+		yield getProductsError( query, error );
+		return error;


We might want to throw error here so that users can catch on getProducts().

getProducts(...).catch(...).

joshuatf · 2022-05-24T15:17:46Z

packages/js/data/src/products/resolvers.ts

+		yield getProductsTotalCountSuccess( query, totalCount );
+		return totalCount;
+	} catch ( error ) {
+		yield getProductsTotalCountError( query, error );


Same comment about throwing here.

joshuatf · 2022-05-24T15:18:25Z

packages/js/data/src/products/test/reducer.ts

+				},
+			},
+			productsCount: {
+				'total-guyisms:{}': 2,


Lol, this was deff not me haha I copy pasted most of these tests and updated them, I somehow never noticed this.

joshuatf · 2022-05-24T15:20:58Z

packages/js/data/src/products/types.ts

+	shipping_class: string;
+	attribute: string;
+	attribute_term: string;
+	tax_class: string;


The REST API states it should be standard, reduced-rate or zero-rate.

https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-products

joshuatf · 2022-05-24T15:23:55Z

packages/js/data/src/products/types.ts

+	date_created_gmt: string;
+	date_modified: string;
+	date_modified_gmt: string;
+	type: 'simple' | 'grouped' | 'external' | 'variable';


These can also be extended by hooks/filters on the backend.

louwie17 · 2022-05-24T18:03:10Z

@joshuatf thanks again for you review and suggestions, I addressed the PR feedback if you have time for a re-review?

joshuatf

Tested various parameters and fetching of totals and all worked as expected. Also double checked to categories for any regresions.

This is a fantastic addition to our data stores. Thank you for all your hard work on this, @louwie17!

…to handle _fields

louwie17 · 2022-05-25T18:13:23Z

@joshuatf I just updated this branch with the fixes for the things we discussed in Slack.
Made sure we always add id when retrieving all the products, and updated the reducer to not overwrite and delete fields that are already present (but only overwrite the new one's).

joshuatf

Thanks for fixing those up, @louwie17! Looks good and I'm able to retrieve individual fields without passing id now.

louwie17 requested a review from a team May 11, 2022 15:17

github-actions bot added the package: @woocommerce/data issues related to @woocommerce/data label May 11, 2022

louwie17 mentioned this pull request May 16, 2022

Remove order/product count from wcSettings #33064

Merged

8 tasks

louwie17 force-pushed the update/32524_order_product_count_api_requests branch from 61a4430 to d68a8da Compare May 17, 2022 12:20

joshuatf reviewed May 19, 2022

View reviewed changes

louwie17 force-pushed the update/32524_order_product_count_api_requests branch from d68a8da to 9e316ab Compare May 20, 2022 13:11

louwie17 requested a review from joshuatf May 20, 2022 13:12

joshuatf reviewed May 24, 2022

View reviewed changes

louwie17 force-pushed the update/32524_order_product_count_api_requests branch from 9e316ab to c35f99d Compare May 24, 2022 18:02

louwie17 requested a review from joshuatf May 24, 2022 18:02

joshuatf previously approved these changes May 25, 2022

View reviewed changes

louwie17 added 7 commits May 25, 2022 12:09

Add products data store

8752e7b

Update selectors

3d84cc0

Update action names, consolidate a request function, and update types

4f3bf0f

Make sure we throw errors within resolvers

df56578

Update Product types, and allow for more extensibility

1299a79

Remove unused action

1fc2f4e

Make sure we always use id for receiving products and update reducer …

defc559

…to handle _fields

louwie17 dismissed joshuatf’s stale review via defc559 May 25, 2022 18:11

louwie17 force-pushed the update/32524_order_product_count_api_requests branch from c35f99d to defc559 Compare May 25, 2022 18:11

joshuatf approved these changes May 25, 2022

View reviewed changes

louwie17 merged commit 434fab9 into trunk May 25, 2022

louwie17 deleted the update/32524_order_product_count_api_requests branch May 25, 2022 20:03

		@@ -0,0 +1,8 @@
		export enum TYPES {
		SET_PRODUCT = 'SET_PRODUCT',


		type ProductGetResponse = Product[] \| ( { data: Product[] } & Response );

		function* request( query: Partial< ProductQuery > ) {

Add products data store #32964

Add products data store #32964

Uh oh!

Conversation

louwie17 commented May 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

All Submissions:

Changes proposed in this Pull Request:

How to test the changes in this Pull Request:

Other information:

FOR PR REVIEWER ONLY:

Uh oh!

botwoo commented May 17, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joshuatf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

louwie17 May 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

louwie17 commented May 20, 2022

Uh oh!

louwie17 commented May 20, 2022

Uh oh!

joshuatf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

louwie17 commented May 24, 2022

Uh oh!

joshuatf left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

louwie17 commented May 25, 2022

Uh oh!

joshuatf left a comment

Choose a reason for hiding this comment

Uh oh!

louwie17 commented May 11, 2022 •

edited

Loading

botwoo commented May 17, 2022 •

edited

Loading

louwie17 May 20, 2022 •

edited

Loading

joshuatf left a comment •

edited

Loading