-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(worker): Added worker pool health check probe
- Loading branch information
Showing
5 changed files
with
182 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| package healthcheck | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/ankorstore/yokai/healthcheck" | ||
| "github.com/ankorstore/yokai/worker" | ||
| ) | ||
|
|
||
| // DefaultProbeName is the name of the worker probe. | ||
| const DefaultProbeName = "worker" | ||
|
|
||
| // WorkerProbe is a probe compatible with the [healthcheck] module. | ||
| // | ||
| // [healthcheck]: https://github.com/ankorstore/yokai/tree/main/healthcheck | ||
| type WorkerProbe struct { | ||
| name string | ||
| pool *worker.WorkerPool | ||
| } | ||
|
|
||
| // NewWorkerProbe returns a new [WorkerProbe]. | ||
| func NewWorkerProbe(pool *worker.WorkerPool) *WorkerProbe { | ||
| return &WorkerProbe{ | ||
| name: DefaultProbeName, | ||
| pool: pool, | ||
| } | ||
| } | ||
|
|
||
| // Name returns the name of the [WorkerProbe]. | ||
| func (p *WorkerProbe) Name() string { | ||
| return p.name | ||
| } | ||
|
|
||
| // SetName sets the name of the [WorkerProbe]. | ||
| func (p *WorkerProbe) SetName(name string) *WorkerProbe { | ||
| p.name = name | ||
|
|
||
| return p | ||
| } | ||
|
|
||
| // Check returns a successful [healthcheck.CheckerProbeResult] if the worker pool executions are all in running status. | ||
| func (p *WorkerProbe) Check(ctx context.Context) *healthcheck.CheckerProbeResult { | ||
| success := true | ||
| messages := []string{} | ||
|
|
||
| for name, execution := range p.pool.Executions() { | ||
| if execution.Status() == worker.Unknown || execution.Status() == worker.Error { | ||
| success = false | ||
| } | ||
|
|
||
| messages = append(messages, fmt.Sprintf("%s: %s", name, execution.Status())) | ||
| } | ||
|
|
||
| return healthcheck.NewCheckerProbeResult(success, strings.Join(messages, ", ")) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| package healthcheck_test | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/ankorstore/yokai/worker" | ||
| "github.com/ankorstore/yokai/worker/healthcheck" | ||
| "github.com/ankorstore/yokai/worker/testdata/workers" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestWorkerProbe(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| t.Run("empty pool", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| pool := worker.NewWorkerPool() | ||
|
|
||
| probe := healthcheck.NewWorkerProbe(pool) | ||
|
|
||
| res := probe.Check(context.Background()) | ||
|
|
||
| assert.True(t, res.Success) | ||
| assert.Empty(t, res.Message) | ||
| }) | ||
|
|
||
| t.Run("success pool", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| pool, err := worker.NewDefaultWorkerPoolFactory().Create( | ||
| worker.WithWorker(workers.NewClassicWorker()), | ||
| ) | ||
| assert.NoError(t, err) | ||
|
|
||
| probe := healthcheck.NewWorkerProbe(pool) | ||
|
|
||
| err = pool.Start(context.Background()) | ||
| assert.NoError(t, err) | ||
|
|
||
| time.Sleep(15 * time.Millisecond) | ||
|
|
||
| res := probe.Check(context.Background()) | ||
|
|
||
| assert.True(t, res.Success) | ||
| assert.Equal(t, "ClassicWorker: success", res.Message) | ||
| }) | ||
|
|
||
| t.Run("error pool", func(t *testing.T) { | ||
| t.Parallel() | ||
|
|
||
| pool, err := worker.NewDefaultWorkerPoolFactory().Create( | ||
| worker.WithWorker(workers.NewClassicWorker()), | ||
| worker.WithWorker(workers.NewErrorWorker()), | ||
| ) | ||
| assert.NoError(t, err) | ||
|
|
||
| probe := healthcheck.NewWorkerProbe(pool) | ||
|
|
||
| err = pool.Start(context.Background()) | ||
| assert.NoError(t, err) | ||
|
|
||
| time.Sleep(15 * time.Millisecond) | ||
|
|
||
| res := probe.Check(context.Background()) | ||
|
|
||
| assert.False(t, res.Success) | ||
| assert.Equal(t, "ClassicWorker: success, ErrorWorker: error", res.Message) | ||
| }) | ||
| } |