Merge pull request #4 from xconnio/structure-fix

Rename module, package and APIs

Author: om26er

.github/workflows/main.yaml

@@ -1,4 +1,4 @@
-name: workerpool CI
+name: timertask CI
 
 on:
   push:

Makefile

@@ -2,5 +2,5 @@ lint:
 	golangci-lint run
 
 test:
-	go test ./...
+	go test -count=1 ./... -v
 

README.md

@@ -1,2 +1,8 @@
-# workerpool
-Imagine a websocket server that sends ping message every X seconds of inactivity to each client, to be able to acheive that, the server would need to run on goroutine per client. Those goroutines are mostly idle and result in memory consumption. workpool attempts to solve that problems by running a single loop that runs every second to check which clients should be sent ping message.
+# timertask
+Imagine a websocket server that sends ping message every X seconds of inactivity to
+each client, to be able to achieve that, the server would need to run on goroutine
+per client. Those goroutines are mostly idle and result in memory consumption.
+timertask attempts to solve that problems by running a single loop that runs every
+second to check which clients should be sent ping message.
+
+This library enables that use-case and probably others.

go.mod

@@ -1,4 +1,4 @@
-module github.com/xconnio/workerpool
+module github.com/xconnio/timertask
 
 go 1.19
 

workerpool.go renamed to timertask.go

@@ -1,50 +1,50 @@
-package workerpool
+package timertask
 
 import (
 	"log"
 	"sync"
 	"time"
 )
 
-type wpConfig struct {
+type taskConfig struct {
 	interval time.Duration
 	callback func() error
 }
 
-type WorkerPool struct {
-	workers            map[int64]map[int64]wpConfig
+type Manager struct {
+	workers            map[int64]map[int64]taskConfig
 	workersByIntervals map[int64]int64
 	mutex              sync.Mutex
 }
 
-// NewWorkerPool creates a new WorkerPool instance.
-func NewWorkerPool() *WorkerPool {
-	return &WorkerPool{
-		workers:            make(map[int64]map[int64]wpConfig),
+// NewManager creates a new Manager instance.
+func NewManager() *Manager {
+	return &Manager{
+		workers:            make(map[int64]map[int64]taskConfig),
 		workersByIntervals: make(map[int64]int64),
 	}
 }
 
-// Add registers a new worker.
-func (m *WorkerPool) Add(id int64, interval time.Duration, callback func() error) {
+// Schedule registers a new worker.
+func (m *Manager) Schedule(id int64, interval time.Duration, callback func() error) {
 	// Calculate the next worker time in seconds
 	timeToWork := time.Now().Add(interval).Unix()
 
 	m.mutex.Lock()
 	defer m.mutex.Unlock()
 	if m.workers[timeToWork] == nil {
-		m.workers[timeToWork] = make(map[int64]wpConfig)
+		m.workers[timeToWork] = make(map[int64]taskConfig)
 	}
 
-	m.workers[timeToWork][id] = wpConfig{
+	m.workers[timeToWork][id] = taskConfig{
 		interval: interval,
 		callback: callback,
 	}
 	m.workersByIntervals[id] = timeToWork
 }
 
-// Remove unregisters a worker.
-func (m *WorkerPool) Remove(id int64) {
+// Cancel unregisters a worker.
+func (m *Manager) Cancel(id int64) {
 	m.mutex.Lock()
 	defer m.mutex.Unlock()
 
@@ -59,7 +59,7 @@ func (m *WorkerPool) Remove(id int64) {
 }
 
 // Reset reschedules the worker for a specific id.
-func (m *WorkerPool) Reset(id int64) {
+func (m *Manager) Reset(id int64) {
 	m.mutex.Lock()
 	defer m.mutex.Unlock()
 
@@ -73,15 +73,15 @@ func (m *WorkerPool) Reset(id int64) {
 
 		newTime := time.Now().Add(wpCfg.interval).Unix()
 		if m.workers[newTime] == nil {
-			m.workers[newTime] = make(map[int64]wpConfig)
+			m.workers[newTime] = make(map[int64]taskConfig)
 		}
 		m.workers[newTime][id] = wpCfg
 		m.workersByIntervals[id] = newTime
 	}
 }
 
 // Start begins the worker process.
-func (m *WorkerPool) Start() {
+func (m *Manager) Start() {
 	go func() {
 		for {
 			nowSeconds := time.Now().Unix()
@@ -93,14 +93,14 @@ func (m *WorkerPool) Start() {
 					err := wpCfg.callback()
 					if err != nil {
 						log.Printf("error pinging client: %v", err)
-						m.Remove(id)
+						m.Cancel(id)
 						continue
 					}
 
 					// Reschedule the next worker
 					timeToWork := time.Now().Add(wpCfg.interval).Unix()
 					if m.workers[timeToWork] == nil {
-						m.workers[timeToWork] = make(map[int64]wpConfig)
+						m.workers[timeToWork] = make(map[int64]taskConfig)
 					}
 					m.workers[timeToWork][id] = wpCfg
 					m.workersByIntervals[id] = timeToWork

workerpool_test.go renamed to timertask_test.go

@@ -1,25 +1,25 @@
-package workerpool_test
+package timertask_test
 
 import (
 	"testing"
 	"time"
 
 	"github.com/stretchr/testify/require"
 
-	"github.com/xconnio/workerpool"
+	"github.com/xconnio/timertask"
 )
 
-func TestManager(t *testing.T) {
-	manager := workerpool.NewWorkerPool()
+func TestManager_Schedule(t *testing.T) {
+	manager := timertask.NewManager()
 
 	messages1 := 0
-	manager.Add(1, 2*time.Second, func() error {
+	manager.Schedule(1, 2*time.Second, func() error {
 		messages1++
 		return nil
 	})
 
 	messages2 := 0
-	manager.Add(2, 1*time.Second, func() error {
+	manager.Schedule(2, 1*time.Second, func() error {
 		messages2++
 		return nil
 	})
@@ -32,25 +32,25 @@ func TestManager(t *testing.T) {
 	require.NotZero(t, messages1)
 	require.NotZero(t, messages2)
 
-	// Remove worker1 and check
-	manager.Remove(1)
+	// Cancel worker1 and check
+	manager.Cancel(1)
 	time.Sleep(3 * time.Second)
 
 	require.Equal(t, messages1, 1)
 
 	require.Greater(t, messages2, 2)
 }
 
-func TestManagerReset(t *testing.T) {
-	manager := workerpool.NewWorkerPool()
+func TestManager_Reset(t *testing.T) {
+	manager := timertask.NewManager()
 
 	messages := 0
-	manager.Add(1, 2*time.Second, func() error {
+	manager.Schedule(1, 2*time.Second, func() error {
 		messages++
 		return nil
 	})
 
-	go manager.Start()
+	manager.Start()
 
 	// Wait for first work
 	time.Sleep(3 * time.Second)