Skip to content
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

fix: Clean up manager creation to avoid NPEs during background start #1586

Merged
merged 4 commits into from
Sep 23, 2024
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
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ ARG UI_TAG
ARG UI_RELEASE
RUN apk add --update --no-cache \
sqlite=3.44.2-r0 \
postgresql16-client=16.3-r0 \
postgresql16-client=16.4-r0 \
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Required to get the build working, looks like the old version of the client has been removed. A quick look through the PostgreSQL release notes for this version suggests it just contains bug fixes: https://www.postgresql.org/docs/release/16.4/

The extent of testing done on the new client version is the UTs in this repo, if there's any further testing required let me know.

curl=8.9.1-r0 \
jq=1.7.1-r0
WORKDIR /firefly
Expand Down
7 changes: 6 additions & 1 deletion internal/contracts/manager.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,12 @@ func NewContractManager(ctx context.Context, ns string, di database.Plugin, bi b
// cause recreation of all the listeners (noting that listeners that were specified to start
// from latest, will start from the new latest rather than replaying from the block they
// started from before they were deleted).
return cm, cm.verifyListeners(ctx)
err = cm.verifyListeners(ctx)
if err != nil {
return nil, err
}

return cm, nil
}

func (cm *contractManager) Name() string {
Expand Down
29 changes: 28 additions & 1 deletion internal/contracts/manager_test.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright © 2023 Kaleido, Inc.
// Copyright © 2024 Kaleido, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
Expand Down Expand Up @@ -98,6 +98,33 @@ func TestName(t *testing.T) {
assert.Equal(t, "ContractManager", cm.Name())
}

func TestNewContractManagerVerifyListenersFails(t *testing.T) {
mdi := &databasemocks.Plugin{}
mdm := &datamocks.Manager{}
mbm := &broadcastmocks.Manager{}
mpm := &privatemessagingmocks.Manager{}
mbp := &batchmocks.Manager{}
mim := &identitymanagermocks.Manager{}
mbi := &blockchainmocks.Plugin{}
mom := &operationmocks.Manager{}
txw := &txwritermocks.Writer{}
cmi := &cachemocks.Manager{}
msa := &syncasyncmocks.Bridge{}

ctx := context.Background()

cmi.On("GetCache", mock.Anything).Return(cache.NewUmanagedCache(ctx, 100, 5*time.Minute), nil)
txHelper, _ := txcommon.NewTransactionHelper(ctx, "ns1", mdi, mdm, cmi)
mbi.On("GetFFIParamValidator", mock.Anything).Return(nil, nil)
mom.On("RegisterHandler", mock.Anything, mock.Anything, mock.Anything)
mbi.On("Name").Return("mockblockchain").Maybe()
mdi.On("GetContractListeners", mock.Anything, "ns1", mock.Anything).Return(nil, nil, fmt.Errorf("KABOOM!")).Once()

cm, err := NewContractManager(context.Background(), "ns1", mdi, mbi, mdm, mbm, mpm, mbp, mim, mom, txHelper, txw, msa, cmi)
assert.Nil(t, cm)
assert.NotNil(t, err)
}

func TestNewContractManagerFFISchemaLoaderFail(t *testing.T) {
mdi := &databasemocks.Plugin{}
mdm := &datamocks.Manager{}
Expand Down
8 changes: 6 additions & 2 deletions internal/definitions/sender.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright © 2023 Kaleido, Inc.
// Copyright © 2024 Kaleido, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
Expand Down Expand Up @@ -93,8 +93,12 @@ func NewDefinitionSender(ctx context.Context, ns *core.Namespace, multiparty boo
tokenBroadcastNames: tokenBroadcastNames,
}
dh, err := newDefinitionHandler(ctx, ns, multiparty, di, bi, dx, dm, im, am, cm, reverseMap(tokenBroadcastNames))
if err != nil {
return nil, nil, err
}

ds.handler = dh
return ds, dh, err
return ds, dh, nil
}

// reverseMap reverses the key/values of a given map
Expand Down
22 changes: 21 additions & 1 deletion internal/definitions/sender_test.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright © 2021 Kaleido, Inc.
// Copyright © 2024 Kaleido, Inc.
//
// SPDX-License-Identifier: Apache-2.0
//
Expand Down Expand Up @@ -105,6 +105,26 @@ func TestInitSenderFail(t *testing.T) {
assert.Regexp(t, "FF10128", err)
}

func TestNewDefinitionSenderHandlerThrows(t *testing.T) {
mdi := &databasemocks.Plugin{}
mbi := &blockchainmocks.Plugin{}
mdx := &dataexchangemocks.Plugin{}
mbm := &broadcastmocks.Manager{}
mim := &identitymanagermocks.Manager{}
mdm := &datamocks.Manager{}
mcm := &contractmocks.Manager{}

tokenBroadcastNames := make(map[string]string)
tokenBroadcastNames["connector1"] = "remote1"

ctx := context.Background()
ns := &core.Namespace{Name: "ns1", NetworkName: "ns1"}
ds, dh, err := NewDefinitionSender(ctx, ns, false, mdi, mbi, mdx, mbm, mim, mdm, nil, mcm, tokenBroadcastNames)
assert.Nil(t, ds)
assert.Nil(t, dh)
assert.NotNil(t, err)
}

func TestName(t *testing.T) {
ds := newTestDefinitionSender(t)
defer ds.cleanup(t)
Expand Down
Loading