Merge pull request #2 from FishGoddess/develop

FishGoddess · web-flow · commit f79e4dfcd54e · 2025-04-12T15:55:55.000+08:00
v0.2.0
diff --git a/.gitattributes b/.gitattributes
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -12,11 +12,11 @@ jobs:
       - name: Setup
         uses: actions/setup-go@v4
         with:
-          go-version: "1.21"
+          go-version: "1.23"
       - run: go version
 
       - name: Checkout
         uses: actions/checkout@v4
 
       - name: Test
-        run: make test
+        run: make test
diff --git a/FUTURE.md b/FUTURE.md
@@ -1,5 +1,10 @@
 ## ✈️ 未来版本的新特性 (Features in future versions)
 
+### v0.2.x
+
+* [x] 优化代码
+* [ ] 增加生命周期检测，资源检查回调
+
 ### v0.1.x
 
 * [x] 实现基础的控制池功能
diff --git a/HISTORY.md b/HISTORY.md
@@ -1,5 +1,11 @@
 ## 📜 历史版本的特性介绍 (Features in old versions)
 
+### v0.2.0
+
+> 此版本发布于 2025-04-12
+
+* 优化代码
+
 ### v0.1.1
 
 > 此版本发布于 2024-03-07
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 FishGoddess
+Copyright (c) 2025 FishGoddess
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the "Software"),
diff --git a/Makefile b/Makefile
@@ -1,10 +1,10 @@
 .PHONY: fmt test
 
+all: fmt test
+
 fmt:
 	go fmt ./...
 
 test:
 	go mod tidy
-	go test -cover -count=1 -test.cpu=1 ./...
-
-all: fmt test
+	go test -v -cover ./...
diff --git a/README.en.md b/README.en.md
@@ -45,7 +45,7 @@ func releaseConn(conn net.Conn) error {
 
 func main() {
 	// Create a resource pool which type is net.Conn and limit is 64.
-	pool := rego.New[net.Conn](acquireConn, releaseConn, rego.WithLimit(64))
+	pool := rego.New(64, acquireConn, releaseConn)
 	defer pool.Close()
 
 	// Take a resource from pool.
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@ func releaseConn(conn net.Conn) error {
 
 func main() {
 	// Create a resource pool which type is net.Conn and limit is 64.
-	pool := rego.New[net.Conn](acquireConn, releaseConn, rego.WithLimit(64))
+	pool := rego.New(64, acquireConn, releaseConn)
 	defer pool.Close()
 
 	// Take a resource from pool.
diff --git a/_examples/basic.go b/_examples/basic.go
@@ -1,4 +1,4 @@
-// Copyright 2024 FishGoddess. All rights reserved.
+// 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.
 
@@ -25,7 +25,7 @@ func releaseConn(conn net.Conn) error {
 
 func main() {
 	// Create a resource pool which type is net.Conn and limit is 64.
-	pool := rego.New[net.Conn](acquireConn, releaseConn, rego.WithLimit(64))
+	pool := rego.New(64, acquireConn, releaseConn)
 	defer pool.Close()
 
 	// Take a resource from pool.
diff --git a/_examples/errors.go b/_examples/errors.go
@@ -1,4 +1,4 @@
-// Copyright 2024 FishGoddess. All rights reserved.
+// 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.
 
@@ -36,7 +36,7 @@ func newPoolClosedErr(ctx context.Context) error {
 func main() {
 	// Create a pool with limit and fast-failed so it will return an error immediately instead of waiting.
 	ctx := context.Background()
-	pool := rego.New[int](acquire, release, rego.WithLimit(1), rego.WithFastFailed())
+	pool := rego.New(1, acquire, release, rego.WithFastFailed())
 
 	// Take one resource from pool which is ok.
 	resource, err := pool.Take(ctx)
@@ -56,7 +56,7 @@ func main() {
 	fmt.Println(resource, err, err == rego.ErrPoolIsClosed)
 
 	// Create a pool with limit and fast-failed and new error funcs.
-	pool = rego.New[int](acquire, release, rego.WithLimit(1), rego.WithFastFailed(), rego.WithPoolFullErr(newPoolFullErr), rego.WithPoolClosedErr(newPoolClosedErr))
+	pool = rego.New(1, acquire, release, rego.WithFastFailed(), rego.WithPoolFullErr(newPoolFullErr), rego.WithPoolClosedErr(newPoolClosedErr))
 
 	// Take one resource from pool which is ok.
 	resource, err = pool.Take(ctx)
diff --git a/_examples/pool.go b/_examples/pool.go
@@ -1,4 +1,4 @@
-// Copyright 2024 FishGoddess. All rights reserved.
+// 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.
 
@@ -56,7 +56,7 @@ func main() {
 	// The acquire function is for acquiring a new resource, and you can do some setups for your resource.
 	// The release function is for releasing the given resource, and you can destroy everything of your resource.
 	// Also, you can specify some options to change the default settings.
-	pool := rego.New[*http.Client](acquireClient, releaseClient, rego.WithLimit(4))
+	pool := rego.New(4, acquireClient, releaseClient)
 	defer pool.Close()
 
 	var wg sync.WaitGroup
diff --git a/_icons/coverage.svg b/_icons/coverage.svg
@@ -10,7 +10,7 @@
     <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="11">
         <text x="32.5" y="15" fill="#010101" fill-opacity=".3">coverage</text>
         <text x="32.5" y="14">coverage</text>
-        <text x="80" y="15" fill="#010101" fill-opacity=".3">76%</text>
-        <text x="80" y="14">76%</text>
+        <text x="80" y="15" fill="#010101" fill-opacity=".3">77%</text>
+        <text x="80" y="14">77%</text>
     </g>
 </svg>
diff --git a/go.mod b/go.mod
@@ -1,3 +1,3 @@
 module github.com/FishGoddess/rego
 
-go 1.21
+go 1.23
diff --git a/option.go b/option.go
@@ -1,25 +1,39 @@
-// Copyright 2024 FishGoddess. All rights reserved.
+// 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"
+import (
+	"context"
+	"errors"
+)
+
+var (
+	ErrPoolIsFull   = errors.New("rego: pool is full")
+	ErrPoolIsClosed = errors.New("rego: pool is closed")
+)
 
 type config struct {
-	limit      uint64
 	fastFailed bool
 
-	newPoolFullErrFunc   func(ctx context.Context) error
-	newPoolClosedErrFunc func(ctx context.Context) error
+	newPoolFullErr   func(ctx context.Context) error
+	newPoolClosedErr func(ctx context.Context) error
 }
 
 func newDefaultConfig() *config {
+	newPoolFullErr := func(_ context.Context) error {
+		return ErrPoolIsFull
+	}
+
+	newPoolClosedErr := func(_ context.Context) error {
+		return ErrPoolIsClosed
+	}
+
 	conf := &config{
-		limit:                64,
-		fastFailed:           false,
-		newPoolFullErrFunc:   nil,
-		newPoolClosedErrFunc: nil,
+		fastFailed:       false,
+		newPoolFullErr:   newPoolFullErr,
+		newPoolClosedErr: newPoolClosedErr,
 	}
 
 	return conf
@@ -31,13 +45,6 @@ func (o Option) ApplyTo(conf *config) {
 	o(conf)
 }
 
-// WithLimit sets limit to config.
-func WithLimit(limit uint64) Option {
-	return func(conf *config) {
-		conf.limit = limit
-	}
-}
-
 // WithFastFailed sets fastFailed to config.
 func WithFastFailed() Option {
 	return func(conf *config) {
@@ -48,13 +55,17 @@ func WithFastFailed() Option {
 // WithPoolFullErr sets newPoolFullErr to config.
 func WithPoolFullErr(newPoolFullErr func(ctx context.Context) error) Option {
 	return func(conf *config) {
-		conf.newPoolFullErrFunc = newPoolFullErr
+		if newPoolFullErr != nil {
+			conf.newPoolFullErr = newPoolFullErr
+		}
 	}
 }
 
 // WithPoolClosedErr sets newPoolClosedErr to config.
 func WithPoolClosedErr(newPoolClosedErr func(ctx context.Context) error) Option {
 	return func(conf *config) {
-		conf.newPoolClosedErrFunc = newPoolClosedErr
+		if newPoolClosedErr != nil {
+			conf.newPoolClosedErr = newPoolClosedErr
+		}
 	}
 }
diff --git a/option_test.go b/option_test.go
@@ -1,4 +1,4 @@
-// Copyright 2024 FishGoddess. All rights reserved.
+// 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.
 
@@ -10,17 +10,7 @@ import (
 	"testing"
 )
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestWithLimit$
-func TestWithLimit(t *testing.T) {
-	conf := &config{limit: 0}
-	WithLimit(64)(conf)
-
-	if conf.limit != 64 {
-		t.Fatalf("conf.limit %d is wrong", conf.limit)
-	}
-}
-
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestWithFastFailed$
+// go test -v -cover -run=^TestWithFastFailed$
 func TestWithFastFailed(t *testing.T) {
 	conf := &config{fastFailed: false}
 	WithFastFailed()(conf)
@@ -30,30 +20,42 @@ func TestWithFastFailed(t *testing.T) {
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestWithPoolFullErr$
+// go test -v -cover -run=^TestWithPoolFullErr$
 func TestWithPoolFullErr(t *testing.T) {
 	newPoolFullErr := func(ctx context.Context) error {
 		return nil
 	}
 
-	conf := &config{newPoolFullErrFunc: nil}
+	conf := &config{newPoolFullErr: nil}
 	WithPoolFullErr(newPoolFullErr)(conf)
 
-	if fmt.Sprintf("%p", conf.newPoolFullErrFunc) != fmt.Sprintf("%p", newPoolFullErr) {
-		t.Fatalf("conf.newPoolFullErrFunc %p is wrong", conf.newPoolFullErrFunc)
+	if fmt.Sprintf("%p", conf.newPoolFullErr) != fmt.Sprintf("%p", newPoolFullErr) {
+		t.Fatalf("conf.newPoolFullErr %p is wrong", conf.newPoolFullErr)
+	}
+
+	WithPoolFullErr(nil)(conf)
+
+	if fmt.Sprintf("%p", conf.newPoolFullErr) != fmt.Sprintf("%p", newPoolFullErr) {
+		t.Fatalf("conf.newPoolFullErr %p is wrong", conf.newPoolFullErr)
 	}
 }
 
-// go test -v -cover -count=1 -test.cpu=1 -run=^TestWithPoolClosedErr$
+// go test -v -cover -run=^TestWithPoolClosedErr$
 func TestWithPoolClosedErr(t *testing.T) {
 	newPoolClosedErr := func(ctx context.Context) error {
 		return nil
 	}
 
-	conf := &config{newPoolClosedErrFunc: nil}
+	conf := &config{newPoolClosedErr: nil}
 	WithPoolClosedErr(newPoolClosedErr)(conf)
 
-	if fmt.Sprintf("%p", conf.newPoolClosedErrFunc) != fmt.Sprintf("%p", newPoolClosedErr) {
-		t.Fatalf("conf.newPoolClosedErrFunc %p is wrong", conf.newPoolClosedErrFunc)
+	if fmt.Sprintf("%p", conf.newPoolClosedErr) != fmt.Sprintf("%p", newPoolClosedErr) {
+		t.Fatalf("conf.newPoolClosedErr %p is wrong", conf.newPoolClosedErr)
+	}
+
+	WithPoolClosedErr(nil)(conf)
+
+	if fmt.Sprintf("%p", conf.newPoolClosedErr) != fmt.Sprintf("%p", newPoolClosedErr) {
+		t.Fatalf("conf.newPoolClosedErr %p is wrong", conf.newPoolClosedErr)
 	}
 }
diff --git a/pool.go b/pool.go
diff --git a/pool_test.go b/pool_test.go
