Skip to content

Commit ce729b6

Browse files
renatomaiarenatomaia
committed
refactor(services): rename fields and methods for clarity
1 parent 8234f20 commit ce729b6

25 files changed

Lines changed: 365 additions & 347 deletions

File tree

‎cmd/cartesi-rollups-advancer/root/root.go‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,21 @@ func run(cmd *cobra.Command, args []string) {
8080
defer cancel()
8181

8282
createInfo := advancer.CreateInfo{
83-
CreateInfo: service.CreateInfo{
84-
Name: config.ServiceAdvancer,
85-
LogLevel: config.ResolveServiceLogLevel(config.ServiceAdvancer, cfg.LogLevel),
86-
LogColor: cfg.LogColor,
87-
EnableSignalHandling: true,
88-
TelemetryCreate: true,
89-
TelemetryAddress: cfg.AdvancerTelemetryAddress,
90-
PollInterval: cfg.AdvancerPollingInterval,
83+
TickServiceConfigs: service.TickServiceConfigs{
84+
PollInterval: cfg.AdvancerPollingInterval,
85+
ServiceConfigs: service.ServiceConfigs{
86+
Name: config.ServiceAdvancer,
87+
LogLevel: config.ResolveServiceLogLevel(config.ServiceAdvancer, cfg.LogLevel),
88+
LogColor: cfg.LogColor,
89+
EnableSignalHandling: true,
90+
TelemetryCreate: true,
91+
TelemetryAddress: cfg.AdvancerTelemetryAddress,
92+
},
9193
},
9294
Config: *cfg,
9395
}
94-
logger := service.NewServiceLogger(&createInfo.CreateInfo)
95-
createInfo.CreateInfo.Logger = logger
96+
logger := service.NewServiceLogger(&createInfo.ServiceConfigs)
97+
createInfo.ServiceConfigs.Logger = logger
9698

9799
var err error
98100
createInfo.Repository, err = factory.NewRepositoryFromConnectionString(ctx, cfg.DatabaseConnection.Raw())

‎cmd/cartesi-rollups-claimer/root/root.go‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,19 +81,21 @@ func run(cmd *cobra.Command, args []string) {
8181
defer cancel()
8282

8383
createInfo := claimer.CreateInfo{
84-
CreateInfo: service.CreateInfo{
85-
Name: config.ServiceClaimer,
86-
LogLevel: config.ResolveServiceLogLevel(config.ServiceClaimer, cfg.LogLevel),
87-
LogColor: cfg.LogColor,
88-
EnableSignalHandling: true,
89-
TelemetryCreate: true,
90-
TelemetryAddress: cfg.ClaimerTelemetryAddress,
91-
PollInterval: cfg.ClaimerPollingInterval,
84+
TickServiceConfigs: service.TickServiceConfigs{
85+
PollInterval: cfg.ClaimerPollingInterval,
86+
ServiceConfigs: service.ServiceConfigs{
87+
Name: config.ServiceClaimer,
88+
LogLevel: config.ResolveServiceLogLevel(config.ServiceClaimer, cfg.LogLevel),
89+
LogColor: cfg.LogColor,
90+
EnableSignalHandling: true,
91+
TelemetryCreate: true,
92+
TelemetryAddress: cfg.ClaimerTelemetryAddress,
93+
},
9294
},
9395
Config: *cfg,
9496
}
95-
logger := service.NewServiceLogger(&createInfo.CreateInfo)
96-
createInfo.CreateInfo.Logger = logger
97+
logger := service.NewServiceLogger(&createInfo.ServiceConfigs)
98+
createInfo.ServiceConfigs.Logger = logger
9799

98100
authOpt, err := config.HTTPAuthorizationOption()
99101
cli.CheckErr(logger, err)

‎cmd/cartesi-rollups-evm-reader/root/root.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ func run(cmd *cobra.Command, args []string) {
8282
defer cancel()
8383

8484
createInfo := evmreader.CreateInfo{
85-
CreateInfo: service.CreateInfo{
85+
ServiceConfigs: service.ServiceConfigs{
8686
Name: config.ServiceEvmReader,
8787
LogLevel: config.ResolveServiceLogLevel(config.ServiceEvmReader, cfg.LogLevel),
8888
LogColor: cfg.LogColor,
@@ -92,8 +92,8 @@ func run(cmd *cobra.Command, args []string) {
9292
},
9393
Config: *cfg,
9494
}
95-
logger := service.NewServiceLogger(&createInfo.CreateInfo)
96-
createInfo.CreateInfo.Logger = logger
95+
logger := service.NewServiceLogger(&createInfo.ServiceConfigs)
96+
createInfo.ServiceConfigs.Logger = logger
9797

9898
var err error
9999
authOpt, err := config.HTTPAuthorizationOption()

‎cmd/cartesi-rollups-jsonrpc-api/root/root.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func run(cmd *cobra.Command, args []string) {
6868
defer cancel()
6969

7070
createInfo := jsonrpc.CreateInfo{
71-
CreateInfo: service.CreateInfo{
71+
ServiceConfigs: service.ServiceConfigs{
7272
Name: config.ServiceJsonrpc,
7373
LogLevel: config.ResolveServiceLogLevel(config.ServiceJsonrpc, cfg.LogLevel),
7474
LogColor: cfg.LogColor,
@@ -78,8 +78,8 @@ func run(cmd *cobra.Command, args []string) {
7878
},
7979
Config: *cfg,
8080
}
81-
logger := service.NewServiceLogger(&createInfo.CreateInfo)
82-
createInfo.CreateInfo.Logger = logger
81+
logger := service.NewServiceLogger(&createInfo.ServiceConfigs)
82+
createInfo.ServiceConfigs.Logger = logger
8383

8484
var err error
8585
createInfo.Repository, err = factory.NewRepositoryFromConnectionString(ctx, cfg.DatabaseConnection.Raw())

‎cmd/cartesi-rollups-node/root/root.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ func run(cmd *cobra.Command, args []string) {
150150
defer cancel()
151151

152152
createInfo := node.CreateInfo{
153-
CreateInfo: service.CreateInfo{
153+
ServiceConfigs: service.ServiceConfigs{
154154
Name: config.ServiceNode,
155155
LogLevel: cfg.LogLevel,
156156
LogColor: cfg.LogColor,
@@ -160,8 +160,8 @@ func run(cmd *cobra.Command, args []string) {
160160
},
161161
Config: *cfg,
162162
}
163-
logger := service.NewServiceLogger(&createInfo.CreateInfo)
164-
createInfo.CreateInfo.Logger = logger
163+
logger := service.NewServiceLogger(&createInfo.ServiceConfigs)
164+
createInfo.ServiceConfigs.Logger = logger
165165

166166
var err error
167167
createInfo.ReaderClient, err = newEthClient(ctx, config.ServiceEvmReader)

‎cmd/cartesi-rollups-prt/root/root.go‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -69,19 +69,21 @@ func run(cmd *cobra.Command, args []string) {
6969
defer cancel()
7070

7171
createInfo := prt.CreateInfo{
72-
CreateInfo: service.CreateInfo{
73-
Name: config.ServicePrt,
74-
LogLevel: config.ResolveServiceLogLevel(config.ServicePrt, cfg.LogLevel),
75-
LogColor: cfg.LogColor,
76-
EnableSignalHandling: true,
77-
TelemetryCreate: true,
78-
TelemetryAddress: cfg.PrtTelemetryAddress,
79-
PollInterval: cfg.PrtPollingInterval,
72+
TickServiceConfigs: service.TickServiceConfigs{
73+
PollInterval: cfg.PrtPollingInterval,
74+
ServiceConfigs: service.ServiceConfigs{
75+
Name: config.ServicePrt,
76+
LogLevel: config.ResolveServiceLogLevel(config.ServicePrt, cfg.LogLevel),
77+
LogColor: cfg.LogColor,
78+
EnableSignalHandling: true,
79+
TelemetryCreate: true,
80+
TelemetryAddress: cfg.PrtTelemetryAddress,
81+
},
8082
},
8183
Config: *cfg,
8284
}
83-
logger := service.NewServiceLogger(&createInfo.CreateInfo)
84-
createInfo.CreateInfo.Logger = logger
85+
logger := service.NewServiceLogger(&createInfo.ServiceConfigs)
86+
createInfo.ServiceConfigs.Logger = logger
8587

8688
var err error
8789
authOpt, err := config.HTTPAuthorizationOption()

‎cmd/cartesi-rollups-validator/root/root.go‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -68,19 +68,21 @@ func run(cmd *cobra.Command, args []string) {
6868
defer cancel()
6969

7070
createInfo := validator.CreateInfo{
71-
CreateInfo: service.CreateInfo{
72-
Name: config.ServiceValidator,
73-
LogLevel: config.ResolveServiceLogLevel(config.ServiceValidator, cfg.LogLevel),
74-
LogColor: cfg.LogColor,
75-
EnableSignalHandling: true,
76-
TelemetryCreate: true,
77-
TelemetryAddress: cfg.ValidatorTelemetryAddress,
71+
TickServiceConfigs: service.TickServiceConfigs{
7872
PollInterval: cfg.ValidatorPollingInterval,
73+
ServiceConfigs: service.ServiceConfigs{
74+
Name: config.ServiceValidator,
75+
LogLevel: config.ResolveServiceLogLevel(config.ServiceValidator, cfg.LogLevel),
76+
LogColor: cfg.LogColor,
77+
EnableSignalHandling: true,
78+
TelemetryCreate: true,
79+
TelemetryAddress: cfg.ValidatorTelemetryAddress,
80+
},
7981
},
8082
Config: *cfg,
8183
}
82-
logger := service.NewServiceLogger(&createInfo.CreateInfo)
83-
createInfo.CreateInfo.Logger = logger
84+
logger := service.NewServiceLogger(&createInfo.ServiceConfigs)
85+
createInfo.ServiceConfigs.Logger = logger
8486

8587
var err error
8688
createInfo.Repository, err = factory.NewRepositoryFromConnectionString(ctx, cfg.DatabaseConnection.Raw())

‎internal/advancer/advancer_test.go‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,15 @@ func newMockAdvancerServiceWithContextAndBatchSize(
6666
machineManager: machineManager,
6767
repository: repo,
6868
}
69-
serviceArgs := &service.CreateInfo{
70-
Name: "advancer",
71-
Impl: s,
72-
Context: ctx,
73-
Cancel: cancelCtx,
69+
serviceArgs := &service.TickServiceConfigs{
70+
ServiceConfigs: service.ServiceConfigs{
71+
Name: "advancer",
72+
Context: ctx,
73+
Cancel: cancelCtx,
74+
},
7475
EnableReschedule: true,
7576
}
76-
err := service.NewTickService(serviceArgs, &s.TickService)
77+
err := service.InitTickServiceTemplate(serviceArgs, &s.TickServiceTemplate, s, s)
7778
if err != nil {
7879
return nil, err
7980
}
@@ -1030,8 +1031,8 @@ func (s *AdvancerSuite) TestRemoveSnapshot() {
10301031

10311032
tmpDir := s.T().TempDir()
10321033
advancer := &Service{snapshotsDir: tmpDir}
1033-
serviceArgs := &service.CreateInfo{Name: "advancer", Impl: advancer}
1034-
require.Nil(service.Create(context.Background(), serviceArgs, &advancer.Service))
1034+
serviceArgs := &service.TickServiceConfigs{ServiceConfigs: service.ServiceConfigs{Name: "advancer"}}
1035+
require.Nil(service.InitTickServiceTemplate(serviceArgs, &advancer.TickServiceTemplate, advancer, advancer))
10351036

10361037
// Create a snapshot directory
10371038
snapshotPath := filepath.Join(tmpDir, "myapp_epoch0_input0")
@@ -1049,8 +1050,8 @@ func (s *AdvancerSuite) TestRemoveSnapshot() {
10491050

10501051
tmpDir := s.T().TempDir()
10511052
advancer := &Service{snapshotsDir: tmpDir}
1052-
serviceArgs := &service.CreateInfo{Name: "advancer", Impl: advancer}
1053-
require.Nil(service.Create(context.Background(), serviceArgs, &advancer.Service))
1053+
serviceArgs := &service.TickServiceConfigs{ServiceConfigs: service.ServiceConfigs{Name: "advancer"}}
1054+
require.Nil(service.InitTickServiceTemplate(serviceArgs, &advancer.TickServiceTemplate, advancer, advancer))
10541055

10551056
snapshotPath := filepath.Join(tmpDir, "myapp_epoch0_input0")
10561057
err := advancer.removeSnapshot(snapshotPath, "myapp")
@@ -1062,8 +1063,8 @@ func (s *AdvancerSuite) TestRemoveSnapshot() {
10621063

10631064
tmpDir := s.T().TempDir()
10641065
advancer := &Service{snapshotsDir: tmpDir}
1065-
serviceArgs := &service.CreateInfo{Name: "advancer", Impl: advancer}
1066-
require.Nil(service.Create(context.Background(), serviceArgs, &advancer.Service))
1066+
serviceArgs := &service.TickServiceConfigs{ServiceConfigs: service.ServiceConfigs{Name: "advancer"}}
1067+
require.Nil(service.InitTickServiceTemplate(serviceArgs, &advancer.TickServiceTemplate, advancer, advancer))
10671068

10681069
// Try to traverse outside snapshotsDir
10691070
maliciousPath := filepath.Join(tmpDir, "..", "outside", "myapp_evil")
@@ -1077,8 +1078,8 @@ func (s *AdvancerSuite) TestRemoveSnapshot() {
10771078

10781079
tmpDir := s.T().TempDir()
10791080
advancer := &Service{snapshotsDir: tmpDir}
1080-
serviceArgs := &service.CreateInfo{Name: "advancer", Impl: advancer}
1081-
require.Nil(service.Create(context.Background(), serviceArgs, &advancer.Service))
1081+
serviceArgs := &service.TickServiceConfigs{ServiceConfigs: service.ServiceConfigs{Name: "advancer"}}
1082+
require.Nil(service.InitTickServiceTemplate(serviceArgs, &advancer.TickServiceTemplate, advancer, advancer))
10821083

10831084
snapshotPath := filepath.Join(tmpDir, "otherapp_epoch0_input0")
10841085
err := advancer.removeSnapshot(snapshotPath, "myapp")

‎internal/advancer/service.go‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,14 +24,14 @@ const httpShutdownTimeout = 10 * time.Second //nolint: mnd
2424

2525
// Service is the main advancer service that processes inputs through Cartesi machines
2626
type Service struct {
27-
service.TickService
27+
service.TickServiceTemplate
2828
inputBatchSize uint64
2929
snapshotsDir string
3030
repository AdvancerRepository
3131
machineManager manager.MachineProvider
3232
inspector *inspect.Inspector
33-
HTTPServer *http.Server
34-
HTTPServerFunc func() error
33+
httpServer *http.Server
34+
httpServerFunc func() error
3535

3636
// cleanedUp ensures HTTP server shutdown and machine manager close run
3737
// exactly once, even when Stop() is called multiple times (by the child's
@@ -41,7 +41,7 @@ type Service struct {
4141

4242
// CreateInfo contains the configuration for creating an advancer service
4343
type CreateInfo struct {
44-
service.CreateInfo
44+
service.TickServiceConfigs
4545
Config config.AdvancerConfig
4646
Repository repository.Repository
4747
}
@@ -54,11 +54,9 @@ func Create(ctx context.Context, c *CreateInfo) (service.IService, error) {
5454
}
5555

5656
s := &Service{}
57-
s.TickImpl = s
58-
c.Impl = s
5957
c.EnableReschedule = true
6058

61-
err = service.NewTickService(&c.CreateInfo, &s.TickService)
59+
err = service.InitTickServiceTemplate(&c.TickServiceConfigs, &s.TickServiceTemplate, s, s)
6260
if err != nil {
6361
return nil, err
6462
}
@@ -84,7 +82,7 @@ func Create(ctx context.Context, c *CreateInfo) (service.IService, error) {
8482

8583
// Initialize the inspect service if enabled
8684
if c.Config.FeatureInspectEnabled {
87-
s.inspector, s.HTTPServer, s.HTTPServerFunc = inspect.NewInspector(
85+
s.inspector, s.httpServer, s.httpServerFunc = inspect.NewInspector(
8886
c.Repository,
8987
manager,
9088
c.Config.InspectAddress,
@@ -126,11 +124,11 @@ func (s *Service) Tick(ctx context.Context) []error {
126124

127125
func (s *Service) OnStop(b bool) []error {
128126
var errs []error
129-
if s.HTTPServer != nil {
127+
if s.httpServer != nil {
130128
s.Logger.Info("Shutting down inspect HTTP server")
131129
shutdownCtx, cancel := context.WithTimeout(context.Background(), httpShutdownTimeout)
132130
defer cancel()
133-
if err := s.HTTPServer.Shutdown(shutdownCtx); err != nil {
131+
if err := s.httpServer.Shutdown(shutdownCtx); err != nil {
134132
errs = append(errs, fmt.Errorf("failed to shutdown inspect HTTP server: %w", err))
135133
}
136134
}
@@ -144,13 +142,13 @@ func (s *Service) OnStop(b bool) []error {
144142
}
145143

146144
func (s *Service) OnServe(ctx context.Context) error {
147-
if s.inspector != nil && s.HTTPServerFunc != nil {
145+
if s.inspector != nil && s.httpServerFunc != nil {
148146
go func() {
149-
if err := s.HTTPServerFunc(); err != nil && !errors.Is(err, http.ErrServerClosed) {
147+
if err := s.httpServerFunc(); err != nil && !errors.Is(err, http.ErrServerClosed) {
150148
s.Logger.Error("Inspect HTTP server failed — shutting down", "error", err)
151149
s.Stop(true)
152150
}
153151
}()
154152
}
155-
return s.TickService.OnServe(ctx)
153+
return s.TickServiceTemplate.OnServe(ctx)
156154
}

‎internal/claimer/claimer_test.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,8 @@ func newServiceMock() (*Service, *claimerRepositoryMock, *claimerBlockchainMock)
188188
blockchain := &claimerBlockchainMock{}
189189

190190
claimer := &Service{
191-
TickService: service.TickService{
192-
Service: service.Service{
191+
TickServiceTemplate: service.TickServiceTemplate{
192+
ServiceTemplate: service.ServiceTemplate{
193193
Logger: slog.New(handler),
194194
},
195195
},

0 commit comments

Comments
 (0)