Skip to content

Fix: [v2] Update message receipts on real time basis #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 22, 2022
Merged

Fix: [v2] Update message receipts on real time basis #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
250b234
Apply on read&delivery receipt updated event handler into the Convers…
HoonBaek Mar 21, 2022
a67ad72
Calculate message status in the message content comp
HoonBaek Mar 21, 2022
4f1fe8a
Modify for test and lint errors
HoonBaek Mar 21, 2022
9f941fa
Apply optional chaining to the channelUrl and leave comments for rece…
HoonBaek Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 34 additions & 10 deletions src/smart-components/Conversation/hooks/useHandleChannelEvents.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
scrollRef,
setQuoteMessage,
}) {
const channelUrl = currentGroupChannel && currentGroupChannel.url;
const channelUrl = currentGroupChannel && currentGroupChannel?.url;
useEffect(() => {
const messageReceiverId = uuidv4();
if (channelUrl && sdk && sdk.ChannelHandler) {
Expand All @@ -29,7 +29,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom

ChannelHandler.onMessageReceived = (channel, message) => {
// donot update if hasMoreToBottom
if (compareIds(channel.url, currentGroupChannel.url) && !hasMoreToBottom) {
if (compareIds(channel.url, channelUrl) && !hasMoreToBottom) {
let scrollToEnd = false;
try {
const { current } = scrollRef;
Expand All @@ -55,14 +55,38 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
}
}
}
if (compareIds(channel.url, currentGroupChannel.url) && hasMoreToBottom) {
if (compareIds(channel.url, channelUrl) && hasMoreToBottom) {
messagesDispatcher({
type: messageActions.UPDATE_UNREAD_COUNT,
payload: { channel },
});
}
};

/**
* We need to update current channel with the channel,
* when onReadReceiptUpdated or onDeliveryReceiptUpdated are called,
* because cachedReadReceiptStatus and cachedDeliveryReceiptStatus properties were changed
*/
ChannelHandler.onReadReceiptUpdated = (channel) => {
if (compareIds(channel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onReadReceiptUpdated', channel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
payload: channel,
});
}
};
ChannelHandler.onDeliveryReceiptUpdated = (channel) => {
if (compareIds(channel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onDeliveryReceiptUpdated', channel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
payload: channel,
});
}
};

ChannelHandler.onMessageUpdated = (channel, message) => {
logger.info('Channel | useHandleChannelEvents: onMessageUpdated', message);
messagesDispatcher({
Expand Down Expand Up @@ -97,7 +121,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
};

ChannelHandler.onChannelChanged = (groupChannel) => {
if (compareIds(groupChannel.url, currentGroupChannel.url)) {
if (compareIds(groupChannel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onChannelChanged', groupChannel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
Expand All @@ -107,7 +131,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
};

ChannelHandler.onChannelFrozen = (groupChannel) => {
if (compareIds(groupChannel.url, currentGroupChannel.url)) {
if (compareIds(groupChannel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onChannelFrozen', groupChannel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
Expand All @@ -117,7 +141,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
};

ChannelHandler.onChannelUnfrozen = (groupChannel) => {
if (compareIds(groupChannel.url, currentGroupChannel.url)) {
if (compareIds(groupChannel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onChannelUnFrozen', groupChannel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
Expand All @@ -127,7 +151,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
};

ChannelHandler.onUserMuted = (groupChannel) => {
if (compareIds(groupChannel.url, currentGroupChannel.url)) {
if (compareIds(groupChannel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onUserMuted', groupChannel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
Expand All @@ -137,7 +161,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
};

ChannelHandler.onUserUnmuted = (groupChannel) => {
if (compareIds(groupChannel.url, currentGroupChannel.url)) {
if (compareIds(groupChannel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onUserUnmuted', groupChannel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
Expand All @@ -147,7 +171,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
};

ChannelHandler.onUserBanned = (groupChannel) => {
if (compareIds(groupChannel.url, currentGroupChannel.url)) {
if (compareIds(groupChannel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onUserBanned', groupChannel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
Expand All @@ -157,7 +181,7 @@ function useHandleChannelEvents({ currentGroupChannel, sdkInit, hasMoreToBottom
};

ChannelHandler.onOperatorUpdated = (groupChannel) => {
if (compareIds(groupChannel.url, currentGroupChannel.url)) {
if (compareIds(groupChannel.url, channelUrl)) {
logger.info('Channel | useHandleChannelEvents: onOperatorUpdated', groupChannel);
messagesDispatcher({
type: messageActions.SET_CURRENT_CHANNEL,
Expand Down
3 changes: 0 additions & 3 deletions src/ui/MessageContent/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@ import {
isTextMessage,
isOGMessage,
isThumbnailMessage,
getOutgoingMessageState,
getSenderName,
} from '../../utils';
import { UserProfileContext } from '../../lib/UserProfileContext';
Expand Down Expand Up @@ -95,7 +94,6 @@ export default function MessageContent({
const supposedHoverClassName = supposedHover ? 'supposed-hover' : '';
const useReplying = !!((replyType === 'QUOTE_REPLY') && message?.parentMessageId && message?.parentMessage);
const useReplyingClassName = useReplying ? 'use-quote' : '';

if (message?.isAdminMessage?.() || message?.messageType === 'admin') {
return (<ClientAdminMessage message={message} />);
}
Expand Down Expand Up @@ -205,7 +203,6 @@ export default function MessageContent({
<MessageStatus
message={message}
channel={channel}
status={getOutgoingMessageState(channel, message)}
/>
</div>
</div>
Expand Down
10 changes: 6 additions & 4 deletions src/ui/MessageStatus/__tests__/MessageStatus.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jest.mock('date-fns/format', () => () => ('mock-date'));
describe('MessageStatus', () => {
it('should contain className', function () {
const text = "example-text";
const component = shallow(<MessageStatus className={text} />);
const component = shallow(<MessageStatus className={text} message={dummyMessage} />);

expect(
component.find(".sendbird-message-status").hasClass(text)
Expand All @@ -23,7 +23,7 @@ describe('MessageStatus', () => {
it('should do a snapshot test of the MessageStatus DOM', function () {
const text = "example-text";
const component = renderer.create(
<MessageStatus className={text} status={MessageStatusTypes.SENT} message={dummyMessage} />,
<MessageStatus className={text} message={dummyMessage} />,
);
let tree = component.toJSON();
expect(tree).toMatchSnapshot();
Expand All @@ -33,10 +33,11 @@ describe('MessageStatus', () => {
const text = "example-text";
const failedMsg = {
...dummyMessage,
sendingStatus: 'failed',
isResendable: () => { return true; },
};
const component = renderer.create(
<MessageStatus className={text} status={MessageStatusTypes.FAILED} message={failedMsg} />,
<MessageStatus className={text} message={failedMsg} />,
);
let tree = component.toJSON();
expect(tree).toMatchSnapshot();
Expand All @@ -46,9 +47,10 @@ describe('MessageStatus', () => {
const text = "example-text";
const failedMsg = {
...dummyMessage,
sendingStatus: 'failed',
};
const component = renderer.create(
<MessageStatus className={text} status={MessageStatusTypes.FAILED} message={failedMsg} />,
<MessageStatus className={text} message={failedMsg} />,
);
let tree = component.toJSON();
expect(tree).toMatchSnapshot();
Expand Down
20 changes: 12 additions & 8 deletions src/ui/MessageStatus/index.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { useContext } from 'react';
import React, { useContext, useMemo } from 'react';
import PropTypes from 'prop-types';

import format from 'date-fns/format';
Expand All @@ -9,6 +9,7 @@ import Label, { LabelColors, LabelTypography } from '../Label';
import Loader from '../Loader';

import {
getOutgoingMessageState,
getOutgoingMessageStates,
isSentStatus,
} from '../../utils';
Expand All @@ -19,7 +20,6 @@ export default function MessageStatus({
className,
message,
channel,
status,
}) {
const { dateLocale } = useContext(LocalizationContext);
const showMessageStatusIcon = channel?.isGroupChannel()
Expand All @@ -39,6 +39,10 @@ export default function MessageStatus({
[MessageStatusTypes.FAILED]: IconColors.ERROR,
};

const messageStatus = useMemo(() => (
getOutgoingMessageState(channel, message)
), [channel?.getUnreadMemberCount?.(message), channel?.getUndeliveredMemberCount?.(message)]);

return (
<div
className={[
Expand All @@ -47,7 +51,7 @@ export default function MessageStatus({
].join(' ')}
>
{(showMessageStatusIcon) && (
(status === MessageStatusTypes.PENDING) ? (
(messageStatus === MessageStatusTypes.PENDING) ? (
<Loader
className="sendbird-message-status__icon"
width="16px"
Expand All @@ -63,14 +67,14 @@ export default function MessageStatus({
) : (
<Icon
className="sendbird-message-status__icon"
type={iconType[status] || IconTypes.ERROR}
fillColor={iconColor[status]}
type={iconType[messageStatus] || IconTypes.ERROR}
fillColor={iconColor[messageStatus]}
width="16px"
height="16px"
/>
)
)}
{isSentStatus(status) && (
{isSentStatus(messageStatus) && (
<Label
className="sendbird-message-status__text"
type={LabelTypography.CAPTION_3}
Expand Down Expand Up @@ -103,13 +107,13 @@ MessageStatus.propTypes = {
isSuper: PropTypes.bool,
isBroadcast: PropTypes.bool,
isPublic: PropTypes.bool,
getUnreadMemberCount: PropTypes.func,
getUndeliveredMemberCount: PropTypes.func,
}),
status: PropTypes.string,
};

MessageStatus.defaultProps = {
className: '',
message: null,
channel: null,
status: '',
};
2 changes: 2 additions & 0 deletions src/ui/MessageStatus/messageDummyData.mock.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ export function generateNormalMessage(pretreatment) {
reqId: "1579767478746",
translations: {},
requestState: "succeeded",
sendingStatus: "succeeded",
requestedMentionUserIds: [],
errorCode: 0,
getUnreadMemberCount: () => 10,
Expand Down Expand Up @@ -70,6 +71,7 @@ export function generateLongMessage(pretreatment) {
reqId: "1579767478746",
translations: {},
requestState: "succeeded",
sendingStatus: "succeeded",
requestedMentionUserIds: [],
errorCode: 0,
requestState: 'DELIVERED',
Expand Down