feat(wallets): add ik support (#1591)

formancehq · Jul 2, 2024 · 78ef89c · 78ef89c
1 parent 6650368
commit 78ef89c
Show file tree

Hide file tree

Showing 31 changed files with 187 additions and 53 deletions.
diff --git a/components/ledger/internal/api/v2/query.go b/components/ledger/internal/api/v2/query.go
@@ -4,6 +4,7 @@ import (
 	"net/http"
 	"strings"
 
+	"github.com/formancehq/stack/libs/go-libs/api"
 	"github.com/formancehq/stack/libs/go-libs/bun/bunpaginate"
 
 	"github.com/formancehq/ledger/internal/engine/command"
@@ -28,10 +29,8 @@ func getCommandParameters(r *http.Request) command.Parameters {
 	dryRunAsString := r.URL.Query().Get("dryRun")
 	dryRun := strings.ToUpper(dryRunAsString) == "YES" || strings.ToUpper(dryRunAsString) == "TRUE" || dryRunAsString == "1"
 
-	idempotencyKey := r.Header.Get("Idempotency-Key")
-
 	return command.Parameters{
 		DryRun:         dryRun,
-		IdempotencyKey: idempotencyKey,
+		IdempotencyKey: api.IdempotencyKeyFromRequest(r),
 	}
 }
diff --git a/ee/wallets/openapi.yaml b/ee/wallets/openapi.yaml
@@ -191,6 +191,12 @@ paths:
       operationId: updateWallet
       tags:
       - Wallets
+      parameters:
+        - name: Idempotency-Key
+          in: header
+          description: Use an idempotency key
+          schema:
+            type: string
       requestBody:
         content:
           application/json:
@@ -323,6 +329,11 @@ paths:
       required: true
       schema:
         type: string
+    - name: Idempotency-Key
+      in: header
+      description: Use an idempotency key
+      schema:
+        type: string
     post:
       summary: Debit a wallet
       operationId: debitWallet
@@ -356,6 +367,11 @@ paths:
       required: true
       schema:
         type: string
+    - name: Idempotency-Key
+      in: header
+      description: Use an idempotency key
+      schema:
+        type: string
     post:
       summary: Credit a wallet
       operationId: creditWallet
@@ -467,6 +483,11 @@ paths:
         required: true
         schema:
           type: string
+      - name: Idempotency-Key
+        in: header
+        description: Use an idempotency key
+        schema:
+          type: string
       requestBody:
         content:
           application/json:
@@ -493,6 +514,11 @@ paths:
       required: true
       schema:
         type: string
+    - name: Idempotency-Key
+      in: header
+      description: Use an idempotency key
+      schema:
+        type: string
     post:
       summary: Cancel a hold
       operationId: voidHold
@@ -974,6 +1000,7 @@ components:
         expiresAt:
           type: string
           format: date-time
+          nullable: true
         priority:
           type: integer
           format: bigint

diff --git a/ee/wallets/pkg/api/handler_balances_create_test.go b/ee/wallets/pkg/api/handler_balances_create_test.go
@@ -76,7 +76,7 @@ func TestBalancesCreate(t *testing.T) {
 				appliedMetadata map[string]string
 			)
 			testEnv := newTestEnv(
-				WithAddMetadataToAccount(func(ctx context.Context, ledger, account string, metadata map[string]string) error {
+				WithAddMetadataToAccount(func(ctx context.Context, ledger, account, ik string, metadata map[string]string) error {
 					targetedLedger = ledger
 					targetedAccount = account
 					appliedMetadata = metadata

diff --git a/ee/wallets/pkg/api/handler_holds_confirm.go b/ee/wallets/pkg/api/handler_holds_confirm.go
@@ -5,6 +5,8 @@ import (
 	"math/big"
 	"net/http"
 
+	"github.com/formancehq/stack/libs/go-libs/api"
+
 	wallet "github.com/formancehq/wallets/pkg"
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/render"
@@ -28,7 +30,7 @@ func (m *MainHandler) confirmHoldHandler(w http.ResponseWriter, r *http.Request)
 		}
 	}
 
-	err := m.manager.ConfirmHold(r.Context(), wallet.ConfirmHold{
+	err := m.manager.ConfirmHold(r.Context(), api.IdempotencyKeyFromRequest(r), wallet.ConfirmHold{
 		HoldID: chi.URLParam(r, "holdID"),
 		Amount: big.NewInt(data.Amount),
 		Final:  data.Final,

diff --git a/ee/wallets/pkg/api/handler_holds_confirm_test.go b/ee/wallets/pkg/api/handler_holds_confirm_test.go
@@ -40,7 +40,7 @@ func TestHoldsConfirm(t *testing.T) {
 				Balances: balances,
 			}, nil
 		}),
-		WithCreateTransaction(func(ctx context.Context, name string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error) {
+		WithCreateTransaction(func(ctx context.Context, name, ik string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error) {
 			compareJSON(t, wallet.PostTransaction{
 				Script: &shared.V2PostTransactionScript{
 					Plain: wallet.BuildConfirmHoldScript(false, "USD"),
@@ -95,7 +95,7 @@ func TestHoldsPartialConfirm(t *testing.T) {
 				},
 			}, nil
 		}),
-		WithCreateTransaction(func(ctx context.Context, name string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error) {
+		WithCreateTransaction(func(ctx context.Context, name, ik string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error) {
 			compareJSON(t, wallet.PostTransaction{
 				Script: &shared.V2PostTransactionScript{
 					Plain: wallet.BuildConfirmHoldScript(false, "USD"),
@@ -230,7 +230,7 @@ func TestHoldsPartialConfirmWithFinal(t *testing.T) {
 				},
 			}, nil
 		}),
-		WithCreateTransaction(func(ctx context.Context, name string, script wallet.PostTransaction) (*shared.V2Transaction, error) {
+		WithCreateTransaction(func(ctx context.Context, name, ik string, script wallet.PostTransaction) (*shared.V2Transaction, error) {
 			compareJSON(t, wallet.PostTransaction{
 				Script: &shared.V2PostTransactionScript{
 					Plain: wallet.BuildConfirmHoldScript(true, "USD"),

diff --git a/ee/wallets/pkg/api/handler_holds_void.go b/ee/wallets/pkg/api/handler_holds_void.go
@@ -4,12 +4,14 @@ import (
 	"errors"
 	"net/http"
 
+	"github.com/formancehq/stack/libs/go-libs/api"
+
 	wallet "github.com/formancehq/wallets/pkg"
 	"github.com/go-chi/chi/v5"
 )
 
 func (m *MainHandler) voidHoldHandler(w http.ResponseWriter, r *http.Request) {
-	err := m.manager.VoidHold(r.Context(), wallet.VoidHold{
+	err := m.manager.VoidHold(r.Context(), api.IdempotencyKeyFromRequest(r), wallet.VoidHold{
 		HoldID: chi.URLParam(r, "holdID"),
 	})
 	if err != nil {

diff --git a/ee/wallets/pkg/api/handler_holds_void_test.go b/ee/wallets/pkg/api/handler_holds_void_test.go
@@ -45,7 +45,7 @@ func TestHoldsVoid(t *testing.T) {
 				},
 			}, nil
 		}),
-		WithCreateTransaction(func(ctx context.Context, name string, script wallet.PostTransaction) (*shared.V2Transaction, error) {
+		WithCreateTransaction(func(ctx context.Context, name, ik string, script wallet.PostTransaction) (*shared.V2Transaction, error) {
 			compareJSON(t, wallet.PostTransaction{
 				Script: &shared.V2PostTransactionScript{
 					Plain: wallet.BuildCancelHoldScript("USD"),

diff --git a/ee/wallets/pkg/api/handler_wallets_create_test.go b/ee/wallets/pkg/api/handler_wallets_create_test.go
@@ -33,7 +33,7 @@ func TestWalletsCreate(t *testing.T) {
 		md      map[string]string
 	)
 	testEnv := newTestEnv(
-		WithAddMetadataToAccount(func(ctx context.Context, l, a string, m map[string]string) error {
+		WithAddMetadataToAccount(func(ctx context.Context, l, a, ik string, m map[string]string) error {
 			ledger = l
 			account = a
 			md = m

diff --git a/ee/wallets/pkg/api/handler_wallets_credit.go b/ee/wallets/pkg/api/handler_wallets_credit.go
@@ -4,6 +4,8 @@ import (
 	"errors"
 	"net/http"
 
+	"github.com/formancehq/stack/libs/go-libs/api"
+
 	wallet "github.com/formancehq/wallets/pkg"
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/render"
@@ -29,7 +31,7 @@ func (m *MainHandler) creditWalletHandler(w http.ResponseWriter, r *http.Request
 		CreditRequest: *data,
 	}
 
-	err := m.manager.Credit(r.Context(), credit)
+	err := m.manager.Credit(r.Context(), api.IdempotencyKeyFromRequest(r), credit)
 	if err != nil {
 		switch {
 		case errors.Is(err, wallet.ErrBalanceNotExists),

diff --git a/ee/wallets/pkg/api/handler_wallets_credit_test.go b/ee/wallets/pkg/api/handler_wallets_credit_test.go
@@ -181,7 +181,7 @@ func TestWalletsCredit(t *testing.T) {
 				postTransaction wallet.PostTransaction
 			)
 			testEnv = newTestEnv(
-				WithCreateTransaction(func(ctx context.Context, ledger string, p wallet.PostTransaction) (*shared.V2Transaction, error) {
+				WithCreateTransaction(func(ctx context.Context, ledger, ik string, p wallet.PostTransaction) (*shared.V2Transaction, error) {
 					require.Equal(t, testEnv.LedgerName(), ledger)
 					postTransaction = p
 					return &testCase.postTransactionResult, nil

diff --git a/ee/wallets/pkg/api/handler_wallets_debit.go b/ee/wallets/pkg/api/handler_wallets_debit.go
@@ -4,6 +4,8 @@ import (
 	"errors"
 	"net/http"
 
+	"github.com/formancehq/stack/libs/go-libs/api"
+
 	wallet "github.com/formancehq/wallets/pkg"
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/render"
@@ -16,7 +18,7 @@ func (m *MainHandler) debitWalletHandler(w http.ResponseWriter, r *http.Request)
 		return
 	}
 
-	hold, err := m.manager.Debit(r.Context(), wallet.Debit{
+	hold, err := m.manager.Debit(r.Context(), api.IdempotencyKeyFromRequest(r), wallet.Debit{
 		WalletID:     chi.URLParam(r, "walletID"),
 		DebitRequest: *data,
 	})

diff --git a/ee/wallets/pkg/api/handler_wallets_debit_test.go b/ee/wallets/pkg/api/handler_wallets_debit_test.go
@@ -336,7 +336,7 @@ func TestWalletsDebit(t *testing.T) {
 						},
 					}, nil
 				}),
-				WithCreateTransaction(func(ctx context.Context, ledger string, p wallet.PostTransaction) (*shared.V2Transaction, error) {
+				WithCreateTransaction(func(ctx context.Context, ledger, ik string, p wallet.PostTransaction) (*shared.V2Transaction, error) {
 					require.Equal(t, testEnv.LedgerName(), ledger)
 					postTransaction = p
 					if testCase.postTransactionError != nil {

diff --git a/ee/wallets/pkg/api/handler_wallets_patch.go b/ee/wallets/pkg/api/handler_wallets_patch.go
@@ -4,6 +4,8 @@ import (
 	"errors"
 	"net/http"
 
+	"github.com/formancehq/stack/libs/go-libs/api"
+
 	wallet "github.com/formancehq/wallets/pkg"
 	"github.com/go-chi/chi/v5"
 	"github.com/go-chi/render"
@@ -16,7 +18,7 @@ func (m *MainHandler) patchWalletHandler(w http.ResponseWriter, r *http.Request)
 		return
 	}
 
-	err := m.manager.UpdateWallet(r.Context(), chi.URLParam(r, "walletID"), data)
+	err := m.manager.UpdateWallet(r.Context(), chi.URLParam(r, "walletID"), api.IdempotencyKeyFromRequest(r), data)
 	if err != nil {
 		switch {
 		case errors.Is(err, wallet.ErrWalletNotFound):

diff --git a/ee/wallets/pkg/api/handler_wallets_patch_test.go b/ee/wallets/pkg/api/handler_wallets_patch_test.go
@@ -42,7 +42,7 @@ func TestWalletsPatch(t *testing.T) {
 				},
 			}, nil
 		}),
-		WithAddMetadataToAccount(func(ctx context.Context, ledger, account string, md map[string]string) error {
+		WithAddMetadataToAccount(func(ctx context.Context, ledger, account, ik string, md map[string]string) error {
 			require.Equal(t, testEnv.LedgerName(), ledger)
 			require.Equal(t, testEnv.Chart().GetMainBalanceAccount(w.ID), account)
 			compareJSON(t, metadata.Metadata{

diff --git a/ee/wallets/pkg/api/utils_test.go b/ee/wallets/pkg/api/utils_test.go
@@ -92,11 +92,11 @@ func newTestEnv(opts ...Option) *testEnv {
 }
 
 type (
-	addMetadataToAccountFn func(ctx context.Context, ledger, account string, metadata map[string]string) error
+	addMetadataToAccountFn func(ctx context.Context, ledger, account, ik string, metadata map[string]string) error
 	getAccountFn           func(ctx context.Context, ledger, account string) (*wallet.AccountWithVolumesAndBalances, error)
 	listAccountsFn         func(ctx context.Context, ledger string, query wallet.ListAccountsQuery) (*wallet.AccountsCursorResponseCursor, error)
 	listTransactionsFn     func(ctx context.Context, ledger string, query wallet.ListTransactionsQuery) (*shared.V2TransactionsCursorResponseCursor, error)
-	createTransactionFn    func(ctx context.Context, ledger string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error)
+	createTransactionFn    func(ctx context.Context, ledger, ik string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error)
 )
 
 type LedgerMock struct {
@@ -111,8 +111,8 @@ func (l *LedgerMock) EnsureLedgerExists(ctx context.Context, name string) error
 	return nil
 }
 
-func (l *LedgerMock) AddMetadataToAccount(ctx context.Context, ledger, account string, metadata map[string]string) error {
-	return l.addMetadataToAccount(ctx, ledger, account, metadata)
+func (l *LedgerMock) AddMetadataToAccount(ctx context.Context, ledger, account, ik string, metadata map[string]string) error {
+	return l.addMetadataToAccount(ctx, ledger, account, ik, metadata)
 }
 
 func (l *LedgerMock) GetAccount(ctx context.Context, ledger, account string) (*wallet.AccountWithVolumesAndBalances, error) {
@@ -123,8 +123,8 @@ func (l *LedgerMock) ListAccounts(ctx context.Context, ledger string, query wall
 	return l.listAccounts(ctx, ledger, query)
 }
 
-func (l *LedgerMock) CreateTransaction(ctx context.Context, ledger string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error) {
-	return l.createTransaction(ctx, ledger, postTransaction)
+func (l *LedgerMock) CreateTransaction(ctx context.Context, ledger, ik string, postTransaction wallet.PostTransaction) (*shared.V2Transaction, error) {
+	return l.createTransaction(ctx, ledger, ik, postTransaction)
 }
 
 func (l *LedgerMock) ListTransactions(ctx context.Context, ledger string, query wallet.ListTransactionsQuery) (*shared.V2TransactionsCursorResponseCursor, error) {

diff --git a/ee/wallets/pkg/ledger_interface.go b/ee/wallets/pkg/ledger_interface.go
@@ -98,11 +98,11 @@ func (c AccountsCursorResponseCursor) GetHasMore() bool {
 
 type Ledger interface {
 	EnsureLedgerExists(ctx context.Context, name string) error
-	AddMetadataToAccount(ctx context.Context, ledger, account string, metadata map[string]string) error
+	AddMetadataToAccount(ctx context.Context, ledger, account, ik string, metadata map[string]string) error
 	GetAccount(ctx context.Context, ledger, account string) (*AccountWithVolumesAndBalances, error)
 	ListAccounts(ctx context.Context, ledger string, query ListAccountsQuery) (*AccountsCursorResponseCursor, error)
 	ListTransactions(ctx context.Context, ledger string, query ListTransactionsQuery) (*shared.V2TransactionsCursorResponseCursor, error)
-	CreateTransaction(ctx context.Context, ledger string, postTransaction PostTransaction) (*shared.V2Transaction, error)
+	CreateTransaction(ctx context.Context, ledger, ik string, postTransaction PostTransaction) (*shared.V2Transaction, error)
 }
 
 type DefaultLedger struct {
@@ -179,7 +179,7 @@ func (d DefaultLedger) ListTransactions(ctx context.Context, ledger string, q Li
 	return &rsp.V2TransactionsCursorResponse.Cursor, nil
 }
 
-func (d DefaultLedger) CreateTransaction(ctx context.Context, ledger string, transaction PostTransaction) (*shared.V2Transaction, error) {
+func (d DefaultLedger) CreateTransaction(ctx context.Context, ledger, ik string, transaction PostTransaction) (*shared.V2Transaction, error) {
 	ret, err := d.client.Ledger.V2CreateTransaction(ctx, operations.V2CreateTransactionRequest{
 		V2PostTransaction: shared.V2PostTransaction{
 			Metadata:  transaction.Metadata,
@@ -193,7 +193,8 @@ func (d DefaultLedger) CreateTransaction(ctx context.Context, ledger string, tra
 				return &transaction.Timestamp.Time
 			}(),
 		},
-		Ledger: ledger,
+		Ledger:         ledger,
+		IdempotencyKey: pointer.For(ik),
 	})
 	if err != nil {
 		return nil, err
@@ -202,12 +203,13 @@ func (d DefaultLedger) CreateTransaction(ctx context.Context, ledger string, tra
 	return &ret.V2CreateTransactionResponse.Data, nil
 }
 
-func (d DefaultLedger) AddMetadataToAccount(ctx context.Context, ledger, account string, metadata map[string]string) error {
+func (d DefaultLedger) AddMetadataToAccount(ctx context.Context, ledger, account, ik string, metadata map[string]string) error {
 
 	_, err := d.client.Ledger.V2AddMetadataToAccount(ctx, operations.V2AddMetadataToAccountRequest{
-		RequestBody: metadata,
-		Address:     account,
-		Ledger:      ledger,
+		RequestBody:    metadata,
+		Address:        account,
+		Ledger:         ledger,
+		IdempotencyKey: pointer.For(ik),
 	})
 	if err != nil {
 		return err