go/pkg/cli/runtime.go

// Package cli provides the CLI runtime and utilities.
//
// The CLI uses the Core framework for its own runtime. Usage is simple:
//
//	cli.Init(cli.Options{AppName: "core"})
//	defer cli.Shutdown()
//
//	cli.Success("Done!")
//	cli.Error("Failed")
//	if cli.Confirm("Proceed?") { ... }
//
//	// When you need the Core instance
//	c := cli.Core()
package cli

import (
	"context"
	"os"
	"os/signal"
	"sync"
	"syscall"

	"github.com/host-uk/core/pkg/framework"
	"github.com/spf13/cobra"
)

var (
	instance *runtime
	once     sync.Once
)

// runtime is the CLI's internal Core runtime.
type runtime struct {
	core   *framework.Core
	root   *cobra.Command
	ctx    context.Context
	cancel context.CancelFunc
}

// Options configures the CLI runtime.
type Options struct {
	AppName  string
	Version  string
	Services []framework.Option // Additional services to register

	// OnReload is called when SIGHUP is received (daemon mode).
	// Use for configuration reloading. Leave nil to ignore SIGHUP.
	OnReload func() error
}

// Init initialises the global CLI runtime.
// Call this once at startup (typically in main.go or cmd.Execute).
func Init(opts Options) error {
	var initErr error
	once.Do(func() {
		ctx, cancel := context.WithCancel(context.Background())

		// Create root command
		rootCmd := &cobra.Command{
			Use:           opts.AppName,
			Version:       opts.Version,
			SilenceErrors: true,
			SilenceUsage:  true,
		}

		// Attach all registered commands
		attachRegisteredCommands(rootCmd)

		// Build signal service options
		var signalOpts []SignalOption
		if opts.OnReload != nil {
			signalOpts = append(signalOpts, WithReloadHandler(opts.OnReload))
		}

		// Build options: app, signal service + any additional services
		coreOpts := []framework.Option{
			framework.WithApp(rootCmd),
			framework.WithName("signal", newSignalService(cancel, signalOpts...)),
		}
		coreOpts = append(coreOpts, opts.Services...)
		coreOpts = append(coreOpts, framework.WithServiceLock())

		c, err := framework.New(coreOpts...)
		if err != nil {
			initErr = err
			cancel()
			return
		}

		instance = &runtime{
			core:   c,
			root:   rootCmd,
			ctx:    ctx,
			cancel: cancel,
		}

		if err := c.ServiceStartup(ctx, nil); err != nil {
			initErr = err
			return
		}
	})
	return initErr
}

func mustInit() {
	if instance == nil {
		panic("cli not initialised - call cli.Init() first")
	}
}

// --- Core Access ---

// Core returns the CLI's framework Core instance.
func Core() *framework.Core {
	mustInit()
	return instance.core
}

// RootCmd returns the CLI's root cobra command.
func RootCmd() *cobra.Command {
	mustInit()
	return instance.root
}

// Execute runs the CLI root command.
// Returns an error if the command fails.
func Execute() error {
	mustInit()
	return instance.root.Execute()
}

// Context returns the CLI's root context.
// Cancelled on SIGINT/SIGTERM.
func Context() context.Context {
	mustInit()
	return instance.ctx
}

// Shutdown gracefully shuts down the CLI.
func Shutdown() {
	if instance == nil {
		return
	}
	instance.cancel()
	_ = instance.core.ServiceShutdown(instance.ctx)
}

// --- Signal Service (internal) ---

type signalService struct {
	cancel       context.CancelFunc
	sigChan      chan os.Signal
	onReload     func() error
	shutdownOnce sync.Once
}

// SignalOption configures signal handling.
type SignalOption func(*signalService)

// WithReloadHandler sets a callback for SIGHUP.
func WithReloadHandler(fn func() error) SignalOption {
	return func(s *signalService) {
		s.onReload = fn
	}
}

func newSignalService(cancel context.CancelFunc, opts ...SignalOption) func(*framework.Core) (any, error) {
	return func(c *framework.Core) (any, error) {
		svc := &signalService{
			cancel:  cancel,
			sigChan: make(chan os.Signal, 1),
		}
		for _, opt := range opts {
			opt(svc)
		}
		return svc, nil
	}
}

func (s *signalService) OnStartup(ctx context.Context) error {
	signals := []os.Signal{syscall.SIGINT, syscall.SIGTERM}
	if s.onReload != nil {
		signals = append(signals, syscall.SIGHUP)
	}
	signal.Notify(s.sigChan, signals...)

	go func() {
		for {
			select {
			case sig := <-s.sigChan:
				switch sig {
				case syscall.SIGHUP:
					if s.onReload != nil {
						if err := s.onReload(); err != nil {
							LogError("reload failed", "err", err)
						} else {
							LogInfo("configuration reloaded")
						}
					}
				case syscall.SIGINT, syscall.SIGTERM:
					s.cancel()
					return
				}
			case <-ctx.Done():
				return
			}
		}
	}()

	return nil
}

func (s *signalService) OnShutdown(ctx context.Context) error {
	s.shutdownOnce.Do(func() {
		signal.Stop(s.sigChan)
		close(s.sigChan)
	})
	return nil
}