Service - Sell Offer Plan
Revision as of 11:22, 10 November 2021 by Sven the Barbarian (talk | contribs)
Overview
A user's plan that connects a user's sell offer to any number of delivery method links and payment method links, and also to the sell offer's prices.
Each sell offer will have one plan, the plan controls the sell offer's prices, and many sell offers can point to the same plan (if they all share the same prices), so any change in price will mean a new sell offer plan.
The plan also links to delivery methods and payment methods using link nodes, so sell offers that use the same sell offer plan must offer the same delivery method and payment methods and their link settings.
Many sell offer plans can use the same delivery method links and payment method links, so if multiple sell offers have the same delivery and payment method settings but different prices, they can share the links but with separate sell offer plans + pricing.
Repository
https://bitbucket.org/izara-market-products/izara-market-products-sell-offer-plan
DynamoDB tables
Standard Config Table Per Service
Configuration tags
{
configTag: "DeliveryMethodManagerServiceName"
configKey: "DeliveryMethodManagerServiceName"
configValue: xxx // eg: "DeliveryMethodManager"
}
{
configTag: "PaymentMethodManagerServiceName"
configKey: "PaymentMethodManagerServiceName"
configValue: xxx // eg: "PaymentMethodManager"
}
{
configTag: "ProductGraphServiceName"
configKey: "ProductGraphServiceName"
configValue: xxx // eg: "ProductGraph"
}
LogicalResults
Stores results for any requests to perform logical searches on sell offer data
{
resultId: xxx // eg: filterMainId for a single logical element
dataId: xxx // one sellofferId
}
- partition key: resultId
- sort key: dataId
PriceLogical
Records ProcessLogical requests for pricing based elements, so when pricing flow completes can find results, save into LogicalResults, and send message out for complexFilter service to receive.
{
filteredSellOfferPlanListId: "xx",
resultId: "xx",
logicalElement: {}, // needed for logicalTag after FilteredSellOfferPlanList completes
timestamp: "xx", //when record created
}
- partition key: filteredSellOfferPlanListId
- sort key: resultId
- links shared FilteredSellOfferPlanList records to any number of processLogical resultId requests (differentiated by comparison and value fields)
- is temporary, after save into LogicalResults and send OutProcessLogical can delete record so not keep sending OutProcessLogical when other comparison/value requests complete
FilteredSellOfferPlanList
Lists of SellOfferPlanIds identified by deliverToLocationIds / orderQuantity / paymentMethodIds / deliveryMethodIds
{
filteredSellOfferPlanListId: "xx",
status: "xx" // "processing"|"complete"
expiryTime: "xx",
}
- partition key: filteredSellOfferPlanListId
- sort key: none
- filteredSellOfferPlanListId: hash of deliverToLocationIds / orderQuantity / paymentMethodIds / deliveryMethodIds
- many PriceLogical records can shared one FilteredSellOfferPlanList list and apply different comparisons to FilteredSellOfferPlanPrice to get their logicalResults
FilteredSellOfferPlanPending
SellOfferPlanIds for one FilteredSellOfferPlanList that has not completed yet
{
filteredSellOfferPlanListId: "xx",
SellOfferPlanId: "xx",
}
- partition key: filteredSellOfferPlanListId
- sort key: SellOfferPlanId
- is temporary and is removed after completed data saved into FilteredSellOfferPlanPrice
- could use SellOfferPlanPriceRange and not have this table, but would need to iterate all SellOfferPlanPriceRange records each time one completes to check if this FilteredSellOfferPlanList is complete, this temporary table might be more efficient when large number of child records are expected
FilteredSellOfferPlanPrice
Every price found for all sellOfferPlans that are children of this filteredSellOfferPlanListId
****---------------------------- needs GSI and change keys to identify SellOfferPlanPrice record
{
filteredSellOfferPlanListId: "xx",
price: "xx",
priceId: "xx",
paymentIdDeliveryId: "xx",
}
- partition key: filteredSellOfferPlanListId
- sort key: price
- SellOfferPlanId can be extracted from priceId, could add it as another field if effective to do so
SellOfferPlanPriceRange
Manages order price calculations for one sellOfferPlanId including Payment and Delivery method costs, for all combinations of the requested deliverToLocationIds, paymentMethodIds, deliveryMethodIds, for the given orderQuantity (so one sellOfferPlanId will have many records here)
{
filteredSellOfferPlanListId: "xx",
sellOfferPlanId: "xx",
// (not needed?) deliverToLocationIds: ["xx","yy"], // array of locationIds
// (not needed?) orderQuantity: x,
// (not needed?) paymentMethodIds: ["xx","yy"], // array of paymentMethodIds(strings), empty array means all available paymentMethods
// (not needed?) deliveryMethodIds: ["xx","yy"], // array of deliveryMethodIds(strings), empty array means all available deliveryMethods
status: "xx", // "processing"|"complete"
expiryTime: "xx"
}
- partition key: filteredSellOfferPlanListId
- sort key: sellOfferPlanId
- a unique record is made up of deliverToLocationIds / orderQuantity / paymentMethodIds / deliveryMethodIds (filteredSellOfferPlanListId), and one sellOfferPlanId
- this is a parent record for individual price results for all combinations of deliverToLocationIds, paymentMethodIds, deliveryMethodIds
SellOfferPlanPriceRangePricePending
Links a pending SellOfferPlanPrice to a waiting parent SellOfferPlanPriceRange
{
sellOfferPlanPriceRangeId: "xx"
pricePendingId: "xx",
}
- partition key: sellOfferPlanPriceRangeId
- sort key: pricePendingId
- sellOfferPlanPriceRangeId is {filteredSellOfferPlanListId}_{sellOfferPlanId}
- pricePendingId is {priceId}_{paymentIdDeliveryId}
- is temporary and is removed after completed data saved into SellOfferPlanPrice and SellOfferPlanPriceRange triggered to check is complete
- maybe let CheckSellOfferPlanPriceRangeComplete lambda remove the SellOfferPlanPriceRangePricePending record to protect against idempotence, eg if we delete then send the message to CheckSellOfferPlanPriceRangeComplete Lambda might end in between, meaning message never gets sent
SellOfferPlanPrice
One completed calculation for a sellOfferPlan's combination of deliverToLocationId, paymentMethodId, deliveryMethodId, and orderQuantity.
{
priceId: "xx",
paymentIdDeliveryId: "xx",
price: "xx"
expiryTime: "xx"
}
- partition key: priceId
- sort key: paymentIdDeliveryId
- priceId is {sellOfferPlanId_deliverToLocationId_orderQuantity}
- paymentIdDeliveryId is {sellOfferPlanUserPaymentMethodLinkId_sellOfferPlanDeliveryMethodLinkId}
- could hash partition and sort key into one partition key but though splitting them out might group them a little better, not need to add these fields separately in SellOfferPlanPriceRangePriceComplete records because can extract from priceId / paymentIdDeliveryId
****-------- probably needs GSI so can sort by price
Graph database
Service - Products Graph
Nodes
{
nodeLabel: "{SellOfferPlanLib.SELLOFFERPLAN_GRAPH_NODE_LABEL}", // "sellOfferPlan"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
sellOfferPlanId: {
identifier: true, // create unique id from request params and uniqueMessageId
},
userId: {
immutable: true, // a sellOfferPlan can only be used by one user (because links to their userPaymentMethods)
},
currencyId: {
immutable: true, // all added deliveryMethods must match
},
},
}
}
{
nodeLabel: "{SellOfferPlanLib.SELLOFFERPLAN_DELIVERYMETHODLINK_GRAPH_NODE_LABEL}", // "sellOfferPlanDeliveryMethodLink"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
sellOfferPlanDeliveryMethodLinkId: {
identifier: true, // create unique id from request params and uniqueMessageId
},
},
}
}
{
nodeLabel: "{SellOfferPlanLib.SELLOFFERPLAN_USERPAYMENTMETHODLINK_GRAPH_NODE_LABEL}", // "sellOfferPlanUserPaymentMethodLink"
schema: {
identifier: true,
restrictProperties: true,
restrictRelationships: true,
properties: {
sellOfferPlanUserPaymentMethodLinkId: {
identifier: true, // create unique id from request params and uniqueMessageId
},
},
}
}
Versioned data
sellOfferPlanDeliveryMethodLinkSettings
{
properties: {
addToRateTableValuePerOrder: {}, // added once per order to the value before calculating delivery method price
addToRateTableValuePerUnit: {}, // added once per orderQuantity to the value before calculating delivery method price
addToCalculatedValuePerOrder: {}, // added once per order to the value after calculating delivery method price
addToCalculatedValuePerUnit: {}, // added once per orderQuantity to the value after calculating delivery method price
valueType: "xx", // orderQuantity|orderValue|productAttributeId|sellOfferTermId, if set overwrites deliveryMethod defaultValueType
valueId: "xx", // if set overwrites deliveryMethod defaultValueId (used for productAttributeId|sellOfferTermId)
},
}
sellOfferPlanUserPaymentMethodLinkSettings
{
properties: {
oneTimePercentage: {}, // increase paymentMethod price by percentage
oneTimeAmount: {}, // increase paymentMethod price by set amount
},
}
- if both oneTimePercentage and oneTimeAmount are set, applies oneTimePercentage first
sellOfferPlanSettings
{
properties: {
combineWins: {}, // true|false
prices: {
sellOfferQuantity: [ // sellOfferQuantity type price settings, ordered low to high
{
upToValue: "xx.xx",
price: "xx.xx",
},
// ...
],
orderQuantity: [ // orderQuantity type price settings, ordered low to high
{
upToValue: "xx.xx",
price: "xx.xx",
},
// ...
]
orderValue: [ // orderValue type price settings, ordered low to high
{
upToValue: "xx.xx",
price: "xx.xx",
},
// ...
]
},
},
}
Relationships
{
relationshipType: "{SellOfferPlanLib.createHasSellOfferPlanGraphRelationshipType()}", // "has_sellOfferPlan"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
- links a user to one of their sell offer plans
{
relationshipType: "{SellOfferPlanLib.createHasDeliveryMethodLinkGraphRelationshipType()}", // "has_deliveryMethodLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
{
relationshipType: "{SellOfferPlanLib.createDisabledDeliveryMethodLinkGraphRelationshipType()}", // "disabled_deliveryMethodLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
{
relationshipType: "{SellOfferPlanLib.createHasUserPaymentMethodLinkGraphRelationshipType()}", // "has_userPaymentMethodLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
{
relationshipType: "{SellOfferPlanLib.createDisabledUserPaymentMethodLinkGraphRelationshipType()}", // "disabled_userPaymentMethodLink"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
- many sell offer plans can link to one delivery method link, or one payment method link, this allows user to share settings in the link nodes across multiple sell offer plans
{
relationshipType: "{SellOfferPlanLib.createIsDeliveryMethodGraphRelationshipType()}", // "is_deliveryMethod"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
{
relationshipType: "{SellOfferPlanLib.createIsUserPaymentMethodGraphRelationshipType()}", // "is_userPaymentMethod"
schema: {
elementCanBeRemoved: true,
allPropertiesImmutable: true,
restrictProperties: true,
properties: {
originTimestamp: //timestamp the request to create/change this relationship was sent
},
}
}
Complex Filter requests
{
filterType: "sellOfferPlan" //unique id is sellOfferPlanId
type: "group",
elements:
[
{
type: "logical",
logicalTag: "userId",
comparison: "equals",
value: "xx"
},
{
type: "logical",
logicalTag: "combineWins",
comparison: "true",
},
{
type: "logical",
logicalTag: "maxPrice",
comparison: "lessThan",
value: "xx"
},
{
type: "logical",
logicalTag: "minPrice",
comparison: "lessThan",
value: "xx"
},
{
type: "complexFilter",
complexFilter: {
filterType: "userPaymentMethod",
// see [[Service - Payment Method Generic|Complex Filter requests]]
}
},
{
type: "complexFilter",
complexFilter: {
filterType: "deliveryMethod",
// see [[Service - Delivery Method Standard|Complex Filter requests]]
}
},
...
]
}
Translate Ids - userPaymentMethod and deliveryMethod to sellOfferPlan
- only find sellOfferPlanIds that have has_userPaymentMethodLink or has_deliveryMethodLink relationships (ignore disabled)
- bypasses link nodes (no complex filterType)
Calc pricing use cases
Complex filter
Complex filter (filterType = sellOfferPlan) can find all sellOfferPlanIds that match a pricing comparison, eg minimumPrice < 100:
- request enters at ProcessLogical and saves PriceLogical record that is used to send final ProcessLogicalComplete message
- creates FilteredSellOfferPlanList which manages the final status of a list of sellOfferPlans that match a range of deliverToLocationIds / orderQuantity / paymentMethodIds / deliveryMethodIds (set by the ProcessLogical request)
- all sellOfferPlans that actively offer both any paymentMethodIds and any deliveryMethodIds are processed
- each sellOfferPlan is saved into FilteredSellOfferPlanPending, then check if SellOfferPlanPriceRange exists and complete/not expired, if not then initiate SellOfferPlanPriceRange processing, if is complete (or no sellOfferPlans found) need to copy all matching SellOfferPlanPrices into FilteredSellOfferPlanPrice and remove FilteredSellOfferPlanPending record
- for each sellOfferPlan find all delivery/payment method links that match given arrays
- for each sellOfferPlan all deliverToLocationIds / orderQuantity / sellOfferPlanUserPaymentMethodLinkId_sellOfferPlanDeliveryMethodLinkId combinations create SellOfferPlanPriceRangePricePending record then check if SellOfferPlanPrice complete/not expired, if not then send to PriceCalc, if is complete need to copy SellOfferPlanPrice into FilteredSellOfferPlanPrice remove SellOfferPlanPriceRangePricePending record, and if all combinations already exist (or no combinations found) invoke CheckSellOfferPlanPriceRangeComplete (be careful if paginating lambda processing, can only check this paginations set of found combinations)
- PriceCalc result is saved into SellOfferPlanPrice
- all matching SellOfferPlanPriceRangePricePending records trigger CheckSellOfferPlanPriceRangeComplete:
- removes SellOfferPlanPriceRangePricePending record (do this in CheckSellOfferPlanPriceRangeComplete for idempodence)
- saves record into FilteredSellOfferPlanPrice according to the SellOfferPlanPrice that was just completed (maybe do this in one hot when SellOfferPlanPriceRange completes, we can use same code for when new FilteredSellOfferPlanList finds existing SellOfferPlanPriceRange
- if no SellOfferPlanPriceRangePricePendings remain, set SellOfferPlanPriceRange status to complete and trigger CheckFilteredSellOfferPlanComplete:
- remove FilteredSellOfferPlanPending record (do this in CheckFilteredSellOfferPlanComplete for idempodence)
- if no FilteredSellOfferPlanPending remain, set FilteredSellOfferPlanList status to complete, find all matching PriceLogicals and trigger CompletePriceLogical:
- perform comparison on FilteredSellOfferPlanPrice and save results into LogicalResults
- send final ProcessLogicalComplete message
Cart price
A cart has a fixed deliveryMethod and paymentMethod so no comparisons are needed across these, instead the array of sellOfferQuantities are sent to PriceCalc which returns the total price, per sellOffer price, orderQuantity, etc..
Presenting a sellOffer's price options
- For a range of (or all) paymentMethodIds / deliveryMethodIds, deliverToLocationIds / orderQuantity are fixed.
- Enters at SellOfferPlanPriceRange flow
- Maybe have another table that triggers result actions, if any (can maybe poll SellOfferPlanPriceRange table to see if complete)
Presenting a product's price options
- For a range of (or all) paymentMethodIds / deliveryMethodIds, deliverToLocationIds / orderQuantity are fixed
- Enters at SellOfferPlanPriceRange flow, for each of the product's sellOffers
- Maybe have a table that manages the status of all found sellOfferPlans's and their SellOfferPlanPriceRange, similar to FilteredSellOfferPlanList/FilteredSellOfferPlanPending
- Probably find all sellOfferPlan's that match paymentMethodIds / deliveryMethodIds for that product before sending to SellOfferPlanPriceRange flow, similar to FilteredSellOfferPlanList flow