-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add support for a lazy refresh (#565)
When creating a Dialer with the WithLazyRefresh option, the connection info and ephemeral certificate will be refreshed only when the cache certificate has expired. No background goroutines run with this option, making it ideal for use in Cloud Run and other serverless environments where the CPU may be throttled. This is a port of GoogleCloudPlatform/cloud-sql-go-connector#772 Fixes #549
- Loading branch information
Showing
5 changed files
with
272 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package alloydb | ||
|
|
||
| import ( | ||
| "context" | ||
| "crypto/rsa" | ||
| "sync" | ||
| "time" | ||
|
|
||
| alloydbadmin "cloud.google.com/go/alloydb/apiv1alpha" | ||
| "cloud.google.com/go/alloydbconn/debug" | ||
| ) | ||
|
|
||
| // LazyRefreshCache is caches connection info and refreshes the cache only when | ||
| // a caller requests connection info and the current certificate is expired. | ||
| type LazyRefreshCache struct { | ||
| uri InstanceURI | ||
| logger debug.Logger | ||
| key *rsa.PrivateKey | ||
| r refresher | ||
| mu sync.Mutex | ||
| needsRefresh bool | ||
| cached ConnectionInfo | ||
| } | ||
|
|
||
| // NewLazyRefreshCache initializes a new LazyRefreshCache. | ||
| func NewLazyRefreshCache( | ||
| uri InstanceURI, | ||
| l debug.Logger, | ||
| client *alloydbadmin.AlloyDBAdminClient, | ||
| key *rsa.PrivateKey, | ||
| _ time.Duration, | ||
| dialerID string, | ||
| ) *LazyRefreshCache { | ||
| return &LazyRefreshCache{ | ||
| uri: uri, | ||
| logger: l, | ||
| key: key, | ||
| r: newRefresher( | ||
| client, | ||
| dialerID, | ||
| ), | ||
| } | ||
| } | ||
|
|
||
| // ConnectionInfo returns connection info for the associated instance. New | ||
| // connection info is retrieved under two conditions: | ||
| // - the current connection info's certificate has expired, or | ||
| // - a caller has separately called ForceRefresh | ||
| func (c *LazyRefreshCache) ConnectionInfo( | ||
| ctx context.Context, | ||
| ) (ConnectionInfo, error) { | ||
| c.mu.Lock() | ||
| defer c.mu.Unlock() | ||
| // strip monotonic clock with UTC() | ||
| now := time.Now().UTC() | ||
| // Pad expiration with a buffer to give the client plenty of time to | ||
| // establish a connection to the server with the certificate. | ||
| exp := c.cached.Expiration.UTC().Add(-refreshBuffer) | ||
| if !c.needsRefresh && now.Before(exp) { | ||
| c.logger.Debugf( | ||
| "[%v] Connection info is still valid, using cached info", | ||
| c.uri.String(), | ||
| ) | ||
| return c.cached, nil | ||
| } | ||
|
|
||
| c.logger.Debugf( | ||
| "[%v] Connection info refresh operation started", | ||
| c.uri.String(), | ||
| ) | ||
| ci, err := c.r.performRefresh(ctx, c.uri, c.key) | ||
| if err != nil { | ||
| c.logger.Debugf( | ||
| "[%v] Connection info refresh operation failed, err = %v", | ||
| c.uri.String(), | ||
| err, | ||
| ) | ||
| return ConnectionInfo{}, err | ||
| } | ||
| c.logger.Debugf( | ||
| "[%v] Connection info refresh operation complete", | ||
| c.uri.String(), | ||
| ) | ||
| c.logger.Debugf( | ||
| "[%v] Current certificate expiration = %v", | ||
| c.uri.String(), | ||
| ci.Expiration.UTC().Format(time.RFC3339), | ||
| ) | ||
| c.cached = ci | ||
| c.needsRefresh = false | ||
| return ci, nil | ||
| } | ||
|
|
||
| // ForceRefresh invalidates the caches and configures the next call to | ||
| // ConnectionInfo to retrieve a fresh connection info. | ||
| func (c *LazyRefreshCache) ForceRefresh() { | ||
| c.mu.Lock() | ||
| defer c.mu.Unlock() | ||
| c.needsRefresh = true | ||
| } | ||
|
|
||
| // Close is a no-op and provided purely for a consistent interface with other | ||
| // caching types. | ||
| func (c *LazyRefreshCache) Close() error { | ||
| return nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package alloydb | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
| "time" | ||
|
|
||
| alloydbadmin "cloud.google.com/go/alloydb/apiv1alpha" | ||
| "cloud.google.com/go/alloydbconn/internal/mock" | ||
| "google.golang.org/api/option" | ||
| ) | ||
|
|
||
| func TestLazyRefreshCacheConnectionInfo(t *testing.T) { | ||
| u := testInstanceURI() | ||
| inst := mock.NewFakeInstance(u.project, u.region, u.cluster, u.name) | ||
| client, url, cleanup := mock.HTTPClient( | ||
| mock.InstanceGetSuccess(inst, 1), | ||
| mock.CreateEphemeralSuccess(inst, 1), | ||
| ) | ||
| defer func() { | ||
| if err := cleanup(); err != nil { | ||
| t.Fatalf("%v", err) | ||
| } | ||
| }() | ||
| ctx := context.Background() | ||
| c, err := alloydbadmin.NewAlloyDBAdminRESTClient( | ||
| ctx, | ||
| option.WithHTTPClient(client), | ||
| option.WithEndpoint(url), | ||
| option.WithTokenSource(stubTokenSource{}), | ||
| ) | ||
| if err != nil { | ||
| t.Fatalf("expected NewClient to succeed, but got error: %v", err) | ||
| } | ||
| cache := NewLazyRefreshCache( | ||
| testInstanceURI(), nullLogger{}, c, | ||
| RSAKey, 30*time.Second, "", | ||
| ) | ||
|
|
||
| ci, err := cache.ConnectionInfo(context.Background()) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| if ci.Instance != u { | ||
| t.Fatalf("want = %v, got = %v", u, ci.Instance) | ||
| } | ||
| // Request connection info again to ensure it uses the cache and doesn't | ||
| // send another API call. | ||
| _, err = cache.ConnectionInfo(context.Background()) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| } | ||
|
|
||
| func TestLazyRefreshCacheForceRefresh(t *testing.T) { | ||
| u := testInstanceURI() | ||
| inst := mock.NewFakeInstance(u.project, u.region, u.cluster, u.name) | ||
| client, url, cleanup := mock.HTTPClient( | ||
| mock.InstanceGetSuccess(inst, 2), | ||
| mock.CreateEphemeralSuccess(inst, 2), | ||
| ) | ||
| defer func() { | ||
| if err := cleanup(); err != nil { | ||
| t.Fatalf("%v", err) | ||
| } | ||
| }() | ||
| ctx := context.Background() | ||
| c, err := alloydbadmin.NewAlloyDBAdminRESTClient( | ||
| ctx, | ||
| option.WithHTTPClient(client), | ||
| option.WithEndpoint(url), | ||
| option.WithTokenSource(stubTokenSource{}), | ||
| ) | ||
| if err != nil { | ||
| t.Fatalf("expected NewClient to succeed, but got error: %v", err) | ||
| } | ||
| cache := NewLazyRefreshCache( | ||
| testInstanceURI(), nullLogger{}, c, | ||
| RSAKey, 30*time.Second, "", | ||
| ) | ||
|
|
||
| _, err = cache.ConnectionInfo(context.Background()) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| cache.ForceRefresh() | ||
|
|
||
| _, err = cache.ConnectionInfo(context.Background()) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters