feat: return entry when request is blocked.

.github/workflows/go.yml

@@ -7,73 +7,66 @@ on:
     branches: "*"
 
 jobs:
-
   build:
     name: ${{ matrix.os }} - Go ${{ matrix.go_version }}
     runs-on: ubuntu-latest
     strategy:
-     # If you want to matrix build , you can append the following list.
+      # If you want to matrix build , you can append the following list.
       matrix:
         go_version:
-          - 1.13
-          - 1.14
+          - 1.18
+          - 1.19
         os:
           - ubuntu-latest
 
     steps:
+      - name: Set up Go ${{ matrix.go_version }}
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go_version }}
+        id: go
 
-    - name: Set up Go ${{ matrix.go_version }}
-      uses: actions/setup-go@v2
-      with:
-        go-version: ${{ matrix.go_version }}
-      id: go
-
-    - name: Check out code into the Go module directory
-      uses: actions/checkout@v2
-
-    - name: Cache build dependence
-      uses: actions/cache@v2
-      with:
-        # Cache
-        path: ~/go/pkg/mod
-        # Cache key
-        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
-        # An ordered list of keys to use for restoring the cache if no cache hit occurred for key
-        restore-keys: ${{ runner.os }}-go-
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v2
 
-    - name: Install goimports
-      run: go get golang.org/x/tools/cmd/goimports
+      - name: Cache build dependence
+        uses: actions/cache@v2
+        with:
+          # Cache
+          path: ~/go/pkg/mod
+          # Cache key
+          key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+          # An ordered list of keys to use for restoring the cache if no cache hit occurred for key
+          restore-keys: ${{ runner.os }}-go-
 
-    - name: Install go ci lint
-      run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.27.0
+      - name: Install go ci lint
+        run: curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.50.1
 
-    - name: Run Linter
-      run: golangci-lint run --timeout=10m -v --disable-all --enable=govet --enable=staticcheck --enable=ineffassign --enable=misspell
+      - name: Run Linter
+        run: golangci-lint run --timeout=10m -v --disable-all --enable=govet --enable=staticcheck --enable=ineffassign --enable=misspell
 
-    - name: Test
-      run: |
-        diff -u <(echo -n) <(gofmt -d -s .)
-        diff -u <(echo -n) <(goimports -d .)
-        go test -v -race ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ./pkg/datasource/consul
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../etcdv3
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../k8s
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../nacos
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../apollo
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../../adapters/echo
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../gear
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../gin
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../grpc
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-        cd ../micro
-        go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
-    - name: Coverage
-      run: bash <(curl -s https://codecov.io/bash)
+      - name: Test
+        run: |
+          go test -v -race ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ./pkg/datasource/consul
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../etcdv3
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../k8s
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../nacos
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../apollo
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../../adapters/echo
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../gear
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../gin
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../grpc
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+          cd ../micro
+          go test -race -count=1 ./... -coverprofile=coverage.txt -covermode=atomic
+      - name: Coverage
+        run: bash <(curl -s https://codecov.io/bash)

api/api.go

@@ -176,7 +176,7 @@ func entry(resource string, options *EntryOptions) (*base.SentinelEntry, *base.B
 		// must finish the lifecycle of r.
 		blockErr := base.NewBlockErrorFromDeepCopy(r.BlockError())
 		e.Exit()
-		return nil, blockErr
+		return e, blockErr
 	}
 
 	return e, nil

api/api_test.go

@@ -146,7 +146,8 @@ func Test_entryWithArgsAndChainBlock(t *testing.T) {
 		flag:         0,
 		slotChain:    sc,
 	})
-	assert.Nil(t, entry)
+	assert.NotNil(t, entry)
+	assert.Equal(t, "ResourceWrapper{name=abc, flowType=Inbound, classification=0}", entry.Resource().String())
 	assert.NotNil(t, b)
 	assert.Equal(t, blockType, b.BlockType())
 

core/config/config.go

@@ -15,7 +15,6 @@
 package config
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strconv"
@@ -100,7 +99,7 @@ func loadGlobalConfigFromYamlFile(filePath string) error {
 	if err != nil && !os.IsExist(err) {
 		return err
 	}
-	content, err := ioutil.ReadFile(filePath)
+	content, err := os.ReadFile(filePath)
 	if err != nil {
 		return err
 	}

core/hotspot/rule.go

@@ -15,7 +15,6 @@
 package hotspot
 
 import (
-	"encoding/json"
 	"fmt"
 	"reflect"
 	"strconv"
@@ -101,13 +100,8 @@ type Rule struct {
 }
 
 func (r *Rule) String() string {
-	b, err := json.Marshal(r)
-	if err != nil {
-		// Return the fallback string
-		return fmt.Sprintf("{Id:%s, Resource:%s, MetricType:%+v, ControlBehavior:%+v, ParamIndex:%d, ParamKey:%s, Threshold:%d, MaxQueueingTimeMs:%d, BurstCount:%d, DurationInSec:%d, ParamsMaxCapacity:%d, SpecificItems:%+v}",
-			r.ID, r.Resource, r.MetricType, r.ControlBehavior, r.ParamIndex, r.ParamKey, r.Threshold, r.MaxQueueingTimeMs, r.BurstCount, r.DurationInSec, r.ParamsMaxCapacity, r.SpecificItems)
-	}
-	return string(b)
+	return fmt.Sprintf("{Id:%s, Resource:%s, MetricType:%+v, ControlBehavior:%+v, ParamIndex:%d, ParamKey:%s, Threshold:%d, MaxQueueingTimeMs:%d, BurstCount:%d, DurationInSec:%d, ParamsMaxCapacity:%d, SpecificItems:%+v}",
+		r.ID, r.Resource, r.MetricType, r.ControlBehavior, r.ParamIndex, r.ParamKey, r.Threshold, r.MaxQueueingTimeMs, r.BurstCount, r.DurationInSec, r.ParamsMaxCapacity, r.SpecificItems)
 }
 func (r *Rule) ResourceName() string {
 	return r.Resource

core/log/metric/common.go

@@ -15,7 +15,6 @@
 package metric
 
 import (
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"regexp"
@@ -83,7 +82,7 @@ func filenameMatches(filename, baseFilename string) bool {
 }
 
 func listMetricFilesConditional(baseDir string, filePattern string, predicate func(string, string) bool) ([]string, error) {
-	dir, err := ioutil.ReadDir(baseDir)
+	dir, err := os.ReadDir(baseDir)
 	if err != nil {
 		return nil, err
 	}

ext/datasource/file/refreshable_file.go

@@ -15,7 +15,6 @@
 package file
 
 import (
-	"io/ioutil"
 	"os"
 	"time"
 
@@ -47,13 +46,7 @@ func NewFileDataSource(sourceFilePath string, handlers ...datasource.PropertyHan
 }
 
 func (s *RefreshableFileDataSource) ReadSource() ([]byte, error) {
-	f, err := os.Open(s.sourceFilePath)
-	if err != nil {
-		return nil, errors.Errorf("RefreshableFileDataSource fail to open the property file, err: %+v.", err)
-	}
-	defer f.Close()
-
-	src, err := ioutil.ReadAll(f)
+	src, err := os.ReadFile(s.sourceFilePath)
 	if err != nil {
 		return nil, errors.Errorf("RefreshableFileDataSource fail to read file, err: %+v.", err)
 	}

ext/datasource/file/refreshable_file_test.go

@@ -15,7 +15,6 @@
 package file
 
 import (
-	"io/ioutil"
 	"os"
 	"reflect"
 	"strings"
@@ -56,7 +55,7 @@ var (
 
 func prepareSystemRulesTestFile() error {
 	content := []byte(TestSystemRules)
-	return ioutil.WriteFile(TestSystemRulesFile, content, os.ModePerm)
+	return os.WriteFile(TestSystemRulesFile, content, os.ModePerm)
 }
 
 func deleteSystemRulesTestFile() error {
@@ -74,7 +73,7 @@ func TestRefreshableFileDataSource_ReadSource(t *testing.T) {
 			sourceFilePath: TestSystemRulesFile + "NotExisted",
 		}
 		got, err := s.ReadSource()
-		assert.True(t, got == nil && err != nil && strings.Contains(err.Error(), "RefreshableFileDataSource fail to open the property file"))
+		assert.True(t, got == nil && err != nil && strings.Contains(err.Error(), "RefreshableFileDataSource fail to read file"))
 
 		err = deleteSystemRulesTestFile()
 		if err != nil {

ext/datasource/helper_test.go

@@ -16,7 +16,6 @@ package datasource
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"reflect"
 	"strings"
@@ -32,17 +31,7 @@ import (
 )
 
 func TestFlowRuleJsonArrayParser(t *testing.T) {
-	// Prepare test data
-	f, err := os.Open("../../tests/testdata/extension/helper/FlowRule.json")
-	defer func() {
-		if err := f.Close(); err != nil {
-			t.Fatal(err)
-		}
-	}()
-	if err != nil {
-		t.Errorf("The rules file is not existed, err:%+v.", errors.WithStack(err))
-	}
-	normalSrc, err := ioutil.ReadAll(f)
+	normalSrc, err := os.ReadFile("../../tests/testdata/extension/helper/FlowRule.json")
 	if err != nil {
 		t.Errorf("Fail to read file, err: %+v.", errors.WithStack(err))
 	}
@@ -156,17 +145,7 @@ func TestFlowRulesUpdater(t *testing.T) {
 
 func TestSystemRuleJsonArrayParser(t *testing.T) {
 	t.Run("TestSystemRuleJsonArrayParser_Normal", func(t *testing.T) {
-		// Prepare test data
-		f, err := os.Open("../../tests/testdata/extension/helper/SystemRule.json")
-		defer func() {
-			if err := f.Close(); err != nil {
-				t.Fatal(err)
-			}
-		}()
-		if err != nil {
-			t.Errorf("The rules file is not existed, err:%+v.", errors.WithStack(err))
-		}
-		normalSrc, err := ioutil.ReadAll(f)
+		normalSrc, err := os.ReadFile("../../tests/testdata/extension/helper/SystemRule.json")
 		if err != nil {
 			t.Errorf("Fail to read file, err: %+v.", errors.WithStack(err))
 		}
@@ -260,17 +239,7 @@ func TestCircuitBreakerRuleJsonArrayParser(t *testing.T) {
 	})
 
 	t.Run("TestCircuitBreakerRuleJsonArrayParser_Succeed", func(t *testing.T) {
-		// Prepare test data
-		f, err := os.Open("../../tests/testdata/extension/helper/CircuitBreakerRule.json")
-		defer func() {
-			if err := f.Close(); err != nil {
-				t.Fatal(err)
-			}
-		}()
-		if err != nil {
-			t.Errorf("The rules file is not existed, err:%+v.", err)
-		}
-		src, err := ioutil.ReadAll(f)
+		src, err := os.ReadFile("../../tests/testdata/extension/helper/CircuitBreakerRule.json")
 		if err != nil {
 			t.Errorf("Fail to read file, err: %+v.", err)
 		}
@@ -382,17 +351,7 @@ func TestHotSpotParamRuleJsonArrayParser(t *testing.T) {
 	})
 
 	t.Run("TestHotSpotParamRuleJsonArrayParser_Normal", func(t *testing.T) {
-		// Prepare test data
-		f, err := os.Open("../../tests/testdata/extension/helper/HotSpotParamFlowRule.json")
-		defer func() {
-			if err := f.Close(); err != nil {
-				t.Fatal(err)
-			}
-		}()
-		if err != nil {
-			t.Errorf("The rules file is not existed, err:%+v.", err)
-		}
-		src, err := ioutil.ReadAll(f)
+		src, err := os.ReadFile("../../tests/testdata/extension/helper/HotSpotParamFlowRule.json")
 		if err != nil {
 			t.Errorf("Fail to read file, err: %+v.", err)
 		}
@@ -513,17 +472,7 @@ func TestIsolationRuleJsonArrayParser(t *testing.T) {
 	})
 
 	t.Run("TestIsolationRuleJsonArrayParser_Normal", func(t *testing.T) {
-		// Prepare test data
-		f, err := os.Open("../../tests/testdata/extension/helper/IsolationRule.json")
-		defer func() {
-			if err := f.Close(); err != nil {
-				t.Fatal(err)
-			}
-		}()
-		if err != nil {
-			t.Errorf("The rules file is not existed, err:%+v.", err)
-		}
-		src, err := ioutil.ReadAll(f)
+		src, err := os.ReadFile("../../tests/testdata/extension/helper/IsolationRule.json")
 		if err != nil {
 			t.Errorf("Fail to read file, err: %+v.", err)
 		}

ext/datasource/property_test.go

@@ -16,7 +16,7 @@ package datasource
 
 import (
 	"encoding/json"
-	"io/ioutil"
+	"os"
 	"testing"
 
 	"github.com/alibaba/sentinel-golang/core/system"
@@ -50,7 +50,7 @@ func TestSinglePropertyHandler_Handle(t *testing.T) {
 	assert.True(t, r1 == nil, "Fail to execute Handle func.")
 
 	h2 := NewDefaultPropertyHandler(MockSystemRulesConverter, MockSystemRulesUpdaterReturnError)
-	src, err := ioutil.ReadFile("../../tests/testdata/extension/SystemRule.json")
+	src, err := os.ReadFile("../../tests/testdata/extension/SystemRule.json")
 	if err != nil {
 		t.Errorf("Fail to get source file, err:%+v", err)
 	}
@@ -60,7 +60,7 @@ func TestSinglePropertyHandler_Handle(t *testing.T) {
 
 func TestSinglePropertyHandler_isPropertyConsistent(t *testing.T) {
 	h := NewDefaultPropertyHandler(MockSystemRulesConverter, MockSystemRulesUpdaterReturnNil)
-	src, err := ioutil.ReadFile("../../tests/testdata/extension/SystemRule.json")
+	src, err := os.ReadFile("../../tests/testdata/extension/SystemRule.json")
 	if err != nil {
 		t.Errorf("Fail to get source file, err:%+v", err)
 	}
@@ -69,7 +69,7 @@ func TestSinglePropertyHandler_isPropertyConsistent(t *testing.T) {
 	isConsistent := h.isPropertyConsistent(ret1)
 	assert.True(t, isConsistent == false, "Fail to execute isPropertyConsistent.")
 
-	src2, err := ioutil.ReadFile("../../tests/testdata/extension/SystemRule2.json")
+	src2, err := os.ReadFile("../../tests/testdata/extension/SystemRule2.json")
 	if err != nil {
 		t.Errorf("Fail to get source file, err:%+v", err)
 	}
@@ -78,7 +78,7 @@ func TestSinglePropertyHandler_isPropertyConsistent(t *testing.T) {
 	isConsistent = h.isPropertyConsistent(ret2)
 	assert.True(t, isConsistent == true, "Fail to execute isPropertyConsistent.")
 
-	src3, err := ioutil.ReadFile("../../tests/testdata/extension/SystemRule3.json")
+	src3, err := os.ReadFile("../../tests/testdata/extension/SystemRule3.json")
 	if err != nil {
 		t.Errorf("Fail to get source file, err:%+v", err)
 	}