Fix ChatClient.currentUserId not removed instantly after calling logout()

[nuno-vieira]

🔗 Issue Links

https://linear.app/stream/issue/IOS-1056

🎯 Goal

Fixes ChatClient.currentUserId not removed instantly after calling logout().

🛠 Implementation

Initially, I removed the currentUser data, only after the removeDevice was called, since it was not possible to create the current user controller without the currentUserId. But actually, now I just realised that we can just create the controller, and right after erase the current user local data.

Now, ff a customer runs this code, it will be correct:

client.logout()
print(client.currentUserId) // nil

🧪 Manual Testing Notes

N/A. Covered by tests.

☑️ Contributor Checklist

• I have signed the Stream CLA (required)
• This change should be manually QAed
• Changelog is updated with client-facing changes
• Changelog is updated with new localization keys
• New code is covered by unit tests
• Documentation has been updated in the docs-content repo

Summary by CodeRabbit

• Bug Fixes

  • Improved the logout process to ensure user logout occurs immediately when initiated, regardless of device removal.

• Tests

  • Enhanced tests to verify that user logout is triggered right after logout is called, ensuring correct operation order.

[coderabbitai]

Walkthrough

The logout logic in ChatClient was revised so that authenticationRepository.logOutUser() is now called immediately upon logout initiation, regardless of device removal. Corresponding tests were updated to assert that user ID erasure occurs right after logout is invoked, ensuring the correct order of operations.

Changes

Cohort / File(s)	Change Summary
ChatClient logout logic Sources/StreamChat/ChatClient.swift	Changed logout flow to unconditionally call authenticationRepository.logOutUser() immediately at logout start, independent of device removal.
Logout order test update Tests/StreamChatTests/ChatClient_Tests.swift	Adjusted test to assert that user ID erasure is triggered immediately after logout is called, before waiting for async completion.
Changelog update CHANGELOG.md	Added a bugfix entry noting the immediate removal of currentUserId after logout.

Sequence Diagram(s)

sequenceDiagram
    participant Client as ChatClient
    participant AuthRepo as authenticationRepository
    participant DeviceRepo as deviceRepository

    Client->>AuthRepo: logOutUser()
    alt removeCurrentDevice == true
        Client->>DeviceRepo: removeDevice()
        DeviceRepo-->>Client: completion
    end
    Client->>Client: Stop tracking, disconnect, clear local data

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Ensure current user ID is cleared immediately after calling logout() (IOS-1056)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Poem

A logout leap, so swift and bright,
The user ID now takes quick flight.
No more delay or waiting game—
The logout flow is not the same!
With tests in tow, it’s all precise,
This bunny’s code is extra nice.
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4ec8a32 and c0831b8.

📒 Files selected for processing (1)

• CHANGELOG.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• CHANGELOG.md

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/logout-not-removing-device-instantly

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

Public Interface

🚀 No changes affecting the public interface.

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	7.92 MB	7.92 MB	0 KB	🟢
StreamChatUI	4.84 MB	4.84 MB	0 KB	🟢

[Stream-SDK-Bot]

SDK Performance

target	metric	benchmark	branch	performance	status
MessageList	Hitches total duration	10 ms	21.7 ms	-117.0% 🔽	🔴
	Duration	2.6 s	2.54 s	2.31% 🔼	🟢
	Hitch time ratio	4 ms per s	8.55 ms per s	-113.75% 🔽	🔴
	Frame rate	75 fps	78.86 fps	5.15% 🔼	🟢
	Number of hitches	1	1.4	-40.0% 🔽	🔴

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud