rename

acceptorwrapper/rate_limiting_conn.go → acceptorwrapper/rate_limiter.go

@@ -31,24 +31,24 @@ import (
 	"github.com/topfreegames/pitaya/metrics"
 )
 
-// RateLimitingConn wraps net.Conn by applying rate limiting
+// RateLimiter wraps net.Conn by applying rate limiting
 // and return empty if exceeded
-type RateLimitingConn struct {
+type RateLimiter struct {
 	net.Conn
 	limit        int
 	interval     time.Duration
 	times        list.List
 	forceDisable bool
 }
 
-// NewRateLimitingConn returns an initialized *RateLimiting
-func NewRateLimitingConn(
+// NewRateLimiter returns an initialized *RateLimiting
+func NewRateLimiter(
 	conn net.Conn,
 	limit int,
 	interval time.Duration,
 	forceDisable bool,
-) *RateLimitingConn {
-	r := &RateLimitingConn{
+) *RateLimiter {
+	r := &RateLimiter{
 		Conn:         conn,
 		limit:        limit,
 		interval:     interval,
@@ -60,7 +60,7 @@ func NewRateLimitingConn(
 	return r
 }
 
-func (r *RateLimitingConn) Read(b []byte) (n int, err error) {
+func (r *RateLimiter) Read(b []byte) (n int, err error) {
 	if r.forceDisable {
 		return r.Conn.Read(b)
 	}
@@ -85,7 +85,7 @@ func (r *RateLimitingConn) Read(b []byte) (n int, err error) {
 
 // take saves the now as time taken or returns an error if
 // in the limit of rate limiting
-func (r *RateLimitingConn) take(now time.Time) error {
+func (r *RateLimiter) take(now time.Time) error {
 	if r.times.Len() < r.limit {
 		r.times.PushBack(now)
 		return nil

acceptorwrapper/rate_limiting_conn_test.go → acceptorwrapper/rate_limiter_test.go

@@ -11,7 +11,7 @@ import (
 	"github.com/topfreegames/pitaya/mocks"
 )
 
-func TestRateLimitingConnRead(t *testing.T) {
+func TestRateLimiterRead(t *testing.T) {
 	t.Parallel()
 
 	var (
@@ -21,7 +21,7 @@ func TestRateLimitingConnRead(t *testing.T) {
 		errTest  = errors.New("error")
 
 		mockConn *mocks.MockConn
-		r        *RateLimitingConn
+		r        *RateLimiter
 	)
 
 	tables := map[string]struct {
@@ -57,10 +57,13 @@ func TestRateLimitingConnRead(t *testing.T) {
 					assert.NoError(t, err)
 				}
 
+				// exceed after this call
 				mockConn.EXPECT().Read(buf).Return(10, nil)
+				// back to for begin, return error to leave for loop
+				mockConn.EXPECT().Read(buf).Return(0, errTest)
 			},
-			expected: 0, // exceed, so 0 even though mock read returned 10
-			err:      nil,
+			expected: 0,
+			err:      errTest,
 		},
 
 		"test_force_disable": {
@@ -85,7 +88,7 @@ func TestRateLimitingConnRead(t *testing.T) {
 			defer ctrl.Finish()
 			mockConn = mocks.NewMockConn(ctrl)
 
-			r = NewRateLimitingConn(mockConn, limit, interval, table.forceDisable)
+			r = NewRateLimiter(mockConn, limit, interval, table.forceDisable)
 
 			table.mock()
 			n, err := r.Read(buf)
@@ -95,14 +98,14 @@ func TestRateLimitingConnRead(t *testing.T) {
 	}
 }
 
-func TestRateLimitingConnTake(t *testing.T) {
+func TestRateLimiterTake(t *testing.T) {
 	t.Parallel()
 
 	var (
 		limit    = 3
 		interval = time.Second
 		now      = time.Now()
-		r        *RateLimitingConn
+		r        *RateLimiter
 	)
 
 	tables := map[string]struct {
@@ -140,7 +143,7 @@ func TestRateLimitingConnTake(t *testing.T) {
 
 	for name, table := range tables {
 		t.Run(name, func(t *testing.T) {
-			r = NewRateLimitingConn(nil, limit, interval, false)
+			r = NewRateLimiter(nil, limit, interval, false)
 
 			table.before()
 			err := r.take(now)

acceptorwrapper/rate_limiting.go → acceptorwrapper/rate_limiting_wrapper.go

@@ -43,7 +43,7 @@ func NewRateLimitingWrapper(c *config.Config) *RateLimitingWrapper {
 			forceDisable = c.GetBool("pitaya.conn.ratelimiting.forcedisable")
 		)
 
-		return NewRateLimitingConn(conn, limit, interval, forceDisable)
+		return NewRateLimiter(conn, limit, interval, forceDisable)
 	})
 
 	return r

acceptorwrapper/rate_limiting_test.go → acceptorwrapper/rate_limiting_wrapper_test.go

@@ -21,6 +21,6 @@ func TestNewRateLimitingWrapper(t *testing.T) {
 	}
 
 	rateLimitingWrapper := NewRateLimitingWrapper(getConfig())
-	expected := NewRateLimitingConn(nil, 20, time.Second, false)
+	expected := NewRateLimiter(nil, 20, time.Second, false)
 	assert.Equal(t, expected, rateLimitingWrapper.wrapConn(nil))
 }