spokes

Spokes - application life cycle manager.

Spokes is a tools that creates a long-running service process, managing the live-cycle of them.

Spokes will take care of:

1. Initialization phase of a top level service
2. Register sub service.
3. Run initiate and run services
4. Shutdown take care of gently stop sub services and close service

Usage

with context

one of use cased is that your service can use context.Done() to terminate itself.

package main

import (
	"context"
	"time"

	"github.com/golang-tire/spokes"
	"go.uber.org/zap"
)

var _ spokes.Service = (*sampleService)(nil)

type sampleService struct{}

func (d *sampleService) Init(ctx context.Context, logger *zap.Logger) error {

	go func() {
		<-ctx.Done()
		// close ...
		logger.Info("context cancel signal received")
	}()

	return nil
}
func (d *sampleService) Shutdown() error { return nil }
func (d *sampleService) Run() error {
	time.Sleep(time.Second * 10)
	return nil
}

func main() {

	ctx := context.Background()
	s, err := spokes.New("service", "v0.1.0", spokes.WithContext(ctx))
	spokes.Panic(err)

	d := &sampleService{}
	err = s.Register("dummy-service", d)
	spokes.Panic(err)

	err = s.Run()
	spokes.Panic(err)
}

without context

package main

import (
	"context"

	"github.com/golang-tire/spokes"
	"go.uber.org/zap"
)
var _ spokes.Service = (*sampleService)(nil)

type sampleService struct{}

func (d *sampleService) Init(ctx context.Context, logger *zap.Logger) error { return nil }
func (d *sampleService) Shutdown() error               { return nil }
func (d *sampleService) Run() error                    { return nil }

func main() {
	s, err := spokes.New("service", "v0.1.0")
	spokes.Panic(err)

	d := &sampleService{}
	err = s.Register("dummy-service", d)
	spokes.Panic(err)

	err = s.Run()
	spokes.Panic(err)
}