ProfileTokenProvider Reload ProfileFile #3608

dave-fn · 2022-12-12T20:47:10Z

Motivation and Context

Update ProfileTokenProvider so that the generated token uses the current contents of a ProfileFile if desired. This change mimics what was done with PR 3487.

Modifications

Mirrored new behavior of ProfileCredentialsProvider.

Testing

Added single test case.

Screenshots (if appropriate)

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Checklist

I have read the CONTRIBUTING document
Local run of mvn install succeeds
My code follows the code style of this project
My change requires a change to the Javadoc documentation
I have updated the Javadoc documentation accordingly
I have added tests to cover my changes
All new and existing tests passed
I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

I confirm that this pull request can be released under the Apache 2 license

L-Applin

We lose the immutable nature of the class, which is not the end of the world if it is required, but I was wondering if there was a way to make this change while keeping the immutable nature if this class.

core/auth/src/main/java/software/amazon/awssdk/auth/token/credentials/ProfileTokenProvider.java

L-Applin · 2022-12-13T19:56:55Z

core/auth/src/main/java/software/amazon/awssdk/auth/token/credentials/ProfileTokenProvider.java

+    }
+
+    private void handleProfileFileReload(ProfileFile profileFile) {
+        tokenProvider = createTokenProvider(profileFile, profileName);


Does this need to be synchronized?

@zoewangg? If needed, will have to make same change to ProfileCredentialsProvider.

L-Applin · 2022-12-13T19:57:29Z

core/auth/src/main/java/software/amazon/awssdk/auth/token/credentials/ProfileTokenProvider.java

+
+        ProfileFile cachedOrRefreshedProfileFile = refreshProfileFile();
+        if (isNewProfileFile(cachedOrRefreshedProfileFile)) {
+            currentProfileFile = cachedOrRefreshedProfileFile;


Does this need to be synchronized?

@zoewangg? If needed, will have to make same change to ProfileCredentialsProvider.

~~Hmm, could resolveToken() be invoked by different threads at the same time? I'd assume no.~~ (update: resolveToken is invoked per request)

Yeah, not sure what the exact use case is. I'd assume a main thread would be resolving?

Took another look and I think we should use some locking mechanism. Here is an example of how it could be done: https://github.com/aws/aws-sdk-java-v2/blob/master/utils/src/main/java/software/amazon/awssdk/utils/cache/CachedSupplier.java#L185

After offline discussion, decided to use CAS

...th/src/test/java/software/amazon/awssdk/auth/token/credentials/ProfileTokenProviderTest.java

zoewangg · 2022-12-13T20:43:01Z

core/auth/src/main/java/software/amazon/awssdk/auth/token/credentials/ProfileTokenProvider.java

+
+        ProfileFile cachedOrRefreshedProfileFile = refreshProfileFile();
+        if (isNewProfileFile(cachedOrRefreshedProfileFile)) {
+            currentProfileFile = cachedOrRefreshedProfileFile;


~~Hmm, could resolveToken() be invoked by different threads at the same time? I'd assume no.~~ (update: resolveToken is invoked per request)

L-Applin

lgtm

…lock

sonarqubecloud · 2022-12-20T01:26:18Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
264 Code Smells

78.6% Coverage
4.5% Duplication

* ProfileCredentialsProvider can now reload credentials when profile files change (#3487) * ProfileFile can update if disk changed, reload as new instance * ProfileCredentialsProvider reloads credentials if profile file has changes * Created class ProfileFileRefresher * Created ReloadingProfileCredentialsProvider; moved new logic in ProfileFile to ProfileFileRefresher * Fix ReloadingProfileCredentialsBehavior when missing ProfileFile Supplier or Predicate, and dealing with defaults * Consolidated ReloadingProfileCredentialsProvider functionality into ProfileCredentialsProvider * Fix behavior when dealing with defaults * Created ProfileFileSupplier interface; refactored * Misc fixes * Created package-private ProfileFileSupplierBuilder; ProfileFileSupplier now extends Supplier; Fixed Javadoc * Fixed unit tests for default credentials file * Removed ProfileFileSupplier.Builder interface * Code cleanup * ProfileFileSupplier API changes, aggregating (#3558) * Added methods for aggregating ProfileFile objects * Removed redundant logic, changelog entry * Removed redundant methods * Use compare and set to make thread safe * DefaultCredentialsProvider reload profile (#3580) * Misc fixes * Reload credentials by DefaultCredentialsProvider; pass supplier to InstanceProfileCredentialsProvider * Fix code alignment * Update public APIs to Supplier<ProfileFile> instead of ProfileFileSupplier (#3607) * ProfileTokenProvider Reload ProfileFile (#3608) * Updated ProfileTokenProvider * Updated tests, do not explicitly swallow exceptions * ProfileTokenProviderLoader can use Supplier<Profilefile> internally * Simplified ProfileTokenProviderLoader API; implemented synchronized block * Use synchronized block (#3646) * S3 support classes take Supplier<ProfileFile> (#3653) * S3 support classes take Supplier<ProfileFile> * Review comments * Presigners, other Support classes take Supplier<ProfileFile> (#3677) * Presigners, other Support classes take Supplier<ProfileFile> * Split new ProfileFile tests from existing parameterized tests * Improved tests readability * ProfileFile updates to BaseClientBuilderClass, other S3 classes (#3685) * Leverage SdkClientOption and SdkExecutionAttributes; fallback to simp… (#3692) * Leverage SdkClientOption and SdkExecutionAttributes; fallback to simple ProfileFile * Addressed review comments * Updated changelog entry (#3699) * Fixed review comments * Removed unnecessary logic * Deprecated SdkClientOption PROFILE_FILE * Deprecated SdkExecutionAttribute PROFILE_FILE * Updated changelog entry

…8861fe626 Pull request: release <- staging/a7fc70f6-4e18-45a1-9d53-0b18861fe626

dave-fn requested a review from a team as a code owner December 12, 2022 20:47

Updated ProfileTokenProvider

9db71b4

dave-fn force-pushed the davidfn/credentials-reload branch from 495181a to 9db71b4 Compare December 12, 2022 21:48

L-Applin reviewed Dec 13, 2022

View reviewed changes

zoewangg reviewed Dec 13, 2022

View reviewed changes

Updated tests, do not explicitly swallow exceptions

82f045e

dave-fn force-pushed the davidfn/credentials-reload branch from ceeef19 to 82f045e Compare December 14, 2022 14:34

L-Applin approved these changes Dec 15, 2022

View reviewed changes

dave-fn force-pushed the davidfn/credentials-reload branch from 1091e59 to c594e62 Compare December 19, 2022 14:21

ProfileTokenProviderLoader can use Supplier<Profilefile> internally

deff952

dave-fn force-pushed the davidfn/credentials-reload branch from c594e62 to deff952 Compare December 19, 2022 17:03

Simplified ProfileTokenProviderLoader API; implemented synchronized b…

f8d76c9

…lock

zoewangg approved these changes Dec 20, 2022

View reviewed changes

dave-fn merged commit 68ff756 into feature/master/credentials-reload Dec 20, 2022

dave-fn deleted the davidfn/credentials-reload branch December 20, 2022 14:29

dave-fn mentioned this pull request Dec 20, 2022

Use synchronized block in ProfileCredentialsProvider #3646

Merged

12 tasks

aws-sdk-java-automation added a commit that referenced this pull request Jan 29, 2025

Merge pull request #3608 from aws/staging/a7fc70f6-4e18-45a1-9d53-0b1…

ad79be6

…8861fe626 Pull request: release <- staging/a7fc70f6-4e18-45a1-9d53-0b18861fe626

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ProfileTokenProvider Reload ProfileFile #3608

ProfileTokenProvider Reload ProfileFile #3608

Uh oh!

dave-fn commented Dec 12, 2022 •

edited

Loading

Uh oh!

L-Applin left a comment

Uh oh!

Uh oh!

L-Applin Dec 13, 2022

Uh oh!

dave-fn Dec 13, 2022

Uh oh!

L-Applin Dec 13, 2022

Uh oh!

dave-fn Dec 13, 2022

Uh oh!

zoewangg Dec 13, 2022 •

edited

Loading

Uh oh!

dave-fn Dec 13, 2022

Uh oh!

zoewangg Dec 13, 2022

Uh oh!

dave-fn Dec 15, 2022

Uh oh!

Uh oh!

zoewangg Dec 13, 2022 •

edited

Loading

Uh oh!

L-Applin left a comment

Uh oh!

sonarqubecloud bot commented Dec 20, 2022 •

edited

Loading

Uh oh!

Uh oh!

ProfileTokenProvider Reload ProfileFile #3608

ProfileTokenProvider Reload ProfileFile #3608

Uh oh!

Conversation

dave-fn commented Dec 12, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation and Context

Modifications

Testing

Screenshots (if appropriate)

Types of changes

Checklist

License

Uh oh!

L-Applin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

L-Applin Dec 13, 2022

Choose a reason for hiding this comment

Uh oh!

dave-fn Dec 13, 2022

Choose a reason for hiding this comment

Uh oh!

L-Applin Dec 13, 2022

Choose a reason for hiding this comment

Uh oh!

dave-fn Dec 13, 2022

Choose a reason for hiding this comment

Uh oh!

zoewangg Dec 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dave-fn Dec 13, 2022

Choose a reason for hiding this comment

Uh oh!

zoewangg Dec 13, 2022

Choose a reason for hiding this comment

Uh oh!

dave-fn Dec 15, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

zoewangg Dec 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

L-Applin left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Dec 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

dave-fn commented Dec 12, 2022 •

edited

Loading

zoewangg Dec 13, 2022 •

edited

Loading

zoewangg Dec 13, 2022 •

edited

Loading

sonarqubecloud bot commented Dec 20, 2022 •

edited

Loading