-
Notifications
You must be signed in to change notification settings - Fork 69
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 lazy refresh strategy (#1093)
Add refresh_strategy argument to Connector() that allows setting the strategy to "lazy" to use a lazy refresh strategy. When creating a Connector via Connector(refresh_strategy="lazy"), the connection info and ephemeral certificate will be refreshed only when the cache certificate has expired. No background tasks run periodically with this option, making it ideal for use in serverless environments such as Cloud Run, Cloud Functions, etc, where the CPU may be throttled.
- Loading branch information
1 parent
b0c699e
commit b9526bb
Showing
7 changed files
with
313 additions
and
55 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
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
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,132 @@ | ||
| # 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 | ||
| # | ||
| # http://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. | ||
|
|
||
| import asyncio | ||
| from datetime import datetime | ||
| from datetime import timedelta | ||
| from datetime import timezone | ||
| import logging | ||
| from typing import Optional | ||
|
|
||
| from google.cloud.sql.connector.client import CloudSQLClient | ||
| from google.cloud.sql.connector.connection_info import ConnectionInfo | ||
| from google.cloud.sql.connector.instance import _parse_instance_connection_name | ||
| from google.cloud.sql.connector.refresh_utils import _refresh_buffer | ||
|
|
||
| logger = logging.getLogger(name=__name__) | ||
|
|
||
|
|
||
| class LazyRefreshCache: | ||
| """Cache that refreshes connection info when a caller requests a connection. | ||
| Only refreshes the cache when a new connection is requested and the current | ||
| certificate is close to or already expired. | ||
| This is the recommended option for serverless environments. | ||
| """ | ||
|
|
||
| def __init__( | ||
| self, | ||
| instance_connection_string: str, | ||
| client: CloudSQLClient, | ||
| keys: asyncio.Future, | ||
| enable_iam_auth: bool = False, | ||
| ) -> None: | ||
| """Initializes a LazyRefreshCache instance. | ||
| Args: | ||
| instance_connection_string (str): The Cloud SQL Instance's | ||
| connection string (also known as an instance connection name). | ||
| client (CloudSQLClient): The Cloud SQL Client instance. | ||
| keys (asyncio.Future): A future to the client's public-private key | ||
| pair. | ||
| enable_iam_auth (bool): Enables automatic IAM database authentication | ||
| (Postgres and MySQL) as the default authentication method for all | ||
| connections. | ||
| """ | ||
| # validate and parse instance connection name | ||
| self._project, self._region, self._instance = _parse_instance_connection_name( | ||
| instance_connection_string | ||
| ) | ||
| self._instance_connection_string = instance_connection_string | ||
|
|
||
| self._enable_iam_auth = enable_iam_auth | ||
| self._keys = keys | ||
| self._client = client | ||
| self._lock = asyncio.Lock() | ||
| self._cached: Optional[ConnectionInfo] = None | ||
| self._needs_refresh = False | ||
|
|
||
| async def force_refresh(self) -> None: | ||
| """ | ||
| Invalidates the cache and configures the next call to | ||
| connect_info() to retrieve a fresh ConnectionInfo instance. | ||
| """ | ||
| async with self._lock: | ||
| self._needs_refresh = True | ||
|
|
||
| async def connect_info(self) -> ConnectionInfo: | ||
| """Retrieves ConnectionInfo instance for establishing a secure | ||
| connection to the Cloud SQL instance. | ||
| """ | ||
| async with self._lock: | ||
| # If connection info is cached, check expiration. | ||
| # Pad expiration with a buffer to give the client plenty of time to | ||
| # establish a connection to the server with the certificate. | ||
| if ( | ||
| self._cached | ||
| and not self._needs_refresh | ||
| and datetime.now(timezone.utc) | ||
| < (self._cached.expiration - timedelta(seconds=_refresh_buffer)) | ||
| ): | ||
| logger.debug( | ||
| f"['{self._instance_connection_string}']: Connection info " | ||
| "is still valid, using cached info" | ||
| ) | ||
| return self._cached | ||
| logger.debug( | ||
| f"['{self._instance_connection_string}']: Connection info " | ||
| "refresh operation started" | ||
| ) | ||
| try: | ||
| conn_info = await self._client.get_connection_info( | ||
| self._project, | ||
| self._region, | ||
| self._instance, | ||
| self._keys, | ||
| self._enable_iam_auth, | ||
| ) | ||
| except Exception as e: | ||
| logger.debug( | ||
| f"['{self._instance_connection_string}']: Connection info " | ||
| f"refresh operation failed: {str(e)}" | ||
| ) | ||
| raise | ||
| logger.debug( | ||
| f"['{self._instance_connection_string}']: Connection info " | ||
| "refresh operation completed successfully" | ||
| ) | ||
| logger.debug( | ||
| f"['{self._instance_connection_string}']: Current certificate " | ||
| f"expiration = {str(conn_info.expiration)}" | ||
| ) | ||
| self._cached = conn_info | ||
| self._needs_refresh = False | ||
| return conn_info | ||
|
|
||
| async def close(self) -> None: | ||
| """Close is a no-op and provided purely for a consistent interface with | ||
| other cache types. | ||
| """ | ||
| pass |
Oops, something went wrong.