Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

Fix message flickering on send

Steven Teydcba2e1ef418
diff --git a/apps/web/app/(ee)/partners.dub.co/(dashboard)/messages/[programSlug]/page.tsx b/apps/web/app/(ee)/partners.dub.co/(dashboard)/messages/[programSlug]/page.tsx
index 5f0b025821..9ce3353557 100644
--- a/apps/web/app/(ee)/partners.dub.co/(dashboard)/messages/[programSlug]/page.tsx
+++ b/apps/web/app/(ee)/partners.dub.co/(dashboard)/messages/[programSlug]/page.tsx
@@ -19,6 +19,7 @@ import {
} from "@/lib/zod/schemas/partners";
import { useMessagesContext } from "@/ui/messages/messages-context";
import { MessagesPanel } from "@/ui/messages/messages-panel";
+import { appendPersistedMessage } from "@/ui/messages/optimistic-message";
import { ToggleSidePanelButton } from "@/ui/messages/toggle-side-panel-button";
import { ProgramHelpLinks } from "@/ui/partners/program-help-links";
import { ProgramRewardsPanel } from "@/ui/partners/program-rewards-panel";
@@ -317,6 +318,7 @@ export default function PartnerMessagesProgramPage() {
: {})}
onSendMessage={async (message, attachments) => {
const createdAt = new Date();
+ const optimisticId = `tmp_${uuid()}`;
try {
await mutateProgramMessages(
@@ -327,15 +329,18 @@ export default function PartnerMessagesProgramPage() {
attachments,
});
- if (result?.data?.message) {
- return data
+ const sentMessage = result?.data?.message;
+
+ if (sentMessage) {
+ return data?.[0]
? [
{
...data[0],
- messages: [
- ...data[0].messages,
- result.data.message,
- ],
+ messages: appendPersistedMessage(
+ data[0].messages,
+ optimisticId,
+ sentMessage,
+ ),
},
]
: [];
@@ -351,7 +356,7 @@ export default function PartnerMessagesProgramPage() {
...data[0].messages,
{
delivered: false,
- id: `tmp_${uuid()}`,
+ id: optimisticId,
programId: program!.id,
partnerId: partner!.id,
text: message,
diff --git a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/messages/[partnerId]/page-client.tsx b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/messages/[partnerId]/page-client.tsx
index 9ea68c30a7..c87381f16b 100644
--- a/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/messages/[partnerId]/page-client.tsx
+++ b/apps/web/app/app.dub.co/(dashboard)/[slug]/(ee)/program/messages/[partnerId]/page-client.tsx
@@ -13,6 +13,7 @@ import useUser from "@/lib/swr/use-user";
import useWorkspace from "@/lib/swr/use-workspace";
import { useMessagesContext } from "@/ui/messages/messages-context";
import { MessagesPanel } from "@/ui/messages/messages-panel";
+import { appendPersistedMessage } from "@/ui/messages/optimistic-message";
import { ToggleSidePanelButton } from "@/ui/messages/toggle-side-panel-button";
import { PartnerAvatar } from "@/ui/partners/partner-avatar";
import { PartnerInfoGroup } from "@/ui/partners/partner-info-group";
@@ -233,6 +234,7 @@ export function ProgramMessagesPartnerPageClient() {
defaultValue={defaultMessage}
onSendMessage={async (message, attachments) => {
const createdAt = new Date();
+ const optimisticId = `tmp_${uuid()}`;
try {
await mutatePartnerMessages(
@@ -244,15 +246,18 @@ export function ProgramMessagesPartnerPageClient() {
attachments,
});
- if (result?.data?.message) {
- return data
+ const sentMessage = result?.data?.message;
+
+ if (sentMessage) {
+ return data?.[0]
? [
{
...data[0],
- messages: [
- ...data[0].messages,
- result.data.message,
- ],
+ messages: appendPersistedMessage(
+ data[0].messages,
+ optimisticId,
+ sentMessage,
+ ),
},
]
: [];
@@ -268,7 +273,7 @@ export function ProgramMessagesPartnerPageClient() {
...data[0].messages,
{
delivered: false,
- id: `tmp_${uuid()}`,
+ id: optimisticId,
programId: program!.id,
partnerId: partnerId,
text: message,
diff --git a/apps/web/ui/messages/messages-panel.tsx b/apps/web/ui/messages/messages-panel.tsx
index 71cd328949..f2589b72f5 100644
--- a/apps/web/ui/messages/messages-panel.tsx
+++ b/apps/web/ui/messages/messages-panel.tsx
@@ -18,6 +18,7 @@ import { Fragment, ReactNode, useMemo, useRef, useState } from "react";
import { MessageInput, PendingAttachment } from "../shared/message-input";
import { MessageAttachmentsList } from "./message-attachments";
import { MessageMarkdown } from "./message-markdown";
+import { reconcileMessages } from "./optimistic-message";
interface Sender {
name: string | null;
@@ -121,6 +122,10 @@ export function MessagesPanel({
first.senderUserId === second.senderUserId &&
first.senderPartnerId === second.senderPartnerId;
+ // Keep the optimistic message and its persisted replacement on one key so
+ // the entrance animation doesn't play a second time when the send resolves.
+ const renderedMessages = messages ? reconcileMessages(messages) : undefined;
+
return (
<div className="flex size-full flex-col">
{messages ? (
@@ -130,22 +135,29 @@ export function MessagesPanel({
className="scrollbar-hide flex grow flex-col-reverse overflow-y-auto"
>
<div className="flex flex-col items-stretch gap-2 p-6">
- {messages?.map((message, idx) => {
- const isNewDate =
- idx === 0 || isMessageNewDate(message, messages[idx - 1]);
+ {renderedMessages?.map(({ message, key }, idx) => {
+ const previousMessage = renderedMessages[idx - 1]?.message;
+ const nextMessage = renderedMessages[idx + 1]?.message;
+
+ const isNewDate = previousMessage
+ ? isMessageNewDate(message, previousMessage)
+ : true;
// If it's been more than 5 minutes since the last message
const isNewTime =
- isNewDate || isMessageNewTime(message, messages[idx - 1]);
+ isNewDate ||
+ (previousMessage
+ ? isMessageNewTime(message, previousMessage)
+ : true);
const isMySide = isMessageMySide(message);
const isMe = isMessageFromMe(message);
// Only show avatar if it's the last from a side
- const showAvatar =
- idx === messages.length - 1 ||
- !isMessageSameSender(message, messages[idx + 1]) ||
- isMessageNewTime(message, messages[idx + 1]);
+ const showAvatar = nextMessage
+ ? !isMessageSameSender(message, nextMessage) ||
+ isMessageNewTime(message, nextMessage)
+ : true;
// Message is new if it was sent within the last 10 seconds (used for intro animations)
const isNew =
@@ -156,22 +168,25 @@ export function MessagesPanel({
const showStatusIndicator =
currentUserType === "user" &&
isMySide &&
- (idx === messages.length - 1 ||
- messages.slice(idx + 1).findIndex(isMessageMySide) === -1);
+ (idx === renderedMessages.length - 1 ||
+ renderedMessages
+ .slice(idx + 1)
+ .findIndex(({ message: laterMessage }) =>
+ isMessageMySide(laterMessage),
+ ) === -1);
const sender = message.senderPartner || message.senderUser;
const isFirstFromSender =
- idx === 0 || !isMessageSameSender(message, messages[idx - 1]);
+ !previousMessage ||
+ !isMessageSameSender(message, previousMessage);
// Messages continuing a sender's group sit tighter together:
// trims the container's 8px gap down to 2px
const isGroupedWithPrevious = !isFirstFromSender && !isNewTime;
return (
- <Fragment
- key={`${new Date(message.createdAt).getTime()}-${message.senderUserId}-${message.senderPartnerId}`}
- >
+ <Fragment key={key}>
{isNewTime && (
<div
className={cn(
diff --git a/apps/web/ui/messages/optimistic-message.ts b/apps/web/ui/messages/optimistic-message.ts
new file mode 100644
index 0000000000..ff274c21d0
--- /dev/null
+++ b/apps/web/ui/messages/optimistic-message.ts
@@ -0,0 +1,55 @@
+const OPTIMISTIC_ID_PREFIX = "tmp_";
+
+// Optimistic messages are created with a temporary id, then replaced by the
+// persisted message. Remember that pair so the thread can keep one React key
+// and not mount the same message a second time.
+const stableKeyByMessageId = new Map<string, string>();
+const serverIdByOptimisticId = new Map<string, string>();
+
+export function linkOptimisticMessage(optimisticId: string, serverId: string) {
+ stableKeyByMessageId.set(optimisticId, optimisticId);
+ stableKeyByMessageId.set(serverId, optimisticId);
+ serverIdByOptimisticId.set(optimisticId, serverId);
+}
+
+export function stableMessageKey(messageId: string) {
+ return stableKeyByMessageId.get(messageId) ?? messageId;
+}
+
+export function appendPersistedMessage<T extends { id: string }>(
+ messages: T[],
+ optimisticId: string,
+ persisted: T,
+) {
+ linkOptimisticMessage(optimisticId, persisted.id);
+
+ return [
+ ...messages.filter(
+ (message) => message.id !== optimisticId && message.id !== persisted.id,
+ ),
+ persisted,
+ ];
+}
+
+export function reconcileMessages<T extends { id: string }>(messages: T[]) {
+ const serverIds = new Set(
+ messages
+ .filter((message) => !message.id.startsWith(OPTIMISTIC_ID_PREFIX))
+ .map((message) => message.id),
+ );
+
+ const seenKeys = new Set<string>();
+
+ return messages.flatMap((message) => {
+ if (message.id.startsWith(OPTIMISTIC_ID_PREFIX)) {
+ const serverId = serverIdByOptimisticId.get(message.id);
+ if (serverId && serverIds.has(serverId)) return [];
+ }
+
+ const key = stableMessageKey(message.id);
+ if (seenKeys.has(key)) return [];
+ seenKeys.add(key);
+
+ return [{ message, key }];
+ });
+}