Skip to content

feat: backport json bulk stream from 2.3 #890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 30, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 34 additions & 11 deletions internal/api/bulking/bulker_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package bulking
import (
"encoding/json"
"github.com/formancehq/go-libs/v2/logging"
"github.com/formancehq/go-libs/v2/pointer"
"github.com/uptrace/bun"
"math/big"
"testing"
Expand Down Expand Up @@ -61,7 +62,9 @@ func TestBulk(t *testing.T) {
Timestamp: now,
}, false),
}).
Return(&ledger.Log{}, &ledger.CreatedTransaction{
Return(&ledger.Log{
ID: pointer.For(1),
}, &ledger.CreatedTransaction{
Transaction: ledger.Transaction{
TransactionData: ledger.TransactionData{
Postings: postings,
Expand Down Expand Up @@ -105,7 +108,9 @@ func TestBulk(t *testing.T) {
},
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)
},
expectResults: []BulkElementResult{{}},
},
Expand All @@ -131,7 +136,9 @@ func TestBulk(t *testing.T) {
},
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)
},
expectResults: []BulkElementResult{{}},
},
Expand All @@ -150,7 +157,9 @@ func TestBulk(t *testing.T) {
TransactionID: 1,
},
}).
Return(&ledger.Log{}, &ledger.RevertedTransaction{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, &ledger.RevertedTransaction{}, nil)
},
expectResults: []BulkElementResult{{
Data: ledger.Transaction{},
Expand All @@ -174,7 +183,9 @@ func TestBulk(t *testing.T) {
Key: "foo",
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)
},
expectResults: []BulkElementResult{{}},
},
Expand All @@ -196,7 +207,9 @@ func TestBulk(t *testing.T) {
Key: "foo",
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)
},
expectResults: []BulkElementResult{{}},
},
Expand Down Expand Up @@ -240,7 +253,9 @@ func TestBulk(t *testing.T) {
},
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)
mockLedger.EXPECT().
SaveAccountMetadata(gomock.Any(), ledgercontroller.Parameters[ledgercontroller.SaveAccountMetadata]{
Input: ledgercontroller.SaveAccountMetadata{
Expand Down Expand Up @@ -300,7 +315,9 @@ func TestBulk(t *testing.T) {
},
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)
mockLedger.EXPECT().
SaveAccountMetadata(gomock.Any(), ledgercontroller.Parameters[ledgercontroller.SaveAccountMetadata]{
Input: ledgercontroller.SaveAccountMetadata{
Expand All @@ -320,7 +337,9 @@ func TestBulk(t *testing.T) {
},
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)
},
expectResults: []BulkElementResult{{}, {
Error: errors.New("unexpected error"),
Expand Down Expand Up @@ -365,7 +384,9 @@ func TestBulk(t *testing.T) {
},
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)

mockLedger.EXPECT().
SaveAccountMetadata(gomock.Any(), ledgercontroller.Parameters[ledgercontroller.SaveAccountMetadata]{
Expand All @@ -376,7 +397,9 @@ func TestBulk(t *testing.T) {
},
},
}).
Return(&ledger.Log{}, nil)
Return(&ledger.Log{
ID: pointer.For(1),
}, nil)

mockLedger.EXPECT().
Commit(gomock.Any()).
Expand Down
86 changes: 86 additions & 0 deletions internal/api/bulking/handler_stream_json.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
package bulking

import (
"encoding/json"
"net/http"
)

type JSONStreamBulkHandler struct {
channel Bulk
terminated chan struct{}
receive chan BulkElementResult
results []BulkElementResult
actions []string
err error
}

func (h *JSONStreamBulkHandler) GetChannels(_ http.ResponseWriter, r *http.Request) (Bulk, chan BulkElementResult, bool) {

h.channel = make(Bulk)
h.receive = make(chan BulkElementResult)
h.terminated = make(chan struct{})

go func() {
defer close(h.channel)

dec := json.NewDecoder(r.Body)

for {
select {
case <-r.Context().Done():
return
default:
nextElement := &BulkElement{}
err := dec.Decode(nextElement)
if err != nil {
h.err = err
return
}

h.actions = append(h.actions, nextElement.GetAction())
h.channel <- *nextElement
}
}
}()
go func() {
defer close(h.terminated)

for {
select {
case <-r.Context().Done():
return
case res, ok := <-h.receive:
if !ok {
return
}
h.results = append(h.results, res)
}
}
}()

return h.channel, h.receive, true
}

func (h *JSONStreamBulkHandler) Terminate(w http.ResponseWriter, r *http.Request) {
select {
case <-h.terminated:
writeJSONResponse(w, h.actions, h.results, h.err)
case <-r.Context().Done():
}
}

func NewJSONStreamBulkHandler() *JSONStreamBulkHandler {
return &JSONStreamBulkHandler{}
}

type JSONStreamBulkHandlerFactory struct{}

func (j JSONStreamBulkHandlerFactory) CreateBulkHandler() Handler {
return NewJSONStreamBulkHandler()
}

func NewJSONStreamBulkHandlerFactory() HandlerFactory {
return &JSONStreamBulkHandlerFactory{}
}

var _ HandlerFactory = (*JSONStreamBulkHandlerFactory)(nil)
93 changes: 93 additions & 0 deletions internal/api/bulking/handler_stream_json_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
package bulking

import (
"github.com/formancehq/go-libs/v2/api"
ledger "github.com/formancehq/ledger/internal"
"github.com/stretchr/testify/require"
"io"
"net/http"
"net/http/httptest"
"testing"
"time"
)

func TestBulkStreamHandlerJSON(t *testing.T) {

t.Parallel()

type testCase struct {
name string
stream string
expectedError bool
expectedStatusCode int

expectScriptCount int
}

for _, testCase := range []testCase{
{
name: "nominal",
stream: `
{"action": "CREATE_TRANSACTION", "data": {"postings": [{"source": "world", "amount": 100, "asset": "USD", "destination": "bank"}]}}
{"action": "CREATE_TRANSACTION", "data": {"postings": [{"source": "world", "amount": 200, "asset": "USD", "destination": "bank"}]}}
`,
expectScriptCount: 2,
},
} {
t.Run(testCase.name, func(t *testing.T) {
t.Parallel()

reader, writer := io.Pipe()

w := httptest.NewRecorder()
r := httptest.NewRequest(http.MethodPost, "/", reader)

h := NewJSONStreamBulkHandler()
send, receive, ok := h.GetChannels(w, r)

if testCase.expectedError {
require.False(t, ok)
require.Equal(t, testCase.expectedStatusCode, w.Result().StatusCode)
return
}

require.True(t, ok)

_, err := writer.Write([]byte(testCase.stream))
require.NoError(t, err)

for id := range testCase.expectScriptCount {
select {
case <-send:
case <-time.After(100 * time.Millisecond):
t.Fatal("should have received send channel")
}
select {
case receive <- BulkElementResult{
Data: ledger.CreatedTransaction{},
LogID: id + 1,
ElementID: id,
}:
case <-time.After(100 * time.Millisecond):
t.Fatal("should have been able to send on receive channel")
}
}

require.NoError(t, writer.Close())
select {
case <-send:
case <-time.After(100 * time.Millisecond):
t.Fatal("send channel should have been closed")
}
close(receive)

h.Terminate(w, r)

require.Equal(t, http.StatusOK, w.Result().StatusCode)

response, ok := api.DecodeSingleResponse[[]APIResult](t, w.Result().Body)
require.True(t, ok)
require.Len(t, response, testCase.expectScriptCount)
})
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"net/http"
)

type ScriptStreamBulkHandler struct {
type TextStreamBulkHandler struct {
channel Bulk
terminated chan struct{}
receive chan BulkElementResult
Expand All @@ -14,7 +14,7 @@ type ScriptStreamBulkHandler struct {
err error
}

func (h *ScriptStreamBulkHandler) GetChannels(_ http.ResponseWriter, r *http.Request) (Bulk, chan BulkElementResult, bool) {
func (h *TextStreamBulkHandler) GetChannels(_ http.ResponseWriter, r *http.Request) (Bulk, chan BulkElementResult, bool) {

h.channel = make(Bulk)
h.receive = make(chan BulkElementResult)
Expand Down Expand Up @@ -65,26 +65,26 @@ func (h *ScriptStreamBulkHandler) GetChannels(_ http.ResponseWriter, r *http.Req
return h.channel, h.receive, true
}

func (h *ScriptStreamBulkHandler) Terminate(w http.ResponseWriter, r *http.Request) {
func (h *TextStreamBulkHandler) Terminate(w http.ResponseWriter, r *http.Request) {
select {
case <-h.terminated:
writeJSONResponse(w, h.actions, h.results, h.err)
case <-r.Context().Done():
}
}

func NewScriptStreamBulkHandler() *ScriptStreamBulkHandler {
return &ScriptStreamBulkHandler{}
func NewTextStreamBulkHandler() *TextStreamBulkHandler {
return &TextStreamBulkHandler{}
}

type scriptStreamBulkHandlerFactory struct{}
type textStreamBulkHandlerFactory struct{}

func (j scriptStreamBulkHandlerFactory) CreateBulkHandler() Handler {
return NewScriptStreamBulkHandler()
func (j textStreamBulkHandlerFactory) CreateBulkHandler() Handler {
return NewTextStreamBulkHandler()
}

func NewScriptStreamBulkHandlerFactory() HandlerFactory {
return &scriptStreamBulkHandlerFactory{}
func NewTextStreamBulkHandlerFactory() HandlerFactory {
return &textStreamBulkHandlerFactory{}
}

var _ HandlerFactory = (*scriptStreamBulkHandlerFactory)(nil)
var _ HandlerFactory = (*textStreamBulkHandlerFactory)(nil)
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ send [USD 100] (
w := httptest.NewRecorder()
r := httptest.NewRequest(http.MethodPost, "/", reader)

h := NewScriptStreamBulkHandler()
h := NewTextStreamBulkHandler()
send, receive, ok := h.GetChannels(w, r)

if testCase.expectedError {
Expand Down Expand Up @@ -84,6 +84,11 @@ send [USD 100] (
}

require.NoError(t, writer.Close())
select {
case <-send:
case <-time.After(100 * time.Millisecond):
t.Fatal("send channel should have been closed")
}
close(receive)

h.Terminate(w, r)
Expand Down
5 changes: 1 addition & 4 deletions internal/api/router.go
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,7 @@ func NewRouter(
v2.WithTracer(routerOptions.tracer),
v2.WithMiddlewares(commonMiddlewares...),
v2.WithBulkerFactory(routerOptions.bulkerFactory),
v2.WithBulkHandlerFactories(map[string]bulking.HandlerFactory{
"application/json": bulking.NewJSONBulkHandlerFactory(routerOptions.bulkMaxSize),
"application/vnd.formance.ledger.api.v2.bulk+script-stream": bulking.NewScriptStreamBulkHandlerFactory(),
}),
v2.WithDefaultBulkHandlerFactories(routerOptions.bulkMaxSize),
v2.WithPaginationConfig(routerOptions.paginationConfig),
)
mux.Handle("/v2*", http.StripPrefix("/v2", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
Expand Down
Loading
Loading