fix: avoid FALSEPREDICATE for user-defined FilterKey

[kaijietti]

🔗 Issue Links

None. The issue is easy to reproduce.

Filter is mainly used in two cases:

1. Construct the payload of the request sent to Stream backend API.
2. Construct the predicate of the request sent to CoreData Database.

After creating a ChatChannelListController, the controller owns a query inside which is a filter. The filter is mix-used in the above two cases.
On one hand, stream API supprt filtering extraData of channel. So user can defined their custom field via extension:

extension FilterKey where Scope: AnyChannelListFilterScope {
  static var customField1: FilterKey<Scope, Bool> { "customField1" }
  static var customField2: FilterKey<Scope, String> { "customField2" }
}

and use it in this way:

extension ChannelListQuery {
  static func custom(id: UserModel.ID) -> Self {
    Self(
      filter: .and([
        .or([
          .equal(.customField1, to: true),
          .or([
            .equal(.customField2, to: "1"),
            .equal(.customField2, to: "2"),
          ])
        ]),
        .containMembers(userIds: [id.rawValue]),
        .equal(.frozen, to: false),
        .equal(.hidden, to: false),
        .equal(.disabled, to: false),
      ]),
      sort: [.init(key: .lastMessageAt)],
      pageSize: 20,
      messagesLimit: 3
    )
  }
}

We have checked the the query sent to the stream backend is correct as it should be.

However, on the other hand, the filter inside the query is also used in the process of constructing predicate of request sent to the local Database. And since the custom FilterKey has no related ChannelDTO field, so the KeyPathString is nil, and thus for all custom FilterKey, the predicate is actually a nil. This works fine when the filter is so flat. But when all the subpredicates inside a logicalPredicate are custom Filterkey, all the NSPredicate? they return is nil and thus being filtered out when using .compactMap(...), and the predicate would be NSCompoundPredicate(andPredicateWithSubpredicates: []) or NSCompoundPredicate(orPredicateWithSubpredicates: []) which is actually a FALSEPREDICATE. And since the final predicate is an .and operator, the predicate is always false and no data is fetched back.

stream-chat-swift/Sources/StreamChat/Database/DTOs/ChannelDTO.swift

Lines 411 to 415 in f908d69

	if chatClientConfig.isChannelAutomaticFilteringEnabled, let filterPredicate = query.filter.predicate {
	subpredicates.append(filterPredicate)
	}
	request.predicate = NSCompoundPredicate(type: .and, subpredicates: subpredicates)

🎯 Goal

Make sure the request SQL sent to the CoreData DB is correct (or, avoid FALSEPREDICATE) when user is using compound predicate in which all the subpredicates are related to user-defined FilterKey.

📝 Summary

Provide bullet points with the most important changes in the codebase.

🛠 Implementation

Provide a detailed description of the implementation and explain your decisions if you find them relevant.

🎨 Showcase

Add relevant screenshots and/or videos/gifs to easily see what this PR changes, if applicable.

Before	After
img	img

🧪 Manual Testing Notes

Explain how this change can be tested manually, if applicable.

☑️ 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
• Comparison screenshots added for visual changes
• Affected documentation updated (docusaurus, tutorial, CMS)

🎁 Meme

Provide a funny gif or image that relates to your work on this pull request. (Optional)

[laevandus]

@kaijietti Thank you for the PR. I have verified this change.

Could you please replace predicates.count > 0 with !predicates.isEmpty due to our enforced formatting rules. If this is done, I will then proceed with merging this PR after verifying that it passes all the CI checks (I will run it separately).

[kaijietti]

@laevandus I replaced in the latest commit, please take a look, thanks!

[nuno-vieira]

@kaijietti @laevandus Would be nice to add this edge case to the ChatChannelListController_Tests.test_filterPredicate_XXX... tests. So that we do not have regressions in the future 🙏

[laevandus]

I'll merge this PR and will create a new one with tests and changelog entry.

[laevandus]

Note, I ran these changes on a CI in a separate job and all was green.

[laevandus]

As said, I'll open a follow-up PR to add some tests and fill in the changelog.