feat: finish_after_command (#53)

MarcStdt · web-flow · commit 85f58fdfcf28 · 2024-11-17T19:54:41.000+01:00
* feat: finish_after_command
diff --git a/Makefile b/Makefile
@@ -41,12 +41,12 @@ test_clean:
 	go test -v ./test
 
 test-integration:
-	go test -v ./test/integration
+	go test -timeout 1200s -v ./test/integration
 
 test-integration-docker:
 	docker build . -f Dockerfile.testing -t druid-cli-test
-	docker run -v ./:/app --entrypoint=/bin/bash --rm druid-cli-test -c "go test -v ./test/integration"
-	docker run -v ./:/app --entrypoint=/bin/bash --rm druid-cli-test -c "go test -v ./test/integration/commands"
+	docker run -v ./:/app --entrypoint=/bin/bash --rm druid-cli-test -c "go test -timeout 1200s -v ./test/integration"
+	docker run -v ./:/app --entrypoint=/bin/bash --rm druid-cli-test -c "go test -timeout 1200s -v ./test/integration/commands"
 
 test-integration-docker-debug:
 	docker build . -f Dockerfile.testing -t druid-cli-test
diff --git a/cmd/coldstarter.go b/cmd/coldstarter.go
@@ -29,9 +29,9 @@ var ColdstarterCmd = &cobra.Command{
 
 		logger.Log().Info("Scroll loaded", zap.String("Name", currentScroll.Name), zap.Any("Version", currentScroll.Version), zap.String("AppVersion", currentScroll.AppVersion), zap.Any("Ports", currentScroll.Ports))
 
-		portsService := services.NewPortServiceWithScrollFile(&currentScroll.File)
+		portService := services.NewPortServiceWithScrollFile(&currentScroll.File)
 
-		coldStarter := services.NewColdStarter(scrollService.GetDir(), portsService)
+		coldStarter := services.NewColdStarter(portService, nil, scrollService.GetDir())
 
 		finish := coldStarter.Start(context.TODO())
 		<-finish
diff --git a/cmd/serve.go b/cmd/serve.go
@@ -112,7 +112,7 @@ to interact and monitor the Scroll Application`,
 
 		portService := services.NewPortServiceWithScrollFile(scrollService.GetFile())
 
-		coldStarter := services.NewColdStarter(scrollService.GetDir(), portService)
+		coldStarter := services.NewColdStarter(portService, queueManager, scrollService.GetDir())
 
 		scrollHandler := handler.NewScrollHandler(scrollService, pluginManager, processLauncher, queueManager)
 		processHandler := handler.NewProcessHandler(processManager)
@@ -165,18 +165,13 @@ to interact and monitor the Scroll Application`,
 							finish := coldStarter.Start(ctx)
 							executedPort := <-finish
 
-							if executedPort != nil && executedPort.StartDelay > 0 {
-								go func() {
-									time.Sleep(time.Duration(executedPort.StartDelay) * time.Second)
-									coldStarter.Stop()
-								}()
-							} else {
-								coldStarter.Stop()
+							if executedPort.FinishAfterCommand == "" {
+								coldStarter.Stop(executedPort.StartDelay)
 							}
 
 							logger.Log().Info("Coldstarter done, starting scroll")
 
-							startup(scrollService, processLauncher, queueManager, cwd, doneChan)
+							startup(scrollService, processLauncher, queueManager, portService, coldStarter, cwd, doneChan)
 
 							portService.ResetOpenPorts()
 
@@ -216,10 +211,10 @@ to interact and monitor the Scroll Application`,
 						}
 					} else {
 						logger.Log().Warn("No ports to start, skipping coldstarter")
-						startup(scrollService, processLauncher, queueManager, cwd, doneChan)
+						startup(scrollService, processLauncher, queueManager, portService, coldStarter, cwd, doneChan)
 					}
 				} else {
-					startup(scrollService, processLauncher, queueManager, cwd, doneChan)
+					startup(scrollService, processLauncher, queueManager, portService, coldStarter, cwd, doneChan)
 				}
 
 			}()
@@ -269,7 +264,7 @@ func init() {
 	ServeCommand.Flags().UintVarP(&maxStartupHealthCheckTimeout, "max-health-check-startup-timeount", "", 0, "Sets the max amount of time the health check is allowed to take on startup. If the value is 0, there will be no timeout. This is useful to prevent the health check from blocking the startup of the daemon fully.")
 }
 
-func startup(scrollService *services.ScrollService, processLauncher *services.ProcedureLauncher, queueManager *services.QueueManager, cwd string, doneChan chan error) {
+func startup(scrollService *services.ScrollService, processLauncher *services.ProcedureLauncher, queueManager *services.QueueManager, portSerivce *services.PortMonitor, coldStarter *services.ColdStarter, cwd string, doneChan chan error) {
 
 	currentScroll := scrollService.GetCurrent()
 
@@ -330,7 +325,17 @@ func startup(scrollService *services.ScrollService, processLauncher *services.Pr
 		logger.Log().Info("Bootstrapping done")
 	}
 
-	err = queueManager.QueueLockFile()
+	callbacks := map[string]func(){}
+
+	for _, port := range portSerivce.GetPorts() {
+		if port.FinishAfterCommand != "" {
+			callbacks[port.FinishAfterCommand] = func() {
+				coldStarter.Stop(port.StartDelay)
+			}
+		}
+	}
+
+	err = queueManager.QueueLockFile(callbacks)
 	if err != nil {
 		doneChan <- err
 		return
diff --git a/examples/minecraft/.scroll/packet_handler/minecraft.lua b/examples/minecraft/.scroll/packet_handler/minecraft.lua
@@ -107,6 +107,8 @@ function handle(ctx, data)
 
     while hex ~= "" do
 
+        queue = get_queue()
+
         hex = string.tohex(restBytes)
 
         debug_print("Remaining Bytes: " .. hex)
@@ -224,7 +226,10 @@ function pingResponse()
         favicon = "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAMAAACdt4HsAAAAAXNSR0IArs4c6QAAAMlQTFRFR3BM6ndq5Wxb3WBQ6HFi0EUvvVxI8IBzzTwm0EUv11RC3GBQ7X1w00w50EUv42pa1lRB3mNT4WZV0Ugz2VlH0ks22lpJ0ks332RU1VI/6XZo8oV4421e63Zn32JR0046ytvZ2FZEieHa5nBgb+fZFerZ1NrZDOrZDurZ1tjYQunZztrZO+jZruDZFOrZDOrZDOrZ6HVoDOrZ09rZ0cvJn+LZbebZi+PZkOPZC+rZ942B7Xpr9op98oR29Id67n1uz9vZH+rZjeTZHadAYQAAADl0Uk5TAOr9sP4WBv4CDXqV8kcf3m277CmGPaAzx1Pg8tD90lw3YxDx/mzTQ+aq/nYk/bT50NSS71SwxIbiWYkesQAABERJREFUeNqll2tfozgUxkshIeF+vxWoiNfRUaszuztDC7rf/0PtISAlpR1dfPLzTZLzz3POIUgXp0XD2PJUkGetfbT4fyJI9+xNsuqVbGx1beDPh7uKnazq7e+96lWSqj79XLihpKv691SrRPU/4YLGtsbCp9quNp5BPjreE1j4KYT9ZxPYDbQt7GObW9XwxxHqTUz/EB/a8hbC2+iVJpiRbUdpokE92RwbdVJQcjp+x3Ztay0N1iFClFLk6oqYMEa3thUKeqp74q7zLYjQdUzIgjBhGiqRBohOdaLjo/FIldm6FhWIEH4NG8pGHgiReywJagnd8eqwzCF0cTAhq/TIDt+stzAE79Rz76pAYKMW4ukZKJDr9nzldJcMIHSd3dloYiAWapCm8iu83ECrO00tIHEH87JojCfP78/O7u/x/pQw3bEcYCM9MKALANht9HH42d3Pn389PF9enw/bLNjWapf4vAUcyDCreaMGn91dfb/49gv09HxNegAS5ZohNIUHuGlrIHVH8bcv/0I40+MDEDoVYGEHkkXMZbAWYBIMjOJfIX7Qw3W/0YjkHSBqOTW4DFQNAElIhvxvX76z+MHDfU+AnUyJPwZQG7jjyv64er34NdbNZb/CvMJmYT0GGCkANAXvDbyCAU7vFkJTZgRNGQP8RAamTsYVeOPiH5/6KqD2LNiteWNALMCUaewBXAZcDjTtHajjJhSCLMvRtARTAAEAEwdYWABoRPwhgJWrkYcUeEAAgNMpPF0P5WLii7g+AJxzReS6AGcxCRZXxKQZAwi5ezlo4+Mz7i9NxeKbRB8DQrPhasD1kcsgTJsOwD/KKAcAdGGv9iq+jUvYG1AE2Amj4l8IWKyaxkRkNANJ7Ak3z+e9gahqmAT+OhMAN6VPRjOYvQ7euqfwso9HQdZ0Mn0eoJtVkymYmzu7vfrn4tvNDbxP+gWqJL0BlgF/HbPJJI5/3N39fXk5vBSRBcd0KteEBxClrCoz5Gf1IEYLMvBc7z2+ykQ0eWPnVVUqmLcV5J6PujnqFmJZNf0wdXIIwB5YyN3FQWWWqWrFuh4Xnlhm1btKDx/51xxl/QJPlcrSNM1SyqpBknjsQwdbZZWZOk81RKmaSLLDaTzrsVSVosFT/UiqMhhVto8/9ZlEQpYE5Qk6EDpl3XACLp7vu5llpoUPPKgOIDIIbSHLyOLy50ULJ5PMNTmoQ6zmzlICLR3bCunitAi1gJDH+MAZaj+7PU8pdJd+9I2ttIQ1nmRHEUIUk8WHQpYjSXlBF3NFaGFKkqkgMhtB41ySnMDFswlYt5fSMorpbBPEDRww4bl4LgKakbcm1gh/IY3WhKjPRhDDa004wXwE1kWzQxhzEciynRYhFuHcx8JQGGKZe7FLZ3a0RbB7qIRzERbUorURWWhuQ9Zq5CyXS0dBs++HbwU5EKwv3FJDh2rk/uILoqFlT38O/QdGyOZnTVzZRwAAAABJRU5ErkJggg=="
     }
 
-    if get_finish_sec() ~= nil then
+    if queue ~= nil and queue["install"] == "running" then
+        obj.version.name = "§2▶ Installing..."
+        obj.description = "Installing Minecraft Server, this might take a moment"
+    elseif get_finish_sec() ~= nil then
         obj.version.name = "§2▶ Starting..."
         obj.description = "Starting " .. math.ceil(get_finish_sec()) .. "s"
     end
diff --git a/examples/minecraft/.scroll/packet_handler/query.lua b/examples/minecraft/.scroll/packet_handler/query.lua
@@ -76,15 +76,19 @@ function handle(ctx, data)
 
     if packetId == "54" then
 
+        queue = get_queue()
         name = get_var("ServerListName") or "Coldstarter is cool (server is idle, join to start)"
 
-        if get_finish_sec() ~= nil then
+        map = get_var("MapName") or "server idle"
+
+        if queue ~= nil and queue["install"] == "running" then
+            name = get_var("ServerListNameInstalling") or "INSTALLING, this might take a moment"
+            map = get_var("MapNameInstalling") or "installing server"
+        elseif get_finish_sec() ~= nil then
             nameTemplate = get_var("ServerListNameStarting") or "Druid Gameserver (starting) - %ds"
             name = string.format(nameTemplate, math.ceil(get_finish_sec()))
         end
 
-        map = get_var("MapName") or "TheIsland"
-
         folder = get_var("GameSteamFolder") or "ark_survival_evolved"
 
         gameName = get_var("GameName") or "ARK: Survival Evolved"
diff --git a/examples/minecraft/.scroll/scroll-lock.json b/examples/minecraft/.scroll/scroll-lock.json
@@ -1 +1 @@
-{"statuses":{"install":{"status":"done","exit_code":null,"last_status_change":1730062651},"start":{"status":"waiting","exit_code":null,"last_status_change":1730235343}},"scroll_version":"0.0.1","scroll_name":"registry-1.docker.io/highcard/scroll-minecraft-spigot"}
+{"statuses":{"install":{"status":"done","exit_code":null,"last_status_change":1731537003},"start":{"status":"running","exit_code":null,"last_status_change":1731539114}},"scroll_version":"0.0.1","scroll_name":"registry-1.docker.io/highcard/scroll-minecraft-spigot"}
diff --git a/examples/minecraft/.scroll/scroll.yaml b/examples/minecraft/.scroll/scroll.yaml
@@ -8,7 +8,6 @@ ports:
     protocol: tcp
     port: 25565
     sleep_handler: packet_handler/minecraft.lua
-    start_delay: 10
     mandatory: true
   - name: query
     protocol: udp
@@ -27,7 +26,6 @@ ports:
       - name: ServerListNameStarting
         value: "▶️ Druid Gameserver (starting) - %ds"
   - name: main
-    start_delay: 10
     protocol: udp
 
 init: "start"
diff --git a/internal/core/domain/broadcast_channel.go b/internal/core/domain/broadcast_channel.go
@@ -48,7 +48,9 @@ func (h *BroadcastChannel) Run() {
 			select {
 			case client <- &message: // Try to send the message.
 			default:
-				logger.Log().Warn("Failed to Broadcast message to channel.. closing channel")
+				// logger.Log().Warn("Channel seems to be closed, removing")
+				logger.Log().Warn("Channel seems to be closed")
+				// delete(h.Clients, client)
 				// h.Unsubscribe(client)
 			}
 		}
diff --git a/internal/core/domain/scroll.go b/internal/core/domain/scroll.go
@@ -32,13 +32,14 @@ type ColdStarterVars struct {
 }
 
 type Port struct {
-	Port         int               `yaml:"port" json:"port"`
-	Protocol     string            `yaml:"protocol" json:"protocol"`
-	Name         string            `yaml:"name" json:"name"`
-	SleepHandler *string           `yaml:"sleep_handler" json:"sleep_handler"`
-	Mandatory    bool              `yaml:"mandatory" json:"mandatory"`
-	Vars         []ColdStarterVars `yaml:"vars" json:"vars"`
-	StartDelay   uint              `yaml:"start_delay" json:"start_delay"`
+	Port               int               `yaml:"port" json:"port"`
+	Protocol           string            `yaml:"protocol" json:"protocol"`
+	Name               string            `yaml:"name" json:"name"`
+	SleepHandler       *string           `yaml:"sleep_handler" json:"sleep_handler"`
+	Mandatory          bool              `yaml:"mandatory" json:"mandatory"`
+	Vars               []ColdStarterVars `yaml:"vars" json:"vars"`
+	StartDelay         uint              `yaml:"start_delay" json:"start_delay"`
+	FinishAfterCommand string            `yaml:"finish_after_command" json:"finish_after_command"`
 }
 
 type AugmentedPort struct {
@@ -66,10 +67,11 @@ type Scroll struct {
 } // @name Scroll
 
 type Procedure struct {
-	Mode string      `yaml:"mode"`
-	Id   *string     `yaml:"id"`
-	Wait interface{} `yaml:"wait"`
-	Data interface{} `yaml:"data"`
+	Mode          string      `yaml:"mode"`
+	Id            *string     `yaml:"id"`
+	Wait          interface{} `yaml:"wait"`
+	Data          interface{} `yaml:"data"`
+	IgnoreFailure bool        `yaml:"ignore_failure"`
 } // @name Procedure
 
 type CommandInstructionSet struct {
diff --git a/internal/core/ports/services_ports.go b/internal/core/ports/services_ports.go
@@ -117,6 +117,6 @@ type ColdStarterServerInterface interface {
 }
 
 type ColdStarterInterface interface {
-	Stop()
+	Stop(uint)
 	Finish(*domain.AugmentedPort)
 }
diff --git a/internal/core/services/coldstarter.go b/internal/core/services/coldstarter.go
@@ -22,12 +22,14 @@ type ColdStarter struct {
 	serveDone    chan error
 	finishChan   chan *domain.AugmentedPort
 	chandlers    []ports.ColdStarterHandlerInterface
+	queueManager ports.QueueManagerInterface
 }
 
 // NewColdStarter initializes the ColdStarter struct with proper channel initialization and no initial finishTime.
 func NewColdStarter(
-	dir string,
 	portsService ports.PortServiceInterface,
+	queueManager ports.QueueManagerInterface,
+	dir string,
 ) *ColdStarter {
 	return &ColdStarter{
 		handler:      make(map[string]uint),
@@ -38,6 +40,7 @@ func NewColdStarter(
 		serveDone:    make(chan error),
 		finishChan:   make(chan *domain.AugmentedPort),
 		chandlers:    nil,
+		queueManager: queueManager,
 	}
 }
 
@@ -92,7 +95,7 @@ func (c *ColdStarter) Serve(ctx context.Context) error {
 				for _, v := range port.Vars {
 					vars[v.Name] = v.Value
 				}
-				handler = lua.NewLuaHandler(path, c.dir, vars, augmentedPortMap)
+				handler = lua.NewLuaHandler(c.queueManager, path, c.dir, vars, augmentedPortMap)
 			}
 
 			c.chandlers = append(c.chandlers, handler)
@@ -134,7 +137,16 @@ func (c *ColdStarter) Serve(ctx context.Context) error {
 }
 
 // Stop sends a nil error to the serveDone channel to gracefully stop the Serve function.
-func (c *ColdStarter) Stop() {
+func (c *ColdStarter) Stop(startDelay uint) {
+
+	if startDelay > 0 {
+		go func() {
+			time.Sleep(time.Duration(startDelay) * time.Second)
+			c.serveDone <- nil
+		}()
+		return
+	}
+
 	c.serveDone <- nil
 }
 
diff --git a/internal/core/services/coldstarter/handler/lua_handler.go b/internal/core/services/coldstarter/handler/lua_handler.go
@@ -16,19 +16,21 @@ type LuaHandler struct {
 	externalVars map[string]string
 	ports        map[string]int
 	finishedAt   *time.Time
+	queueManager ports.QueueManagerInterface
 }
 
 type LuaWrapper struct {
 	luaState *lua.LState
 }
 
-func NewLuaHandler(file string, luaPath string, externalVars map[string]string, ports map[string]int) *LuaHandler {
+func NewLuaHandler(queueManager ports.QueueManagerInterface, file string, luaPath string, externalVars map[string]string, ports map[string]int) *LuaHandler {
 
 	handler := &LuaHandler{
 		file:         file,
 		luaPath:      luaPath,
 		externalVars: externalVars,
 		ports:        ports,
+		queueManager: queueManager,
 	}
 	return handler
 }
@@ -127,6 +129,24 @@ func (handler *LuaHandler) GetHandler(funcs map[string]func(data ...string)) (po
 		},
 	))
 
+	l.SetGlobal("get_queue", l.NewFunction(
+		func(l *lua.LState) int {
+			if handler.queueManager == nil {
+				return 0
+			}
+
+			queueMap := handler.queueManager.GetQueue()
+			table := l.NewTable()
+
+			for key, value := range queueMap {
+				l.SetField(table, key, lua.LString(value))
+			}
+
+			l.Push(table)
+			return 1
+		},
+	))
+
 	// set package.path to include the luaPath
 	l.DoString(fmt.Sprintf("package.path = package.path .. ';;%s/?.lua'", handler.luaPath))
 
diff --git a/internal/core/services/procedure_launcher.go b/internal/core/services/procedure_launcher.go
@@ -120,6 +120,13 @@ func (sc *ProcedureLauncher) Run(cmd string, runCommandCb func(cmd string) error
 		}
 
 		if exitCode != nil && *exitCode != 0 {
+			if proc.IgnoreFailure {
+				logger.Log().Warn("Procedure failed but ignoring failure",
+					zap.String("cmd", commandIdx),
+					zap.Int("exitCode", *exitCode),
+				)
+				continue
+			}
 			logger.Log().Error("Procedure ended with exit code "+fmt.Sprintf("%d", *exitCode),
 				zap.String("cmd", commandIdx),
 				zap.Int("exitCode", *exitCode),
diff --git a/internal/core/services/queue_manager.go b/internal/core/services/queue_manager.go
diff --git a/internal/signals/process_shutdown.go b/internal/signals/process_shutdown.go
diff --git a/test/integration/commands/serve_test.go b/test/integration/commands/serve_test.go

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{"statuses":{"install":{"status":"done","exit_code":null,"last_status_change":1730062651},"start":{"status":"waiting","exit_code":null,"last_status_change":1730235343}},"scroll_version":"0.0.1","scroll_name":"registry-1.docker.io/highcard/scroll-minecraft-spigot"}`
	`1`	`+{"statuses":{"install":{"status":"done","exit_code":null,"last_status_change":1731537003},"start":{"status":"running","exit_code":null,"last_status_change":1731539114}},"scroll_version":"0.0.1","scroll_name":"registry-1.docker.io/highcard/scroll-minecraft-spigot"}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,9 @@ func (h *BroadcastChannel) Run() {`
`48`	`48`	`select {`
`49`	`49`	`case client <- &message: // Try to send the message.`
`50`	`50`	`default:`
`51`		`- logger.Log().Warn("Failed to Broadcast message to channel.. closing channel")`
	`51`	`+ // logger.Log().Warn("Channel seems to be closed, removing")`
	`52`	`+ logger.Log().Warn("Channel seems to be closed")`
	`53`	`+ // delete(h.Clients, client)`
`52`	`54`	`// h.Unsubscribe(client)`
`53`	`55`	`}`
`54`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -117,6 +117,6 @@ type ColdStarterServerInterface interface {`
`117`	`117`	`}`
`118`	`118`
`119`	`119`	`type ColdStarterInterface interface {`
`120`		`- Stop()`
	`120`	`+ Stop(uint)`
`121`	`121`	`Finish(*domain.AugmentedPort)`
`122`	`122`	`}`