Skip to content

Commit b49cabf

Browse files
committed
refactor: rename PoolPutResults
1 parent 09dd5ac commit b49cabf

File tree

7 files changed

+61
-61
lines changed

7 files changed

+61
-61
lines changed

src/code.cloudfoundry.org/gorouter/handlers/routeservice_test.go

+6-6
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ var _ = Describe("Route Service Handler", func() {
129129
endpoint := route.NewEndpoint(&route.EndpointOpts{})
130130

131131
added := routePool.Put(endpoint)
132-
Expect(added).To(Equal(route.ADDED))
132+
Expect(added).To(Equal(route.EndpointAdded))
133133
})
134134
It("should not add route service metadata to the request for normal routes", func() {
135135
handler.ServeHTTP(resp, req)
@@ -152,7 +152,7 @@ var _ = Describe("Route Service Handler", func() {
152152
BeforeEach(func() {
153153
endpoint := route.NewEndpoint(&route.EndpointOpts{RouteServiceUrl: "route-service.com"})
154154
added := routePool.Put(endpoint)
155-
Expect(added).To(Equal(route.ADDED))
155+
Expect(added).To(Equal(route.EndpointAdded))
156156
})
157157

158158
It("returns 502 Bad Gateway", func() {
@@ -172,7 +172,7 @@ var _ = Describe("Route Service Handler", func() {
172172
BeforeEach(func() {
173173
endpoint := route.NewEndpoint(&route.EndpointOpts{})
174174
added := routePool.Put(endpoint)
175-
Expect(added).To(Equal(route.ADDED))
175+
Expect(added).To(Equal(route.EndpointAdded))
176176
})
177177
It("should not add route service metadata to the request for normal routes", func() {
178178
handler.ServeHTTP(resp, req)
@@ -211,7 +211,7 @@ var _ = Describe("Route Service Handler", func() {
211211
BeforeEach(func() {
212212
endpoint := route.NewEndpoint(&route.EndpointOpts{RouteServiceUrl: "https://route-service.com"})
213213
added := routePool.Put(endpoint)
214-
Expect(added).To(Equal(route.ADDED))
214+
Expect(added).To(Equal(route.EndpointAdded))
215215
})
216216

217217
It("sends the request to the route service with X-CF-Forwarded-Url using https scheme", func() {
@@ -699,7 +699,7 @@ var _ = Describe("Route Service Handler", func() {
699699
endpoint := route.NewEndpoint(&route.EndpointOpts{RouteServiceUrl: "https://goodrouteservice.com"})
700700

701701
added := routePool.Put(endpoint)
702-
Expect(added).To(Equal(route.ADDED))
702+
Expect(added).To(Equal(route.EndpointAdded))
703703
req.Header.Set("connection", "upgrade")
704704
req.Header.Set("upgrade", "websocket")
705705

@@ -718,7 +718,7 @@ var _ = Describe("Route Service Handler", func() {
718718
BeforeEach(func() {
719719
endpoint := route.NewEndpoint(&route.EndpointOpts{RouteServiceUrl: "https://bad%20service.com"})
720720
added := routePool.Put(endpoint)
721-
Expect(added).To(Equal(route.ADDED))
721+
Expect(added).To(Equal(route.EndpointAdded))
722722

723723
})
724724
It("returns a 500 internal server error response", func() {

src/code.cloudfoundry.org/gorouter/metrics/metricsreporter_test.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -467,18 +467,18 @@ var _ = Describe("MetricsReporter", func() {
467467

468468
It("sends number of nats messages received from each component", func() {
469469
endpoint.Tags = map[string]string{}
470-
metricReporter.CaptureRegistryMessage(endpoint, route.ADDED.String())
470+
metricReporter.CaptureRegistryMessage(endpoint, route.EndpointAdded.String())
471471

472472
Expect(batcher.BatchIncrementCounterCallCount()).To(Equal(1))
473473
Expect(batcher.BatchIncrementCounterArgsForCall(0)).To(Equal("registry_message"))
474474
})
475475

476476
It("sends number of nats messages received from each component", func() {
477477
endpoint.Tags = map[string]string{"component": "uaa"}
478-
metricReporter.CaptureRegistryMessage(endpoint, route.ADDED.String())
478+
metricReporter.CaptureRegistryMessage(endpoint, route.EndpointAdded.String())
479479

480480
endpoint.Tags = map[string]string{"component": "route-emitter"}
481-
metricReporter.CaptureRegistryMessage(endpoint, route.ADDED.String())
481+
metricReporter.CaptureRegistryMessage(endpoint, route.EndpointAdded.String())
482482

483483
Expect(batcher.BatchIncrementCounterCallCount()).To(Equal(2))
484484
Expect(batcher.BatchIncrementCounterArgsForCall(0)).To(Equal("registry_message.uaa"))

src/code.cloudfoundry.org/gorouter/metrics_prometheus/metrics_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ var _ = Describe("Metrics", func() {
3535

3636
It("sends number of nats messages received from each component", func() {
3737
endpoint.Tags = map[string]string{}
38-
m.CaptureRegistryMessage(endpoint, route.UPDATED.String())
39-
expected := fmt.Sprintf("registry_message{action=\"%s\",component=\"\"} 1", route.UPDATED.String())
38+
m.CaptureRegistryMessage(endpoint, route.EndpointUpdated.String())
39+
expected := fmt.Sprintf("registry_message{action=\"%s\",component=\"\"} 1", route.EndpointUpdated.String())
4040
Expect(getMetrics(r.Port())).To(ContainSubstring(expected))
4141

42-
m.CaptureRegistryMessage(endpoint, route.UPDATED.String())
43-
expected = fmt.Sprintf("registry_message{action=\"%s\",component=\"\"} 2", route.UPDATED.String())
42+
m.CaptureRegistryMessage(endpoint, route.EndpointUpdated.String())
43+
expected = fmt.Sprintf("registry_message{action=\"%s\",component=\"\"} 2", route.EndpointUpdated.String())
4444
Expect(getMetrics(r.Port())).To(ContainSubstring(expected))
4545
})
4646

src/code.cloudfoundry.org/gorouter/proxy/round_tripper/proxy_round_tripper_test.go

+17-17
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ var _ = Describe("ProxyRoundTripper", func() {
160160
})
161161

162162
added := routePool.Put(endpoint)
163-
Expect(added).To(Equal(route.ADDED))
163+
Expect(added).To(Equal(route.EndpointAdded))
164164
}
165165

166166
proxyRoundTripper = round_tripper.NewProxyRoundTripper(
@@ -418,11 +418,11 @@ var _ = Describe("ProxyRoundTripper", func() {
418418
if transport.RoundTripCallCount() == 1 {
419419
endpoint := endpointFor(4)
420420
updated := routePool.Put(endpoint)
421-
Expect(updated).To(Equal(route.REFRESHED))
421+
Expect(updated).To(Equal(route.EndpointRefreshed))
422422

423423
endpoint = endpointFor(5)
424424
updated = routePool.Put(endpoint)
425-
Expect(updated).To(Equal(route.REFRESHED))
425+
Expect(updated).To(Equal(route.EndpointRefreshed))
426426
}
427427

428428
return nil, &net.OpError{Op: "dial", Err: errors.New("connection refused")}
@@ -445,7 +445,7 @@ var _ = Describe("ProxyRoundTripper", func() {
445445
for i := 6; i <= 7; i++ {
446446
endpoint := endpointFor(i)
447447
added := routePool.Put(endpoint)
448-
Expect(added).To(Equal(route.ADDED))
448+
Expect(added).To(Equal(route.EndpointAdded))
449449
}
450450
}
451451

@@ -467,7 +467,7 @@ var _ = Describe("ProxyRoundTripper", func() {
467467
transport.RoundTripStub = func(*http.Request) (*http.Response, error) {
468468
if transport.RoundTripCallCount() == 2 {
469469
added := routePool.Put(endpointFor(6))
470-
Expect(added).To(Equal(route.ADDED))
470+
Expect(added).To(Equal(route.EndpointAdded))
471471

472472
removed := routePool.Remove(endpointFor(2))
473473
Expect(removed).To(BeTrue())
@@ -495,7 +495,7 @@ var _ = Describe("ProxyRoundTripper", func() {
495495
transport.RoundTripStub = func(*http.Request) (*http.Response, error) {
496496
if transport.RoundTripCallCount() == 5 {
497497
added := routePool.Put(endpointFor(6))
498-
Expect(added).To(Equal(route.ADDED))
498+
Expect(added).To(Equal(route.EndpointAdded))
499499

500500
removed := routePool.Remove(endpointFor(2))
501501
Expect(removed).To(BeTrue())
@@ -603,7 +603,7 @@ var _ = Describe("ProxyRoundTripper", func() {
603603
})
604604

605605
added := routePool.Put(endpoint)
606-
Expect(added).To(Equal(route.ADDED))
606+
Expect(added).To(Equal(route.EndpointAdded))
607607

608608
_, err := proxyRoundTripper.RoundTrip(req)
609609
Expect(err).To(MatchError(ContainSubstring("tls: handshake failure")))
@@ -797,14 +797,14 @@ var _ = Describe("ProxyRoundTripper", func() {
797797
Port: 20222,
798798
UseTLS: true,
799799
})
800-
Expect(routePool.Put(tlsEndpoint)).To(Equal(route.ADDED))
800+
Expect(routePool.Put(tlsEndpoint)).To(Equal(route.EndpointAdded))
801801

802802
nonTLSEndpoint := route.NewEndpoint(&route.EndpointOpts{
803803
Host: "3.3.3.3",
804804
Port: 30333,
805805
UseTLS: false,
806806
})
807-
Expect(routePool.Put(nonTLSEndpoint)).To(Equal(route.ADDED))
807+
Expect(routePool.Put(nonTLSEndpoint)).To(Equal(route.EndpointAdded))
808808
})
809809

810810
Context("when retrying different backends", func() {
@@ -858,7 +858,7 @@ var _ = Describe("ProxyRoundTripper", func() {
858858
})
859859

860860
added := routePool.Put(endpoint)
861-
Expect(added).To(Equal(route.ADDED))
861+
Expect(added).To(Equal(route.EndpointAdded))
862862
transport.RoundTripReturns(
863863
&http.Response{StatusCode: http.StatusTeapot}, nil,
864864
)
@@ -881,7 +881,7 @@ var _ = Describe("ProxyRoundTripper", func() {
881881
})
882882

883883
added := routePool.Put(endpoint)
884-
Expect(added).To(Equal(route.UPDATED))
884+
Expect(added).To(Equal(route.EndpointUpdated))
885885
transport.RoundTripReturns(
886886
&http.Response{StatusCode: http.StatusTeapot}, nil,
887887
)
@@ -918,7 +918,7 @@ var _ = Describe("ProxyRoundTripper", func() {
918918
Host: "1.1.1.1", Port: 9091, UseTLS: true, PrivateInstanceId: "instanceId-2",
919919
})
920920
added := routePool.Put(endpoint)
921-
Expect(added).To(Equal(route.ADDED))
921+
Expect(added).To(Equal(route.EndpointAdded))
922922

923923
_, err := proxyRoundTripper.RoundTrip(req)
924924
Expect(err).ToNot(HaveOccurred())
@@ -1202,9 +1202,9 @@ var _ = Describe("ProxyRoundTripper", func() {
12021202
})
12031203

12041204
added := routePool.Put(endpoint1)
1205-
Expect(added).To(Equal(route.ADDED))
1205+
Expect(added).To(Equal(route.EndpointAdded))
12061206
added = routePool.Put(endpoint2)
1207-
Expect(added).To(Equal(route.ADDED))
1207+
Expect(added).To(Equal(route.EndpointAdded))
12081208
removed := routePool.Remove(endpoint)
12091209
Expect(removed).To(BeTrue())
12101210
})
@@ -1505,7 +1505,7 @@ var _ = Describe("ProxyRoundTripper", func() {
15051505

15061506
new_endpoint := route.NewEndpoint(&route.EndpointOpts{PrivateInstanceId: "id-5"})
15071507
added := routePool.Put(new_endpoint)
1508-
Expect(added).To(Equal(route.ADDED))
1508+
Expect(added).To(Equal(route.EndpointAdded))
15091509
})
15101510

15111511
Context("when route service headers are not on the request", func() {
@@ -1568,7 +1568,7 @@ var _ = Describe("ProxyRoundTripper", func() {
15681568

15691569
new_endpoint := route.NewEndpoint(&route.EndpointOpts{PrivateInstanceId: "id-5"})
15701570
added := routePool.Put(new_endpoint)
1571-
Expect(added).To(Equal(route.ADDED))
1571+
Expect(added).To(Equal(route.EndpointAdded))
15721572
})
15731573

15741574
Context("when route service headers are not on the request", func() {
@@ -1634,7 +1634,7 @@ var _ = Describe("ProxyRoundTripper", func() {
16341634

16351635
new_endpoint := route.NewEndpoint(&route.EndpointOpts{PrivateInstanceId: "id-5"})
16361636
added := routePool.Put(new_endpoint)
1637-
Expect(added).To(Equal(route.ADDED))
1637+
Expect(added).To(Equal(route.EndpointAdded))
16381638
})
16391639

16401640
Context("when route service headers are not on the request", func() {

src/code.cloudfoundry.org/gorouter/registry/registry.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -92,24 +92,24 @@ func (r *RouteRegistry) Register(uri route.Uri, endpoint *route.Endpoint) {
9292

9393
r.reporter.CaptureRegistryMessage(endpoint, poolPutResult.String())
9494

95-
if poolPutResult == route.ADDED && !endpoint.UpdatedAt.IsZero() {
95+
if poolPutResult == route.EndpointAdded && !endpoint.UpdatedAt.IsZero() {
9696
r.reporter.CaptureRouteRegistrationLatency(time.Since(endpoint.UpdatedAt))
9797
}
9898

9999
switch poolPutResult {
100-
case route.ADDED:
100+
case route.EndpointAdded:
101101
if r.logger.Enabled(context.Background(), slog.LevelInfo) {
102102
r.logger.Info("endpoint-registered", buildSlogAttrs(uri, endpoint)...)
103103
}
104-
case route.UPDATED:
104+
case route.EndpointUpdated:
105105
if r.logger.Enabled(context.Background(), slog.LevelInfo) {
106106
r.logger.Info("endpoint-registered", buildSlogAttrs(uri, endpoint)...)
107107
}
108-
case route.UNMODIFIED:
108+
case route.EndpointUnmodified:
109109
if r.logger.Enabled(context.Background(), slog.LevelDebug) {
110110
r.logger.Debug("endpoint-not-registered", buildSlogAttrs(uri, endpoint)...)
111111
}
112-
case route.REFRESHED:
112+
case route.EndpointRefreshed:
113113
if r.logger.Enabled(context.Background(), slog.LevelDebug) {
114114
r.logger.Debug("endpoint-refreshed", buildSlogAttrs(uri, endpoint)...)
115115
}

src/code.cloudfoundry.org/gorouter/route/pool.go

+12-12
Original file line numberDiff line numberDiff line change
@@ -25,24 +25,24 @@ type PoolPutResult int
2525

2626
func (p PoolPutResult) String() string {
2727
switch p {
28-
case UNMODIFIED:
28+
case EndpointUnmodified:
2929
return "unmodified"
30-
case UPDATED:
30+
case EndpointUpdated:
3131
return "updated"
32-
case ADDED:
32+
case EndpointAdded:
3333
return "added"
34-
case REFRESHED:
34+
case EndpointRefreshed:
3535
return "refreshed"
3636
default:
3737
panic("invalid PoolPutResult")
3838
}
3939
}
4040

4141
const (
42-
UNMODIFIED = PoolPutResult(iota)
43-
UPDATED
44-
ADDED
45-
REFRESHED
42+
EndpointUnmodified = PoolPutResult(iota)
43+
EndpointUpdated
44+
EndpointAdded
45+
EndpointRefreshed
4646
)
4747

4848
func NewCounter(initial int64) *Counter {
@@ -294,12 +294,12 @@ func (p *EndpointPool) Put(endpoint *Endpoint) PoolPutResult {
294294
e.updated = time.Now()
295295
p.Update()
296296

297-
return REFRESHED
297+
return EndpointRefreshed
298298

299299
case found && !e.endpoint.ModificationTag.SucceededBy(&endpoint.ModificationTag):
300300
// This exists to protect against flapping when a route receives a change (e.g. a new
301301
// route-service URL) and messages for the old and new config are still floating around.
302-
return UNMODIFIED
302+
return EndpointUnmodified
303303

304304
case found && !equal:
305305
// The same endpoint was announced with different data, replace the old endpoint with the
@@ -324,7 +324,7 @@ func (p *EndpointPool) Put(endpoint *Endpoint) PoolPutResult {
324324
e.updated = time.Now()
325325
p.Update()
326326

327-
return UPDATED
327+
return EndpointUpdated
328328

329329
case !found:
330330
// New endpoint.
@@ -344,7 +344,7 @@ func (p *EndpointPool) Put(endpoint *Endpoint) PoolPutResult {
344344
p.setPoolLoadBalancingAlgorithm(e.endpoint)
345345
p.Update()
346346

347-
return ADDED
347+
return EndpointAdded
348348

349349
default:
350350
panic("quantum state discovered")

0 commit comments

Comments
 (0)