Skip to content

docs(auth): fix AmplifyCognitoClient doc inconsistencies - #4408

Open
harsh62 wants to merge 1 commit into
mainfrom
docs/cognito-client-doc-fixes
Open

harsh62 wants to merge 1 commit into
mainfrom
docs/cognito-client-doc-fixes

Conversation

@harsh62

@harsh62 harsh62 commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes inconsistencies in the AmplifyCognitoClient docs. No code changes, apart from a doc comment.

  • Credentials example. The class doc comment and the README's "Credentials for other AmplifyClients" example
    passed work.credentialsProvider to an AmplifyKinesisClient. Kinesis and Firehose share one offline cache per
    region, so two sessions that each wire one up can send each other's records (README, "Known limitations"). Both
    examples now use AmplifyConnectClient, as the design does for this example, and the README says why Kinesis and
    Firehose need care.
  • README "Differences from the Auth plugin" table.
    • Events for autoSignIn() and clearFederationToIdentityPool(): the plugin sends an API Hub event for each, just
      no lifecycle event. The table said "No Hub event".
    • Second sign-in: the rule now covers a session restored with an expiry saved by an earlier launch. The table still
      said "in this process".
  • Decision 15 and design §14.8. Both list the hosted-UI sign-out page that can't be shown as .failed. Neither
    said that a sign-out given no window (signOut(options:), signOutStoredSession) shows no page and is .partial
    with hostedUIError, as §4.7 and the README already say.
  • Design change log. Limit 6 was restated in an earlier revision with no entry. The new entry records what it used
    to say, and that restoring it is an open question.

General Checklist

  • Documentation update
  • Commit messages follow the Conventional Commits convention

- Use Connect, not Kinesis, as the credentials-provider example in the class
  doc comment and the README, and warn that Kinesis and Firehose share one
  offline cache per region.
- README differences table: the plugin sends an API Hub event (no lifecycle
  event) for autoSignIn() and clearFederationToIdentityPool(), and the
  second sign-in rule covers an expiry saved by an earlier launch.
- Decision 15 and design §14.8: a sign-out given no window shows no hosted-UI
  sign-out page and is .partial with hostedUIError.
- Design change log: record the earlier restatement of limit 6.
@harsh62
harsh62 requested a review from a team as a code owner November 3, 2026 14:33
@harsh62
harsh62 deployed to IntegrationTest November 3, 2026 14:34 — with GitHub Actions Active
@harsh62
harsh62 deployed to IntegrationTest November 3, 2026 14:34 — with GitHub Actions Active
@harsh62
harsh62 deployed to IntegrationTest November 3, 2026 14:34 — with GitHub Actions Active
@harsh62
harsh62 deployed to IntegrationTest November 3, 2026 14:34 — with GitHub Actions Active
@harsh62
harsh62 deployed to IntegrationTest November 3, 2026 14:34 — with GitHub Actions Active
@codecov

codecov Bot commented Nov 3, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.17%. Comparing base (5a9f3f0) to head (056e75f).

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #4408       +/-   ##
===========================================
+ Coverage   76.04%   88.17%   +12.13%     
===========================================
  Files        1362      487      -875     
  Lines       57864    25405    -32459     
===========================================
- Hits        44003    22401    -21602     
+ Misses      13861     3004    -10857     
Flag Coverage Δ
API_plugin_unit_test ?
AWSPluginsCore ?
Amplify ?
Amplify_Foundation_Bridge_unit_test ?
Amplify_Foundation_unit_test ?
Amplify_Keychain_unit_test ?
Analytics_plugin_unit_test ?
Auth_plugin_unit_test 84.03% <ø> (+0.03%) ⬆️
CloudWatchClient_unit_test ?
CognitoClient_unit_test 95.58% <ø> (ø)
Connect_unit_test ?
DataStore_plugin_unit_test ?
EventEnrichment_unit_test ?
Firehose_plugin_unit_test ?
Geo_plugin_unit_test ?
Kinesis_plugin_unit_test ?
Logging_plugin_unit_test ?
Predictions_plugin_unit_test ?
PushNotifications_plugin_unit_test ?
RecordCache_unit_test ?
Storage_plugin_unit_test ?
unit_tests 88.17% <ø> (+12.13%) ⬆️

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

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

1 participant