Repository navigation
ENG-41633: docs(conversations): tag filters apply to the initial fetch only - #625
ketanyekale wants to merge 1 commit into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
raj-dubey1
left a comment
There was a problem hiding this comment.
Automated first-pass review (Claude), Raj hasn't reviewed this yet and will do the final review.
Requested by Ketan Yekale on Slack · commit 36d6e5ed58
Needs discussion. PR #625 adds one identical <Note> block to 12 conversations docs pages, stating that tag filters apply only at fetch time and aren't re-evaluated on real-time message events "because real-time message events don't include tags." The MDX is valid, the wording is consistent across all files, and the version scoping is correct (every current-version page updated; only older v4/v5/v6 pages skipped). The blocking concern is accuracy: the behavioral claim — especially the causal "because…" clause — could not be verified from this docs-only worktree and needs confirmation (or a source citation) from the SDK/UI-Kit owner before merge, since the whole PR asserts it as fact. One page (Vue) gets the note with no surrounding tag-filter content, making it orphaned.
Findings
- 🟠 major
sdk/javascript/retrieve-conversations.mdx:250: Core behavioral claim unverified; the "because real-time message events don't include tags" mechanism is an over-claim
The note is added as fact to all 12 files (e.g. sdk/javascript/retrieve-conversations.mdx:250-252, ui-kit/react/components/conversations.mdx:307-309). The observable behavior (tag filter applied at fetch, not re-evaluated when a conversation moves/updates on a new message) is plausible and consistent with how the SDK's ConversationsRequest + real-time message listener work, but it could NOT be verified: this worktree contains only the docs repo (no Chat SDK / UI-Kit source), and nothing in the docs supports or refutes it. The second clause — 'because real-time message events don't include tags' — is a specific causal mechanism that is riskier: (a) it is logically shaky, since the filter would not be re-applied on a live update regardless of whether the event payload carries tags, so the stated cause may be wrong even if the effect is right; (b) it conflates message-level payloads with conversation-level tag filtering; (c) the UI-Kit conversations pages involve component-level update logic beyond raw SDK message events, so the blanket SDK-mechanism claim may not hold uniformly across the 7 UI-Kit pages. Suggested fix: confirm the behavior with the SDK/UI-Kit owner and cite the source listener code, OR soften the note to the observable behavior only and drop the unverified 'because…' clause (e.g. 'Tag filters are applied when the list is fetched and are not re-evaluated as conversations update in real time, so a conversation already in the list is not removed if its tags would no longer match.'). - 🟡 minor
ui-kit/vue/conversations.mdx:75: Vue note is orphaned — page has no tag-filter content
On ui-kit/vue/conversations.mdx the note is inserted at line 75 under### RequestBuilder, directly after the genericconversationsRequestBuilderproperty table. Verified: the ONLY occurrence of 'tag' anywhere on this page is the note text itself (grep -ni 'tag' returns only line 75). Unlike the other 11 pages, there is no tag-filtering example or table nearby to give the reader context, so the caveat appears with nothing to attach to. Suggested fix: either remove the note from the Vue page (it has no tag-filter UX documented), or add a brief tag-filter example/row and place the note next to it. - ⚪ nit
ui-kit/angular/components/cometchat-conversations.mdx:451: Angular note placement is loose (follows a generic requestBuilder example, not tag-specific content)
On ui-kit/angular/components/cometchat-conversations.mdx the note is inserted at line 451, right after a generic FilteredConversationsComponent code example rather than immediately beside tag-specific content. It is acceptable (the page does cover tag filtering, e.g. the withTags snippet earlier), but the association to tag filtering is weaker than on the SDK pages where the note sits directly after the 'Set Tags' section. Suggested fix: optionally move the note adjacent to the tag-filter example for a tighter association; low priority.
Checks run
| Command | Exit | Result |
|---|---|---|
git diff origin/main...HEAD (and --stat) |
0 | 12 files changed, 48 insertions(+); verified the same 4-line block added to each, wording identical, blank lines around each JSX block (MDX-valid). |
git log --oneline -5 / git rev-parse origin/main HEAD |
0 | Head 36d6e5e, base 8a3486b confirmed. |
sed -n / grep -ni 'tag' ui-kit/vue/conversations.mdx |
0 | Only match is line 75 (the note itself) — confirms Vue note is orphaned; placed under '### RequestBuilder'. |
Glob for 5 'skipped' pages + Grep [Tt]ag counts |
0 | All 5 pages exist and contain tag content (android unversioned 52, flutter/v4 69, ui-kit android/v5 3, flutter/v5 9, react/v6 3). |
grep -n '"version"' docs.json (version-group bracketing of conversation entries) |
0 | Confirmed skipped pages are OLDER versions: sdk/android/retrieve-conversations=v4 (current v5 WAS updated), sdk/flutter/v4=v4, ui-kit android/v5 & flutter/v5=v5, react/v6=v6 (current UI Kit=v7, which |
grep -rln '<Note>' sdk/javascript |
0 | is a standard, widely-used Mintlify component in this repo — insertions are valid MDX; no build/link risk (no new links or nav entries added). |
docs build / mintlify broken-links |
-1 | NOT RUN — no docs lint/build command found in repo; change adds no links or navigation entries so build-break risk is low but unverified. Per brief: no live/e2e. |
This comment doesn't approve or block the PR.
Why
ENG-41633 / Zendesk #45926: a Vue UI Kit customer filtering conversations by tags saw filtered-out conversations reappear when new messages arrived. Tag filters on
ConversationsRequestBuilderapply only when the list is fetched; real-time message events don't carry tags, so the Conversations component updates or adds the conversation without re-checking it against the filter.What changed
Added the same short
<Note>next to the tag filters on current-version pages:SDK retrieve-conversations
sdk/javascript/retrieve-conversations.mdxsdk/react-native/retrieve-conversations.mdxsdk/ios/retrieve-conversations.mdxsdk/android/v5/retrieve-conversations.mdx(current Android SDK version indocs.json)sdk/flutter/retrieve-conversations.mdxUI Kit Conversations
ui-kit/react/components/conversations.mdxui-kit/react-native/conversations.mdxui-kit/ios/conversations.mdxui-kit/android/conversations.mdxui-kit/flutter/conversations.mdxui-kit/angular/components/cometchat-conversations.mdx(Filtering Conversations section)ui-kit/vue/conversations.mdx(RequestBuilder section; the page has no tag-filter example)Needs confirmation