Add webhook for orders create events to notify customer.io of placed orders

Author: toddkazakov

auth/service/service/service.go

@@ -333,7 +333,12 @@ func (s *Service) initializeRouter() error {
 		return errors.Wrap(err, "unable to create fulfillment event processor")
 	}
 
-	shopifyRouter, err := shopifyAPI.NewRouter(fulfillmentEventProcessor)
+	ordersCreateEventProcessor, err := shopify.NewOrdersCreateEventProcessor(s.Logger(), customerIOClient, shopifyClnt)
+	if err != nil {
+		return errors.Wrap(err, "unable to create orders create event processor")
+	}
+
+	shopifyRouter, err := shopifyAPI.NewRouter(fulfillmentEventProcessor, ordersCreateEventProcessor)
 	if err != nil {
 		return errors.Wrap(err, "unable to create shopify router")
 	}

oura/customerio/events.go

@@ -2,7 +2,9 @@ package customerio
 
 const (
 	OuraEligibilitySurveyCompletedEventType = "oura_eligibility_survey_completed"
+	OuraSizingKitOrderedEventType           = "oura_sizing_kit_ordered"
 	OuraSizingKitDeliveredEventType         = "oura_sizing_kit_delivered"
+	OuraRingOrderedEventType                = "oura_ring_ordered"
 	OuraRingDeliveredEventType              = "oura_ring_delivered"
 )
 
@@ -12,8 +14,18 @@ type OuraEligibilitySurveyCompletedData struct {
 	OuraSizingKitDiscountCode     string `json:"oura_sizing_kit_discount_code,omitempty"`
 }
 
+type OuraSizingKitOrderedData struct {
+	OuraSizingKitDiscountCode string `json:"oura_sizing_kit_discount_code"`
+}
+
 type OuraSizingKitDeliveredData struct {
-	OuraRingDiscountCode string `json:"oura_ring_discount_code"`
+	OuraSizingKitDiscountCode string `json:"oura_sizing_kit_discount_code"`
+	OuraRingDiscountCode      string `json:"oura_ring_discount_code"`
 }
 
-type OuraRingDeliveredData struct{}
+type OuraRingOrderedData struct {
+	OuraRingDiscountCode string `json:"oura_ring_discount_code"`
+}
+type OuraRingDeliveredData struct {
+	OuraRingDiscountCode string `json:"oura_ring_discount_code"`
+}

oura/shopify/api/router.go

@@ -10,18 +10,21 @@ import (
 )
 
 type Router struct {
-	fulfillmentEventProcessor *shopify.FulfillmentEventProcessor
+	fulfillmentEventProcessor  *shopify.FulfillmentEventProcessor
+	ordersCreateEventProcessor *shopify.OrdersCreateEventProcessor
 }
 
-func NewRouter(fulfillmentEventProcessor *shopify.FulfillmentEventProcessor) (*Router, error) {
+func NewRouter(fulfillmentEventProcessor *shopify.FulfillmentEventProcessor, ordersCreateEventProcessor *shopify.OrdersCreateEventProcessor) (*Router, error) {
 	return &Router{
-		fulfillmentEventProcessor: fulfillmentEventProcessor,
+		fulfillmentEventProcessor:  fulfillmentEventProcessor,
+		ordersCreateEventProcessor: ordersCreateEventProcessor,
 	}, nil
 }
 
 func (r *Router) Routes() []*rest.Route {
 	return []*rest.Route{
 		rest.Post("/v1/partners/shopify/fulfillment", r.HandleFulfillmentEvent),
+		rest.Post("/v1/partners/shopify/orders/create", r.HandleOrdersCreateEvent),
 	}
 }
 
@@ -30,7 +33,7 @@ func (r *Router) HandleFulfillmentEvent(res rest.ResponseWriter, req *rest.Reque
 	responder := request.MustNewResponder(res, req)
 
 	event := shopify.FulfillmentEvent{}
-	if err := request.DecodeRequestBody(req.Request, event); err != nil {
+	if err := request.DecodeRequestBody(req.Request, &event); err != nil {
 		responder.Error(http.StatusBadRequest, err)
 		return
 	}
@@ -43,3 +46,22 @@ func (r *Router) HandleFulfillmentEvent(res rest.ResponseWriter, req *rest.Reque
 	responder.Empty(http.StatusOK)
 	return
 }
+
+func (r *Router) HandleOrdersCreateEvent(res rest.ResponseWriter, req *rest.Request) {
+	ctx := req.Context()
+	responder := request.MustNewResponder(res, req)
+
+	event := shopify.OrdersCreateEvent{}
+	if err := request.DecodeRequestBody(req.Request, &event); err != nil {
+		responder.Error(http.StatusBadRequest, err)
+		return
+	}
+
+	if err := r.ordersCreateEventProcessor.Process(ctx, event); err != nil {
+		responder.Error(http.StatusInternalServerError, err)
+		return
+	}
+
+	responder.Empty(http.StatusOK)
+	return
+}

oura/shopify/client.go

@@ -21,7 +21,6 @@ type DiscountCodeInput struct {
 }
 
 type DeliveredProducts struct {
-	OrderID      string   `json:"order_id"`
 	IDs          []string `json:"products"`
 	DiscountCode string   `json:"discount_code"`
 }

oura/shopify/client/order.go

@@ -59,5 +59,12 @@ func (c *defaultClient) GetDeliveredProducts(ctx context.Context, orderID string
 		}
 	}
 
-	return &shopify.DeliveredProducts{IDs: ids}, nil
+	var discountCode string
+	if resp.GetOrderByIdentifier().GetDiscountCode() != nil {
+		discountCode = *resp.GetOrderByIdentifier().GetDiscountCode()
+	}
+	return &shopify.DeliveredProducts{
+		IDs:          ids,
+		DiscountCode: discountCode,
+	}, nil
 }

oura/shopify/fulfillment.go

@@ -12,7 +12,7 @@ import (
 )
 
 var (
-	deliveredProductIDToOuraDiscountAttribute = map[string]string{
+	productIDToOuraDiscountAttribute = map[string]string{
 		OuraSizingKitProductID: "oura_sizing_kit_discount_code",
 		OuraRingProductID:      "oura_ring_discount_code",
 	}
@@ -75,7 +75,7 @@ func (f *FulfillmentEventProcessor) Process(ctx context.Context, event Fulfillme
 	deliveredProductID := deliveredProducts.IDs[0]
 	logger = logger.WithField("orderId", orderId).WithField("productId", deliveredProductID)
 
-	attribute, ok := deliveredProductIDToOuraDiscountAttribute[deliveredProductID]
+	attribute, ok := productIDToOuraDiscountAttribute[deliveredProductID]
 	if !ok {
 		logger.Warn("unable to find discount attribute for delivered product")
 		return nil
@@ -85,9 +85,11 @@ func (f *FulfillmentEventProcessor) Process(ctx context.Context, event Fulfillme
 		"filter": map[string]any{
 			"and": []any{
 				map[string]any{
-					"field":    attribute,
-					"operator": "eq",
-					"value":    deliveredProducts.DiscountCode,
+					"attribute": map[string]any{
+						"field":    attribute,
+						"operator": "eq",
+						"value":    deliveredProducts.DiscountCode,
+					},
 				},
 			},
 		},
@@ -111,12 +113,12 @@ func (f *FulfillmentEventProcessor) Process(ctx context.Context, event Fulfillme
 
 	switch deliveredProductID {
 	case OuraSizingKitProductID:
-		if err := f.onSizingKitDelivered(ctx, customers.Identifiers[0], event); err != nil {
+		if err := f.onSizingKitDelivered(ctx, customers.Identifiers[0], event, deliveredProducts.DiscountCode); err != nil {
 			logger.WithError(err).Warn("unable to send sizing kit delivered event")
 			return err
 		}
 	case OuraRingProductID:
-		if err := f.onRingDelivered(ctx, customers.Identifiers[0], event); err != nil {
+		if err := f.onRingDelivered(ctx, customers.Identifiers[0], event, deliveredProducts.DiscountCode); err != nil {
 			logger.WithError(err).Warn("unable to send ring delivered event")
 			return err
 		}
@@ -127,7 +129,7 @@ func (f *FulfillmentEventProcessor) Process(ctx context.Context, event Fulfillme
 	return nil
 }
 
-func (f *FulfillmentEventProcessor) onSizingKitDelivered(ctx context.Context, identifiers customerio.Identifiers, event FulfillmentEvent) error {
+func (f *FulfillmentEventProcessor) onSizingKitDelivered(ctx context.Context, identifiers customerio.Identifiers, event FulfillmentEvent, sizingKitDiscountCode string) error {
 	discountCode := RandomDiscountCode()
 	err := f.shopifyClient.CreateDiscountCode(ctx, DiscountCodeInput{
 		Title:     OuraRingDiscountCodeTitle,
@@ -142,18 +144,21 @@ func (f *FulfillmentEventProcessor) onSizingKitDelivered(ctx context.Context, id
 		Name: customerio.OuraSizingKitDeliveredEventType,
 		ID:   fmt.Sprintf("%d", event.ID),
 		Data: customerio.OuraSizingKitDeliveredData{
-			OuraRingDiscountCode: discountCode,
+			OuraRingDiscountCode:      discountCode,
+			OuraSizingKitDiscountCode: sizingKitDiscountCode,
 		},
 	}
 
 	return f.customerIOClient.SendEvent(ctx, identifiers.ID, sizingKitDelivered)
 }
 
-func (f *FulfillmentEventProcessor) onRingDelivered(ctx context.Context, identifiers customerio.Identifiers, event FulfillmentEvent) error {
+func (f *FulfillmentEventProcessor) onRingDelivered(ctx context.Context, identifiers customerio.Identifiers, event FulfillmentEvent, ringDiscountCode string) error {
 	ringDelivered := customerio.Event{
 		Name: customerio.OuraRingDeliveredEventType,
 		ID:   fmt.Sprintf("%d", event.ID),
-		Data: customerio.OuraRingDeliveredData{},
+		Data: customerio.OuraRingDeliveredData{
+			OuraRingDiscountCode: ringDiscountCode,
+		},
 	}
 
 	return f.customerIOClient.SendEvent(ctx, identifiers.ID, ringDelivered)

oura/shopify/fulfillment_test.go

@@ -86,7 +86,6 @@ var _ = Describe("FulfillmentEventProcessor", func() {
 			shopifyClnt.EXPECT().
 				GetDeliveredProducts(gomock.Any(), fmt.Sprintf("gid://shopify/Order/%d", event.OrderID)).
 				Return(&shopify.DeliveredProducts{
-					OrderID:      fmt.Sprintf("%d", event.OrderID),
 					IDs:          []string{shopify.OuraSizingKitProductID},
 					DiscountCode: sizingKitDiscountCode,
 				}, nil)
@@ -100,9 +99,11 @@ var _ = Describe("FulfillmentEventProcessor", func() {
 					    "filter": {
 				  		    "and": [
 				 		        {
-							        "field": "oura_sizing_kit_discount_code",
-							        "operator": "eq",
-							        "value": "` + sizingKitDiscountCode + `"
+									"attribute": {
+										"field": "oura_sizing_kit_discount_code",
+							        	"operator": "eq",
+							        	"value": "` + sizingKitDiscountCode + `"
+                                    }
 						        }
 						    ]
 					    }
@@ -125,7 +126,8 @@ var _ = Describe("FulfillmentEventProcessor", func() {
 					  	        "name": "oura_sizing_kit_delivered",
 						        "id": "` + fmt.Sprintf("%d", event.ID) + `",
 						        "data": {
-                                    "oura_ring_discount_code": "` + input.Code + `"
+                                    "oura_ring_discount_code": "` + input.Code + `",
+                                    "oura_sizing_kit_discount_code": "` + sizingKitDiscountCode + `"
                                 }
 					        }`),
 						},
@@ -153,7 +155,6 @@ var _ = Describe("FulfillmentEventProcessor", func() {
 			shopifyClnt.EXPECT().
 				GetDeliveredProducts(gomock.Any(), fmt.Sprintf("gid://shopify/Order/%d", event.OrderID)).
 				Return(&shopify.DeliveredProducts{
-					OrderID:      fmt.Sprintf("%d", event.OrderID),
 					IDs:          []string{shopify.OuraRingProductID},
 					DiscountCode: discountCode,
 				}, nil)
@@ -167,9 +168,11 @@ var _ = Describe("FulfillmentEventProcessor", func() {
 					    "filter": {
 				  		    "and": [
 				 		        {
-							        "field": "oura_ring_discount_code",
-							        "operator": "eq",
-							        "value": "` + discountCode + `"
+									"attribute": {
+										"field": "oura_ring_discount_code",
+										"operator": "eq",
+										"value": "` + discountCode + `"
+									}
 						        }
 						    ]
 					    }
@@ -184,7 +187,9 @@ var _ = Describe("FulfillmentEventProcessor", func() {
 					ouraTest.NewRequestJSONBodyMatcher(`{
 					  	"name": "oura_ring_delivered",
 						"id": "` + fmt.Sprintf("%d", event.ID) + `",
-						"data": {}
+                        "data": {
+                          "oura_ring_discount_code": "` + discountCode + `"
+                        }
 					}`),
 				},
 				ouraTest.Response{StatusCode: http.StatusOK, Body: "{}"},