Merge pull request #10184 from overleaf/ii-ignore-received-chat-messages-test

[web] Outdated chat context tests for receiving messages

GitOrigin-RevId: c91cda5ada1c0ef26d41589cdbee31a8afd1e36a

services/web/frontend/js/features/chat/context/chat-context.js

@@ -5,6 +5,7 @@ import {
   useEffect,
   useReducer,
   useMemo,
+  useRef,
 } from 'react'
 import PropTypes from 'prop-types'
 import { v4 as uuid } from 'uuid'
@@ -18,8 +19,6 @@ import { useLayoutContext } from '../../../shared/context/layout-context'
 
 const PAGE_SIZE = 50
 
-const clientId = uuid()
-
 export function chatReducer(state, action) {
   switch (action.type) {
     case 'INITIAL_FETCH_MESSAGES':
@@ -116,6 +115,7 @@ ChatContext.Provider.propTypes = {
 }
 
 export function ChatProvider({ children }) {
+  const clientId = useRef(uuid())
   const user = useUserContext({
     id: PropTypes.string.isRequired,
   })
@@ -197,7 +197,7 @@ export function ChatProvider({ children }) {
 
       const url = `/project/${projectId}/messages`
       postJSON(url, {
-        body: { content, client_id: clientId },
+        body: { content, client_id: clientId.current },
       }).catch(error => {
         dispatch({
           type: 'ERROR',
@@ -220,7 +220,7 @@ export function ChatProvider({ children }) {
     function receivedMessage(message) {
       // If the message is from the current client id, then we are receiving the sent message back from the socket.
       // Ignore it to prevent double message.
-      if (message.clientId === clientId) return
+      if (message.clientId === clientId.current) return
 
       dispatch({ type: 'RECEIVE_MESSAGE', message })
     }

services/web/test/frontend/features/chat/context/chat-context.test.js

@@ -3,9 +3,10 @@
 
 import { renderHook, act } from '@testing-library/react-hooks/dom'
 import { expect } from 'chai'
+import sinon from 'sinon'
 import fetchMock from 'fetch-mock'
 import EventEmitter from 'events'
-
+import uuid from 'uuid'
 import { useChatContext } from '../../../../../frontend/js/features/chat/context/chat-context'
 import {
   ChatProviders,
@@ -19,6 +20,7 @@ describe('ChatContext', function () {
     first_name: 'fake_user_first_name',
     email: 'fake@example.com',
   }
+  const uuidValue = '00000000-0000-0000-0000-000000000000'
 
   beforeEach(function () {
     fetchMock.reset()
@@ -28,12 +30,15 @@ describe('ChatContext', function () {
 
     window.metaAttributesCache = new Map()
     window.metaAttributesCache.set('ol-user', user)
+
+    this.stub = sinon.stub(uuid, 'v4').returns(uuidValue)
   })
 
   afterEach(function () {
     tearDownMathJaxStubs()
 
     window.metaAttributesCache = new Map()
+    this.stub.restore()
   })
 
   describe('socket connection', function () {
@@ -105,22 +110,25 @@ describe('ChatContext', function () {
       await waitForNextUpdate()
 
       // Send a message from the current user
-      result.current.sendMessage('sent message')
+      const sentMsg = 'sent message'
+      result.current.sendMessage(sentMsg)
 
-      // Receive a message from the current user
-      socket.emit('new-chat-message', {
-        id: 'msg_1',
-        content: 'received message',
-        timestamp: Date.now(),
-        user,
+      act(() => {
+        // Receive a message from the current user
+        socket.emit('new-chat-message', {
+          id: 'msg_1',
+          content: 'received message',
+          timestamp: Date.now(),
+          user,
+          clientId: uuidValue,
+        })
       })
 
-      // Expect that the sent message is shown, but the new message is not
-      const messageContents = result.current.messages.map(
-        ({ contents }) => contents[0]
-      )
-      expect(messageContents).to.include('sent message')
-      expect(messageContents).to.not.include('received message')
+      expect(result.current.messages).to.have.length(1)
+
+      const [message] = result.current.messages
+
+      expect(message.contents).to.deep.equal([sentMsg])
     })
 
     it('adds the new message from the current user if another message was received after sending', async function () {
@@ -134,44 +142,47 @@ describe('ChatContext', function () {
       await waitForNextUpdate()
 
       // Send a message from the current user
-      result.current.sendMessage('sent message from current user')
+      const sentMsg = 'sent message from current user'
+      result.current.sendMessage(sentMsg)
 
       const [sentMessageFromCurrentUser] = result.current.messages
-      expect(sentMessageFromCurrentUser.contents).to.deep.equal([
-        'sent message from current user',
-      ])
+      expect(sentMessageFromCurrentUser.contents).to.deep.equal([sentMsg])
+
+      const otherMsg = 'new message from other user'
 
       act(() => {
         // Receive a message from another user.
         socket.emit('new-chat-message', {
           id: 'msg_1',
-          content: 'new message from other user',
+          content: otherMsg,
           timestamp: Date.now(),
           user: {
             id: 'another_fake_user',
             first_name: 'another_fake_user_first_name',
             email: 'another_fake@example.com',
           },
+          clientId: '123',
         })
       })
 
       const [, messageFromOtherUser] = result.current.messages
-      expect(messageFromOtherUser.contents).to.deep.equal([
-        'new message from other user',
-      ])
+      expect(messageFromOtherUser.contents).to.deep.equal([otherMsg])
 
-      // Receive a message from the current user
-      socket.emit('new-chat-message', {
-        id: 'msg_2',
-        content: 'received message from current user',
-        timestamp: Date.now(),
-        user,
+      act(() => {
+        // Receive a message from the current user
+        socket.emit('new-chat-message', {
+          id: 'msg_2',
+          content: 'received message from current user',
+          timestamp: Date.now(),
+          user,
+          clientId: uuidValue,
+        })
       })
 
       // Since the current user didn't just send a message, it is now shown
-      const [, , receivedMessageFromCurrentUser] = result.current.messages
-      expect(receivedMessageFromCurrentUser.contents).to.deep.equal([
-        'received message from current user',
+      expect(result.current.messages).to.deep.equal([
+        sentMessageFromCurrentUser,
+        messageFromOtherUser,
       ])
     })
   })