refactor: Reduce namespace polution by moving service examples into a…

… package

pkg/service/dummy/dummy.go

@@ -0,0 +1,27 @@
+// (c) Cartesi and individual authors (see AUTHORS)
+// SPDX-License-Identifier: Apache-2.0 (see LICENSE)
+
+// A Service implementation that does nothing
+package dummy
+
+import (
+	"github.com/cartesi/rollups-node/pkg/service"
+)
+
+type Service struct {
+	service.Service
+}
+
+type CreateInfo struct {
+	service.CreateInfo
+}
+
+func Create(c *CreateInfo, s *Service) error {
+	return service.Create(&c.CreateInfo, &s.Service)
+}
+
+func (s *Service) Alive() bool       { return true }
+func (s *Service) Ready() bool       { return true }
+func (s *Service) Reload() []error   { return nil }
+func (s *Service) Tick() []error     { return nil }
+func (s *Service) Stop(bool) []error { return nil }

pkg/service/list.go → pkg/service/list/list.go

@@ -1,32 +1,34 @@
 // (c) Cartesi and individual authors (see AUTHORS)
 // SPDX-License-Identifier: Apache-2.0 (see LICENSE)
 
+// A service implementation of a list of services
 package service
 
 import (
 	"fmt"
 	"net/http"
 	"strings"
 	"time"
+	"github.com/cartesi/rollups-node/pkg/service"
 )
 
 // A Service implementation in terms of a list of other services
-type ListService struct {
-	Service
+type Service struct {
+	service.Service
 	Children []*Service
 }
 
 type CreateListInfo struct {
-	CreateInfo
+	service.CreateInfo
 }
 
-func CreateList(ci CreateListInfo, list *ListService) error {
-	err := Create(&ci.CreateInfo, &list.Service)
+func CreateList(c *CreateListInfo, list *Service) error {
+	err := service.Create(&c.CreateInfo, &list.Service)
 	if err != nil {
 		return err
 	}
 
-	if ci.CreateInfo.TelemetryCreate {
+	if c.CreateInfo.TelemetryCreate {
 		list.ServeMux.Handle("/"+list.Name+"/readyz",
 			http.HandlerFunc(list.ReadyHandler))
 		list.ServeMux.Handle("/"+list.Name+"/livez",
@@ -35,15 +37,15 @@ func CreateList(ci CreateListInfo, list *ListService) error {
 	return nil
 }
 
-func (me *ListService) Alive() bool {
+func (me *Service) Alive() bool {
 	alive := true
 	for _, s := range me.Children {
 		alive = alive && s.Alive()
 	}
 	return alive
 }
 
-func (me *ListService) Ready() bool {
+func (me *Service) Ready() bool {
 	allReady := true
 	for _, s := range me.Children {
 		ready := s.Ready()
@@ -52,7 +54,7 @@ func (me *ListService) Ready() bool {
 	return allReady
 }
 
-func (me *ListService) Reload() []error {
+func (me *Service) Reload() []error {
 	var all []error
 	for _, s := range me.Children {
 		es := s.Reload()
@@ -63,7 +65,7 @@ func (me *ListService) Reload() []error {
 
 /*
 // Simple tick runs children one at a time
-func (me *ListService) Tick() []error {
+func (me *Service) Tick() []error {
 	var all []error
 	for _, s := range me.Children {
 		all = append(all, s.Tick()...)
@@ -72,8 +74,8 @@ func (me *ListService) Tick() []error {
 }
 */
 
-// *
-func (me *ListService) Tick() []error {
+// Tick runs all registered services in parallel.
+func (me *Service) Tick() []error {
 	c := make(chan []error)
 	var all []error
 	for _, s := range me.Children {
@@ -98,9 +100,7 @@ func (me *ListService) Tick() []error {
 	return all
 }
 
-//*/
-
-func (me *ListService) Stop(force bool) []error {
+func (me *Service) Stop(force bool) []error {
 	var all []error
 	for _, s := range me.Children {
 		es := s.Stop(force)
@@ -109,7 +109,7 @@ func (me *ListService) Stop(force bool) []error {
 	return all
 }
 
-func (me *ListService) AliveHandler(w http.ResponseWriter, r *http.Request) {
+func (me *Service) AliveHandler(w http.ResponseWriter, r *http.Request) {
 	ss := []string{}
 
 	allAlive := true
@@ -128,7 +128,7 @@ func (me *ListService) AliveHandler(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
-func (me *ListService) ReadyHandler(w http.ResponseWriter, r *http.Request) {
+func (me *Service) ReadyHandler(w http.ResponseWriter, r *http.Request) {
 	ss := []string{}
 
 	allReady := true

pkg/service/slow/slow.go

@@ -0,0 +1,47 @@
+// (c) Cartesi and individual authors (see AUTHORS)
+// SPDX-License-Identifier: Apache-2.0 (see LICENSE)
+
+// A service implementation that simulate a long running Tick
+package slow
+
+import (
+	"time"
+	"github.com/cartesi/rollups-node/pkg/service"
+)
+
+// A Service implementation that takes time to Tick
+type Service struct {
+	service.Service
+	Time time.Duration
+}
+
+type CreageInfo struct {
+	service.CreateInfo
+	Time time.Duration
+}
+
+func Creage(c *CreageInfo, s *Service) error {
+	s.Time = c.Time
+	return service.Create(&c.CreateInfo, &s.Service)
+}
+
+func (me *Service) Alive() bool {
+	return true
+}
+
+func (me *Service) Ready() bool {
+	return true
+}
+
+func (me *Service) Reload() []error {
+	return nil
+}
+
+func (me *Service) Tick() []error {
+	time.Sleep(me.Time)
+	return nil
+}
+
+func (me *Service) Stop(bool) []error {
+	return nil
+}