path: root/static_pool.go

package roadrunner

import (
	"context"
	"fmt"
	"os/exec"
	"sync"

	"github.com/pkg/errors"
)

const (
	// StopRequest can be sent by worker to indicate that restart is required.
	StopRequest = "{\"stop\":true}"
)

var bCtx = context.Background()

// StaticPool controls worker creation, destruction and task routing. Pool uses fixed amount of stack.
type StaticPool struct {
	// pool behaviour
	cfg *Config

	// worker command creator
	cmd func() *exec.Cmd

	// creates and connects to stack
	factory Factory

	// protects state of worker list, does not affect allocation
	muw sync.RWMutex

	ww *WorkersWatcher

	events chan PoolEvent
}
type PoolEvent struct {
	Payload interface{}
}

// NewPool creates new worker pool and task multiplexer. StaticPool will initiate with one worker.
// TODO why cfg is passed by pointer?
func NewPool(ctx context.Context, cmd func() *exec.Cmd, factory Factory, cfg *Config) (Pool, error) {
	cfg.InitDefaults()

	p := &StaticPool{
		cfg:     cfg,
		cmd:     cmd,
		factory: factory,
		events:  make(chan PoolEvent),
	}

	p.ww = NewWorkerWatcher(func(args ...interface{}) (WorkerBase, error) {
		w, err := p.factory.SpawnWorkerWithContext(ctx, p.cmd())
		if err != nil {
			return nil, err
		}

		sw, err := NewSyncWorker(w)
		if err != nil {
			return nil, err
		}
		return sw, nil
	}, p.cfg.NumWorkers, p.events)

	workers, err := p.allocateWorkers(ctx, p.cfg.NumWorkers)
	if err != nil {
		return nil, err
	}

	// put stack in the pool
	err = p.ww.AddToWatch(ctx, workers)
	if err != nil {
		return nil, err
	}

	return p, nil
}

// Config returns associated pool configuration. Immutable.
func (p *StaticPool) Config() Config {
	return *p.cfg
}

// Workers returns worker list associated with the pool.
func (p *StaticPool) Workers() (workers []WorkerBase) {
	return p.ww.WorkersList()
}

func (p *StaticPool) RemoveWorker(ctx context.Context, wb WorkerBase) error {
	return p.ww.RemoveWorker(ctx, wb)
}

func (p *StaticPool) Exec(rqs Payload) (Payload, error) {
	w, err := p.ww.GetFreeWorker(context.Background())
	if err != nil && errors.Is(err, ErrWatcherStopped) {
		return EmptyPayload, ErrWatcherStopped
	} else if err != nil {
		return EmptyPayload, err
	}

	sw := w.(SyncWorker)

	rsp, err := sw.Exec(rqs)
	if err != nil {
		errJ := p.checkMaxJobs(bCtx, w)
		if errJ != nil {
			return EmptyPayload, fmt.Errorf("%v, %v", err, errJ)
		}
		// soft job errors are allowed
		if _, jobError := err.(TaskError); jobError {
			p.ww.PushWorker(w)
			return EmptyPayload, err
		}

		sw.State().Set(StateInvalid)
		errS := w.Stop(bCtx)
		if errS != nil {
			return EmptyPayload, fmt.Errorf("%v, %v", err, errS)
		}

		return EmptyPayload, err
	}

	// worker want's to be terminated
	if rsp.Body == nil && rsp.Context != nil && string(rsp.Context) == StopRequest {
		w.State().Set(StateInvalid)
		err = w.Stop(bCtx)
		if err != nil {
			return EmptyPayload, err
		}
		return p.ExecWithContext(bCtx, rqs)
	}

	if p.cfg.MaxJobs != 0 && w.State().NumExecs() >= p.cfg.MaxJobs {
		err = p.ww.AllocateNew(bCtx)
		if err != nil {
			return EmptyPayload, err
		}
	} else {
		p.muw.Lock()
		p.ww.PushWorker(w)
		p.muw.Unlock()
	}
	return rsp, nil
}

// Exec one task with given payload and context, returns result or error.
func (p *StaticPool) ExecWithContext(ctx context.Context, rqs Payload) (Payload, error) {
	// todo: why TODO passed here?
	getWorkerCtx, cancel := context.WithTimeout(context.TODO(), p.cfg.AllocateTimeout)
	defer cancel()
	w, err := p.ww.GetFreeWorker(getWorkerCtx)
	if err != nil && errors.Is(err, ErrWatcherStopped) {
		return EmptyPayload, ErrWatcherStopped
	} else if err != nil {
		return EmptyPayload, err
	}

	sw := w.(SyncWorker)

	var execCtx context.Context
	if p.cfg.ExecTTL != 0 {
		var cancel2 context.CancelFunc
		execCtx, cancel2 = context.WithTimeout(context.TODO(), p.cfg.ExecTTL)
		defer cancel2()
	} else {
		execCtx = ctx
	}

	rsp, err := sw.ExecWithContext(execCtx, rqs)
	if err != nil {
		errJ := p.checkMaxJobs(ctx, w)
		if errJ != nil {
			return EmptyPayload, fmt.Errorf("%v, %v", err, errJ)
		}
		// soft job errors are allowed
		if _, jobError := err.(TaskError); jobError {
			p.ww.PushWorker(w)
			return EmptyPayload, err
		}

		sw.State().Set(StateInvalid)
		errS := w.Stop(ctx)
		if errS != nil {
			return EmptyPayload, fmt.Errorf("%v, %v", err, errS)
		}

		return EmptyPayload, err
	}

	// worker want's to be terminated
	if rsp.Body == nil && rsp.Context != nil && string(rsp.Context) == StopRequest {
		w.State().Set(StateInvalid)
		err = w.Stop(ctx)
		if err != nil {
			return EmptyPayload, err
		}
		return p.ExecWithContext(ctx, rqs)
	}

	if p.cfg.MaxJobs != 0 && w.State().NumExecs() >= p.cfg.MaxJobs {
		err = p.ww.AllocateNew(ctx)
		if err != nil {
			return EmptyPayload, err
		}
	} else {
		p.muw.Lock()
		p.ww.PushWorker(w)
		p.muw.Unlock()
	}
	return rsp, nil
}

// Destroy all underlying stack (but let them to complete the task).
func (p *StaticPool) Destroy(ctx context.Context) {
	p.ww.Destroy(ctx)
}

func (p *StaticPool) Events() chan PoolEvent {
	return p.events
}

// allocate required number of stack
func (p *StaticPool) allocateWorkers(ctx context.Context, numWorkers int64) ([]WorkerBase, error) {
	var workers []WorkerBase

	// constant number of stack simplify logic
	for i := int64(0); i < numWorkers; i++ {
		ctx, cancel := context.WithTimeout(ctx, p.cfg.AllocateTimeout)
		w, err := p.factory.SpawnWorkerWithContext(ctx, p.cmd())
		if err != nil {
			cancel()
			return nil, err
		}
		cancel()
		workers = append(workers, w)
	}
	return workers, nil
}

func (p *StaticPool) checkMaxJobs(ctx context.Context, w WorkerBase) error {
	if p.cfg.MaxJobs != 0 && w.State().NumExecs() >= p.cfg.MaxJobs {
		err := p.ww.AllocateNew(ctx)
		if err != nil {
			return err
		}
	}
	return nil
}