fix(core): ensure StreamChannel future completes after channel initialization

[xsahil03x]

Submit a pull request

Fixes: #2323

Description of the pull request

The StreamChannel widget's _channelInitFuture could previously complete before the underlying channel.initialized future. This change ensures that _channelInitFuture now waits for both the channel's initialization process and the channel.initialized future to complete.

Summary by CodeRabbit

• Bug Fixes

  • Improved the reliability of channel initialization, ensuring the channel is fully initialized before proceeding.
  • Enhanced error handling for channel initialization failures, providing clearer error messages when issues occur.

• Tests

  • Updated mock channel classes to better simulate asynchronous initialization states for more accurate testing.
  • Removed redundant mocking of channel initialization state in message list tests.

[coderabbitai]

Walkthrough

This change updates the StreamChannel widget in the stream_chat_flutter_core package to ensure its future builder waits for both channel initialization and the completion of _maybeInitChannel(). Error handling is improved with a helper to unwrap parallel errors, and test mocks are updated to reflect asynchronous channel initialization. Additionally, some test code removing redundant mocking of the initialized property was done.

Changes

File(s)	Change Summary
packages/stream_chat_flutter_core/CHANGELOG.md	Added changelog entry describing the fix for channel initialization timing in StreamChannel.
packages/stream_chat_flutter_core/lib/src/stream_channel.dart	Enhanced error handling with unwrapParallelError; changed _channelInitFuture to wait for both channel init steps.
packages/stream_chat_flutter_core/test/mocks.dart	Updated MockChannel and NonInitializedMockChannel to override initialized as an async getter with explicit values.
packages/stream_chat_flutter_core/test/message_list_core_test.dart	Removed mocking of initialized property on mockChannel in tests.

Sequence Diagram(s)

sequenceDiagram
    participant Widget as StreamChannel
    participant Channel as Channel
    participant FutureBuilder as FutureBuilder

    Widget->>Channel: _maybeInitChannel()
    Widget->>Channel: channel.initialized
    Note right of Widget: Waits for both futures to complete
    Widget->>FutureBuilder: Build with _channelInitFuture
    FutureBuilder->>Widget: Render child when both complete
    FutureBuilder->>Widget: Show loading/error as appropriate

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

• fix(core): handle channel reload failure on dispose #2311: Modifies StreamChannel initialization logic, directly related to ensuring proper channel readiness before rendering children.

Suggested reviewers

• renefloor

Poem

In the meadow where channels hop,
A future waits—no premature stop!
Errors unwrapped, like carrots revealed,
Initialization now properly sealed.
With every async hop and bound,
Our chat is safe and sound!
🥕✨

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 3f4ea79 and 62d5847.

📒 Files selected for processing (1)

• packages/stream_chat_flutter_core/test/message_list_core_test.dart (0 hunks)

💤 Files with no reviewable changes (1)

• packages/stream_chat_flutter_core/test/message_list_core_test.dart

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (9)

• GitHub Check: test
• GitHub Check: build (android)
• GitHub Check: analyze
• GitHub Check: stream_chat_flutter
• GitHub Check: stream_chat_localizations
• GitHub Check: stream_chat_flutter_core
• GitHub Check: stream_chat_persistence
• GitHub Check: stream_chat
• GitHub Check: analyze_legacy_versions

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/issue-2323

---

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.
  • @coderabbitai modularize this function.
• 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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.

[codecov]

Codecov Report

Attention: Patch coverage is 87.50000% with 1 line in your changes missing coverage. Please review.

Project coverage is 63.65%. Comparing base (72d6e35) to head (62d5847).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
...ream_chat_flutter_core/lib/src/stream_channel.dart	87.50%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2324   +/-   ##
=======================================
  Coverage   63.64%   63.65%           
=======================================
  Files         409      409           
  Lines       25605    25609    +4     
=======================================
+ Hits        16297    16301    +4     
  Misses       9308     9308           

☔ View full report in Codecov by Sentry.
📢 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.