Add Stripe-Request-Trigger header (#2288)

* add "prepare" to justfile

* add Stripe-Request-Trigger header

* remove new generated code

Author: xavdid-stripe

event_notification.go

@@ -2,6 +2,7 @@ package stripe
 
 import (
 	"context"
+	"fmt"
 	"net/http"
 	"time"
 )
@@ -37,6 +38,8 @@ func (n *V2CoreEventNotification) fetchEvent(ctx context.Context) (V2CoreEvent,
 	// TODO: usage?
 	params := &V2CoreEventRetrieveParams{}
 	params.SetStripeContextFrom(n.Context)
+	params.Headers = make(http.Header)
+	params.Headers.Set("Stripe-Request-Trigger", fmt.Sprintf("event=%s", n.ID))
 
 	return n.client.V2CoreEvents.Retrieve(ctx, n.ID, params)
 }
@@ -74,6 +77,8 @@ func (n *UnknownEventNotification) FetchRelatedObject(ctx context.Context) (*API
 	obj := &APIResource{}
 	params := &eventNotificationParams{Params: Params{Context: ctx}}
 	params.SetStripeContextFrom(n.Context)
+	params.Headers = make(http.Header)
+	params.Headers.Set("Stripe-Request-Trigger", fmt.Sprintf("event=%s", n.ID))
 
 	err := n.client.backend.Call(http.MethodGet, n.RelatedObject.URL, n.client.key, params, obj)
 	return obj, err

justfile

@@ -8,6 +8,9 @@ export PATH := home_directory() + "/go/bin:" + env('PATH')
 _default:
     just --list --unsorted
 
+# ⭐ run format, lint, and tests to prepare for CI
+prepare: format lint test
+
 # ⭐ run all unit tests, or pass a package name (./invoice) to only run those tests
 test *args="./...":
     go run scripts/test_with_stripe_mock/main.go -race {{ args }}

stripe_client_test.go

@@ -6,6 +6,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"net/http"
+	"net/http/httptest"
 	"testing"
 	"time"
 
@@ -198,7 +199,14 @@ func TestParseUnknownEventNotificationWithRelatedObject(t *testing.T) {
 	}`
 
 	// Create mock server that expects a GET to /v1/related_objects/ro_123
-	server := MockServerWithStripeContext(t, http.MethodGet, "/v1/related_objects/ro_123", "ctx_123", nil, relatedObjectResp)
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, http.MethodGet, r.Method)
+		assert.Equal(t, "/v1/related_objects/ro_123", r.URL.Path)
+		assert.Equal(t, "Bearer "+TestAPIKey, r.Header.Get("Authorization"))
+		assert.Equal(t, "ctx_123", r.Header.Get("Stripe-Context"))
+		assert.Equal(t, "event=evt_test_webhook", r.Header.Get("Stripe-Request-Trigger"))
+		w.Write([]byte(relatedObjectResp))
+	}))
 	defer server.Close()
 
 	// Create client with custom backend pointing to mock server
@@ -262,7 +270,14 @@ func TestFetchEventHTTPCall(t *testing.T) {
 	}`
 
 	// Create mock server that expects a GET to /v2/core/events/evt_123
-	server := MockServerWithStripeContext(t, http.MethodGet, "/v2/core/events/evt_123", "ctx_123", nil, mockEventResponse)
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, http.MethodGet, r.Method)
+		assert.Equal(t, "/v2/core/events/evt_123", r.URL.Path)
+		assert.Equal(t, "Bearer "+TestAPIKey, r.Header.Get("Authorization"))
+		assert.Equal(t, "ctx_123", r.Header.Get("Stripe-Context"))
+		assert.Equal(t, "event=evt_123", r.Header.Get("Stripe-Request-Trigger"))
+		w.Write([]byte(mockEventResponse))
+	}))
 	defer server.Close()
 
 	// Create client with custom backend pointing to mock server
@@ -319,7 +334,13 @@ func TestFetchRelatedObject(t *testing.T) {
 	}`
 
 	// Create mock server that expects a GET to /v1/billing/meters/bm_123
-	server := MockServer(t, http.MethodGet, "/v1/billing/meters/bm_123", nil, mockRelatedObjectResponse)
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, http.MethodGet, r.Method)
+		assert.Equal(t, "/v1/billing/meters/bm_123", r.URL.Path)
+		assert.Equal(t, "Bearer "+TestAPIKey, r.Header.Get("Authorization"))
+		assert.Equal(t, "event=evt_123", r.Header.Get("Stripe-Request-Trigger"))
+		w.Write([]byte(mockRelatedObjectResponse))
+	}))
 	defer server.Close()
 
 	// Create client with custom backend pointing to mock server
@@ -385,7 +406,14 @@ func TestFetchRelatedObjectUnknownEvent(t *testing.T) {
 
 	// Create mock server that expects a GET to /v1/billing/meters/bm_123
 	// it also checks that stripe-context is correct
-	server := MockServerWithStripeContext(t, http.MethodGet, "/v1/billing/meters/bm_123", "ctx_123", nil, mockRelatedObjectResponse)
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, http.MethodGet, r.Method)
+		assert.Equal(t, "/v1/billing/meters/bm_123", r.URL.Path)
+		assert.Equal(t, "Bearer "+TestAPIKey, r.Header.Get("Authorization"))
+		assert.Equal(t, "ctx_123", r.Header.Get("Stripe-Context"))
+		assert.Equal(t, "event=evt_123", r.Header.Get("Stripe-Request-Trigger"))
+		w.Write([]byte(mockRelatedObjectResponse))
+	}))
 	defer server.Close()
 
 	// Create client with custom backend pointing to mock server