New fulfillment impacted plugins #6615

sujithvn · 2022-11-03T13:36:52Z

Signed-off-by: Sujith mail.sujithvn@gmail.com

Resolves #6471
Impact: breaking
Type: feature

This PR replaces #6582

Issue

In the current system, the only way for order fulfillment is via shipping which is hardcoded into the system. We need to introduce the flexibility for users to add their own fulfillment types via plugins.

Solution

We are creating a base fulfillment plugin which would enable other fulfillment types (like shipping, pickup, digital) to be introduced via plugins. Each of the newly introduced fulfillment type plugin would need to have the specific fulfillment methods also to be added as separate plugins. Example, fulfillment type 'pickup' could have fulfillment methods like 'store pickup' and 'curb-side pickup'.

This PR is 4th entry (new-fulfillment-impacted-plugins)

PR Details in order

feat/fulfillment-types
 | 
 | __ 00 fulfillment base #6610 
 |        | __ new-fulfillment-type-shipping      #6614
 |        | __ new-fulfillment-type-pickup.    #6613 
 |__ new-fulfillment-impacted-plugins. [carts, products, orders, catalogs]  <--- This PR #6615 
 |__ new-placeOrder refactor validateOrder #6616

Existing PRs based on the #6480 (to be updated to point to #6610)

We shall change the base branch of the 3 existing PRs (i18n #6545, dataMigration #6544, setDefaultFFtype #6543) to point to 00 fulfillment base

Changes in detail:

CARTS

New field - cartVersion in the cart to identify the new carts. Old carts will not have this field
New field - selectedFulfillmentType: This field allows UI to send the fulfillment-type selected by user for the product while adding to the cart. This is optional and if not selected the item would default to undecided fulfillment group.
New field - supportedFulfillmentTypes: This field was supposed to be existing but was missing. Added now (bug fix).
New Mutation - setFulfillmentTypeForItems: Accepts an array of itemIds and a selected fulfillment type along with cart details. This mutation would move all the provided items to the requested fulfillment group depending on conditions like FFtype is supported by product, FFtype is active etc.
Exported ShippingMethod & Shipment from SimpleSchema - these schemas will be extended in the api-plugin-fulfillment plugin to have the allowedValues changed from the hard coded "shipping" to dynamic array containing all the installed FFTypes
New field - fulfillmentMethod - This is field will be non-editable and used for matching the fulfillment method from other functions/calls. Matching on existing fields like 'name' which are user-input in flat-rate method is not reliable.
New field - displayMessageMethod - This new field will hold any string to be displayed along the FF Method in the UI, example store pickup requesting user to come in only after 24hrs of ordering.
New field - methodAdditionalData: This could be fulfillment specific information used for processing in the system. Example Store may provide store details.
updateCartFulfillmentGroups: logic updated - when new item is added to cart, if "selectedFulfillmentType" is provided, we add to that group, else the item goes to "Undecided" group.

CATALOGS

supportedFulfillmentTypes - this field will be extended in the api-plugin-fulfillment plugin to have the allowedValues changed from the hard coded "shipping" to dynamic array containing all the installed FFTypes

PRODUCTS

supportedFulfillmentTypes - this field will be extended in the api-plugin-fulfillment plugin to have the allowedValues changed from the hard coded "shipping" to dynamic array containing all the installed FFTypes

ORDERS

Exported CommonOrder, orderFulfillmentGroupInputSchema, SelectedFulfillmentOption - these schemas will be extended in the api-plugin-fulfillment plugin to have the allowedValues changed from the hard coded "shipping" to dynamic array containing all the installed FFTypes
New field - methodAdditionalData: This could be fulfillment specific information used for processing in the system. Example Store may provide store details.
(above 2 changes are spread across multiple files)

Integration Tests updated

Updated the integration tests to match the changes in plugins.

Breaking changes

Since this is the new way of handling fulfillment, the existing shipment plugins would not work along with this. User would need to migrate the data (migration script will be developed) and remove the shipment plugins (api-plugin-shipments and api-plugin-shipments-flat-rate).

Testing

All this is new code and at this stage this is not integrated to reaction, meaning the plugins.json is not updated to include this plugin. Hence proper testing can be carried out only after merging in the remaining PRs.

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

changeset-bot · 2022-11-03T13:36:57Z

⚠️ No Changeset found

Latest commit: 761bd13

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

apps/reaction/package.json

packages/api-plugin-carts/src/util/updateCartFulfillmentGroups.js

aldeed

See a few suggestions, but overall this seems on the right track. I am not sure I like the "undecided" group. What if someone registers a fulfillment type plugin with the name "undecided"? If this ability is necessary, you could make the group.type field optional and have null mean undecided. But it seems like the best approach would be to have a required shop default and use that.

packages/api-plugin-carts/src/schemas/cart.graphql

aldeed · 2022-12-08T19:39:49Z

packages/api-plugin-carts/src/simpleSchemas.js

+    type: String,
+    optional: true,
+    label: "Display message to show in UI for this Method"
+  },


I believe fulfillmentMethod is sort of a subtype, corresponding with the providing package (e.g. flat rate vs dynamic rate, but both are "shipping" type). The problem is that the project already uses the term "method" for individual methods, so it seems confusing. I think some other ecommerce platforms use fulfillmentProvider, and that makes more sense to me. @zenweasel

aldeed · 2022-12-08T19:51:07Z

packages/api-plugin-carts/src/simpleSchemas.js

@@ -733,6 +744,19 @@ export const CartItem = new SimpleSchema({
    blackbox: true
  },
  "updatedAt": Date,
+  "selectedFulfillmentType": {
+    type: String,
+    allowedValues: ["undecided"], // extended with dynamic values in fulfillment plugin startup


Another option would be to have fulfillment plugins include an array in their plugin registration options:

{ fulfillmentTypes: ["shipping"] }

Then use registerPluginHandler in this cart plugin to read all of the plugin.fulfillmentTypes and add them all to allowedValues in the schema. That way all cart schema changes will happen in the cart plugin, which makes the most sense to me.

Something similar is how payment methods, address validation methods, etc. are registered from individual plugins.

packages/api-plugin-carts/src/util/updateCartFulfillmentGroups.js

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

…lugins Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

…acted-plugins Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

…ction into 00-fulfillment-base Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

sujithvn added 9 commits November 3, 2022 18:29

feat: changes related to carts plugin

2da2803

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

feat: changes related to catalogs plugin

d2d37ec

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

feat: changes related to orders plugin

b455518

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

feat: changes related to products plugin

d8f2465

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

feat: integration test updates

25a91b6

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

feat: switch from old shipments to fulfillment

7314195

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

feat: test setFulfillmentTypeForItems

b047c03

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

fix: package and plugin.json update

0ddcaa4

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

fix: review comment combine destructure

d88a878

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

sujithvn requested review from vanpho93, tedraykov and aldeed November 3, 2022 13:37

sujithvn mentioned this pull request Nov 3, 2022

02 fulfillment type impacted plugins #6582

Closed

vanpho93 reviewed Nov 20, 2022

View reviewed changes

aldeed requested changes Dec 8, 2022

View reviewed changes

sujithvn removed the request for review from tedraykov January 9, 2023 04:16

sujithvn added 12 commits March 10, 2023 23:58

fix: review comment updates

edaa82b

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Merge branch 'feat/fulfillment-types' into new-fulfillment-impacted-p…

13caba9

…lugins Signed-off-by: Sujith <mail.sujithvn@gmail.com>

fix: unit test update

61bc0a3

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

fix: variable reuse

3e6b7d2

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Merge branch '00-fulfillment-base' into new-fulfillment-impacted-plugins

a2bc593

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Merge branch 'new-fulfillment-type-shipping' into new-fulfillment-imp…

bf821f7

…acted-plugins Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Merge fulfillment-pickup into impacted plugins

1e8b011

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

fix: integration test updates

a1cfcd7

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

fix: filename case change

1d94aa6

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

fix: filename case 2

059e4f0

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Merge branch '00-fulfillment-base' of github.com:reactioncommerce/rea…

bf77d11

…ction into 00-fulfillment-base Signed-off-by: Sujith <mail.sujithvn@gmail.com>

Merge branch '00-fulfillment-base' into new-fulfillment-impacted-plugins

761bd13

Signed-off-by: Sujith <mail.sujithvn@gmail.com>

sujithvn merged commit 5fed7d5 into 00-fulfillment-base May 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

New fulfillment impacted plugins #6615

New fulfillment impacted plugins #6615

Uh oh!

sujithvn commented Nov 3, 2022 •

edited

Loading

Uh oh!

changeset-bot bot commented Nov 3, 2022 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aldeed left a comment

Uh oh!

Uh oh!

aldeed Dec 8, 2022

Uh oh!

aldeed Dec 8, 2022

Uh oh!

Uh oh!

Uh oh!

New fulfillment impacted plugins #6615

New fulfillment impacted plugins #6615

Uh oh!

Conversation

sujithvn commented Nov 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

This PR replaces #6582

Issue

Solution

PR Details in order

Existing PRs based on the #6480 (to be updated to point to #6610)

Changes in detail:

CARTS

CATALOGS

PRODUCTS

ORDERS

Integration Tests updated

Breaking changes

Testing

Uh oh!

changeset-bot bot commented Nov 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

⚠️ No Changeset found

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aldeed left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aldeed Dec 8, 2022

Choose a reason for hiding this comment

Uh oh!

aldeed Dec 8, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sujithvn commented Nov 3, 2022 •

edited

Loading

changeset-bot bot commented Nov 3, 2022 •

edited

Loading