Skip to content

Commit 860aaa2

Browse files
jordanschalmjordanschalm
authored
Merge pull request #7958 from onflow/jord/combine-store-proc-oper-pkgs
Remove `procedure` package
2 parents fa65b20 + 3db60b4 commit 860aaa2

File tree

20 files changed

+483
-519
lines changed

20 files changed

+483
-519
lines changed

‎cmd/util/cmd/read-light-block/read_light_block_test.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ import (
1010
"github.com/onflow/flow-go/storage"
1111
"github.com/onflow/flow-go/storage/operation"
1212
"github.com/onflow/flow-go/storage/operation/dbtest"
13-
"github.com/onflow/flow-go/storage/procedure"
1413
"github.com/onflow/flow-go/storage/store"
1514
"github.com/onflow/flow-go/utils/unittest"
1615
)
@@ -41,14 +40,14 @@ func TestReadClusterRange(t *testing.T) {
4140
for _, block := range blocks {
4241
err = unittest.WithLock(t, lockManager, storage.LockInsertOrFinalizeClusterBlock, func(lctx lockctx.Context) error {
4342
err := db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
44-
return procedure.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
43+
return operation.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
4544
})
4645
if err != nil {
4746
return err
4847
}
4948

5049
return db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
51-
return procedure.FinalizeClusterBlock(lctx, rw, block.ID())
50+
return operation.FinalizeClusterBlock(lctx, rw, block.ID())
5251
})
5352
})
5453
require.NoError(t, err)

‎module/builder/collection/builder.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import (
2020
"github.com/onflow/flow-go/state/protocol"
2121
"github.com/onflow/flow-go/storage"
2222
"github.com/onflow/flow-go/storage/operation"
23-
"github.com/onflow/flow-go/storage/procedure"
2423
"github.com/onflow/flow-go/utils/logging"
2524
)
2625

@@ -231,7 +230,7 @@ func (b *Builder) BuildOn(parentID flow.Identifier, setter func(*flow.HeaderBody
231230
span, _ = b.tracer.StartSpanFromContext(ctx, trace.COLBuildOnDBInsert)
232231

233232
err = b.db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
234-
return procedure.InsertClusterBlock(lctx, rw, blockProposal)
233+
return operation.InsertClusterBlock(lctx, rw, blockProposal)
235234
})
236235
span.End()
237236
if err != nil {

‎module/builder/collection/builder_test.go‎

Lines changed: 26 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@ import (
3434
"github.com/onflow/flow-go/storage"
3535
"github.com/onflow/flow-go/storage/operation"
3636
"github.com/onflow/flow-go/storage/operation/pebbleimpl"
37-
"github.com/onflow/flow-go/storage/procedure"
3837
"github.com/onflow/flow-go/storage/store"
3938
"github.com/onflow/flow-go/utils/unittest"
4039
)
@@ -204,7 +203,7 @@ func (suite *BuilderSuite) TearDownTest() {
204203
func (suite *BuilderSuite) InsertBlock(block *model.Block) {
205204
err := unittest.WithLock(suite.T(), suite.lockManager, storage.LockInsertOrFinalizeClusterBlock, func(lctx lockctx.Context) error {
206205
return suite.db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
207-
return procedure.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
206+
return operation.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
208207
})
209208
})
210209
suite.Require().NoError(err)
@@ -218,7 +217,7 @@ func (suite *BuilderSuite) FinalizeBlock(block model.Block) {
218217
if err != nil {
219218
return err
220219
}
221-
err = procedure.FinalizeClusterBlock(lctx, rw, block.ID())
220+
err = operation.FinalizeClusterBlock(lctx, rw, block.ID())
222221
if err != nil {
223222
return err
224223
}
@@ -286,7 +285,7 @@ func (suite *BuilderSuite) TestBuildOn_Success() {
286285

287286
// should be able to retrieve built block from storage
288287
var built model.Block
289-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), proposal.Header.ID(), &built)
288+
err = operation.RetrieveClusterBlock(suite.db.Reader(), proposal.Header.ID(), &built)
290289
suite.Assert().NoError(err)
291290
builtCollection := built.Payload.Collection
292291

@@ -349,7 +348,7 @@ func (suite *BuilderSuite) TestBuildOn_WithUnknownReferenceBlock() {
349348

350349
// should be able to retrieve built block from storage
351350
var built model.Block
352-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
351+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
353352
suite.Assert().NoError(err)
354353
builtCollection := built.Payload.Collection
355354

@@ -390,7 +389,7 @@ func (suite *BuilderSuite) TestBuildOn_WithUnfinalizedReferenceBlock() {
390389

391390
// should be able to retrieve built block from storage
392391
var built model.Block
393-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
392+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
394393
suite.Assert().NoError(err)
395394
builtCollection := built.Payload.Collection
396395

@@ -441,7 +440,7 @@ func (suite *BuilderSuite) TestBuildOn_WithOrphanedReferenceBlock() {
441440

442441
// should be able to retrieve built block from storage
443442
var built model.Block
444-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
443+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
445444
suite.Assert().NoError(err)
446445
builtCollection := built.Payload.Collection
447446

@@ -484,7 +483,7 @@ func (suite *BuilderSuite) TestBuildOn_WithForks() {
484483

485484
// should be able to retrieve built block from storage
486485
var built model.Block
487-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
486+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
488487
assert.NoError(t, err)
489488
builtCollection := built.Payload.Collection
490489

@@ -531,7 +530,7 @@ func (suite *BuilderSuite) TestBuildOn_ConflictingFinalizedBlock() {
531530

532531
// retrieve the built block from storage
533532
var built model.Block
534-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
533+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
535534
assert.NoError(t, err)
536535
builtCollection := built.Payload.Collection
537536

@@ -581,7 +580,7 @@ func (suite *BuilderSuite) TestBuildOn_ConflictingInvalidatedForks() {
581580

582581
// retrieve the built block from storage
583582
var built model.Block
584-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
583+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
585584
assert.NoError(t, err)
586585
builtCollection := built.Payload.Collection
587586

@@ -645,7 +644,7 @@ func (suite *BuilderSuite) TestBuildOn_LargeHistory() {
645644
// conflicting fork, build on the parent of the head
646645
parent := *head
647646
if conflicting {
648-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), parent.ParentID, &parent)
647+
err = operation.RetrieveClusterBlock(suite.db.Reader(), parent.ParentID, &parent)
649648
assert.NoError(t, err)
650649
// add the transaction to the invalidated list
651650
invalidatedTxIds = append(invalidatedTxIds, tx.ID())
@@ -681,7 +680,7 @@ func (suite *BuilderSuite) TestBuildOn_LargeHistory() {
681680

682681
// retrieve the built block from storage
683682
var built model.Block
684-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
683+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
685684
require.NoError(t, err)
686685
builtCollection := built.Payload.Collection
687686

@@ -715,7 +714,7 @@ func (suite *BuilderSuite) TestBuildOn_MaxCollectionSize() {
715714

716715
// retrieve the built block from storage
717716
var built model.Block
718-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
717+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
719718
suite.Require().NoError(err)
720719
builtCollection := built.Payload.Collection
721720

@@ -748,7 +747,7 @@ func (suite *BuilderSuite) TestBuildOn_MaxCollectionByteSize() {
748747

749748
// retrieve the built block from storage
750749
var built model.Block
751-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
750+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
752751
suite.Require().NoError(err)
753752
builtCollection := built.Payload.Collection
754753

@@ -781,7 +780,7 @@ func (suite *BuilderSuite) TestBuildOn_MaxCollectionTotalGas() {
781780

782781
// retrieve the built block from storage
783782
var built model.Block
784-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
783+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
785784
suite.Require().NoError(err)
786785
builtCollection := built.Payload.Collection
787786

@@ -858,7 +857,7 @@ func (suite *BuilderSuite) TestBuildOn_ExpiredTransaction() {
858857

859858
// retrieve the built block from storage
860859
var built model.Block
861-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
860+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
862861
suite.Require().NoError(err)
863862
builtCollection := built.Payload.Collection
864863

@@ -893,7 +892,7 @@ func (suite *BuilderSuite) TestBuildOn_EmptyMempool() {
893892
suite.Require().NoError(err)
894893

895894
var built model.Block
896-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
895+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
897896
suite.Require().NoError(err)
898897

899898
// should reference a valid reference block
@@ -964,7 +963,7 @@ func (suite *BuilderSuite) TestBuildOn_NoRateLimiting() {
964963

965964
// each collection should be full with 10 transactions
966965
var built model.Block
967-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
966+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
968967
suite.Assert().NoError(err)
969968
suite.Assert().Len(built.Payload.Collection.Transactions, 10)
970969
}
@@ -1035,7 +1034,7 @@ func (suite *BuilderSuite) TestBuildOn_RateLimitNonPayer() {
10351034

10361035
// each collection should be full with 10 transactions
10371036
var built model.Block
1038-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
1037+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
10391038
suite.Assert().NoError(err)
10401039
suite.Assert().Len(built.Payload.Collection.Transactions, 10)
10411040
}
@@ -1097,7 +1096,7 @@ func (suite *BuilderSuite) TestBuildOn_HighRateLimit() {
10971096

10981097
// each collection should be half-full with 5 transactions
10991098
var built model.Block
1100-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
1099+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
11011100
suite.Assert().NoError(err)
11021101
suite.Assert().Len(built.Payload.Collection.Transactions, 5)
11031102
}
@@ -1180,7 +1179,7 @@ func (suite *BuilderSuite) TestBuildOn_MaxCollectionSizeRateLimiting() {
11801179

11811180
// each collection should be equal to the minimum collection size
11821181
var built model.Block
1183-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
1182+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
11841183
suite.Assert().NoError(err)
11851184
suite.Assert().Len(built.Payload.Collection.Transactions, int(rateLimiterCfg.MinCollectionSize()))
11861185
}
@@ -1243,7 +1242,7 @@ func (suite *BuilderSuite) TestBuildOn_LowRateLimit() {
12431242

12441243
// collections should either be empty or have 1 transaction
12451244
var built model.Block
1246-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
1245+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
12471246
suite.Assert().NoError(err)
12481247
if i%2 == 0 {
12491248
suite.Assert().Len(built.Payload.Collection.Transactions, 1)
@@ -1308,7 +1307,7 @@ func (suite *BuilderSuite) TestBuildOn_UnlimitedPayer() {
13081307

13091308
// each collection should be full with 10 transactions
13101309
var built model.Block
1311-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
1310+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
13121311
suite.Assert().NoError(err)
13131312
suite.Assert().Len(built.Payload.Collection.Transactions, 10)
13141313

@@ -1373,7 +1372,7 @@ func (suite *BuilderSuite) TestBuildOn_RateLimitDryRun() {
13731372

13741373
// each collection should be full with 10 transactions
13751374
var built model.Block
1376-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
1375+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
13771376
suite.Assert().NoError(err)
13781377
suite.Assert().Len(built.Payload.Collection.Transactions, 10)
13791378
}
@@ -1425,7 +1424,7 @@ func (suite *BuilderSuite) TestBuildOn_SystemTxAlwaysIncluded() {
14251424
suite.Require().NoError(err)
14261425

14271426
var built model.Block
1428-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
1427+
err = operation.RetrieveClusterBlock(suite.db.Reader(), header.Header.ID(), &built)
14291428
suite.Assert().NoError(err)
14301429
suite.Assert().Len(built.Payload.Collection.Transactions, 2)
14311430
for _, tx := range built.Payload.Collection.Transactions {
@@ -1536,7 +1535,7 @@ func benchmarkBuildOn(b *testing.B, size int) {
15361535
)
15371536
err := unittest.WithLock(b, suite.lockManager, storage.LockInsertOrFinalizeClusterBlock, func(lctx lockctx.Context) error {
15381537
return suite.db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
1539-
return procedure.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
1538+
return operation.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
15401539
})
15411540
})
15421541
require.NoError(b, err)
@@ -1545,7 +1544,7 @@ func benchmarkBuildOn(b *testing.B, size int) {
15451544
if rand.Intn(100) < 80 {
15461545
err = unittest.WithLock(b, suite.lockManager, storage.LockInsertOrFinalizeClusterBlock, func(lctx lockctx.Context) error {
15471546
return suite.db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
1548-
return procedure.FinalizeClusterBlock(lctx, rw, block.ID())
1547+
return operation.FinalizeClusterBlock(lctx, rw, block.ID())
15491548
})
15501549
})
15511550
require.NoError(b, err)

‎module/finalizer/collection/finalizer.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ import (
1313
"github.com/onflow/flow-go/module/mempool"
1414
"github.com/onflow/flow-go/storage"
1515
"github.com/onflow/flow-go/storage/operation"
16-
"github.com/onflow/flow-go/storage/procedure"
1716
)
1817

1918
// Finalizer is a simple wrapper around our temporary state to clean up after a
@@ -120,7 +119,7 @@ func (f *Finalizer) MakeFinal(blockID flow.Identifier) error {
120119
step := steps[i]
121120
var payload cluster.Payload
122121
// This does not require a lock, as a block's payload once set never changes.
123-
err = procedure.RetrieveClusterPayload(rw.GlobalReader(), clusterBlockID, &payload)
122+
err = operation.RetrieveClusterPayload(rw.GlobalReader(), clusterBlockID, &payload)
124123
if err != nil {
125124
return fmt.Errorf("could not retrieve payload for cluster block (id=%x): %w", clusterBlockID, err)
126125
}
@@ -133,7 +132,7 @@ func (f *Finalizer) MakeFinal(blockID flow.Identifier) error {
133132
}
134133

135134
// finalize the block in cluster state
136-
err = procedure.FinalizeClusterBlock(lctx, rw, clusterBlockID)
135+
err = operation.FinalizeClusterBlock(lctx, rw, clusterBlockID)
137136
if err != nil {
138137
return fmt.Errorf("could not finalize cluster block (id=%x): %w", clusterBlockID, err)
139138
}

‎module/finalizer/collection/finalizer_test.go‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ import (
2020
"github.com/onflow/flow-go/storage"
2121
"github.com/onflow/flow-go/storage/operation"
2222
"github.com/onflow/flow-go/storage/operation/pebbleimpl"
23-
"github.com/onflow/flow-go/storage/procedure"
2423
"github.com/onflow/flow-go/utils/unittest"
2524
)
2625

@@ -54,7 +53,7 @@ func TestFinalizer(t *testing.T) {
5453
insert := func(db storage.DB, lockManager lockctx.Manager, block *model.Block) {
5554
err := unittest.WithLock(t, lockManager, storage.LockInsertOrFinalizeClusterBlock, func(lctx lockctx.Context) error {
5655
return db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
57-
return procedure.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
56+
return operation.InsertClusterBlock(lctx, rw, unittest.ClusterProposalFromBlock(block))
5857
})
5958
})
6059
require.NoError(t, err)

‎state/cluster/badger/mutator.go‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ import (
1818
"github.com/onflow/flow-go/state/fork"
1919
"github.com/onflow/flow-go/storage"
2020
"github.com/onflow/flow-go/storage/operation"
21-
"github.com/onflow/flow-go/storage/procedure"
2221
)
2322

2423
type MutableState struct {
@@ -62,7 +61,7 @@ func (m *MutableState) getExtendCtx(candidate *cluster.Block) (extendContext, er
6261
r := m.State.db.Reader()
6362
// get the latest finalized cluster block and latest finalized consensus height
6463
ctx.finalizedClusterBlock = new(flow.Header)
65-
err := procedure.RetrieveLatestFinalizedClusterHeader(r, candidate.ChainID, ctx.finalizedClusterBlock)
64+
err := operation.RetrieveLatestFinalizedClusterHeader(r, candidate.ChainID, ctx.finalizedClusterBlock)
6665
if err != nil {
6766
return extendContext{}, fmt.Errorf("could not retrieve finalized cluster head: %w", err)
6867
}
@@ -145,7 +144,7 @@ func (m *MutableState) Extend(proposal *cluster.Proposal) error {
145144

146145
span, _ = m.tracer.StartSpanFromContext(ctx, trace.COLClusterStateMutatorExtendDBInsert)
147146
err = m.State.db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
148-
return procedure.InsertClusterBlock(lctx, rw, proposal)
147+
return operation.InsertClusterBlock(lctx, rw, proposal)
149148
})
150149
span.End()
151150
if err != nil {

‎state/cluster/badger/mutator_test.go‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@ import (
3030
"github.com/onflow/flow-go/storage"
3131
"github.com/onflow/flow-go/storage/operation"
3232
"github.com/onflow/flow-go/storage/operation/pebbleimpl"
33-
"github.com/onflow/flow-go/storage/procedure"
3433
"github.com/onflow/flow-go/storage/store"
3534
"github.com/onflow/flow-go/utils/unittest"
3635
)
@@ -204,7 +203,7 @@ func (suite *MutatorSuite) FinalizeBlock(block model.Block) {
204203

205204
err = unittest.WithLock(suite.T(), suite.lockManager, storage.LockInsertOrFinalizeClusterBlock, func(lctx lockctx.Context) error {
206205
return suite.db.WithReaderBatchWriter(func(rw storage.ReaderBatchWriter) error {
207-
err := procedure.FinalizeClusterBlock(lctx, rw, block.ID())
206+
err := operation.FinalizeClusterBlock(lctx, rw, block.ID())
208207
if err != nil {
209208
return err
210209
}
@@ -383,7 +382,7 @@ func (suite *MutatorSuite) TestExtend_Success() {
383382
// should be able to retrieve the block
384383
r := suite.db.Reader()
385384
var extended model.Block
386-
err = procedure.RetrieveClusterBlock(r, proposal.Block.ID(), &extended)
385+
err = operation.RetrieveClusterBlock(r, proposal.Block.ID(), &extended)
387386
suite.Assert().Nil(err)
388387
suite.Assert().Equal(proposal.Block.Payload, extended.Payload)
389388

@@ -608,7 +607,7 @@ func (suite *MutatorSuite) TestExtend_LargeHistory() {
608607
// conflicting fork, build on the parent of the head
609608
parent := *head
610609
if conflicting {
611-
err = procedure.RetrieveClusterBlock(suite.db.Reader(), parent.ParentID, &parent)
610+
err = operation.RetrieveClusterBlock(suite.db.Reader(), parent.ParentID, &parent)
612611
assert.NoError(t, err)
613612
// add the transaction to the invalidated list
614613
invalidatedTransactions = append(invalidatedTransactions, &tx)

0 commit comments

Comments
 (0)