goNextService

README

Service base

This repository contains base components for our backend services.

Usage

// Any http.Handler compatible struct
mux := http.NewServerMux()
// Create http component
http := application.NewHttpComponent(router)
// Compose new application
app := application.NewApplications(http)
// Run blocks until application exits
err :=  app.Run()
if err ! nil{
    return err
}

Structure

Each compoonent is composed of 3 functions, that will be invoked by the Application

• Startup
• Run
• Close

Lifecycle

---
title: Lifecycle
---
stateDiagram-v2
    state "Application starting" as AS
    state "Application running" as AR
    state is_c_running_state <<choice>>
    state is_a_running_state <<choice>>
    
    [*] --> AS: Application.Run()
    AS --> Component
    state Component {
        [*] --> Starting: Component.Startup()
        Starting --> Running: Component.Run()
        Running --> is_c_running_state
        is_c_running_state --> Running
        is_c_running_state --> Closing: Error
        Closing --> Done: Component.Close()
    }
    AS --> AR: All components has started
    AR --> is_a_running_state
    is_a_running_state --> AR
    is_a_running_state --> Closing: Signal to shutdown
    Done --> [*]

TODO

• Test
• Replace zap with configurable logger
• Move hardcoded strings into config
• Document metricz and healthz components
• Document how to create new components
• Better documentation

Documentation

Index

• type Application
  • func NewApplications(components ...Component) *Application
  • func (app *Application) AddComponent(c Component)
  • func (app *Application) Run() error
  • func (app Application) WithLogger(logger Logger) Application
  • func (app Application) WithTimeout(timeout time.Duration) Application
• type Component
• type Logger

Types

type Application

type Application struct {
	// contains filtered or unexported fields
}

func NewApplications

func NewApplications(components ...Component) *Application

func (*Application) AddComponent

func (app *Application) AddComponent(c Component)

func (*Application) Run

func (app *Application) Run() error

func (Application) WithLogger

func (app Application) WithLogger(logger Logger) Application

func (Application) WithTimeout

func (app Application) WithTimeout(timeout time.Duration) Application

type Component

type Component interface {
	// Synchronous startup, container runs this one by one
	Startup() error
	// Asynchronous run,  container runs this in parrallel
	// Has to block until it's done
	// When one of componenst exits this func, container will start shutting down
	Run() error
	// Cleanup function
	Close(ctx context.Context) error
}

type Logger

type Logger interface {
	Debugf(mgs string, params ...any)
	Infof(mgs string, params ...any)
}