Skip to content

Prefer Supplier<ProfileFile> over ProfileFileSupplier in APIs #3607

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

Merged

Conversation

dave-fn
Copy link
Contributor

@dave-fn dave-fn commented Dec 9, 2022

Motivation and Context

In order to keep the APIs consistent, current public methods taking ProfileFileSupplier as an argument will be switched over to Supplier<ProfileFile>. The former class is a subclass of the latter, so this is not a breaking change.

Testing

Only existing test cases.

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

@dave-fn dave-fn requested a review from a team as a code owner December 9, 2022 17:35
Copy link
Contributor

@cenedhryn cenedhryn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see any test changes? Can you add tests where both ProfileFileSupplier and Supplier is submitted to the builder?

@dave-fn dave-fn force-pushed the davidfn/credentials-reload branch from 39b168f to b39dc71 Compare December 9, 2022 19:19
@@ -63,6 +64,39 @@ void resolveCredentials_requestFallsIntoProfileCredentialsProviderWithProfileFil
});
}

@Test
void resolveCredentials_requestFallsIntoProfileCredentialsProviderWithProfileFileSupplier_returnsCredentials() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "requestFallsInto" mean? Is it even necessary in any of the test names?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It refers to the provider within the chain doing the actual resolving. Will update test case names.

@dave-fn dave-fn force-pushed the davidfn/credentials-reload branch from b39dc71 to 468fce7 Compare December 10, 2022 00:08
@sonarqubecloud
Copy link

sonarqubecloud bot commented Dec 10, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

85.0% 85.0% Coverage
0.2% 0.2% Duplication

@dave-fn dave-fn merged commit 2f8f819 into feature/master/credentials-reload Dec 12, 2022
dave-fn added a commit that referenced this pull request Feb 6, 2023
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants