Make playground module non internal (#150)

ferranbt · web-flow · commit a8bbb2894db8 · 2025-05-10T21:03:40.000+02:00
diff --git a/main.go b/main.go
@@ -12,7 +12,7 @@ import (
 	"strings"
 	"time"
 
-	"github.com/flashbots/builder-playground/internal"
+	"github.com/flashbots/builder-playground/playground"
 	"github.com/spf13/cobra"
 )
 
@@ -27,7 +27,7 @@ var logLevelFlag string
 var bindExternal bool
 var withPrometheus bool
 var networkName string
-var labels internal.MapStringFlag
+var labels playground.MapStringFlag
 var disableLogs bool
 
 var rootCmd = &cobra.Command{
@@ -59,23 +59,23 @@ var artifactsCmd = &cobra.Command{
 			return fmt.Errorf("please specify a service name")
 		}
 		serviceName := args[0]
-		component := internal.FindComponent(serviceName)
+		component := playground.FindComponent(serviceName)
 		if component == nil {
 			return fmt.Errorf("service %s not found", serviceName)
 		}
-		releaseService, ok := component.(internal.ReleaseService)
+		releaseService, ok := component.(playground.ReleaseService)
 		if !ok {
 			return fmt.Errorf("service %s is not a release service", serviceName)
 		}
 		output := outputFlag
 		if output == "" {
-			homeDir, err := internal.GetHomeDir()
+			homeDir, err := playground.GetHomeDir()
 			if err != nil {
 				return fmt.Errorf("failed to get home directory: %w", err)
 			}
 			output = homeDir
 		}
-		location, err := internal.DownloadRelease(output, releaseService.ReleaseArtifact())
+		location, err := playground.DownloadRelease(output, releaseService.ReleaseArtifact())
 		if err != nil {
 			return fmt.Errorf("failed to download release: %w", err)
 		}
@@ -92,18 +92,18 @@ var artifactsAllCmd = &cobra.Command{
 
 		output := outputFlag
 		if output == "" {
-			homeDir, err := internal.GetHomeDir()
+			homeDir, err := playground.GetHomeDir()
 			if err != nil {
 				return fmt.Errorf("failed to get home directory: %w", err)
 			}
 			output = homeDir
 		}
-		for _, component := range internal.Components {
-			releaseService, ok := component.(internal.ReleaseService)
+		for _, component := range playground.Components {
+			releaseService, ok := component.(playground.ReleaseService)
 			if !ok {
 				continue
 			}
-			location, err := internal.DownloadRelease(output, releaseService.ReleaseArtifact())
+			location, err := playground.DownloadRelease(output, releaseService.ReleaseArtifact())
 			if err != nil {
 				return fmt.Errorf("failed to download release: %w", err)
 			}
@@ -138,17 +138,17 @@ var inspectCmd = &cobra.Command{
 			cancel()
 		}()
 
-		if err := internal.Inspect(ctx, serviceName, connectionName); err != nil {
+		if err := playground.Inspect(ctx, serviceName, connectionName); err != nil {
 			return fmt.Errorf("failed to inspect connection: %w", err)
 		}
 		return nil
 	},
 }
 
-var recipes = []internal.Recipe{
-	&internal.L1Recipe{},
-	&internal.OpRecipe{},
-	&internal.BuilderNetRecipe{},
+var recipes = []playground.Recipe{
+	&playground.L1Recipe{},
+	&playground.OpRecipe{},
+	&playground.BuilderNetRecipe{},
 }
 
 func main() {
@@ -168,7 +168,7 @@ func main() {
 		recipeCmd.Flags().StringArrayVar(&withOverrides, "override", []string{}, "override a service's config")
 		recipeCmd.Flags().BoolVar(&dryRun, "dry-run", false, "dry run the recipe")
 		recipeCmd.Flags().BoolVar(&dryRun, "mise-en-place", false, "mise en place mode")
-		recipeCmd.Flags().Uint64Var(&genesisDelayFlag, "genesis-delay", internal.MinimumGenesisDelay, "")
+		recipeCmd.Flags().Uint64Var(&genesisDelayFlag, "genesis-delay", playground.MinimumGenesisDelay, "")
 		recipeCmd.Flags().BoolVar(&interactive, "interactive", false, "interactive mode")
 		recipeCmd.Flags().DurationVar(&timeout, "timeout", 0, "") // Used for CI
 		recipeCmd.Flags().StringVar(&logLevelFlag, "log-level", "info", "log level")
@@ -196,8 +196,8 @@ func main() {
 	}
 }
 
-func runIt(recipe internal.Recipe) error {
-	var logLevel internal.LogLevel
+func runIt(recipe playground.Recipe) error {
+	var logLevel playground.LogLevel
 	if err := logLevel.Unmarshal(logLevelFlag); err != nil {
 		return fmt.Errorf("failed to parse log level: %w", err)
 	}
@@ -222,7 +222,7 @@ func runIt(recipe internal.Recipe) error {
 		return err
 	}
 
-	svcManager := recipe.Apply(&internal.ExContext{LogLevel: logLevel}, artifacts)
+	svcManager := recipe.Apply(&playground.ExContext{LogLevel: logLevel}, artifacts)
 	if err := svcManager.Validate(); err != nil {
 		return fmt.Errorf("failed to validate manifest: %w", err)
 	}
@@ -239,7 +239,7 @@ func runIt(recipe internal.Recipe) error {
 	}
 
 	if withPrometheus {
-		if err := internal.CreatePrometheusServices(svcManager, artifacts.Out); err != nil {
+		if err := playground.CreatePrometheusServices(svcManager, artifacts.Out); err != nil {
 			return fmt.Errorf("failed to create prometheus services: %w", err)
 		}
 	}
@@ -255,7 +255,7 @@ func runIt(recipe internal.Recipe) error {
 		}
 	}
 
-	dockerRunner, err := internal.NewLocalRunner(artifacts.Out, svcManager, overrides, interactive, !bindExternal, networkName, labels, !disableLogs)
+	dockerRunner, err := playground.NewLocalRunner(artifacts.Out, svcManager, overrides, interactive, !bindExternal, networkName, labels, !disableLogs)
 	if err != nil {
 		return fmt.Errorf("failed to create docker runner: %w", err)
 	}
@@ -286,7 +286,7 @@ func runIt(recipe internal.Recipe) error {
 			portsStr := []string{}
 			for _, p := range ports {
 				protocol := ""
-				if p.Protocol == internal.ProtocolUDP {
+				if p.Protocol == playground.ProtocolUDP {
 					protocol = "/udp"
 				}
 				portsStr = append(portsStr, fmt.Sprintf("%s: %d/%d%s", p.Name, p.Port, p.HostPort, protocol))
@@ -300,7 +300,7 @@ func runIt(recipe internal.Recipe) error {
 		return fmt.Errorf("failed to wait for service readiness: %w", err)
 	}
 
-	if err := internal.CompleteReady(dockerRunner.Instances()); err != nil {
+	if err := playground.CompleteReady(dockerRunner.Instances()); err != nil {
 		dockerRunner.Stop()
 		return fmt.Errorf("failed to complete ready: %w", err)
 	}
@@ -317,7 +317,7 @@ func runIt(recipe internal.Recipe) error {
 	watchdogErr := make(chan error, 1)
 	if watchdog {
 		go func() {
-			if err := internal.RunWatchdog(artifacts.Out, dockerRunner.Instances()); err != nil {
+			if err := playground.RunWatchdog(artifacts.Out, dockerRunner.Instances()); err != nil {
 				watchdogErr <- fmt.Errorf("watchdog failed: %w", err)
 			}
 		}()
diff --git a/playground/artifacts.go b/playground/artifacts.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"bytes"
diff --git a/playground/artifacts_test.go b/playground/artifacts_test.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"os"
diff --git a/playground/catalog.go b/playground/catalog.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 var Components = []ServiceGen{}
 
diff --git a/playground/components.go b/playground/components.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"context"
diff --git a/playground/config.yaml.tmpl b/playground/config.yaml.tmpl
diff --git a/playground/genesis_op.go b/playground/genesis_op.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"encoding/json"
diff --git a/playground/genesis_op_test.go b/playground/genesis_op_test.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"encoding/json"
diff --git a/playground/inspect.go b/playground/inspect.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"context"
diff --git a/playground/local_runner.go b/playground/local_runner.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"bytes"
diff --git a/playground/manifest.go b/playground/manifest.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"fmt"
diff --git a/playground/manifest_test.go b/playground/manifest_test.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"testing"
diff --git a/playground/recipe_buildernet.go b/playground/recipe_buildernet.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"fmt"
diff --git a/playground/recipe_l1.go b/playground/recipe_l1.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"fmt"
diff --git a/playground/recipe_opstack.go b/playground/recipe_opstack.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	flag "github.com/spf13/pflag"
diff --git a/playground/releases.go b/playground/releases.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"archive/tar"
diff --git a/playground/testcases/l2_genesis_ishtmus.json b/playground/testcases/l2_genesis_ishtmus.json
diff --git a/playground/utils.go b/playground/utils.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"fmt"
diff --git a/playground/utils/README.md b/playground/utils/README.md
diff --git a/playground/utils/genesis.json b/playground/utils/genesis.json
diff --git a/playground/utils/intent.toml b/playground/utils/intent.toml
diff --git a/playground/utils/query.sh b/playground/utils/query.sh
diff --git a/playground/utils/rollup.json b/playground/utils/rollup.json
diff --git a/playground/utils/state.json b/playground/utils/state.json
diff --git a/playground/watchdog.go b/playground/watchdog.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"context"
diff --git a/playground/watchers.go b/playground/watchers.go
@@ -1,4 +1,4 @@
-package internal
+package playground
 
 import (
 	"context"

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import (`
`12`	`12`	`"strings"`
`13`	`13`	`"time"`
`14`	`14`
`15`		`- "github.com/flashbots/builder-playground/internal"`
	`15`	`+ "github.com/flashbots/builder-playground/playground"`
`16`	`16`	`"github.com/spf13/cobra"`
`17`	`17`	`)`
`18`	`18`
`@@ -27,7 +27,7 @@ var logLevelFlag string`
`27`	`27`	`var bindExternal bool`
`28`	`28`	`var withPrometheus bool`
`29`	`29`	`var networkName string`
`30`		`-var labels internal.MapStringFlag`
	`30`	`+var labels playground.MapStringFlag`
`31`	`31`	`var disableLogs bool`
`32`	`32`
`33`	`33`	`var rootCmd = &cobra.Command{`
`@@ -59,23 +59,23 @@ var artifactsCmd = &cobra.Command{`
`59`	`59`	`return fmt.Errorf("please specify a service name")`
`60`	`60`	`}`
`61`	`61`	`serviceName := args[0]`
`62`		`- component := internal.FindComponent(serviceName)`
	`62`	`+ component := playground.FindComponent(serviceName)`
`63`	`63`	`if component == nil {`
`64`	`64`	`return fmt.Errorf("service %s not found", serviceName)`
`65`	`65`	`}`
`66`		`- releaseService, ok := component.(internal.ReleaseService)`
	`66`	`+ releaseService, ok := component.(playground.ReleaseService)`
`67`	`67`	`if !ok {`
`68`	`68`	`return fmt.Errorf("service %s is not a release service", serviceName)`
`69`	`69`	`}`
`70`	`70`	`output := outputFlag`
`71`	`71`	`if output == "" {`
`72`		`- homeDir, err := internal.GetHomeDir()`
	`72`	`+ homeDir, err := playground.GetHomeDir()`
`73`	`73`	`if err != nil {`
`74`	`74`	`return fmt.Errorf("failed to get home directory: %w", err)`
`75`	`75`	`}`
`76`	`76`	`output = homeDir`
`77`	`77`	`}`
`78`		`- location, err := internal.DownloadRelease(output, releaseService.ReleaseArtifact())`
	`78`	`+ location, err := playground.DownloadRelease(output, releaseService.ReleaseArtifact())`
`79`	`79`	`if err != nil {`
`80`	`80`	`return fmt.Errorf("failed to download release: %w", err)`
`81`	`81`	`}`
`@@ -92,18 +92,18 @@ var artifactsAllCmd = &cobra.Command{`
`92`	`92`
`93`	`93`	`output := outputFlag`
`94`	`94`	`if output == "" {`
`95`		`- homeDir, err := internal.GetHomeDir()`
	`95`	`+ homeDir, err := playground.GetHomeDir()`
`96`	`96`	`if err != nil {`
`97`	`97`	`return fmt.Errorf("failed to get home directory: %w", err)`
`98`	`98`	`}`
`99`	`99`	`output = homeDir`
`100`	`100`	`}`
`101`		`- for _, component := range internal.Components {`
`102`		`- releaseService, ok := component.(internal.ReleaseService)`
	`101`	`+ for _, component := range playground.Components {`
	`102`	`+ releaseService, ok := component.(playground.ReleaseService)`
`103`	`103`	`if !ok {`
`104`	`104`	`continue`
`105`	`105`	`}`
`106`		`- location, err := internal.DownloadRelease(output, releaseService.ReleaseArtifact())`
	`106`	`+ location, err := playground.DownloadRelease(output, releaseService.ReleaseArtifact())`
`107`	`107`	`if err != nil {`
`108`	`108`	`return fmt.Errorf("failed to download release: %w", err)`
`109`	`109`	`}`
`@@ -138,17 +138,17 @@ var inspectCmd = &cobra.Command{`
`138`	`138`	`cancel()`
`139`	`139`	`}()`
`140`	`140`
`141`		`- if err := internal.Inspect(ctx, serviceName, connectionName); err != nil {`
	`141`	`+ if err := playground.Inspect(ctx, serviceName, connectionName); err != nil {`
`142`	`142`	`return fmt.Errorf("failed to inspect connection: %w", err)`
`143`	`143`	`}`
`144`	`144`	`return nil`
`145`	`145`	`},`
`146`	`146`	`}`
`147`	`147`
`148`		`-var recipes = []internal.Recipe{`
`149`		`- &internal.L1Recipe{},`
`150`		`- &internal.OpRecipe{},`
`151`		`- &internal.BuilderNetRecipe{},`
	`148`	`+var recipes = []playground.Recipe{`
	`149`	`+ &playground.L1Recipe{},`
	`150`	`+ &playground.OpRecipe{},`
	`151`	`+ &playground.BuilderNetRecipe{},`
`152`	`152`	`}`
`153`	`153`
`154`	`154`	`func main() {`
`@@ -168,7 +168,7 @@ func main() {`
`168`	`168`	`recipeCmd.Flags().StringArrayVar(&withOverrides, "override", []string{}, "override a service's config")`
`169`	`169`	`recipeCmd.Flags().BoolVar(&dryRun, "dry-run", false, "dry run the recipe")`
`170`	`170`	`recipeCmd.Flags().BoolVar(&dryRun, "mise-en-place", false, "mise en place mode")`
`171`		`- recipeCmd.Flags().Uint64Var(&genesisDelayFlag, "genesis-delay", internal.MinimumGenesisDelay, "")`
	`171`	`+ recipeCmd.Flags().Uint64Var(&genesisDelayFlag, "genesis-delay", playground.MinimumGenesisDelay, "")`
`172`	`172`	`recipeCmd.Flags().BoolVar(&interactive, "interactive", false, "interactive mode")`
`173`	`173`	`recipeCmd.Flags().DurationVar(&timeout, "timeout", 0, "") // Used for CI`
`174`	`174`	`recipeCmd.Flags().StringVar(&logLevelFlag, "log-level", "info", "log level")`
`@@ -196,8 +196,8 @@ func main() {`
`196`	`196`	`}`
`197`	`197`	`}`
`198`	`198`
`199`		`-func runIt(recipe internal.Recipe) error {`
`200`		`- var logLevel internal.LogLevel`
	`199`	`+func runIt(recipe playground.Recipe) error {`
	`200`	`+ var logLevel playground.LogLevel`
`201`	`201`	`if err := logLevel.Unmarshal(logLevelFlag); err != nil {`
`202`	`202`	`return fmt.Errorf("failed to parse log level: %w", err)`
`203`	`203`	`}`
`@@ -222,7 +222,7 @@ func runIt(recipe internal.Recipe) error {`
`222`	`222`	`return err`
`223`	`223`	`}`
`224`	`224`
`225`		`- svcManager := recipe.Apply(&internal.ExContext{LogLevel: logLevel}, artifacts)`
	`225`	`+ svcManager := recipe.Apply(&playground.ExContext{LogLevel: logLevel}, artifacts)`
`226`	`226`	`if err := svcManager.Validate(); err != nil {`
`227`	`227`	`return fmt.Errorf("failed to validate manifest: %w", err)`
`228`	`228`	`}`
`@@ -239,7 +239,7 @@ func runIt(recipe internal.Recipe) error {`
`239`	`239`	`}`
`240`	`240`
`241`	`241`	`if withPrometheus {`
`242`		`- if err := internal.CreatePrometheusServices(svcManager, artifacts.Out); err != nil {`
	`242`	`+ if err := playground.CreatePrometheusServices(svcManager, artifacts.Out); err != nil {`
`243`	`243`	`return fmt.Errorf("failed to create prometheus services: %w", err)`
`244`	`244`	`}`
`245`	`245`	`}`
`@@ -255,7 +255,7 @@ func runIt(recipe internal.Recipe) error {`
`255`	`255`	`}`
`256`	`256`	`}`
`257`	`257`
`258`		`- dockerRunner, err := internal.NewLocalRunner(artifacts.Out, svcManager, overrides, interactive, !bindExternal, networkName, labels, !disableLogs)`
	`258`	`+ dockerRunner, err := playground.NewLocalRunner(artifacts.Out, svcManager, overrides, interactive, !bindExternal, networkName, labels, !disableLogs)`
`259`	`259`	`if err != nil {`
`260`	`260`	`return fmt.Errorf("failed to create docker runner: %w", err)`
`261`	`261`	`}`
`@@ -286,7 +286,7 @@ func runIt(recipe internal.Recipe) error {`
`286`	`286`	`portsStr := []string{}`
`287`	`287`	`for _, p := range ports {`
`288`	`288`	`protocol := ""`
`289`		`- if p.Protocol == internal.ProtocolUDP {`
	`289`	`+ if p.Protocol == playground.ProtocolUDP {`
`290`	`290`	`protocol = "/udp"`
`291`	`291`	`}`
`292`	`292`	`portsStr = append(portsStr, fmt.Sprintf("%s: %d/%d%s", p.Name, p.Port, p.HostPort, protocol))`
`@@ -300,7 +300,7 @@ func runIt(recipe internal.Recipe) error {`
`300`	`300`	`return fmt.Errorf("failed to wait for service readiness: %w", err)`
`301`	`301`	`}`
`302`	`302`
`303`		`- if err := internal.CompleteReady(dockerRunner.Instances()); err != nil {`
	`303`	`+ if err := playground.CompleteReady(dockerRunner.Instances()); err != nil {`
`304`	`304`	`dockerRunner.Stop()`
`305`	`305`	`return fmt.Errorf("failed to complete ready: %w", err)`
`306`	`306`	`}`
`@@ -317,7 +317,7 @@ func runIt(recipe internal.Recipe) error {`
`317`	`317`	`watchdogErr := make(chan error, 1)`
`318`	`318`	`if watchdog {`
`319`	`319`	`go func() {`
`320`		`- if err := internal.RunWatchdog(artifacts.Out, dockerRunner.Instances()); err != nil {`
	`320`	`+ if err := playground.RunWatchdog(artifacts.Out, dockerRunner.Instances()); err != nil {`
`321`	`321`	`watchdogErr <- fmt.Errorf("watchdog failed: %w", err)`
`322`	`322`	`}`
`323`	`323`	`}()`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package internal`
	`1`	`+package playground`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"bytes"`