Skip to content
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

feat(Auth): Adding network preferences #3379

Merged
merged 5 commits into from
Dec 7, 2023
Merged

Conversation

harsh62
Copy link
Member

@harsh62 harsh62 commented Nov 24, 2023

Issue #

#3004

Description

This PR aims to add network preferences (AWSCognitoNetworkPreferences ) back to the Auth plugin which were accidentally removed while release Amplify V2.

This preference helps control

  • Max number of retries the underlying SDK client will make
  • The connection timeout that the underlying SDK client should set.

Example configuration:

        let plugin = AWSCognitoAuthPlugin(
            networkPreferences: .init(
                maxRetryCount: 2,
                timeoutIntervalForRequest: 60,
                timeoutIntervalForResource: 60))
        try Amplify.add(plugin: plugin)

NOTE: Resource time out is only applicable to HostedUI ATM, because the underlying Swift SDK does not support resource timeouts. Hence timeoutIntervalForResource has been made an optional.

General Checklist

  • Added new tests to cover change, if needed
  • Build succeeds with all target using Swift Package Manager
  • All unit tests pass
  • All integration tests pass
  • Security oriented best practices and standards are followed (e.g. using input sanitization, principle of least privilege, etc)
  • Documentation update for the change if required
  • PR title conforms to conventional commit style
  • New or updated tests include Given When Then inline code documentation and are named accordingly testThing_condition_expectation()
  • If breaking change, documentation/changelog update with migration instructions

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@codecov-commenter
Copy link

codecov-commenter commented Nov 24, 2023

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Comparison is base (b9b5918) 68.17% compared to head (b5b8e2b) 68.13%.

Files Patch % Lines
...itoAuthPlugin/AWSCognitoAuthPlugin+Configure.swift 71.42% 4 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3379      +/-   ##
==========================================
- Coverage   68.17%   68.13%   -0.04%     
==========================================
  Files        1077     1078       +1     
  Lines       35973    35994      +21     
==========================================
+ Hits        24523    24525       +2     
- Misses      11450    11469      +19     
Flag Coverage Δ
API_plugin_unit_test 67.07% <ø> (ø)
AWSPluginsCore 64.59% <ø> (ø)
Amplify 47.81% <ø> (ø)
Analytics_plugin_unit_test 81.16% <ø> (ø)
Auth_plugin_unit_test 79.58% <80.95%> (+0.12%) ⬆️
CoreMLPredictions_plugin_unit_test 59.44% <ø> (ø)
DataStore_plugin_unit_test 80.56% <ø> (-0.42%) ⬇️
Geo_plugin_unit_test 70.75% <ø> (ø)
Logging_plugin_unit_test 63.09% <ø> (ø)
Predictions_plugin_unit_test 37.29% <ø> (ø)
PushNotifications_plugin_unit_test 87.03% <ø> (ø)
Storage_plugin_unit_test 78.00% <ø> (ø)
unit_tests 68.13% <80.95%> (-0.04%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@harsh62 harsh62 marked this pull request as ready for review November 24, 2023 18:43
@harsh62 harsh62 requested a review from a team as a code owner November 24, 2023 18:43
Copy link
Contributor

@lawmicha lawmicha left a comment

Choose a reason for hiding this comment

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

questions regarding the types in AWSCognitoNetworkPreferences. Not sure if there's an opportunity here to change some of the types of those properties considering we are adding back something that was taken out by accident.

…nitoNetworkPreferences.swift

Co-authored-by: Sebastian Villena <[email protected]>
@harsh62 harsh62 merged commit 56d5339 into main Dec 7, 2023
76 checks passed
@harsh62 harsh62 deleted the auth-network-preferences branch December 7, 2023 18:37
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.

4 participants