Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Einstein API to support product sets #962

Merged
merged 4 commits into from
Feb 7, 2023

Conversation

yunakim714
Copy link
Collaborator

Description

This PR enables product sets data to be forwarded through Einstein activities so that we can visualize product sets data on reports and dashboards.

We are forwarding data for the following events:

  • viewCategory
  • viewSearch
  • viewProduct (send event for parent product AND every children set product)
  • addToCart (send event for every child product when user clicks "Add Set to Cart")
  • viewReco

Types of Changes

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Documentation update
  • Breaking change (could cause existing functionality to not work as expected)
  • Other changes (non-breaking changes that does not fit any of the above)

Breaking changes include:

  • Removing a public function or component or prop
  • Adding a required argument to a function
  • Changing the data type of a function parameter or return value
  • Adding a new peer dependency to package.json

Changes

  • Products sets data is being forwarded so that the einstein API can send an event with the correct data

How to Test-Drive This PR

  • Checkout this branch
  • Run npm start
  • Go to the "Network" tab in DevTools
  • Go through the different events to verify each event is being sent with a 200 status

Checklists

General

  • Changes are covered by test cases
  • CHANGELOG.md updated with a short description of changes (not required for documentation updates)

Accessibility Compliance

You must check off all items in one of the follow two lists:

  • There are no changes to UI

or...

Localization

  • Changes include a UI text update in the Retail React App (which requires translation)

@yunakim714 yunakim714 marked this pull request as ready for review February 6, 2023 17:30
@yunakim714 yunakim714 requested a review from a team as a code owner February 6, 2023 17:30
@vcua-mobify vcua-mobify self-requested a review February 7, 2023 01:10
// handle sets for viewProduct
return {
id: product.id,
sku: product.id,
Copy link
Contributor

@vcua-mobify vcua-mobify Feb 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for product sets we can avoid having a separate case and let any product within the set that doesn't have variants fall through to the else block.

That's because I'm not sure if it's relevant for us to be sending 'sku' if it is the same as the regular 'id'.

Also, are there any changes we need to make in einstein.test.js?

Otherwise, the changes look good to me.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The einstein test file only tests for whether the event sends the expected api request. I don't think any changes need to be made since there are no new events.

Copy link
Contributor

@vcua-mobify vcua-mobify left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for following up on my comment @yunakim714, LGTM.

@yunakim714 yunakim714 merged commit 1711d10 into feature/product-sets Feb 7, 2023
vmarta added a commit that referenced this pull request Mar 1, 2023
* Product sets: basic PLP (#878)

* Show product sets on PLP (alongside other products)

For now, the product sets would look the same as any other kinds of products.

* Parse the product type

* Add todo

* Ignore linting of this line for now

* Add "Starting at" label

* Product sets: basic pdp (@W-12301851@) (#897)

* Product set: render the children products with minimal UI

* No longer showing breadcrumbs in the child items

* Individual swatches now have correct `value`

There was a subtle bug where the `value` of the SwatchGroup was passed down to override all the values of the children Swatch components.

* 1st attempt at saving swatches state in the page url

* Avoid null in the url search params

* Some refactoring

* Add-to-cart now works for child items

* Show accordion for each child item

* Add todo

* Rename variable for accuracy

The child product itself is actually not a set, but is considered a set product.

* Optional argument

* Some refactoring and fix linting

* Helper hook for url search params

* Clean up

* Rename module for a specific use case (PDP)

* Show/hide add-to-cart buttons accordingly

* Modal shows product set data

* Parent product

* Variant's product image shows up in add-to-cart modal

* Rename variables for clarity

* Fix linting error

* Add horizontal rules to separate the parent and child items

* Tweak whitespace

* Localize the Starting At label

* Add todo

* Product sets: wishlist (@W-12301966@) (#917)

* Starting At label

* 1st attempt at updating wishlist for product sets

* "Select Options" → "View Options"

* Some refactoring

* Render add-all-to-cart button if necessary

* Better way to fetch `setProducts` data

* Switch to zzrf-009 temporarily

* For debugging purpose

I'll revert this commit later

* Simpler requirement

* Update what quantity meant for product set

* Some refactoring

* Add comment

* Add-to-wishlist for the individual child items

* Rename variable

* Update button text on PDP

* Update button text on Wishlist page

* Revert "Switch to zzrf-009 temporarily"

This reverts commit 484c8d8.

* PDP: show wishlist button on mobile

* Fix formatting issues (prettier)

* PR feedback

* Clearer as to which is product or variant

* Make it consistent with addToWishlist signature

* [Feature] Add `Add Set to Cart` Button for Product Sets (#931)

* Product sets: basic PLP (#878)

* Variant's product image shows up in add-to-cart modal

* Get modal showing multiple items added to cart

* Add scroll to after validation

Co-authored-by: Vincent Marta <[email protected]>

* Einstein API to support product sets (#962)

* verify viewcategory and viewsearch is working

* viewproduct event is sent for every child product

* addtocart event fires for all children when add set to cart

* parent set only sends id

* Design enhancements for product sets (#975)

* remove complete the set carousel

* remove complete the set translations

* sticky buttons on mobile view

* fix modal vertical margins on desktop

* move recos to modalbody and cleanup margins

* add dividers between product set items in mobile view

* fix margins so sticky buttons do not overlap with content

* add lazy loading of product set children product images

* remove height - does nothing

* bump build size to 55

* add conditional for complete the set and change loading var name

* lint

* revert translations

* Cleanup

* added to cart modal is scrollable and 90% of viewport

* remove dialogprops

* lint

* Testing product sets - @W-12414116@ (#1003)

* Product tile: test product set's price label

* Test product set rendering

* Test callbacks are called properly

* itemAccumulatedCount is redundant

* Test that modal can render multiple products

* Finally the add-to-cart modal shows up in testing

* Clean up

* Test error messages

* Test lazy loading of the child products

* Split a test into smaller ones

* Use `describe` to group all the related tests

* Update comment

* Test the wishlist and its primary action buttons

* Clean up

* Some refactoring

* Some refactoring

* Linting fix

* Update comment

* Test `getDisplayVariationValues`

* Test the usePDPSearchParams

* Tweak another test to pass

Not related to product sets, but needing CI to pass.

* Move mocked data into their own files

* Moving it to within `beforeEach`

---------

Co-authored-by: Ben Chypak <[email protected]>
Co-authored-by: yunakim714 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants