Repository navigation
feat(spanner): support --access_token_file in google-cloud-spanner-executor #14976
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gyang-google
wants to merge
5
commits into
googleapis:main
Choose a base branch
from
gyang-google:feat/executor-access-token-file
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
28105db
feat(spanner): support --access_token_file in google-cloud-spanner-ex…
gyang-google 0619d66
refactor(spanner): lazily load access token file on first request
gyang-google 07ae364
Merge branch 'main' into feat/executor-access-token-file
gyang-google 525915a
Merge branch 'main' into feat/executor-access-token-file
gyang-google e3a8ce3
test(spanner): use Assert.assertThrows in AccessTokenFileCredentialsTest
gyang-google File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
82 changes: 82 additions & 0 deletions
82
...-executor/src/main/java/com/google/cloud/executor/spanner/AccessTokenFileCredentials.java
This file contains hidden or 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,82 @@ | ||
| /* | ||
| * Copyright 2026 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. | ||
| */ | ||
|
|
||
| package com.google.cloud.executor.spanner; | ||
|
|
||
| import com.google.auth.oauth2.AccessToken; | ||
| import com.google.auth.oauth2.OAuth2Credentials; | ||
| import com.google.common.base.Preconditions; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.time.Duration; | ||
| import java.util.Date; | ||
| import org.apache.commons.io.FileUtils; | ||
|
|
||
| /** | ||
| * {@link OAuth2Credentials} backed by a local file containing a raw OAuth2 bearer access token. | ||
| * | ||
| * <p>An external host process periodically refreshes and atomically replaces the token file before | ||
| * the underlying OAuth2 token expires. Because the file contains only the raw token string without | ||
| * expiry metadata, each read assigns a bounded synthetic lifetime so {@link OAuth2Credentials} | ||
| * periodically re-reads the file via {@link #refreshAccessToken()}. | ||
| */ | ||
| final class AccessTokenFileCredentials extends OAuth2Credentials { | ||
|
|
||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| /** | ||
| * Assign a 15-minute synthetic lifetime to each file read. With {@link OAuth2Credentials}'s | ||
| * default refresh/expiration margins (~3m45s / 3m), cached tokens are refreshed from disk roughly | ||
| * every 11 minutes, well within a typical 1-hour OAuth2 access token lifetime. | ||
| */ | ||
| static final Duration DEFAULT_SYNTHETIC_LIFETIME = Duration.ofMinutes(15); | ||
|
|
||
| private final File tokenFile; | ||
| private final Duration syntheticLifetime; | ||
|
|
||
| AccessTokenFileCredentials(File tokenFile) { | ||
| super(null); | ||
| this.tokenFile = Preconditions.checkNotNull(tokenFile, "tokenFile"); | ||
| this.syntheticLifetime = DEFAULT_SYNTHETIC_LIFETIME; | ||
| } | ||
|
|
||
| AccessTokenFileCredentials( | ||
| File tokenFile, | ||
| Duration syntheticLifetime, | ||
| Duration refreshMargin, | ||
| Duration expirationMargin) { | ||
| super(null, refreshMargin, expirationMargin); | ||
| this.tokenFile = Preconditions.checkNotNull(tokenFile, "tokenFile"); | ||
| this.syntheticLifetime = Preconditions.checkNotNull(syntheticLifetime, "syntheticLifetime"); | ||
| Preconditions.checkArgument( | ||
| !syntheticLifetime.isNegative(), "syntheticLifetime cannot be negative"); | ||
| } | ||
|
|
||
| @Override | ||
| public AccessToken refreshAccessToken() throws IOException { | ||
| if (!tokenFile.isFile()) { | ||
| throw new IOException( | ||
| "Access token file does not exist or is not a regular file: " + tokenFile); | ||
| } | ||
| String token = FileUtils.readFileToString(tokenFile, StandardCharsets.UTF_8).trim(); | ||
| if (token.isEmpty()) { | ||
| throw new IOException("Access token file is empty: " + tokenFile); | ||
| } | ||
| Date expirationTime = new Date(System.currentTimeMillis() + syntheticLifetime.toMillis()); | ||
| return new AccessToken(token, expirationTime); | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.