Files
f755e1a3a4 feat(bitstamp): EN-1015 add orders + conversions and refactor for production-readiness (#724)
* feat(bitstamp): EN-1015 add orders + conversions and refactor for production-readiness

Adds first-class orders and conversions primitives to the Bitstamp connector and refactors the package along Formance conventions. The HTTP client is split into client/types.go + client/error.go with OpenTelemetry instrumentation and a typed DerivativesUnsupportedError that drives a process-lifetime try-and-skip cache for permission-gated endpoints (my_markets, fees, crypto-transactions). State is moved to opaque cursors with backward-compatible decoders so existing installs keep their watermarks. Payments are now a three-source union (user_transactions + crypto-transactions + withdrawal-requests) with fail-whole-cycle semantics on top-level source errors and log+continue on per-row map errors. Orders reconcile open_orders snapshots with order_status; conversions detect two-asset user_transactions.type=36 (instant buy/sell). Accounts surface the currency ticker as Name; sub-account transfers (types 14/33/35) are modelled as linked PAYOUT/PAYIN pairs correlated via metadata, reflecting Bitstamp's one-API-key-per-account scope. The Temporal task tree nests balances under accounts (Qonto FromPayload pattern) with payments, orders and conversions as independent roots. Install-time enrichment loads markets, my_markets, trading fees and withdrawal fees in parallel via a generic refreshCache[T] helper with TTL. Full transformation logic lives in a dedicated mappers/ subpackage with extensive unit coverage. MAPPINGS.md documents every decision, the error-policy matrix, and the known historical-orders gap.

* fix(bitstamp): address PR #724 CodeRabbit review — evict on order_status error, deterministic enrichment, log levels

Evict retention-expired tracked orders in fetchNextOrders when GetOrderStatus errors out: a stale ID past the 30-day window will keep failing the call indefinitely, growing state unbounded and spamming Error logs every cycle. Log the eviction at Info because the failure is expected for retention-expired entries. Make representative market/trading-fee selection in buildEnrichmentForCurrency deterministic by picking the lexicographically-smallest match on a composite key (CounterCurrency|MarketType for markets, CurrencyPair for fees) to prevent account-metadata flapping if the PSP returns rows reordered between cycles. Downgrade the derivatives-row skip log in fetchNextConversions from Errorf to Infof — it is an expected branch on a spot-only connector, not a fault. Drop a redundant AbsAmount wrap inside an IsZeroAmount call (Sign() already handles negatives natively). Add language tag to a MAPPINGS.md fenced block to satisfy markdownlint. New unit tests cover the eviction-on-error path and lock the deterministic-representative contract via permutation testing.

Co-authored-by: Cursor <[email protected]>

* Remove any cache initializations from Install step, remove useless skip behaviour for crypto-transactions and withdrawals

* Use GET request for my_markets endpoint, and only handle derivative not supported error where likely to occur

* Drastically reduce amount of caching - instead fetch enrichment data only when new accounts are found

* Delay fetch currencies calls until after we know if work needs to be done to reduce unneeded requests in inactive accounts

* Revert changes to balance fetching that made it only fetch balance once

* Import transactions with trailing zeros that exceed the currency's reported precision

* One exclusive decimal amount parser function among different functions

* Allow two orders with the same ID to be present in a slice by combining them into one record with multiple adjustments

* Use CreatedAt to determine order or order adjustments

* Make Orders workflow a child of accounts, and search markets related to the currency of the account

* Enhance metadata returned in orders

* Only save real account IDs related to orders

* Import each order event only once via the source currency

* Regenerate capabilities

* Add paging mechanism and fix expectations about market event IDs

* Export even if account is destination account

* Address coderabbit comments

* Fix comments on workflow header

* Address coderabbit comments regarding models order

* Only use user transactions endpoint to fetch both conversions and payments

* Truncate trailing digits when they exceed the precision bitstamp provided - raw values still preserved in raw payload

---------

Co-authored-by: Cursor <[email protected]>
Co-authored-by: Crimson Thompson <[email protected]>
2026-05-28 08:40:34 +00:00

181 lines
5.4 KiB
Go

package bitstamp
import (
"encoding/json"
"testing"
)
// TestPaymentsStateDecode_LegacyFlatShape locks the migration path from
// the legacy single-watermark {"lastTransactionID": N} state JSON.
func TestPaymentsStateDecode_LegacyFlatShape(t *testing.T) {
t.Parallel()
cases := []struct {
name string
json string
wantID int64
}{
{"non-zero watermark", `{"lastTransactionID": 458254264}`, 458254264},
{"zero watermark", `{"lastTransactionID": 0}`, 0},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
var s paymentsState
if err := json.Unmarshal([]byte(tc.json), &s); err != nil {
t.Fatalf("unmarshal: %v", err)
}
if s.LastTransactionID != tc.wantID {
t.Errorf("LastTransactionID = %d, want %d", s.LastTransactionID, tc.wantID)
}
})
}
}
// TestPaymentsStateRoundTrip asserts the flat shape round-trips.
func TestPaymentsStateRoundTrip(t *testing.T) {
t.Parallel()
in := paymentsState{LastTransactionID: 999}
raw, err := json.Marshal(in)
if err != nil {
t.Fatalf("marshal: %v", err)
}
var out paymentsState
if err := json.Unmarshal(raw, &out); err != nil {
t.Fatalf("unmarshal: %v", err)
}
if out != in {
t.Errorf("round-trip mismatch: got %+v, want %+v", out, in)
}
}
// TestPaymentsStateDecode_EmptyObject must yield the zero value (cold start).
func TestPaymentsStateDecode_EmptyObject(t *testing.T) {
t.Parallel()
var s paymentsState
if err := json.Unmarshal([]byte(`{}`), &s); err != nil {
t.Fatalf("unmarshal: %v", err)
}
if (s != paymentsState{}) {
t.Errorf("empty object must decode to zero value, got %+v", s)
}
}
// TestPaymentsStateDecode_InvalidJSON returns a clean error.
func TestPaymentsStateDecode_InvalidJSON(t *testing.T) {
t.Parallel()
var s paymentsState
if err := json.Unmarshal([]byte(`{not json`), &s); err == nil {
t.Error("expected error on malformed JSON")
}
}
// TestOrdersStateDecode_LegacyTrackedOrders: the previous ordersState had a
// "trackedOrders" map and then "lastSeenIDPerMarket". Old state must decode
// into the new shape without error; unknown fields are ignored and
// LastSeenEventIDPerMarket starts empty (cold start — correct on upgrade).
func TestOrdersStateDecode_LegacyTrackedOrders(t *testing.T) {
t.Parallel()
payload := `{
"trackedOrders": {
"100": {"lastStatus": "Open", "firstSeenAt": "2025-09-25T14:00:00Z", "limitPrice": "60000.00"}
}
}`
var s ordersState
if err := json.Unmarshal([]byte(payload), &s); err != nil {
t.Fatalf("unmarshal: %v", err)
}
if len(s.LastSeenEventIDPerMarket) != 0 {
t.Errorf("LastSeenEventIDPerMarket must be empty on upgrade from legacy state, got %v", s.LastSeenEventIDPerMarket)
}
}
func TestOrdersStateRoundTrip(t *testing.T) {
t.Parallel()
in := ordersState{
LastSeenEventIDPerMarket: map[string]string{
"btcusd": "a1b2c3d4-e5f6-a1b2-c3d4-e5f6a1b2c3d4",
"ethusd": "00112233-4455-6677-8899-aabbccddeeff",
},
}
raw, err := json.Marshal(in)
if err != nil {
t.Fatalf("marshal: %v", err)
}
var out ordersState
if err := json.Unmarshal(raw, &out); err != nil {
t.Fatalf("unmarshal: %v", err)
}
if out.LastSeenEventIDPerMarket["btcusd"] != in.LastSeenEventIDPerMarket["btcusd"] ||
out.LastSeenEventIDPerMarket["ethusd"] != in.LastSeenEventIDPerMarket["ethusd"] {
t.Errorf("round-trip mismatch: got %+v, want %+v", out, in)
}
}
// TestAdvanceInt64Cursor locks the canonical "never reset on empty
// response" invariant.
func TestAdvanceInt64Cursor(t *testing.T) {
t.Parallel()
cases := []struct {
name string
current int64
candidate int64
want int64
}{
{"empty page on cold start", 0, 0, 0},
{"empty page after history walked", 1000, 0, 1000},
{"smaller candidate (stale page)", 1000, 500, 1000},
{"equal candidate (idempotent re-poll)", 1000, 1000, 1000},
{"larger candidate advances", 1000, 1500, 1500},
{"first non-empty page from zero", 0, 42, 42},
}
for _, tc := range cases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
t.Parallel()
if got := advanceInt64Cursor(tc.current, tc.candidate); got != tc.want {
t.Errorf("advanceInt64Cursor(%d, %d) = %d, want %d",
tc.current, tc.candidate, got, tc.want)
}
})
}
}
func TestIsValidMarketEventID(t *testing.T) {
t.Parallel()
cases := []struct {
id string
want bool
}{
{"000652ba-1467-f198-0000-00d800000020", true}, // valid UUID lowercase
{"AABBCCDD-EEFF-0011-2233-445566778899", true}, // valid UUID uppercase
{"", false}, // empty
{"tooshort", false}, // too short
{"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4", false}, // 32-char hex, no hyphens
{"000652ba-1467-f198-0000-00d80000002", false}, // UUID too short by one
{"000652ba-1467-f198-0000-00d8000000200", false}, // UUID too long by one
{"000652ba_1467_f198_0000_00d800000020", false}, // wrong separator
{"zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz", false}, // non-hex UUID
}
for _, tc := range cases {
tc := tc
t.Run(tc.id, func(t *testing.T) {
t.Parallel()
if got := isValidMarketEventID(tc.id); got != tc.want {
t.Errorf("isValidMarketEventID(%q) = %v, want %v", tc.id, got, tc.want)
}
})
}
}
func TestConversionsStateDecode(t *testing.T) {
t.Parallel()
var s conversionsState
if err := json.Unmarshal([]byte(`{"lastTransactionID": 12345}`), &s); err != nil {
t.Fatalf("unmarshal: %v", err)
}
if s.LastTransactionID != 12345 {
t.Errorf("LastTransactionID = %d", s.LastTransactionID)
}
}