fix(DataStore): retry on session expired requests

[lawmicha]

Issue #

#3259
More specifically #3259 (comment)

Case 1: Expired Cognito Token

Description

An expired token will be refreshed automatically when Amplify.API retrieves the token from the token provider, via Amplify.Auth. At this point, it should refresh the token if it is expired. When the token cannot be refreshed because the Refresh token is expired, then API receives an AuthError, which is wrapped in an APIError.operationError. The user needs to sign in again.

DataStore's SyncMutationToCloudOperation uses Amplify.API to make the user pool auth request and receives API.opeationError(,,AuthError.sessionExpired) error. When the session is expired, DataStore shouldn't delete mutation event because the request never made it to the service to perform the authorization check. The PR adds a check for session expired errors and goes into the exponential retry state.

Once the user signs in, and the mutation event gets sent on the next retry, then the response will be handled as normally. Mutation events should only be deleted if the response is Unauthorized, by calling errorHandler to notify the developer that we're dropping the event, then deleting it.

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.

[thisisabhash]

can we have a unit test for this change?

[lawmicha]

added!

[codecov-commenter]

Codecov Report

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

Comparison is base (f9b02de) 67.89% compared to head (570d556) 68.03%.
Report is 3 commits behind head on main.

Files	Patch %	Lines
...ngMutationQueue/SyncMutationToCloudOperation.swift	0.00%	10 Missing ⚠️

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

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3477      +/-   ##
==========================================
+ Coverage   67.89%   68.03%   +0.13%     
==========================================
  Files        1079     1069      -10     
  Lines       36359    36010     -349     
==========================================
- Hits        24687    24498     -189     
+ Misses      11672    11512     -160     

Flag	Coverage Δ
API_plugin_unit_test	67.07% <ø> (ø)
AWSPluginsCore	64.13% <ø> (ø)
Amplify	48.12% <ø> (+0.01%)	⬆️
Analytics_plugin_unit_test	81.16% <ø> (ø)
Auth_plugin_unit_test	78.99% <ø> (ø)
CoreMLPredictions_plugin_unit_test	59.44% <ø> (ø)
DataStore_plugin_unit_test	81.23% <16.66%> (+0.83%)	⬆️
Geo_plugin_unit_test	?
Logging_plugin_unit_test	63.34% <ø> (ø)
Predictions_plugin_unit_test	37.16% <ø> (ø)
PushNotifications_plugin_unit_test	87.13% <ø> (ø)
Storage_plugin_unit_test	77.51% <ø> (ø)
unit_tests	68.03% <16.66%> (+0.13%)	⬆️

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.