doMarkReadMessage prop to Channel component

GetStream · Jul 31, 2020 · 49a058b · 49a058b
1 parent 185575b
commit 49a058b
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 4 deletions.
diff --git a/src/components/Channel/Channel.js b/src/components/Channel/Channel.js
@@ -107,6 +107,12 @@ Channel.propTypes = {
    * @param {Object} message
    */
   doSendMessageRequest: PropTypes.func,
+  /**
+   * Override mark channel read request (Advanced usage only)
+   *
+   * @param {Channel} channel object
+   * */
+  doMarkReadRequest: PropTypes.func,
   /** Override update(edit) message request (Advanced usage only)
    *
    * @param {String} channelId full channel ID in format of `type:id`
@@ -121,6 +127,7 @@ const ChannelInner = ({
   LoadingErrorIndicator = LoadingErrorIndicatorComponent,
   Attachment = AttachmentComponent,
   Message = MessageSimpleComponent,
+  doMarkReadRequest,
   ...props
   // eslint-disable-next-line sonarjs/cognitive-complexity
 }) => {
@@ -148,13 +155,15 @@ const ChannelInner = ({
       return;
     }
     lastRead.current = new Date();
-
-    logChatPromiseExecution(channel.markRead(), 'mark read');
-
+    if (doMarkReadRequest) {
+      doMarkReadRequest(channel);
+    } else {
+      logChatPromiseExecution(channel.markRead(), 'mark read');
+    }
     if (originalTitle.current) {
       document.title = originalTitle.current;
     }
-  }, [channel]);
+  }, [channel, doMarkReadRequest]);
 
   // eslint-disable-next-line react-hooks/exhaustive-deps
   const markReadThrottled = useCallback(

diff --git a/src/components/Channel/__tests__/Channel.test.js b/src/components/Channel/__tests__/Channel.test.js
@@ -181,6 +181,16 @@ describe('Channel', () => {
 
     await waitFor(() => expect(markReadSpy).toHaveBeenCalledWith());
   });
+  it('should use the doMarkReadRequest prop to mark channel as read, if that is defined', async () => {
+    jest.spyOn(channel, 'countUnread').mockImplementationOnce(() => 1);
+    const doMarkReadRequest = jest.fn();
+
+    renderComponent({
+      doMarkReadRequest,
+    });
+
+    await waitFor(() => expect(doMarkReadRequest).toHaveBeenCalledTimes(1));
+  });
 
   // eslint-disable-next-line sonarjs/cognitive-complexity
   describe('Children that consume ChannelContext', () => {

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -130,6 +130,9 @@ export interface ChannelProps {
     channelId: string,
     message: Client.Message,
   ): Promise<Client.MessageResponse> | void;
+  doMarkReadRequest?(
+    channel: Client.Channel,
+  ): Promise<Client.MessageResponse> | void;
   /** Override update(edit) message request (Advanced usage only) */
   doUpdateMessageRequest?(
     channelId: string,