feat: [#783] Add app.Run(...runner) function to optimize the app running process (#1221)

* feat: [#783] Add bootstrap.Run(...facade) function to optimize the app running process

* optimize

* optimize

* address comments

* address comments

* add Shutdown

* address comments

* address comments

* chore: update mocks

* address comments

* remove

* address comments

---------

Co-authored-by: hwbrzzl <24771476+hwbrzzl@users.noreply.github.com>
Co-authored-by: Bowen <hwbrzzl@github.com>

Author: hwbrzzl

.gitignore

@@ -1,4 +1,3 @@
-.env
 .idea
 .DS_Store
 .vscode

contracts/foundation/application.go

@@ -30,6 +30,12 @@ import (
 	"github.com/goravel/framework/contracts/validation"
 )
 
+type Runner interface {
+	ShouldRun() bool
+	Run() error
+	Shutdown() error
+}
+
 type AboutItem struct {
 	Key   string
 	Value string
@@ -42,6 +48,8 @@ type Application interface {
 	Boot()
 	// Commands register the given commands with the console application.
 	Commands([]console.Command)
+	// Context gets the application context.
+	Context() context.Context
 	// GetJson get the JSON implementation.
 	GetJson() Json
 	// IsLocale get the current application locale.
@@ -50,10 +58,14 @@ type Application interface {
 	Publishes(packageName string, paths map[string]string, groups ...string)
 	// Refresh all modules after changing config, will call the Boot method simultaneously.
 	Refresh()
+	// Run runs modules.
+	Run(runners ...Runner)
 	// SetJson set the JSON implementation.
 	SetJson(json Json)
 	// SetLocale set the current application locale.
 	SetLocale(ctx context.Context, locale string) context.Context
+	// Shutdown the application and all its runners.
+	Shutdown()
 	// Version gets the version number of the application.
 	Version() string
 

contracts/foundation/service_provider.go

@@ -10,10 +10,15 @@ type ServiceProvider interface {
 }
 
 type ServiceProviderWithRelations interface {
+	ServiceProvider
+
 	// Relationship returns the service provider's relationship.
 	Relationship() binding.Relationship
-	// Register any application services.
-	Register(app Application)
-	// Boot any application services after register.
-	Boot(app Application)
+}
+
+type ServiceProviderWithRunners interface {
+	ServiceProvider
+
+	// Runners returns the service provider's runners.
+	Runners(app Application) []Runner
 }

foundation/.env

@@ -0,0 +1,2 @@
+# For testing purposes only.
+APP_KEY=12345678901234567890123456789012

foundation/application.go

@@ -6,10 +6,12 @@ import (
 	"fmt"
 	"maps"
 	"os"
+	"os/signal"
 	"path/filepath"
 	"slices"
 	"sort"
 	"strings"
+	"syscall"
 
 	"github.com/goravel/framework/config"
 	frameworkconsole "github.com/goravel/framework/console"
@@ -26,18 +28,19 @@ import (
 	"github.com/goravel/framework/support/path/internals"
 )
 
-var (
-	App foundation.Application
-)
-
+var App foundation.Application
 var _ = flag.String("env", support.EnvFilePath, "custom .env path")
 
 func init() {
 	setEnv()
 	setRootPath()
 
+	ctx, cancel := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
+
 	app := &Application{
 		Container:     NewContainer(),
+		ctx:           ctx,
+		cancel:        cancel,
 		publishes:     make(map[string]map[string]string),
 		publishGroups: make(map[string]map[string]string),
 	}
@@ -50,6 +53,8 @@ func init() {
 
 type Application struct {
 	*Container
+	ctx                        context.Context
+	cancel                     context.CancelFunc
 	configuredServiceProviders []foundation.ServiceProvider
 	publishes                  map[string]map[string]string
 	publishGroups              map[string]map[string]string
@@ -61,6 +66,10 @@ func NewApplication() foundation.Application {
 	return App
 }
 
+func (r *Application) About(section string, items []foundation.AboutItem) {
+	console.AddAboutInformation(section, items...)
+}
+
 func (r *Application) Boot() {
 	r.configuredServiceProviders = r.configuredServiceProviders[:0]
 	clear(r.publishes)
@@ -87,77 +96,119 @@ func (r *Application) Commands(commands []contractsconsole.Command) {
 	r.registerCommands(commands)
 }
 
-func (r *Application) Path(path ...string) string {
-	return internals.Path(path...)
+func (r *Application) Context() context.Context {
+	return r.ctx
 }
 
-func (r *Application) BasePath(path ...string) string {
-	return r.absPath(path...)
-}
-
-func (r *Application) ConfigPath(path ...string) string {
-	path = append([]string{support.RelativePath, "config"}, path...)
-	return r.absPath(path...)
-}
-
-func (r *Application) DatabasePath(path ...string) string {
-	path = append([]string{support.RelativePath, "database"}, path...)
-	return r.absPath(path...)
-}
-
-func (r *Application) ExecutablePath(path ...string) string {
-	path = append([]string{support.RootPath}, path...)
-	return r.absPath(path...)
+func (r *Application) GetJson() foundation.Json {
+	return r.json
 }
 
-func (r *Application) FacadesPath(path ...string) string {
-	return internals.FacadesPath(path...)
+func (r *Application) IsLocale(ctx context.Context, locale string) bool {
+	return r.CurrentLocale(ctx) == locale
 }
 
-func (r *Application) StoragePath(path ...string) string {
-	path = append([]string{support.RelativePath, "storage"}, path...)
-	return r.absPath(path...)
+func (r *Application) Publishes(packageName string, paths map[string]string, groups ...string) {
+	if _, exist := r.publishes[packageName]; !exist {
+		r.publishes[packageName] = make(map[string]string)
+	}
+	maps.Copy(r.publishes[packageName], paths)
+	for _, group := range groups {
+		r.addPublishGroup(group, paths)
+	}
 }
 
 func (r *Application) Refresh() {
 	r.Fresh()
 	r.Boot()
 }
 
-func (r *Application) ResourcePath(path ...string) string {
-	path = append([]string{support.RelativePath, "resources"}, path...)
-	return r.absPath(path...)
-}
+func (r *Application) Run(runners ...foundation.Runner) {
+	type RunnerWithInfo struct {
+		name    string
+		runner  foundation.Runner
+		running bool
+	}
 
-func (r *Application) LangPath(path ...string) string {
-	defaultPath := "lang"
-	if configFacade := r.MakeConfig(); configFacade != nil {
-		defaultPath = configFacade.GetString("app.lang_path", defaultPath)
+	var allRunners []*RunnerWithInfo
+
+	for _, serviceProvider := range r.getConfiguredServiceProviders() {
+		if serviceProviderWithRunners, ok := serviceProvider.(foundation.ServiceProviderWithRunners); ok {
+			for _, runner := range serviceProviderWithRunners.Runners(r) {
+				allRunners = append(allRunners, &RunnerWithInfo{name: fmt.Sprintf("%T", runner), runner: runner, running: false})
+			}
+		}
 	}
 
-	path = append([]string{support.RelativePath, defaultPath}, path...)
-	return r.absPath(path...)
-}
+	for _, runner := range runners {
+		allRunners = append(allRunners, &RunnerWithInfo{name: fmt.Sprintf("%T", runner), runner: runner, running: false})
+	}
 
-func (r *Application) PublicPath(path ...string) string {
-	path = append([]string{support.RelativePath, "public"}, path...)
-	return r.absPath(path...)
+	run := func(runner *RunnerWithInfo) {
+		go func() {
+			if err := runner.runner.Run(); err != nil {
+				color.Errorf("%s Run error: %v", runner.name, err)
+			} else {
+				runner.running = true
+			}
+		}()
+
+		go func() {
+			<-r.ctx.Done()
+
+			if !runner.running {
+				return
+			}
+
+			if err := runner.runner.Shutdown(); err != nil {
+				color.Errorf("%s Shutdown error: %v", runner.name, err)
+			}
+		}()
+	}
+
+	for _, runner := range allRunners {
+		run(runner)
+	}
 }
 
-func (r *Application) Publishes(packageName string, paths map[string]string, groups ...string) {
-	if _, exist := r.publishes[packageName]; !exist {
-		r.publishes[packageName] = make(map[string]string)
+func (r *Application) SetJson(j foundation.Json) {
+	if j != nil {
+		r.json = j
 	}
-	maps.Copy(r.publishes[packageName], paths)
-	for _, group := range groups {
-		r.addPublishGroup(group, paths)
+}
+
+func (r *Application) SetLocale(ctx context.Context, locale string) context.Context {
+	lang := r.MakeLang(ctx)
+	if lang == nil {
+		color.Errorln("Lang facade not initialized.")
+		return ctx
 	}
+
+	return lang.SetLocale(locale)
+}
+
+func (r *Application) Shutdown() {
+	r.cancel()
 }
 
 func (r *Application) Version() string {
 	return support.Version
 }
 
+func (r *Application) BasePath(path ...string) string {
+	return r.absPath(path...)
+}
+
+func (r *Application) ConfigPath(path ...string) string {
+	path = append([]string{support.RelativePath, "config"}, path...)
+	return r.absPath(path...)
+}
+
+func (r *Application) DatabasePath(path ...string) string {
+	path = append([]string{support.RelativePath, "database"}, path...)
+	return r.absPath(path...)
+}
+
 func (r *Application) CurrentLocale(ctx context.Context) string {
 	lang := r.MakeLang(ctx)
 	if lang == nil {
@@ -168,32 +219,42 @@ func (r *Application) CurrentLocale(ctx context.Context) string {
 	return lang.CurrentLocale()
 }
 
-func (r *Application) SetLocale(ctx context.Context, locale string) context.Context {
-	lang := r.MakeLang(ctx)
-	if lang == nil {
-		color.Errorln("Lang facade not initialized.")
-		return ctx
-	}
+func (r *Application) ExecutablePath(path ...string) string {
+	path = append([]string{support.RootPath}, path...)
+	return r.absPath(path...)
+}
 
-	return lang.SetLocale(locale)
+func (r *Application) FacadesPath(path ...string) string {
+	return internals.FacadesPath(path...)
 }
 
-func (r *Application) SetJson(j foundation.Json) {
-	if j != nil {
-		r.json = j
+func (r *Application) LangPath(path ...string) string {
+	defaultPath := "lang"
+	if configFacade := r.MakeConfig(); configFacade != nil {
+		defaultPath = configFacade.GetString("app.lang_path", defaultPath)
 	}
+
+	path = append([]string{support.RelativePath, defaultPath}, path...)
+	return r.absPath(path...)
 }
 
-func (r *Application) GetJson() foundation.Json {
-	return r.json
+func (r *Application) Path(path ...string) string {
+	return internals.Path(path...)
 }
 
-func (r *Application) About(section string, items []foundation.AboutItem) {
-	console.AddAboutInformation(section, items...)
+func (r *Application) PublicPath(path ...string) string {
+	path = append([]string{support.RelativePath, "public"}, path...)
+	return r.absPath(path...)
 }
 
-func (r *Application) IsLocale(ctx context.Context, locale string) bool {
-	return r.CurrentLocale(ctx) == locale
+func (r *Application) ResourcePath(path ...string) string {
+	path = append([]string{support.RelativePath, "resources"}, path...)
+	return r.absPath(path...)
+}
+
+func (r *Application) StoragePath(path ...string) string {
+	path = append([]string{support.RelativePath, "storage"}, path...)
+	return r.absPath(path...)
 }
 
 func (r *Application) absPath(paths ...string) string {