feat: conversations widget #2700
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Contributor
|
Size Change: +27.4 kB (+0.52%) Total Size: 5.26 MB
ℹ️ View Unchanged
|
Wiz Scan Summary
To detect these findings earlier in the dev lifecycle, try using Wiz Code VS Code Extension. |
pauldambra
approved these changes
Dec 15, 2025
Member
pauldambra
left a comment
pauldambra
left a comment
There was a problem hiding this comment.
ok, and then did a very nit-picky review since as soon as it's out there we'll get coupled to the decision we learn to like least :rolling_on_the_floor_laughing:
didn't run it
and only thought loosely about the security since we talked about the implementation in person and this follows it as far as i can tell
Comment on lines
185
to
189
| "disable_conversations": [ | ||
| "false", | ||
| "true" | ||
| ], | ||
| "conversations": [ |
Member
There was a problem hiding this comment.
ok, going through with a nitpicking mindset :)
we could have conversations: false, instead of disable_conversations: true
but arguably disable_conversations is more clear
|
|
||
| const calls = (mockPosthog._send_request as jest.Mock).mock.calls | ||
| const getMessagesCall = calls.find((call) => call[0].url.includes('/widget/messages/')) | ||
| expect(getMessagesCall[0].url).not.toContain('distinct_id=') |
Member
There was a problem hiding this comment.
very nitpicky... we could be including the actual distinct id but not keyed by distinct_id=
so really we should test the distinct id
| private _widgetSessionId: string | ||
|
|
||
| constructor( | ||
| config: ConversationsRemoteConfig, |
Member
There was a problem hiding this comment.
Suggested change
| config: ConversationsRemoteConfig, | |
| private readonly _config: ConversationsRemoteConfig, |
nitpick that you can avoid having to declare and assign to a field this way
(really very stylistic though - don't think there's a right and wrong)
| } | ||
|
|
||
| // Track message sent | ||
| this._posthog.capture('$conversations_message_sent', { |
Member
There was a problem hiding this comment.
we should maybe exclude these $conversations_etc events from billing
and then set up tracking in the billing report
so that this is free while in beta
but it's not going to be sooo many events so maybe OK to have it be the event cost for now
| this._pollMessages() | ||
|
|
||
| // Set up interval | ||
| this._pollIntervalId = window?.setInterval(() => { |
Member
There was a problem hiding this comment.
we should listen to document visibility and pause and resume this polling when the page is not visible
(it's one of the things that stops a browser freezing a tab)
and it saves us handling API calls for tabs nobody is on
(not blocking now, but as a follow-up)
| * SECURITY: This is the key for access control. Only the browser that created | ||
| * the widget_session_id can access tickets associated with it. | ||
| */ | ||
| getOrCreateWidgetSessionId(): string { |
Member
There was a problem hiding this comment.
silly check,... since we default to local storage in persistence
i guess this means if you have multiple tabs open they all have the same chat messages
i assume that's ok
Contributor
Author
There was a problem hiding this comment.
yes, that's correct as you could accidentally close one
| */ | ||
| function extractHostname(domain: string): string | null { | ||
| // Remove protocol if present | ||
| let hostname = domain.replace(/^https?:\/\//, '') |
Member
There was a problem hiding this comment.
silly nit pick that this won't work for capacitor (and maybe electron)
and that might be OK
Comment on lines
+21
to
+24
| /** | ||
| * Whether conversations are enabled for this team | ||
| */ | ||
| enabled: boolean |
Member
There was a problem hiding this comment.
could also avoid this by just returning false or nothing when disabled
and that is the signal that it isn't enabled
not a biggie, but we're sending enabled: true over the wire billions and billions of times but can avoid it
Comment on lines
+35
to
+45
| greetingText?: string | ||
|
|
||
| /** | ||
| * Primary color for the widget UI | ||
| */ | ||
| color?: string | ||
|
|
||
| /** | ||
| * Placeholder text for the message input | ||
| */ | ||
| placeholderText?: string |
Member
There was a problem hiding this comment.
could also nest some of these under customization: {}?
i feel like as the amount of options grows a flat list will get annoying
but it's nit-picky
| /** | ||
| * Visual state of the conversations widget | ||
| */ | ||
| export enum ConversationsWidgetState { |
Member
There was a problem hiding this comment.
https://www.totaltypescript.com/why-i-dont-like-typescript-enums
could just be export const ConversationsWidgetState = 'open' | 'closed'
Contributor
Author
There was a problem hiding this comment.
enum PackStatus {
Draft = 0,
Approved = 1,
Shipped = 2,
}
// [0, "Draft", 1, "Approved", 2, "Shipped"]
console.log(Object.keys(PackStatus));
WAT?!?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Conversations widget version 1
Changes
Adding conversations extension
Release info Sub-libraries affected
Libraries affected
Checklist
If releasing new changes
pnpm changesetto generate a changeset file