testing: update Go to 1.19 (grpc#5717)

temawi · Oct 17, 2022 · 778860e · 778860e
1 parent eb8aa31
commit 778860e
Show file tree

Hide file tree

Showing 94 changed files with 570 additions and 503 deletions.
diff --git a/.github/workflows/testing.yml b/.github/workflows/testing.yml
@@ -24,7 +24,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Checkout repo
         uses: actions/checkout@v2
 
@@ -44,31 +44,31 @@ jobs:
       matrix:
         include:
           - type: vet+tests
-            goversion: 1.18
+            goversion: 1.19
 
           - type: tests
-            goversion: 1.18
+            goversion: 1.19
             testflags: -race
 
           - type: tests
-            goversion: 1.18
+            goversion: 1.19
             goarch: 386
 
           - type: tests
-            goversion: 1.18
+            goversion: 1.19
             goarch: arm64
 
           - type: tests
-            goversion: 1.17
+            goversion: 1.18
 
           - type: tests
-            goversion: 1.16
+            goversion: 1.17
 
           - type: tests
-            goversion: 1.15
+            goversion: 1.16
 
           - type: extras
-            goversion: 1.18
+            goversion: 1.19
 
     steps:
       # Setup the environment.

diff --git a/admin/admin.go b/admin/admin.go
@@ -23,7 +23,7 @@
 //
 // - CSDS: https://github.com/grpc/proposal/blob/master/A40-csds-support.md
 //
-// Experimental
+// # Experimental
 //
 // Notice: All APIs in this package are experimental and may be removed in a
 // later release.

diff --git a/attributes/attributes.go b/attributes/attributes.go
@@ -19,7 +19,7 @@
 // Package attributes defines a generic key/value store used in various gRPC
 // components.
 //
-// Experimental
+// # Experimental
 //
 // Notice: This package is EXPERIMENTAL and may be changed or removed in a
 // later release.

diff --git a/authz/rbac_translator.go b/authz/rbac_translator.go
@@ -16,7 +16,7 @@
 
 // Package authz exposes methods to manage authorization within gRPC.
 //
-// Experimental
+// # Experimental
 //
 // Notice: This package is EXPERIMENTAL and may be changed or removed
 // in a later release.

diff --git a/backoff.go b/backoff.go
@@ -48,7 +48,7 @@ type BackoffConfig struct {
 // here for more details:
 // https://github.com/grpc/grpc/blob/master/doc/connection-backoff.md.
 //
-// Experimental
+// # Experimental
 //
 // Notice: This type is EXPERIMENTAL and may be changed or removed in a
 // later release.

diff --git a/balancer/base/balancer.go b/balancer/base/balancer.go
@@ -157,8 +157,8 @@ func (b *baseBalancer) mergeErrors() error {
 
 // regeneratePicker takes a snapshot of the balancer, and generates a picker
 // from it. The picker is
-//  - errPicker if the balancer is in TransientFailure,
-//  - built by the pickerBuilder with all READY SubConns otherwise.
+//   - errPicker if the balancer is in TransientFailure,
+//   - built by the pickerBuilder with all READY SubConns otherwise.
 func (b *baseBalancer) regeneratePicker() {
 	if b.state == connectivity.TransientFailure {
 		b.picker = NewErrPicker(b.mergeErrors())

diff --git a/balancer/conn_state_evaluator.go b/balancer/conn_state_evaluator.go
@@ -34,10 +34,10 @@ type ConnectivityStateEvaluator struct {
 // RecordTransition records state change happening in subConn and based on that
 // it evaluates what aggregated state should be.
 //
-//  - If at least one SubConn in Ready, the aggregated state is Ready;
-//  - Else if at least one SubConn in Connecting, the aggregated state is Connecting;
-//  - Else if at least one SubConn is Idle, the aggregated state is Idle;
-//  - Else if at least one SubConn is TransientFailure (or there are no SubConns), the aggregated state is Transient Failure.
+//   - If at least one SubConn in Ready, the aggregated state is Ready;
+//   - Else if at least one SubConn in Connecting, the aggregated state is Connecting;
+//   - Else if at least one SubConn is Idle, the aggregated state is Idle;
+//   - Else if at least one SubConn is TransientFailure (or there are no SubConns), the aggregated state is Transient Failure.
 //
 // Shutdown is not considered.
 func (cse *ConnectivityStateEvaluator) RecordTransition(oldState, newState connectivity.State) connectivity.State {

diff --git a/balancer/grpclb/grpc_lb_v1/load_balancer.pb.go b/balancer/grpclb/grpc_lb_v1/load_balancer.pb.go
diff --git a/balancer/grpclb/grpclb.go b/balancer/grpclb/grpclb.go
@@ -19,7 +19,8 @@
 // Package grpclb defines a grpclb balancer.
 //
 // To install grpclb balancer, import this package as:
-//    import _ "google.golang.org/grpc/balancer/grpclb"
+//
+//	import _ "google.golang.org/grpc/balancer/grpclb"
 package grpclb
 
 import (
@@ -229,8 +230,9 @@ type lbBalancer struct {
 
 // regeneratePicker takes a snapshot of the balancer, and generates a picker from
 // it. The picker
-//  - always returns ErrTransientFailure if the balancer is in TransientFailure,
-//  - does two layer roundrobin pick otherwise.
+//   - always returns ErrTransientFailure if the balancer is in TransientFailure,
+//   - does two layer roundrobin pick otherwise.
+//
 // Caller must hold lb.mu.
 func (lb *lbBalancer) regeneratePicker(resetDrop bool) {
 	if lb.state == connectivity.TransientFailure {
@@ -290,14 +292,14 @@ func (lb *lbBalancer) regeneratePicker(resetDrop bool) {
 // fallback and grpclb). lb.scState contains states for all SubConns, including
 // those in cache (SubConns are cached for 10 seconds after remove).
 //
-// The aggregated state is:
-//  - If at least one SubConn in Ready, the aggregated state is Ready;
-//  - Else if at least one SubConn in Connecting or IDLE, the aggregated state is Connecting;
-//    - It's OK to consider IDLE as Connecting. SubConns never stay in IDLE,
-//    they start to connect immediately. But there's a race between the overall
-//    state is reported, and when the new SubConn state arrives. And SubConns
-//    never go back to IDLE.
-//  - Else the aggregated state is TransientFailure.
+//	The aggregated state is:
+//	- If at least one SubConn in Ready, the aggregated state is Ready;
+//	- Else if at least one SubConn in Connecting or IDLE, the aggregated state is Connecting;
+//	  - It's OK to consider IDLE as Connecting. SubConns never stay in IDLE,
+//	    they start to connect immediately. But there's a race between the overall
+//	    state is reported, and when the new SubConn state arrives. And SubConns
+//	    never go back to IDLE.
+//	- Else the aggregated state is TransientFailure.
 func (lb *lbBalancer) aggregateSubConnStates() connectivity.State {
 	var numConnecting uint64
 

diff --git a/balancer/rls/balancer.go b/balancer/rls/balancer.go
@@ -426,7 +426,6 @@ func (b *rlsBalancer) ExitIdle() {
 
 // sendNewPickerLocked pushes a new picker on to the channel.
 //
-//
 // Note that regardless of what connectivity state is reported, the policy will
 // return its own picker, and not a picker that unconditionally queues
 // (typically used for IDLE or CONNECTING) or a picker that unconditionally
@@ -485,14 +484,14 @@ func (b *rlsBalancer) sendNewPicker() {
 }
 
 // The aggregated connectivity state reported is determined as follows:
-// - If there is at least one child policy in state READY, the connectivity
-//   state is READY.
-// - Otherwise, if there is at least one child policy in state CONNECTING, the
-//   connectivity state is CONNECTING.
-// - Otherwise, if there is at least one child policy in state IDLE, the
-//   connectivity state is IDLE.
-// - Otherwise, all child policies are in TRANSIENT_FAILURE, and the
-//   connectivity state is TRANSIENT_FAILURE.
+//   - If there is at least one child policy in state READY, the connectivity
+//     state is READY.
+//   - Otherwise, if there is at least one child policy in state CONNECTING, the
+//     connectivity state is CONNECTING.
+//   - Otherwise, if there is at least one child policy in state IDLE, the
+//     connectivity state is IDLE.
+//   - Otherwise, all child policies are in TRANSIENT_FAILURE, and the
+//     connectivity state is TRANSIENT_FAILURE.
 //
 // If the RLS policy has no child policies and no configured default target,
 // then we will report connectivity state IDLE.
@@ -542,9 +541,9 @@ func (b *rlsBalancer) UpdateState(id string, state balancer.State) {
 // This method is invoked by the BalancerGroup whenever a child policy sends a
 // state update. We cache the child policy's connectivity state and picker for
 // two reasons:
-// - to suppress connectivity state transitions from TRANSIENT_FAILURE to states
-//   other than READY
-// - to delegate picks to child policies
+//   - to suppress connectivity state transitions from TRANSIENT_FAILURE to states
+//     other than READY
+//   - to delegate picks to child policies
 func (b *rlsBalancer) handleChildPolicyStateUpdate(id string, newState balancer.State) {
 	b.stateMu.Lock()
 	defer b.stateMu.Unlock()

diff --git a/balancer/rls/config.go b/balancer/rls/config.go
@@ -113,33 +113,36 @@ type lbConfigJSON struct {
 // ParseConfig parses the JSON load balancer config provided into an
 // internal form or returns an error if the config is invalid.
 //
-// When parsing a config update, the following validations are performed:
-// - routeLookupConfig:
-//   - grpc_keybuilders field:
-//     - must have at least one entry
-//     - must not have two entries with the same `Name`
-//     - within each entry:
-//       - must have at least one `Name`
-//       - must not have a `Name` with the `service` field unset or empty
-//       - within each `headers` entry:
-//         - must not have `required_match` set
-//         - must not have `key` unset or empty
-//       - across all `headers`, `constant_keys` and `extra_keys` fields:
-//         - must not have the same `key` specified twice
-//         - no `key` must be the empty string
-//   - `lookup_service` field must be set and must parse as a target URI
-//   - if `max_age` > 5m, it should be set to 5 minutes
-//   - if `stale_age` > `max_age`, ignore it
-//   - if `stale_age` is set, then `max_age` must also be set
-//   - ignore `valid_targets` field
-//   - `cache_size_bytes` field must have a value greater than 0, and if its
-//      value is greater than 5M, we cap it at 5M
-// - routeLookupChannelServiceConfig:
-//   - if specified, must parse as valid service config
-// - childPolicy:
-//   - must find a valid child policy with a valid config
-// - childPolicyConfigTargetFieldName:
-//   - must be set and non-empty
+//	 When parsing a config update, the following validations are performed:
+//	 - routeLookupConfig:
+//	   - grpc_keybuilders field:
+//	     - must have at least one entry
+//	     - must not have two entries with the same `Name`
+//	     - within each entry:
+//	       - must have at least one `Name`
+//	       - must not have a `Name` with the `service` field unset or empty
+//	       - within each `headers` entry:
+//	         - must not have `required_match` set
+//	         - must not have `key` unset or empty
+//	       - across all `headers`, `constant_keys` and `extra_keys` fields:
+//	         - must not have the same `key` specified twice
+//	         - no `key` must be the empty string
+//	   - `lookup_service` field must be set and must parse as a target URI
+//	   - if `max_age` > 5m, it should be set to 5 minutes
+//	   - if `stale_age` > `max_age`, ignore it
+//	   - if `stale_age` is set, then `max_age` must also be set
+//	   - ignore `valid_targets` field
+//	   - `cache_size_bytes` field must have a value greater than 0, and if its
+//	     value is greater than 5M, we cap it at 5M
+//
+//	- routeLookupChannelServiceConfig:
+//	  - if specified, must parse as valid service config
+//
+//	- childPolicy:
+//	  - must find a valid child policy with a valid config
+//
+//	- childPolicyConfigTargetFieldName:
+//	  - must be set and non-empty
 func (rlsBB) ParseConfig(c json.RawMessage) (serviceconfig.LoadBalancingConfig, error) {
 	logger.Infof("Received JSON service config: %v", pretty.ToJSON(c))
 	cfgJSON := &lbConfigJSON{}

diff --git a/balancer/rls/helpers_test.go b/balancer/rls/helpers_test.go
@@ -220,12 +220,12 @@ func startManualResolverWithConfig(t *testing.T, rlsConfig *e2e.RLSConfig) *manu
 //
 // There are many instances where it can take a while before the attempted RPC
 // reaches the expected backend. Examples include, but are not limited to:
-// - control channel is changed in a config update. The RLS LB policy creates a
-//   new control channel, and sends a new picker to gRPC. But it takes a while
-//   before gRPC actually starts using the new picker.
-// - test is waiting for a cache entry to expire after which we expect a
-//   different behavior because we have configured the fake RLS server to return
-//   different backends.
+//   - control channel is changed in a config update. The RLS LB policy creates a
+//     new control channel, and sends a new picker to gRPC. But it takes a while
+//     before gRPC actually starts using the new picker.
+//   - test is waiting for a cache entry to expire after which we expect a
+//     different behavior because we have configured the fake RLS server to return
+//     different backends.
 //
 // Therefore, we do not return an error when the RPC fails. Instead, we wait for
 // the context to expire before failing.

diff --git a/balancer/rls/internal/adaptive/adaptive.go b/balancer/rls/internal/adaptive/adaptive.go
@@ -45,21 +45,21 @@ const (
 // The throttler has the following knobs for which we will use defaults for
 // now. If there is a need to make them configurable at a later point in time,
 // support for the same will be added.
-// * Duration: amount of recent history that will be taken into account for
-//   making client-side throttling decisions. A default of 30 seconds is used.
-// * Bins: number of bins to be used for bucketing historical data. A default
-//   of 100 is used.
-// * RatioForAccepts: ratio by which accepts are multiplied, typically a value
-//   slightly larger than 1.0. This is used to make the throttler behave as if
-//   the backend had accepted more requests than it actually has, which lets us
-//   err on the side of sending to the backend more requests than we think it
-//   will accept for the sake of speeding up the propagation of state. A
-//   default of 2.0 is used.
-// * RequestsPadding: is used to decrease the (client-side) throttling
-//   probability in the low QPS regime (to speed up propagation of state), as
-//   well as to safeguard against hitting a client-side throttling probability
-//   of 100%. The weight of this value decreases as the number of requests in
-//   recent history grows. A default of 8 is used.
+//   - Duration: amount of recent history that will be taken into account for
+//     making client-side throttling decisions. A default of 30 seconds is used.
+//   - Bins: number of bins to be used for bucketing historical data. A default
+//     of 100 is used.
+//   - RatioForAccepts: ratio by which accepts are multiplied, typically a value
+//     slightly larger than 1.0. This is used to make the throttler behave as if
+//     the backend had accepted more requests than it actually has, which lets us
+//     err on the side of sending to the backend more requests than we think it
+//     will accept for the sake of speeding up the propagation of state. A
+//     default of 2.0 is used.
+//   - RequestsPadding: is used to decrease the (client-side) throttling
+//     probability in the low QPS regime (to speed up propagation of state), as
+//     well as to safeguard against hitting a client-side throttling probability
+//     of 100%. The weight of this value decreases as the number of requests in
+//     recent history grows. A default of 8 is used.
 //
 // The adaptive throttler attempts to estimate the probability that a request
 // will be throttled using recent history. Server requests (both throttled and

diff --git a/balancer/weightedroundrobin/weightedroundrobin.go b/balancer/weightedroundrobin/weightedroundrobin.go
@@ -45,7 +45,7 @@ func (a AddrInfo) Equal(o interface{}) bool {
 // SetAddrInfo returns a copy of addr in which the BalancerAttributes field is
 // updated with addrInfo.
 //
-// Experimental
+// # Experimental
 //
 // Notice: This API is EXPERIMENTAL and may be changed or removed in a
 // later release.
@@ -57,7 +57,7 @@ func SetAddrInfo(addr resolver.Address, addrInfo AddrInfo) resolver.Address {
 // GetAddrInfo returns the AddrInfo stored in the BalancerAttributes field of
 // addr.
 //
-// Experimental
+// # Experimental
 //
 // Notice: This API is EXPERIMENTAL and may be changed or removed in a
 // later release.

diff --git a/benchmark/benchmain/main.go b/benchmark/benchmain/main.go
@@ -21,21 +21,22 @@ Package main provides benchmark with setting flags.
 
 An example to run some benchmarks with profiling enabled:
 
-go run benchmark/benchmain/main.go -benchtime=10s -workloads=all \
-  -compression=gzip -maxConcurrentCalls=1 -trace=off \
-  -reqSizeBytes=1,1048576 -respSizeBytes=1,1048576 -networkMode=Local \
-  -cpuProfile=cpuProf -memProfile=memProf -memProfileRate=10000 -resultFile=result
+	go run benchmark/benchmain/main.go -benchtime=10s -workloads=all \
+	  -compression=gzip -maxConcurrentCalls=1 -trace=off \
+	  -reqSizeBytes=1,1048576 -respSizeBytes=1,1048576 -networkMode=Local \
+	  -cpuProfile=cpuProf -memProfile=memProf -memProfileRate=10000 -resultFile=result
 
 As a suggestion, when creating a branch, you can run this benchmark and save the result
 file "-resultFile=basePerf", and later when you at the middle of the work or finish the
 work, you can get the benchmark result and compare it with the base anytime.
 
 Assume there are two result files names as "basePerf" and "curPerf" created by adding
 -resultFile=basePerf and -resultFile=curPerf.
-	To format the curPerf, run:
-  	go run benchmark/benchresult/main.go curPerf
-	To observe how the performance changes based on a base result, run:
-  	go run benchmark/benchresult/main.go basePerf curPerf
+
+		To format the curPerf, run:
+	  	go run benchmark/benchresult/main.go curPerf
+		To observe how the performance changes based on a base result, run:
+	  	go run benchmark/benchresult/main.go basePerf curPerf
 */
 package main