Keep hidden state unchanged when receiving campaign message #3851

laevandus · 2025-10-22T11:31:37Z

🔗 Issue Links

🎯 Goal

Keep channel hidden state unchanged wen receiving campaign message

📝 Summary

If new message is from campaign, do not change hidden status because campaign API does that automatically through show_channels: true/false configuration

🛠 Implementation

Campaign API has a setting called show_channels. If it is true, channels are automatically shown, if false, hidden state is not changed. On the other hand SDKs support "Hiding a channel will remove it from query channel requests for that user until a new message is added." (docs). Only way for supporting both is opting out of showing channels on the SDK side when receiving a new message if the message is from campaign API.

🎨 Showcase

🧪 Manual Testing Notes

Download the script

Log in with anakin (hide the existing campaign channel if it is visible from previous testing)
Send a message with campaign API script when show_channels: false - channel does not appear in the channel list
Send a message with campaign API script when show_channels: true - channel appears in the channel list

☑️ 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
- Fixed an issue where channels were incorrectly displayed when receiving campaign messages with visibility settings set to false. Channels now properly maintain their hidden state when handling campaign-related messages.

coderabbitai · 2025-10-22T11:32:10Z

Walkthrough

The PR adds a campaignId field to the MessagePayload structure and modifies channel visibility logic to prevent campaign messages from unhiding user-hidden channels. Campaign messages with the show_channels: false setting now respect the user's channel visibility preferences.

Changes

Cohort / File(s)	Change Summary
Changelog `CHANGELOG.md`	Adds entry documenting fix for campaign messages incorrectly unhiding hidden channels (issue #3851).
Campaign ID Support `Sources/StreamChat/APIClient/Endpoints/Payloads/MessagePayloads.swift`	Introduces new optional `campaignId: String?` field to `MessagePayload` with corresponding coding key mapping to `"created_by_campaign_id"`; includes decoder and initializer updates.
Middleware Logic `Sources/StreamChat/WebSocketClient/EventMiddlewares/ChannelVisibilityEventMiddleware.swift`	Adds condition to prevent channel unhiding for messages with `campaignId` (only unhides when message is not shadowed AND has no campaignId).
Test Utilities `TestTools/StreamChatTestTools/TestData/DummyData/MessagePayload.swift`	Adds `campaignId: String? = nil` parameter to `MessagePayload.dummy()` helper function for test data generation.
Middleware Tests `Tests/StreamChatTests/WebSocketClient/EventMiddlewares/ChannelVisibilityEventMiddleware_Tests.swift`	Adds two new tests verifying that `MessageNewEvent` and `NotificationMessageNewEvent` with campaignId do not unhide hidden channels.

Sequence Diagram

sequenceDiagram
    participant Client
    participant Middleware as ChannelVisibilityEventMiddleware
    participant ChannelDB as Channel Database

    rect rgb(200, 220, 255)
    Note over Client,ChannelDB: Regular Message Flow
    Client->>Middleware: MessageNewEvent (no campaignId)
    Middleware->>ChannelDB: Check isHidden & isShadowed
    alt Not shadowed
        Middleware->>ChannelDB: Set isHidden = false
    end
    end

    rect rgb(220, 255, 200)
    Note over Client,ChannelDB: Campaign Message Flow (NEW)
    Client->>Middleware: MessageNewEvent (campaignId present)
    Middleware->>ChannelDB: Check isHidden, isShadowed, & campaignId
    alt Has campaignId
        Middleware->>ChannelDB: Keep isHidden unchanged
    else No campaignId and not shadowed
        Middleware->>ChannelDB: Set isHidden = false
    end
    end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Show message with restricted visiblity in the message list on the message.updated web-socket event #3674: Modifies MessagePayload to add restrictedVisibility field; related at code-level through shared payload structure changes.

Suggested labels

🌐 SDK: StreamChat (LLC)

Suggested reviewers

martinmitrevski

Poem

🐰 A campaign whispers through the wire,
Yet hidden channels stay unseen!
With campaignId as our guide,
No unwanted reveals between,
The user's privacy runs true. 🤫✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 14.29% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The PR title "Keep hidden state unchanged when receiving campaign message" directly and clearly describes the primary objective of the changeset. The title is concise, specific, and accurately reflects the key behavioral change being implemented—preventing channels from being automatically unhidden when receiving campaign API messages. A developer scanning the repository history would immediately understand the purpose of this change without needing to examine the details.
Linked Issues Check	✅ Passed	The code changes fully implement the objectives from IOS-1194. The PR adds a `campaignId` field to `MessagePayload` to identify campaign-originated messages, modifies `ChannelVisibilityEventMiddleware` to skip unhiding channels when `campaignId` is present (allowing Campaign API's `show_channels` setting to control visibility), includes corresponding test helper updates, and adds unit tests verifying that campaign messages do not reset the hidden state. All coding-related requirements from the linked issue have been addressed through these implementation changes.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch fix/keeping-channel-hidden-for-campaign-messages

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

Sources/StreamChat/WebSocketClient/EventMiddlewares/ChannelVisibilityEventMiddleware.swift (1)
37-39: Consider adding inline documentation for campaign message exclusion

The logic correctly prevents campaign messages from unhiding channels, which aligns with the Campaign API's show_channels configuration controlling visibility. However, the reasoning might not be immediately obvious to future maintainers.

Consider adding a brief comment explaining why campaign messages are excluded:
// Campaign messages don't unhide channels because visibility is controlled 
// by the Campaign API's show_channels configuration
if !event.message.isShadowed && event.message.campaignId == nil && !channelDTO.isBlocked {
    channelDTO.isHidden = false
}
Also applies to: 48-50

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 9178258 and 813bab4.

📒 Files selected for processing (5)

CHANGELOG.md (1 hunks)
Sources/StreamChat/APIClient/Endpoints/Payloads/MessagePayloads.swift (5 hunks)
Sources/StreamChat/WebSocketClient/EventMiddlewares/ChannelVisibilityEventMiddleware.swift (2 hunks)
TestTools/StreamChatTestTools/TestData/DummyData/MessagePayload.swift (2 hunks)
Tests/StreamChatTests/WebSocketClient/EventMiddlewares/ChannelVisibilityEventMiddleware_Tests.swift (2 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

**/*.swift