Merge pull request #6 from FishGoddess/develop

v0.2.4

Author: FishGoddess

FUTURE.md

@@ -2,6 +2,7 @@
 
 ### v0.3.x
 
+* [ ] 使用令牌+链表的方式实现
 * [ ] 增加生命周期检测，资源检查回调
 
 ### v0.2.x

HISTORY.md

@@ -1,5 +1,12 @@
 ## 📜 历史版本的特性介绍
 
+### v0.2.4
+
+> 此版本发布于 2025-05-03
+
+* 修复 DefaultReleaseFunc 定义错误的问题
+* 调整平均等待时间的上报逻辑
+
 ### v0.2.3
 
 > 此版本发布于 2025-05-03

_icons/coverage.svg

@@ -10,22 +10,12 @@ import (
 	"time"
 )
 
-// Status is the statistics of pool.
-type Status struct {
-	// Limit is the maximum quantity of resources in pool.
-	Limit uint64 `json:"limit"`
+var _ ReleaseFunc[int] = DefaultReleaseFunc[int]
 
-	// Active is the quantity of resources in pool including idle and using.
-	Active uint64 `json:"active"`
-
-	// Idle is the quantity of idle resources in pool.
-	Idle uint64 `json:"idle"`
-
-	// Waiting is the quantity of waiting for a resource.
-	Waiting uint64 `json:"waiting"`
-
-	// AverageWaitDuration is the average wait duration for new resources.
-	AverageWaitDuration time.Duration `json:"average_wait_duration"`
+// DefaultReleaseFunc is a default func to release a resource.
+// It does nothing to the resource.
+func DefaultReleaseFunc[T any](ctx context.Context, resource T) error {
+	return nil
 }
 
 // AcquireFunc is a function acquires a new resource and returns error if failed.
@@ -34,12 +24,6 @@ type AcquireFunc[T any] func(ctx context.Context) (T, error)
 // ReleaseFunc is a function releases a resource and returns error if failed.
 type ReleaseFunc[T any] func(ctx context.Context, resource T) error
 
-// DefaultReleaseFunc is a default func to release a resource.
-// It does nothing to the resource.
-func DefaultReleaseFunc[T any](resource T) error {
-	return nil
-}
-
 // Pool stores resources for reusing.
 type Pool[T any] struct {
 	conf config
@@ -51,7 +35,7 @@ type Pool[T any] struct {
 	active  uint64
 	waiting uint64
 
-	totalTaken          uint64
+	totalWaited         uint64
 	totalWaitedDuration time.Duration
 
 	resources chan T
@@ -140,8 +124,6 @@ func (p *Pool[T]) Take(ctx context.Context) (resource T, err error) {
 		return resource, err
 	}
 
-	p.totalTaken++
-
 	var ok bool
 	if resource, ok = p.tryToTake(); ok {
 		p.lock.Unlock()
@@ -183,24 +165,25 @@ func (p *Pool[T]) Take(ctx context.Context) (resource T, err error) {
 
 		p.lock.Lock()
 		p.waiting--
+		p.totalWaited++
 		p.totalWaitedDuration += waitDuration
 		p.lock.Unlock()
 	}()
 
 	return p.waitToTake(ctx)
 }
 
-// Status returns the status of the pool.
-func (p *Pool[T]) Status() Status {
+// Status returns the statistics of the pool.
+func (p *Pool[T]) Status() PoolStatus {
 	p.lock.RLock()
 	defer p.lock.RUnlock()
 
 	var averageWaitDuration time.Duration
-	if p.totalTaken > 0 {
-		averageWaitDuration = p.totalWaitedDuration / time.Duration(p.totalTaken)
+	if p.totalWaited > 0 {
+		averageWaitDuration = p.totalWaitedDuration / time.Duration(p.totalWaited)
 	}
 
-	status := Status{
+	status := PoolStatus{
 		Limit:               p.limit,
 		Active:              p.active,
 		Idle:                uint64(len(p.resources)),
@@ -239,7 +222,7 @@ func (p *Pool[T]) Close(ctx context.Context) error {
 
 	p.active = 0
 	p.waiting = 0
-	p.totalTaken = 0
+	p.totalWaited = 0
 	p.totalWaitedDuration = 0
 	p.closed = true
 

pool.go

@@ -71,8 +71,7 @@ func TestPool(t *testing.T) {
 		}
 	}()
 
-	totalTaken1 := 1024
-	for i := 0; i < totalTaken1; i++ {
+	for i := 0; i < 1024; i++ {
 		resource, err := pool.Take(ctx)
 		if err != nil {
 			t.Fatal(err)
@@ -97,17 +96,17 @@ func TestPool(t *testing.T) {
 
 	t.Logf("%+v", pool.Status())
 
-	if pool.totalTaken != uint64(totalTaken1) {
-		t.Fatalf("pool.totalTaken %d is wrong", pool.totalTaken)
+	if pool.totalWaited != 0 {
+		t.Fatalf("pool.totalWaited %d is wrong", pool.totalWaited)
 	}
 
 	if pool.totalWaitedDuration != 0 {
 		t.Fatalf("pool.totalWaitedDuration %d is wrong", pool.totalWaitedDuration)
 	}
 
+	var totalWaited = 65536
 	var wg sync.WaitGroup
-	totalTaken2 := 65536
-	for i := 0; i < totalTaken2; i++ {
+	for i := 0; i < totalWaited; i++ {
 		wg.Add(1)
 		go func() {
 			defer wg.Done()
@@ -131,39 +130,22 @@ func TestPool(t *testing.T) {
 				t.Errorf("status.Idle %d is wrong", status.Idle)
 				return
 			}
+
+			if status.Waiting > 0 && pool.totalWaited > 0 && status.AverageWaitDuration <= 0 {
+				t.Errorf("status.AverageWaitDuration %d is wrong", status.AverageWaitDuration)
+				return
+			}
 		}()
 	}
 
 	wg.Wait()
 	t.Logf("%+v", pool.Status())
 
-	if pool.totalTaken != uint64(totalTaken1)+uint64(totalTaken2) {
-		t.Fatalf("pool.totalTaken %d is wrong", pool.totalTaken)
+	if pool.totalWaited > uint64(totalWaited) {
+		t.Fatalf("pool.totalWaited %d is wrong", pool.totalWaited)
 	}
 
-	totalTaken1 = 4096
-	for i := 0; i < totalTaken1; i++ {
-		resource, err := pool.Take(ctx)
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		time.Sleep(time.Millisecond)
-		pool.Put(ctx, resource)
-
-		status := pool.Status()
-		if status.Active != uint64(limit) {
-			t.Fatalf("status.Active %d is wrong", status.Active)
-		}
-
-		if status.Idle != uint64(limit) {
-			t.Fatalf("status.Idle %d is wrong", status.Idle)
-		}
-
-		if status.AverageWaitDuration == 0 {
-			t.Fatalf("status.AverageWaitDuration %d is wrong", status.AverageWaitDuration)
-		}
+	if pool.totalWaited > 0 && pool.totalWaitedDuration <= 0 {
+		t.Fatalf("pool.totalWaitedDuration %d is wrong", pool.totalWaitedDuration)
 	}
-
-	t.Logf("%+v", pool.Status())
 }

pool_test.go

@@ -0,0 +1,25 @@
+// Copyright 2025 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package rego
+
+import "time"
+
+// PoolStatus is the statistics of pool.
+type PoolStatus struct {
+	// Limit is the maximum quantity of resources in pool.
+	Limit uint64 `json:"limit"`
+
+	// Active is the quantity of resources in pool including idle and using.
+	Active uint64 `json:"active"`
+
+	// Idle is the quantity of idle resources in pool.
+	Idle uint64 `json:"idle"`
+
+	// Waiting is the quantity of waiting for a resource.
+	Waiting uint64 `json:"waiting"`
+
+	// AverageWaitDuration is the average wait duration for new resources.
+	AverageWaitDuration time.Duration `json:"average_wait_duration"`
+}

status.go

@@ -0,0 +1,53 @@
+// Copyright 2025 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package rego
+
+import (
+	"context"
+	"testing"
+	"time"
+)
+
+// go test -v -cover -run=^TestPoolStatus$
+func TestPoolStatus(t *testing.T) {
+	limit := 16
+
+	pool := &Pool[int]{
+		limit:               uint64(limit),
+		release:             DefaultReleaseFunc[int],
+		active:              4,
+		waiting:             8,
+		totalWaited:         0,
+		totalWaitedDuration: 0,
+		resources:           make(chan int, limit),
+	}
+
+	ctx := context.Background()
+	defer pool.Close(ctx)
+
+	for i := range limit {
+		pool.resources <- i
+	}
+
+	poolStatus := PoolStatus{
+		Limit:               pool.limit,
+		Active:              pool.active,
+		Idle:                uint64(len(pool.resources)),
+		Waiting:             pool.waiting,
+		AverageWaitDuration: 0,
+	}
+
+	if pool.Status() != poolStatus {
+		t.Fatalf("pool.Status %+v != %+v", pool.Status(), poolStatus)
+	}
+
+	pool.totalWaited = 2
+	pool.totalWaitedDuration = time.Second
+	poolStatus.AverageWaitDuration = pool.totalWaitedDuration / time.Duration(pool.totalWaited)
+
+	if pool.Status() != poolStatus {
+		t.Fatalf("pool.Status %+v != %+v", pool.Status(), poolStatus)
+	}
+}