Fix Cypress failures #2063
Fix Cypress failures #2063
Conversation
Passing run #2396 ↗︎
Details:
Review all test suite changes for PR #2063 ↗︎ |
|||||||||||||||
| if (this.isInCypress) { | ||
| // NOTE: When the user's actions are very quick, that can logout before to save `readUntilMessageHash`, | ||
| // we should save `readUntilMessageHash` before to update contract state. | ||
| // This normally happens in Cypress, when user logs out just after sending a message. | ||
| const curMessages = newContractState.messages || [] | ||
| if (addedOrDeleted === 'ADDED' && curMessages.length) { | ||
| const lastMessage = curMessages[curMessages.length - 1] | ||
| this.updateReadUntilMessageHash({ | ||
| messageHash: lastMessage.hash, | ||
| createdHeight: lastMessage.height | ||
| }) | ||
| } | ||
| } |
There was a problem hiding this comment.
Even with the comment, it's not clear to me why this code is here.
- What issue is this fixing, and which Cypress test would be failing without it?
- Is it possible to fix this in some other way, perhaps by modifying the Cypress tests themselves and having them wait on something?
There was a problem hiding this comment.
What issue is this fixing, and which Cypress test would be failing without it?
This was a very picky situation which kept making Cypress to be failed. Let me explain.
Once we receive the message event(e.g., 'gi.contracts/chatroom/addMessage'), we process the event in this function and the this.messageState is updated. So the computed value this.messages would be updated.
After that, we save the readUntil message to the KV store by calling this.updateReadUntilMessageHash function.
Now, let's think about Cypress test scenario to logout as soon as to send a message. So the workflow is like the following.
- User sends a message
- Cypress waits for the message to be added (
pendingnow) - Cypress waits for the message status to be
sent(This is when the event is received, processed andthis.messageStateis updated) - (Cypress decides the
Sending a messageis finished, actually is.) Call cy.giLogout()
So the Cypress didn't wait for the this.updateReadUntilMessageHash to be called, and also for the invocations from the queue UNREAD_MESSAGES_QUEUE. The invocations from UNREAD_MESSAGES_QUEUE run the following sbp function, so it would break Cypress whenever the invocations were called after logout.
return sbp('chelonia/kv/set', ourIdentityContractId, KV_KEYS.UNREAD_MESSAGES, data, {
encryptionKeyId: sbp('chelonia/contract/currentKeyIdByName', ourIdentityContractId, 'cek'),
signingKeyId: sbp('chelonia/contract/currentKeyIdByName', ourIdentityContractId, 'csk'),
})
Adding await sbp('okTurtles.eventQueue/queueEvent', UNREAD_MESSAGES_QUEUE, () => {}) in the gi.actions/identity/logout function, couldn't solve the problem because a new invocation could be added after we call the gi.actions/identity/logout function. When the user's actions are very quick, only in Cypress. Look at the following orders of function calls
- Update this.messageState in ChatMain.vue
- Call
gi.actions/identity/logoutfunction - Call
await sbp('okTurtles.eventQueue/queueEvent', UNREAD_MESSAGES_QUEUE, () => {}) - Call
this.updateReadUntilMessageHashand add new invocation toUNREAD_MESSAGES_QUEUE
Is it possible to fix this in some other way, perhaps by modifying the Cypress tests themselves and having them wait on something?
I did also tried to find another way to wait for this in Cypress, but couldn't find alternative solution which doesn't use cy.wait().
There was a problem hiding this comment.
I have just had an inspiration that add exception handler in fetchChatRoomUnreadMessages and saveChatRoomUnreadMessages function.
EDITED: I just realised that the exception handler couldn't solve the problem too. Because it's necessary to wait for the UNREAD_MESSAGES_QUEUE invocations to be finished before user logs out, and those kinds of exceptions (which would be related to the identityContractID) should not be thrown. So far, I couldn't find the alternative solution.
There was a problem hiding this comment.
@taoeffect, I will re-write the test scenario and remove the picky cases.
taoeffect
deleted the
2058-broken-cypress-test-related-to-login-modal-heisenbug
branch
Summary of Changes