1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
package limithandler_test
import (
"context"
"io"
"net"
"testing"
grpcmwlogrus "github.com/grpc-ecosystem/go-grpc-middleware/logging/logrus"
"github.com/sirupsen/logrus"
"github.com/sirupsen/logrus/hooks/test"
"github.com/stretchr/testify/require"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/catfile"
"gitlab.com/gitlab-org/gitaly/v16/internal/git/gittest"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/config"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/service/ref"
"gitlab.com/gitlab-org/gitaly/v16/internal/gitaly/transaction"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/backchannel"
"gitlab.com/gitlab-org/gitaly/v16/internal/grpc/middleware/limithandler"
"gitlab.com/gitlab-org/gitaly/v16/internal/log"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper"
"gitlab.com/gitlab-org/gitaly/v16/internal/testhelper/testcfg"
"gitlab.com/gitlab-org/gitaly/v16/proto/go/gitalypb"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/test/bufconn"
)
func createNewServer(t *testing.T, cfg config.Cfg, logger *logrus.Logger) *grpc.Server {
t.Helper()
logrusEntry := logrus.NewEntry(logger).WithField("test", t.Name())
concurrencyLimitHandler := limithandler.New(
cfg,
func(ctx context.Context) string { return "@hashed/1234" },
limithandler.WithConcurrencyLimiters,
)
opts := []grpc.ServerOption{
grpc.ChainStreamInterceptor(
limithandler.StatsStreamInterceptor,
grpcmwlogrus.StreamServerInterceptor(logrusEntry,
grpcmwlogrus.WithTimestampFormat(log.LogTimestampFormat),
grpcmwlogrus.WithMessageProducer(log.MessageProducer(grpcmwlogrus.DefaultMessageProducer, limithandler.FieldsProducer))),
concurrencyLimitHandler.StreamInterceptor(),
),
grpc.ChainUnaryInterceptor(
limithandler.StatsUnaryInterceptor,
grpcmwlogrus.UnaryServerInterceptor(logrusEntry,
grpcmwlogrus.WithTimestampFormat(log.LogTimestampFormat),
grpcmwlogrus.WithMessageProducer(log.MessageProducer(grpcmwlogrus.DefaultMessageProducer, limithandler.FieldsProducer))),
concurrencyLimitHandler.UnaryInterceptor(),
),
}
server := grpc.NewServer(opts...)
gitCommandFactory := gittest.NewCommandFactory(t, cfg)
catfileCache := catfile.NewCache(cfg)
t.Cleanup(catfileCache.Stop)
gitalypb.RegisterRefServiceServer(server, ref.NewServer(
config.NewLocator(cfg),
gitCommandFactory,
transaction.NewManager(cfg, backchannel.NewRegistry()),
catfileCache,
))
return server
}
func getBufDialer(listener *bufconn.Listener) func(context.Context, string) (net.Conn, error) {
return func(ctx context.Context, url string) (net.Conn, error) {
return listener.Dial()
}
}
func TestInterceptor(t *testing.T) {
t.Parallel()
ctx := testhelper.Context(t)
cfg := testcfg.Build(t, testcfg.WithBase(config.Cfg{
Concurrency: []config.Concurrency{
{
RPC: "/gitaly.RefService/RefExists",
MaxPerRepo: 1,
},
{
RPC: "/gitaly.RefService/ListRefs",
MaxPerRepo: 1,
},
},
}))
repo, _ := gittest.CreateRepository(t, ctx, cfg, gittest.CreateRepositoryConfig{
SkipCreationViaService: true,
})
logger, hook := test.NewNullLogger()
s := createNewServer(t, cfg, logger)
defer s.Stop()
bufferSize := 1024 * 1024
listener := bufconn.Listen(bufferSize)
go testhelper.MustServe(t, s, listener)
tests := []struct {
name string
performRPC func(t *testing.T, ctx context.Context, client gitalypb.RefServiceClient)
expectedLogData map[string]any
}{
{
name: "Unary",
performRPC: func(t *testing.T, ctx context.Context, client gitalypb.RefServiceClient) {
req := &gitalypb.RefExistsRequest{Repository: repo, Ref: []byte("refs/foo")}
_, err := client.RefExists(ctx, req)
require.NoError(t, err)
},
expectedLogData: map[string]any{
"limit.limiting_type": "per-rpc",
"limit.limiting_key": "@hashed/1234",
"limit.concurrency_queue_length": 0,
},
},
{
name: "Stream",
performRPC: func(t *testing.T, ctx context.Context, client gitalypb.RefServiceClient) {
req := &gitalypb.ListRefsRequest{Repository: repo, Patterns: [][]byte{[]byte("refs/heads/")}}
stream, err := client.ListRefs(ctx, req)
require.NoError(t, err)
for {
_, err := stream.Recv()
if err == io.EOF {
break
}
require.NoError(t, err)
}
},
expectedLogData: map[string]any{
"limit.limiting_type": "per-rpc",
"limit.limiting_key": "@hashed/1234",
"limit.concurrency_queue_length": 0,
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
hook.Reset()
conn, err := grpc.DialContext(ctx, "", grpc.WithContextDialer(getBufDialer(listener)), grpc.WithTransportCredentials(insecure.NewCredentials()))
require.NoError(t, err)
defer conn.Close()
client := gitalypb.NewRefServiceClient(conn)
tt.performRPC(t, ctx, client)
logEntries := hook.AllEntries()
require.Len(t, logEntries, 1)
for expectedLogKey, expectedLogValue := range tt.expectedLogData {
require.Equal(t, expectedLogValue, logEntries[0].Data[expectedLogKey])
}
require.GreaterOrEqual(t, logEntries[0].Data["limit.concurrency_queue_ms"], int64(0))
})
}
}
|
