Merge pull request #12 from achu-1612/ac/ref

runner: ref handling restart of service

README.md

@@ -1,4 +1,5 @@
 # glcm: Go Routine Lifecycle Management
+
 ```
 
       ___           ___       ___           ___
@@ -15,8 +16,6 @@
 
 ```
 
-
-
 `glcm` is a Go package designed to manage the complete lifecycle of goroutines, providing a structured approach to starting, stopping, and monitoring services within your Go applications.
 
 ## Features
@@ -25,6 +24,7 @@
 - **Lifecycle Management**: Control the startup and shutdown sequences of all registered services.
 - **Service Control**: Individually start, stop, and restart services as needed.
 - **Hooks Integration**: Define pre-run and post-run hooks for services to execute custom logic before starting or after stopping a service.
+- **Auto-Restart with Backoff**: Automatically restart services with optional exponential backoff.
 
 ## Installation
 
@@ -107,27 +107,20 @@ if err != nil {
 ctx := context.Background()
 
 // BootUp boots up the runner. This will start all the registered services.
-runner.BootUp(ctx)
-```
-
-### 6. Wait for the runner to stop
-
-```go
-// Wait waits for the runner to stop.
-// Note: This is a blocking call. It is to be called after BootUp.
+//Note: This is a blocking call. It is to be called after BootUp.
 // Only a ShutDown() call will stop the runner.
-// Even after all the registered services are stopped, runner would still be running.
-runner.Wait()
+// Even after all the registered services are stopped, runner would 
+runner.BootUp(ctx)
 ```
 
-### 7. Shutdown the runner
+### 6. Shutdown the runner
 
 ```go
 // Shutdown shuts down the runner. This will stop all the registered services.
 runner.Shutdown()
 ```
 
-### 8. Stop service(s)
+### 7. Stop service(s)
 
 ```go
 // StopService stops the given list of services.
@@ -147,6 +140,23 @@ runner.RestartService("MyService1", "MyService2")
 runner.RestartAllServices()
 ```
 
+## Auto-Restart with Backoff
+To enable auto-restart with backoff for a service, use the following options during service registration:
+Note: The service will be restarted automatically only when `service.WithAutoRestart()` options is given while service registration and when the service exits automatically not by runner shutting it down.
+
+```go
+err := runner.RegisterService(
+    &MyService{},
+    service.WithAutoRestart(),
+    service.WithBackoff(),
+    service.WithMaxRetries(5), // Optional: Set maximum retries
+    service.WithBackoffExponent(2), // Optional: Set backoff exponent
+)
+if err != nil {
+    // Handle error
+}
+```
+
 ## Service Hooks
 
 The `hook` package allows you to define hooks that execute before or after a service starts.
@@ -188,9 +198,7 @@ Contributions are welcome! Please submit issues and pull requests for any improv
 This project is licensed under the MIT License.
 
 ## TODO
-- Support for timeout for go-routine shutdowns (if possible)
-- Better error handling for the pre and post hooks for service
-- Service dependency
-- Auto restart config for services
-- Exponential back-off restart for restart of service
-
+- Support for Job with scheduling.
+- Support for timeout for go-routine shutdowns (if possible).
+- Better error handling for the pre and post hooks for service.
+- Service dependency.

example/advanced/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"log"
 	"os"
 	"syscall"
@@ -76,15 +75,17 @@ func main() {
 
 		process, err := os.FindProcess(os.Getpid())
 		if err != nil {
-			fmt.Printf("Error finding process: %s\n", err)
+			log.Printf("Error finding process: %s\n", err)
 			return
 		}
 
 		if err := process.Signal(syscall.SIGTERM); err != nil {
-			fmt.Printf("Error sending termination signal: %s\n", err)
+			log.Printf("Error sending termination signal: %s\n", err)
 		}
 
 	}()
 
-	base.BootUp(context.TODO())
+	if err := base.BootUp(context.TODO()); err != nil {
+		log.Fatalf("Error while booting up the runner: %v", err)
+	}
 }

example/auto-restart/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"log"
 	"os"
 	"syscall"
@@ -51,16 +50,17 @@ func main() {
 
 		process, err := os.FindProcess(os.Getpid())
 		if err != nil {
-			fmt.Printf("Error finding process: %s\n", err)
+			log.Printf("Error finding process: %s\n", err)
 			return
 		}
 
 		if err := process.Signal(syscall.SIGTERM); err != nil {
-			fmt.Printf("Error sending termination signal: %s\n", err)
+			log.Printf("Error sending termination signal: %s\n", err)
 		}
 
 	}()
 
-	base.BootUp(context.TODO())
-	// base.Wait()
+	if err := base.BootUp(context.TODO()); err != nil {
+		log.Fatalf("Error while booting up the runner: %v", err)
+	}
 }

example/backoff/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"log"
 	"os"
 	"syscall"
@@ -30,16 +29,17 @@ func main() {
 
 		process, err := os.FindProcess(os.Getpid())
 		if err != nil {
-			fmt.Printf("Error finding process: %s\n", err)
+			log.Printf("Error finding process: %s\n", err)
 			return
 		}
 
 		if err := process.Signal(syscall.SIGTERM); err != nil {
-			fmt.Printf("Error sending termination signal: %s\n", err)
+			log.Printf("Error sending termination signal: %s\n", err)
 		}
 
 	}()
 
-	base.BootUp(context.TODO())
-	// base.Wait()
+	if err := base.BootUp(context.TODO()); err != nil {
+		log.Fatalf("Error while booting up the runner: %v", err)
+	}
 }

example/bootup/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"log"
 	"os"
 	"syscall"
@@ -50,15 +49,17 @@ func main() {
 
 		process, err := os.FindProcess(os.Getpid())
 		if err != nil {
-			fmt.Printf("Error finding process: %s\n", err)
+			log.Printf("Error finding process: %s\n", err)
 			return
 		}
 
 		if err := process.Signal(syscall.SIGTERM); err != nil {
-			fmt.Printf("Error sending termination signal: %s\n", err)
+			log.Printf("Error sending termination signal: %s\n", err)
 		}
 
 	}()
 
-	base.BootUp(context.TODO())
+	if err := base.BootUp(context.TODO()); err != nil {
+		log.Fatalf("Error while booting up the runner: %v", err)
+	}
 }

example/restart/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"log"
 	"os"
 	"syscall"
@@ -66,15 +65,17 @@ func main() {
 
 		process, err := os.FindProcess(os.Getpid())
 		if err != nil {
-			fmt.Printf("Error finding process: %s\n", err)
+			log.Printf("Error finding process: %s\n", err)
 			return
 		}
 
 		if err := process.Signal(syscall.SIGTERM); err != nil {
-			fmt.Printf("Error sending termination signal: %s\n", err)
+			log.Printf("Error sending termination signal: %s\n", err)
 		}
 
 	}()
 
-	base.BootUp(context.TODO())
+	if err := base.BootUp(context.TODO()); err != nil {
+		log.Fatalf("Error while booting up the runner: %v", err)
+	}
 }

example/stop/main.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"context"
-	"fmt"
 	"log"
 	"os"
 	"syscall"
@@ -66,15 +65,17 @@ func main() {
 
 		process, err := os.FindProcess(os.Getpid())
 		if err != nil {
-			fmt.Printf("Error finding process: %s\n", err)
+			log.Printf("Error finding process: %s\n", err)
 			return
 		}
 
 		if err := process.Signal(syscall.SIGTERM); err != nil {
-			fmt.Printf("Error sending termination signal: %s\n", err)
+			log.Printf("Error sending termination signal: %s\n", err)
 		}
 
 	}()
 
-	base.BootUp(context.TODO())
+	if err := base.BootUp(context.TODO()); err != nil {
+		log.Fatalf("Error while booting up the runner: %v", err)
+	}
 }

runner/base.go

@@ -11,10 +11,9 @@ import (
 // Base is the blueprint for the runner.
 type Base interface {
 	// BootUp boots up the runner. This will start all the registered services.
-	// Note: This is a blocking call. It is to be called after BootUp.
-	// Only a ShutDown() call will stop the runner.
+	// Note: This is a blocking call. Only a ShutDown() or Term signal to process will stop the runner.
 	// Even after all the registered services are stopped, runner would still be running.
-	BootUp(context.Context)
+	BootUp(context.Context) error
 
 	// Shutdown shuts down the runner. This will stop all the registered services.
 	Shutdown()

runner/error.go

@@ -3,6 +3,7 @@ package runner
 import "errors"
 
 var (
-	ErrServiceAlreadyExists = errors.New("service already exists")
-	ErrRunnerAlreadyRunning = errors.New("runner already running")
+	ErrRegisterServiceAlreadyExists = errors.New("service already exists")
+	ErrRunnerAlreadyRunning         = errors.New("runner already running")
+	ErrRegisterNilService           = errors.New("can not register nil service")
 )