refactor: determine stripe checkout mode dynamically (#2986)

Author: clD11

services/skus/model/model.go

@@ -449,21 +449,16 @@ type OrderItemRequest struct {
 
 // CreateOrderRequestNew includes information needed to create an order.
 type CreateOrderRequestNew struct {
-	Email           string                `json:"email" validate:"required,email"`
-	CustomerID      string                `json:"customer_id"` // Optional.
-	Currency        string                `json:"currency" validate:"required,iso4217"`
-	StripeMetadata  *OrderStripeMetadata  `json:"stripe_metadata"`
-	RadomMetadata   *OrderRadomMetadata   `json:"radom_metadata"`
-	PaymentMethods  []string              `json:"payment_methods"`
-	Discounts       []string              `json:"discounts"`
-	Items           []OrderItemRequestNew `json:"items" validate:"required,gt=0,dive"`
-	Metadata        map[string]string     `json:"metadata"`
-	Locale          string                `json:"locale" validate:"omitempty,bcp47_language_tag"`
-	PricingInterval string                `json:"pricing_interval" validate:"omitempty,oneof=one-off"`
-}
-
-func (r *CreateOrderRequestNew) IsOneOffPayment() bool {
-	return r.PricingInterval == "one-off"
+	Email          string                `json:"email" validate:"required,email"`
+	CustomerID     string                `json:"customer_id"` // Optional.
+	Currency       string                `json:"currency" validate:"required,iso4217"`
+	StripeMetadata *OrderStripeMetadata  `json:"stripe_metadata"`
+	RadomMetadata  *OrderRadomMetadata   `json:"radom_metadata"`
+	PaymentMethods []string              `json:"payment_methods"`
+	Discounts      []string              `json:"discounts"`
+	Items          []OrderItemRequestNew `json:"items" validate:"required,gt=0,dive"`
+	Metadata       map[string]string     `json:"metadata"`
+	Locale         string                `json:"locale" validate:"omitempty,bcp47_language_tag"`
 }
 
 // OrderItemRequestNew represents an item in an order request.

services/skus/model/model_test.go

@@ -1958,49 +1958,3 @@ func TestOrderItem_IsSearchAnnual(t *testing.T) {
 func ptrTo[T any](v T) *T {
 	return &v
 }
-
-func TestCreateOrderRequestNew_IsOneOffPayment(t *testing.T) {
-	type tcGiven struct {
-		req *model.CreateOrderRequestNew
-	}
-
-	type tcExpected struct {
-		res bool
-	}
-
-	type testCase struct {
-		name  string
-		given tcGiven
-		exp   tcExpected
-	}
-
-	tests := []testCase{
-		{
-			name: "pricing_interval_none",
-			given: tcGiven{
-				req: &model.CreateOrderRequestNew{},
-			},
-		},
-
-		{
-			name: "pricing_interval_one_off",
-			given: tcGiven{
-				req: &model.CreateOrderRequestNew{
-					PricingInterval: "one-off",
-				},
-			},
-			exp: tcExpected{
-				res: true,
-			},
-		},
-	}
-
-	for i := range tests {
-		tc := tests[i]
-
-		t.Run(tc.name, func(t *testing.T) {
-			actual := tc.given.req.IsOneOffPayment()
-			should.Equal(t, tc.exp.res, actual)
-		})
-	}
-}

services/skus/service.go

@@ -2163,11 +2163,6 @@ func (s *Service) createStripeSession(ctx context.Context, req *model.CreateOrde
 		return "", err
 	}
 
-	csm := string(stripe.CheckoutSessionModeSubscription)
-	if req.IsOneOffPayment() {
-		csm = string(stripe.CheckoutSessionModePayment)
-	}
-
 	sreq := createStripeSessionRequest{
 		orderID:    oid,
 		email:      req.Email,
@@ -2179,7 +2174,7 @@ func (s *Service) createStripeSession(ctx context.Context, req *model.CreateOrde
 		discounts:  buildStripeDiscounts(req.Discounts),
 		metadata:   req.Metadata,
 		Locale:     req.Locale,
-		csMode:     csm,
+		csMode:     determineStripeCheckoutSessionMode(req.Items),
 	}
 
 	return createStripeSession(ctx, s.stripeCl, sreq, s.stripeLocaleValid)
@@ -3110,6 +3105,14 @@ func buildStripeDiscounts(discounts []string) []*stripe.CheckoutSessionDiscountP
 	return result
 }
 
+func determineStripeCheckoutSessionMode(items []model.OrderItemRequestNew) string {
+	if len(items) == 1 && items[0].Period == "one-off" {
+		return string(stripe.CheckoutSessionModePayment)
+	}
+
+	return string(stripe.CheckoutSessionModeSubscription)
+}
+
 func handleRedeemFnError(ctx context.Context, w http.ResponseWriter, kind string, cred *cbr.CredentialRedemption, err error) *handlers.AppError {
 	msg := err.Error()
 

services/skus/service_nonint_test.go

@@ -4285,6 +4285,13 @@ func TestService_createStripeSession(t *testing.T) {
 		{
 			name: "success_mode_payment",
 			given: tcGiven{
+				req: &model.CreateOrderRequestNew{
+					Items: []model.OrderItemRequestNew{
+						{
+							Period: "one-off",
+						},
+					},
+				},
 				cl: &xstripe.MockClient{
 					FnCreateSession: func(ctx context.Context, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error) {
 						if *params.Mode != string(stripe.CheckoutSessionModePayment) {
@@ -4296,9 +4303,6 @@ func TestService_createStripeSession(t *testing.T) {
 						return result, nil
 					},
 				},
-				req: &model.CreateOrderRequestNew{
-					PricingInterval: "one-off",
-				},
 				ord: &model.Order{},
 			},
 			exp: tcExpected{

services/skus/service_test.go

@@ -793,3 +793,105 @@ func TestTimeChunking(t *testing.T) {
 		})
 	}
 }
+
+func TestDetermineStripeCheckoutSessionMode(t *testing.T) {
+	type tcGiven struct {
+		items []model.OrderItemRequestNew
+	}
+
+	type tcExpected struct {
+		csm string
+	}
+
+	type testCase struct {
+		name  string
+		given tcGiven
+		exp   tcExpected
+	}
+
+	tests := []testCase{
+		{
+			name: "no_items",
+			exp: tcExpected{
+				csm: "subscription",
+			},
+		},
+
+		{
+			name: "one_item_empty_period",
+			given: tcGiven{
+				items: []model.OrderItemRequestNew{{}},
+			},
+			exp: tcExpected{
+				csm: "subscription",
+			},
+		},
+
+		{
+			name: "one_item_period_subscription",
+			given: tcGiven{
+				items: []model.OrderItemRequestNew{{
+					Period: "subscription",
+				}},
+			},
+			exp: tcExpected{
+				csm: "subscription",
+			},
+		},
+
+		{
+			name: "one_item_period_one_off",
+			given: tcGiven{
+				items: []model.OrderItemRequestNew{{
+					Period: "one-off",
+				}},
+			},
+			exp: tcExpected{
+				csm: "payment",
+			},
+		},
+
+		{
+			name: "multiple_items_period_subscription",
+			given: tcGiven{
+				items: []model.OrderItemRequestNew{
+					{
+						Period: "subscription",
+					},
+					{
+						Period: "subscription",
+					},
+				},
+			},
+			exp: tcExpected{
+				csm: "subscription",
+			},
+		},
+
+		{
+			name: "multiple_items_period_one_off",
+			given: tcGiven{
+				items: []model.OrderItemRequestNew{
+					{
+						Period: "one-off",
+					},
+					{
+						Period: "one-off",
+					},
+				},
+			},
+			exp: tcExpected{
+				csm: "subscription",
+			},
+		},
+	}
+
+	for i := range tests {
+		tc := tests[i]
+
+		t.Run(tc.name, func(t *testing.T) {
+			actual := determineStripeCheckoutSessionMode(tc.given.items)
+			should.Equal(t, tc.exp.csm, actual)
+		})
+	}
+}