✨ feat: ⚡ add worker pool sample

✨ add worker pool sample

Author: yuanyu90221

.github/workflows/go.yml

@@ -0,0 +1,30 @@
+name: Go
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup go-task
+        uses: pnorton5432/setup-task@v1
+        with:
+          task-version: 3.29.1
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: 'stable'
+          check-latest: true
+      - name: Task Build
+        run: task build
+      - name: Task Build for mage
+        run: task build-gg
+      - name: Test with gg build
+        run: ./gg build

.gitignore

@@ -0,0 +1,28 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+go.work.sum
+
+# env file
+.env
+gg
+bin
+mage

README.md

@@ -0,0 +1,159 @@
+# golang-worker-pool-management-with-tunny
+
+This repository is demo how to use tunny library to implementing worker-pool management
+
+## implementation
+
+1. simple worker pool with create function
+
+```golang
+package main
+
+import (
+	"errors"
+	"fmt"
+	"runtime"
+	"time"
+
+	"github.com/Jeffail/tunny"
+)
+
+func SendEmail(email string, subject string, body string) {
+	fmt.Printf("Sending email to %s\n", email)
+	fmt.Printf("Subject %s\n Body: %s\n", subject, body)
+	// Simulate sending email
+	time.Sleep(2 * time.Second)
+}
+
+func main() {
+	numCPUs := runtime.NumCPU()
+	fmt.Printf("Number of CPUs: %d\n\n", numCPUs)
+
+	pool := tunny.NewFunc(numCPUs, func(payload any) any {
+		m, ok := payload.(map[string]any)
+		if !ok {
+			return errors.New("unable to extract map")
+		}
+
+		// Extract the fields
+		email, ok := m["email"].(string)
+		if !ok {
+			return errors.New("email field is missing or not a string")
+		}
+
+		subject, ok := m["subject"].(string)
+		if !ok {
+			return errors.New("subject field is missing or not a string")
+		}
+
+		body, ok := m["body"].(string)
+		if !ok {
+			return errors.New("body field is missing or not a string")
+		}
+
+		SendEmail(email, subject, body)
+		return nil
+	})
+	defer pool.Close()
+
+	for i := 0; i < 100; i++ {
+		var data any = map[string]any{
+			"email":   fmt.Sprintf("email%d@sample.io", i+1),
+			"subject": "Welcome",
+			"body":    "Thank you for signing up",
+		}
+		go func() {
+			result := pool.Process(data)
+			if result == nil {
+				fmt.Println("Mail sent!")
+			}
+		}()
+	}
+
+	for {
+		qLen := pool.QueueLength()
+		fmt.Printf("----------------- Queue Length: %d\n", qLen)
+		if qLen == 0 {
+			break
+		}
+		time.Sleep(1 * time.Second)
+	}
+	time.Sleep(3 * time.Second)
+}
+
+```
+
+2. manage state by create worker structure with each state hook
+
+```golang
+package main
+
+import (
+	"fmt"
+	"runtime"
+	"time"
+
+	"github.com/Jeffail/tunny"
+)
+
+type myWorker struct {
+	jobID int
+	state string
+}
+
+func (w myWorker) Process(payload any) any {
+	w.jobID, _ = payload.(int)
+	w.state = "processing"
+	fmt.Printf("Processing job %v, state: %s\n", payload, w.state)
+	time.Sleep(2 * time.Second)
+	return nil
+}
+func (w myWorker) BlockUntilReady() {
+	w.state = "starting"
+	fmt.Printf("State: %s\n", w.state)
+	time.Sleep(10 * time.Millisecond)
+}
+
+func (w myWorker) Interrupt() {
+	w.state = "interrputed"
+	fmt.Printf("State: %s\n", w.state)
+	time.Sleep(10 * time.Millisecond)
+}
+
+func (w myWorker) Terminate() {
+	w.state = "terminated"
+	fmt.Printf("State: %s\n", w.state)
+}
+
+func main() {
+	numCPUs := runtime.NumCPU()
+	pool := tunny.New(numCPUs, func() tunny.Worker {
+		return myWorker{}
+	})
+	defer pool.Close()
+
+	for i := 0; i < 10; i++ {
+		go func() {
+			var data any = i
+			result := pool.Process(data)
+			if result == nil {
+				fmt.Println("success!")
+			} else {
+				fmt.Println("failure!")
+			}
+		}()
+	}
+	for {
+		qLen := pool.QueueLength()
+		fmt.Printf("------------------- Queue Length: %d\n", qLen)
+		if qLen == 0 {
+			break
+		}
+		time.Sleep(1 * time.Second)
+	}
+
+	time.Sleep(5 * time.Second)
+	fmt.Println("Done!")
+}
+
+```

Taskfile.yml

@@ -0,0 +1,40 @@
+version: '3'
+
+tasks:
+  default:
+    cmds:
+      - echo "This is task cmd"
+    silent: true
+  
+  build:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o bin/simple cmd/simple/main.go
+    silent: true
+  run:
+    cmds:
+      - ./bin/simple
+    deps:
+      - build
+    silent: true
+
+  build-mage:
+    cmds:
+      - CGO_ENABLED=0 GOOS=linux go build -o ./mage mage-tools/mage.go
+    silent: true
+  
+  build-gg:
+    cmds:
+      - ./mage -d mage-tools -compile ../gg
+    deps:
+      - build-mage
+    silent: true
+
+  coverage:
+    cmds:
+      - go test -v -cover ./...
+    silent: true
+  test:
+    cmds:
+      - go test -v ./...
+    silent: true
+  

cmd/simple/main.go

@@ -0,0 +1,73 @@
+package main
+
+import (
+	"errors"
+	"fmt"
+	"runtime"
+	"time"
+
+	"github.com/Jeffail/tunny"
+)
+
+func SendEmail(email string, subject string, body string) {
+	fmt.Printf("Sending email to %s\n", email)
+	fmt.Printf("Subject %s\n Body: %s\n", subject, body)
+	// Simulate sending email
+	time.Sleep(2 * time.Second)
+}
+
+func main() {
+	numCPUs := runtime.NumCPU()
+	fmt.Printf("Number of CPUs: %d\n\n", numCPUs)
+
+	pool := tunny.NewFunc(numCPUs, func(payload any) any {
+		m, ok := payload.(map[string]any)
+		if !ok {
+			return errors.New("unable to extract map")
+		}
+
+		// Extract the fields
+		email, ok := m["email"].(string)
+		if !ok {
+			return errors.New("email field is missing or not a string")
+		}
+
+		subject, ok := m["subject"].(string)
+		if !ok {
+			return errors.New("subject field is missing or not a string")
+		}
+
+		body, ok := m["body"].(string)
+		if !ok {
+			return errors.New("body field is missing or not a string")
+		}
+
+		SendEmail(email, subject, body)
+		return nil
+	})
+	defer pool.Close()
+
+	for i := 0; i < 100; i++ {
+		var data any = map[string]any{
+			"email":   fmt.Sprintf("email%[email protected]", i+1),
+			"subject": "Welcome",
+			"body":    "Thank you for signing up",
+		}
+		go func() {
+			result := pool.Process(data)
+			if result == nil {
+				fmt.Println("Mail sent!")
+			}
+		}()
+	}
+
+	for {
+		qLen := pool.QueueLength()
+		fmt.Printf("----------------- Queue Length: %d\n", qLen)
+		if qLen == 0 {
+			break
+		}
+		time.Sleep(1 * time.Second)
+	}
+	time.Sleep(3 * time.Second)
+}