Introduce the concept of instance (#122)

* Use concrete artifacts

* Add manifest file

Author: ferranbt

internal/components.go

@@ -191,24 +191,24 @@ func (o *OpGeth) Name() string {
 
 var _ ServiceReady = &OpGeth{}
 
-func (o *OpGeth) Ready(service *service) error {
-	enodeLine, err := service.logs.FindLog("enode://")
+func (o *OpGeth) Ready(instance *instance) error {
+	enodeLine, err := instance.logs.FindLog("enode://")
 	if err != nil {
 		return err
 	}
 
 	parts := strings.Split(enodeLine, "enode://")[1]
 	enodeID := strings.Split(parts, "@")[0]
 
-	enode := fmt.Sprintf("enode://%s@127.0.0.1:%d?discport=0", enodeID, service.MustGetPort("rpc").HostPort)
+	enode := fmt.Sprintf("enode://%s@127.0.0.1:%d?discport=0", enodeID, instance.service.MustGetPort("rpc").HostPort)
 	o.Enode = enode
 	return nil
 }
 
 var _ ServiceWatchdog = &OpGeth{}
 
-func (o *OpGeth) Watchdog(out io.Writer, service *service, ctx context.Context) error {
-	gethURL := fmt.Sprintf("http://localhost:%d", service.MustGetPort("http").HostPort)
+func (o *OpGeth) Watchdog(out io.Writer, instance *instance, ctx context.Context) error {
+	gethURL := fmt.Sprintf("http://localhost:%d", instance.service.MustGetPort("http").HostPort)
 	return watchChainHead(out, gethURL, 2*time.Second)
 }
 
@@ -296,8 +296,8 @@ func (r *RethEL) Name() string {
 
 var _ ServiceWatchdog = &RethEL{}
 
-func (r *RethEL) Watchdog(out io.Writer, service *service, ctx context.Context) error {
-	rethURL := fmt.Sprintf("http://localhost:%d", service.MustGetPort("http").HostPort)
+func (r *RethEL) Watchdog(out io.Writer, instance *instance, ctx context.Context) error {
+	rethURL := fmt.Sprintf("http://localhost:%d", instance.service.MustGetPort("http").HostPort)
 	return watchChainHead(out, rethURL, 12*time.Second)
 }
 
@@ -438,8 +438,8 @@ func (m *MevBoostRelay) Name() string {
 
 var _ ServiceWatchdog = &MevBoostRelay{}
 
-func (m *MevBoostRelay) Watchdog(out io.Writer, service *service, ctx context.Context) error {
-	beaconNodeURL := fmt.Sprintf("http://localhost:%d", service.MustGetPort("http").HostPort)
+func (m *MevBoostRelay) Watchdog(out io.Writer, instance *instance, ctx context.Context) error {
+	beaconNodeURL := fmt.Sprintf("http://localhost:%d", instance.service.MustGetPort("http").HostPort)
 
 	watchGroup := newWatchGroup()
 	watchGroup.watch(func() error {
@@ -567,7 +567,7 @@ func (o *OpReth) ReleaseArtifact() *release {
 
 var _ ServiceWatchdog = &OpReth{}
 
-func (p *OpReth) Watchdog(out io.Writer, service *service, ctx context.Context) error {
-	rethURL := fmt.Sprintf("http://localhost:%d", service.MustGetPort("http").HostPort)
+func (p *OpReth) Watchdog(out io.Writer, instance *instance, ctx context.Context) error {
+	rethURL := fmt.Sprintf("http://localhost:%d", instance.service.MustGetPort("http").HostPort)
 	return watchChainHead(out, rethURL, 2*time.Second)
 }

internal/local_runner.go

@@ -57,6 +57,9 @@ type LocalRunner struct {
 	// signals whether we are running in interactive mode
 	interactive bool
 
+	// TODO: Merge instance with tasks
+	instances []*instance
+
 	// tasks tracks the status of each service
 	tasksMtx     sync.Mutex
 	tasks        map[string]*task
@@ -115,6 +118,49 @@ func NewLocalRunner(out *output, manifest *Manifest, overrides map[string]string
 		overrides[k] = v
 	}
 
+	// Create the concrete instances to run
+	instances := []*instance{}
+	for _, service := range manifest.Services() {
+		log_output, err := out.LogOutput(service.Name)
+		if err != nil {
+			return nil, fmt.Errorf("error getting log output: %w", err)
+		}
+		logs := &serviceLogs{
+			logRef: log_output,
+			path:   log_output.Name(),
+		}
+		component := FindComponent(service.componentName)
+		if component == nil {
+			return nil, fmt.Errorf("component not found '%s'", service.componentName)
+		}
+		instance := &instance{
+			service:   service,
+			logs:      logs,
+			component: component,
+		}
+		instances = append(instances, instance)
+	}
+
+	// download any local release artifacts for the services that require them
+	// TODO: it feels a bit weird to have all this logic on the new command. We should split it later on.
+	for _, instance := range instances {
+		ss := instance.service
+		if ss.labels[useHostExecutionLabel] == "true" {
+			// If the service wants to run on the host, it must implement the ReleaseService interface
+			// which provides functions to download the release artifact.
+			releaseService, ok := instance.component.(ReleaseService)
+			if !ok {
+				return nil, fmt.Errorf("service '%s' must implement the ReleaseService interface", ss.Name)
+			}
+			releaseArtifact := releaseService.ReleaseArtifact()
+			bin, err := DownloadRelease(out.homeDir, releaseArtifact)
+			if err != nil {
+				return nil, fmt.Errorf("failed to download release artifact for service '%s': %w", ss.Name, err)
+			}
+			overrides[ss.Name] = bin
+		}
+	}
+
 	// Now, the override can either be one of two things (we are overloading the override map):
 	// - docker image: In that case, change the manifest and remove from override map
 	// - a path to an executable: In that case, we need to run it on the host machine
@@ -162,6 +208,7 @@ func NewLocalRunner(out *output, manifest *Manifest, overrides map[string]string
 		bindHostPortsLocally: bindHostPortsLocally,
 		sessionID:            uuid.New().String(),
 		networkName:          networkName,
+		instances:            instances,
 	}
 
 	if interactive {
@@ -176,6 +223,10 @@ func NewLocalRunner(out *output, manifest *Manifest, overrides map[string]string
 	return d, nil
 }
 
+func (d *LocalRunner) Instances() []*instance {
+	return d.instances
+}
+
 func (d *LocalRunner) printStatus() {
 	fmt.Print("\033[s")
 	lineOffset := 0
@@ -921,15 +972,8 @@ func (d *LocalRunner) Run() error {
 	}
 
 	// generate the output log file for each service so that it is available after Run is done
-	for _, svc := range d.manifest.services {
-		log_output, err := d.out.LogOutput(svc.Name)
-		if err != nil {
-			return fmt.Errorf("error getting log output: %w", err)
-		}
-		svc.logs = &serviceLogs{
-			path: log_output.Name(),
-		}
-		d.tasks[svc.Name].logs = log_output
+	for _, instance := range d.instances {
+		d.tasks[instance.service.Name].logs = instance.logs.logRef
 	}
 
 	// First start the services that are running in docker-compose

internal/manifest.go

@@ -1,9 +1,7 @@
 package internal
 
 import (
-	"context"
 	"fmt"
-	"io"
 	"os"
 	"path/filepath"
 	"strings"
@@ -81,47 +79,7 @@ type Service interface {
 }
 
 type ServiceReady interface {
-	Ready(ouservice *service) error
-}
-
-func (m *Manifest) CompleteReady() error {
-	for _, s := range m.services {
-		if readyFn, ok := s.component.(ServiceReady); ok {
-			if err := readyFn.Ready(s); err != nil {
-				return err
-			}
-		}
-	}
-	return nil
-}
-
-type ServiceWatchdog interface {
-	Watchdog(out io.Writer, service *service, ctx context.Context) error
-}
-
-func RunWatchdog(manifest *Manifest) error {
-	watchdogErr := make(chan error, len(manifest.Services()))
-
-	output, err := manifest.out.LogOutput("watchdog")
-	if err != nil {
-		return fmt.Errorf("failed to create log output: %w", err)
-	}
-
-	for _, s := range manifest.Services() {
-		if watchdogFn, ok := s.component.(ServiceWatchdog); ok {
-			go func() {
-				if err := watchdogFn.Watchdog(output, s, context.Background()); err != nil {
-					watchdogErr <- fmt.Errorf("service %s watchdog failed: %w", s.Name, err)
-				}
-			}()
-		}
-	}
-
-	// If any of the watchdogs fail, we return the error
-	if err := <-watchdogErr; err != nil {
-		return fmt.Errorf("failed to run watchdog: %w", err)
-	}
-	return nil
+	Ready(instance *instance) error
 }
 
 func (s *Manifest) Services() []*service {
@@ -135,7 +93,7 @@ type ReleaseService interface {
 
 func (s *Manifest) AddService(name string, srv Service) {
 	service := s.NewService(name)
-	service.component = srv
+	service.componentName = srv.Name()
 	srv.Run(service, s.ctx)
 
 	s.services = append(s.services, service)
@@ -191,21 +149,17 @@ func (s *Manifest) Validate() error {
 		}
 	}
 
-	// download any local release artifacts for the services that require them
+	// validate that the mounts are correct
 	for _, ss := range s.services {
-		if ss.labels[useHostExecutionLabel] == "true" {
-			// If the service wants to run on the host, it must implement the ReleaseService interface
-			// which provides functions to download the release artifact.
-			releaseService, ok := ss.component.(ReleaseService)
-			if !ok {
-				return fmt.Errorf("service '%s' must implement the ReleaseService interface", ss.Name)
-			}
-			releaseArtifact := releaseService.ReleaseArtifact()
-			bin, err := DownloadRelease(s.out.homeDir, releaseArtifact)
-			if err != nil {
-				return fmt.Errorf("failed to download release artifact for service '%s': %w", ss.Name, err)
+		for _, fileNameRef := range ss.filesMapped {
+			fileLoc := filepath.Join(s.out.dst, fileNameRef)
+
+			if _, err := os.Stat(fileLoc); err != nil {
+				if os.IsNotExist(err) {
+					return fmt.Errorf("service %s includes an unknown file %s does not exist", ss.Name, fileLoc)
+				}
+				return fmt.Errorf("failed to stat file %s: %w", fileLoc, err)
 			}
-			s.overrides[ss.Name] = bin
 		}
 	}
 
@@ -256,7 +210,8 @@ type NodeRef struct {
 
 // serviceLogs is a service to access the logs of the running service
 type serviceLogs struct {
-	path string
+	logRef *os.File
+	path   string
 }
 
 func (s *serviceLogs) readLogs() (string, error) {
@@ -301,9 +256,15 @@ type service struct {
 	filesMapped   map[string]string
 	volumesMapped map[string]string
 
+	componentName string
+
 	tag        string
 	image      string
 	entrypoint string
+}
+
+type instance struct {
+	service *service
 
 	logs      *serviceLogs
 	component Service

internal/recipe_opstack.go

@@ -93,12 +93,14 @@ func (o *OpRecipe) Apply(ctx *ExContext, artifacts *Artifacts) *Manifest {
 }
 
 func (o *OpRecipe) Output(manifest *Manifest) map[string]interface{} {
-	opGeth := manifest.MustGetService("op-geth").component.(*OpGeth)
-	if opGeth.Enode != "" {
-		// Only output if enode was set
-		return map[string]interface{}{
-			"op-geth-enode": opGeth.Enode,
+	/*
+		opGeth := manifest.MustGetService("op-geth").component.(*OpGeth)
+		if opGeth.Enode != "" {
+			// Only output if enode was set
+			return map[string]interface{}{
+				"op-geth-enode": opGeth.Enode,
+			}
 		}
-	}
+	*/
 	return map[string]interface{}{}
 }

internal/watchdog.go

@@ -0,0 +1,47 @@
+package internal
+
+import (
+	"context"
+	"fmt"
+	"io"
+)
+
+type ServiceWatchdog interface {
+	Watchdog(out io.Writer, instance *instance, ctx context.Context) error
+}
+
+func RunWatchdog(out *output, instances []*instance) error {
+	watchdogErr := make(chan error, len(instances))
+
+	output, err := out.LogOutput("watchdog")
+	if err != nil {
+		return fmt.Errorf("failed to create log output: %w", err)
+	}
+
+	for _, s := range instances {
+		if watchdogFn, ok := s.component.(ServiceWatchdog); ok {
+			go func() {
+				if err := watchdogFn.Watchdog(output, s, context.Background()); err != nil {
+					watchdogErr <- fmt.Errorf("service %s watchdog failed: %w", s.service.Name, err)
+				}
+			}()
+		}
+	}
+
+	// If any of the watchdogs fail, we return the error
+	if err := <-watchdogErr; err != nil {
+		return fmt.Errorf("failed to run watchdog: %w", err)
+	}
+	return nil
+}
+
+func CompleteReady(instances []*instance) error {
+	for _, s := range instances {
+		if readyFn, ok := s.component.(ServiceReady); ok {
+			if err := readyFn.Ready(s); err != nil {
+				return err
+			}
+		}
+	}
+	return nil
+}

main.go

@@ -291,7 +291,7 @@ func runIt(recipe internal.Recipe) error {
 		return fmt.Errorf("failed to wait for service readiness: %w", err)
 	}
 
-	if err := svcManager.CompleteReady(); err != nil {
+	if err := internal.CompleteReady(dockerRunner.Instances()); err != nil {
 		dockerRunner.Stop()
 		return fmt.Errorf("failed to complete ready: %w", err)
 	}
@@ -308,7 +308,7 @@ func runIt(recipe internal.Recipe) error {
 	watchdogErr := make(chan error, 1)
 	if watchdog {
 		go func() {
-			if err := internal.RunWatchdog(svcManager); err != nil {
+			if err := internal.RunWatchdog(artifacts.Out, dockerRunner.Instances()); err != nil {
 				watchdogErr <- fmt.Errorf("watchdog failed: %w", err)
 			}
 		}()