From 80523a9a3ea80d93b3a063dff702de91638e356d Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Wed, 25 Nov 2020 12:26:42 +1100 Subject: [PATCH] rename MessageQueue event to be more easily searchable success -> sendSuccess fail -> sendFail --- ts/components/session/SessionInboxView.tsx | 7 +++++-- ts/session/sending/MessageQueue.ts | 10 +++++----- ts/session/sending/MessageQueueInterface.ts | 4 ++-- .../session/unit/sending/MessageQueue_test.ts | 16 ++++++++-------- 4 files changed, 20 insertions(+), 17 deletions(-) diff --git a/ts/components/session/SessionInboxView.tsx b/ts/components/session/SessionInboxView.tsx index 6b08a7e12..747d5b955 100644 --- a/ts/components/session/SessionInboxView.tsx +++ b/ts/components/session/SessionInboxView.tsx @@ -226,11 +226,14 @@ export class SessionInboxView extends React.Component { this.handleMessageSentSuccess = this.handleMessageSentSuccess.bind(this); getMessageQueue().events.addListener( - 'success', + 'sendSuccess', this.handleMessageSentSuccess ); - getMessageQueue().events.addListener('fail', this.handleMessageSentFailure); + getMessageQueue().events.addListener( + 'sendFail', + this.handleMessageSentFailure + ); window.Whisper.events.on('messageExpired', messageExpired); window.Whisper.events.on('messageChanged', messageChanged); diff --git a/ts/session/sending/MessageQueue.ts b/ts/session/sending/MessageQueue.ts index ca495f63c..bebeee967 100644 --- a/ts/session/sending/MessageQueue.ts +++ b/ts/session/sending/MessageQueue.ts @@ -65,7 +65,7 @@ export class MessageQueue implements MessageQueueInterface { const result = await MessageSender.sendToOpenGroup(message); // sendToOpenGroup returns -1 if failed or an id if succeeded if (result.serverId < 0) { - this.events.emit('fail', message, error); + this.events.emit('sendFail', message, error); } else { const messageEventData = { pubKey: message.group.groupId, @@ -73,7 +73,7 @@ export class MessageQueue implements MessageQueueInterface { serverId: result.serverId, serverTimestamp: result.serverTimestamp, }; - this.events.emit('success', message); + this.events.emit('sendSuccess', message); window.Whisper.events.trigger('publicMessageSent', messageEventData); } @@ -82,7 +82,7 @@ export class MessageQueue implements MessageQueueInterface { `Failed to send message to open group: ${message.group.server}`, e ); - this.events.emit('fail', message, error); + this.events.emit('sendFail', message, error); } return; @@ -164,9 +164,9 @@ export class MessageQueue implements MessageQueueInterface { const job = async () => { try { const wrappedEnvelope = await MessageSender.send(message); - this.events.emit('success', message, wrappedEnvelope); + this.events.emit('sendSuccess', message, wrappedEnvelope); } catch (e) { - this.events.emit('fail', message, e); + this.events.emit('sendFail', message, e); } finally { // Remove from the cache because retrying is done in the sender void this.pendingMessageCache.remove(message); diff --git a/ts/session/sending/MessageQueueInterface.ts b/ts/session/sending/MessageQueueInterface.ts index 596b84bea..70e2ffead 100644 --- a/ts/session/sending/MessageQueueInterface.ts +++ b/ts/session/sending/MessageQueueInterface.ts @@ -15,11 +15,11 @@ type GroupMessageType = | MediumGroupMessage; export interface MessageQueueInterfaceEvents { - success: ( + sendSuccess: ( message: RawMessage | OpenGroupMessage, wrappedEnvelope?: Uint8Array ) => void; - fail: (message: RawMessage | OpenGroupMessage, error: Error) => void; + sendFail: (message: RawMessage | OpenGroupMessage, error: Error) => void; } export interface MessageQueueInterface { diff --git a/ts/test/session/unit/sending/MessageQueue_test.ts b/ts/test/session/unit/sending/MessageQueue_test.ts index 41d65d9e8..9674ed613 100644 --- a/ts/test/session/unit/sending/MessageQueue_test.ts +++ b/ts/test/session/unit/sending/MessageQueue_test.ts @@ -113,7 +113,7 @@ describe('MessageQueue', () => { await pendingMessageCache.add(device, TestUtils.generateChatMessage()); const successPromise = PromiseUtils.waitForTask(done => { - messageQueueStub.events.once('success', done); + messageQueueStub.events.once('sendSuccess', done); }); await messageQueueStub.processPending(device); await expect(successPromise).to.be.fulfilled; @@ -123,9 +123,9 @@ describe('MessageQueue', () => { it('should remove message from cache', async () => { hasSessionStub.resolves(true); - const events = ['success', 'fail']; + const events = ['sendSuccess', 'sendFail']; for (const event of events) { - if (event === 'success') { + if (event === 'sendSuccess') { sendStub.resolves(); } else { sendStub.throws(new Error('fail')); @@ -157,7 +157,7 @@ describe('MessageQueue', () => { const eventPromise = PromiseUtils.waitForTask< RawMessage | OpenGroupMessage >(complete => { - messageQueueStub.events.once('success', complete); + messageQueueStub.events.once('sendSuccess', complete); }); await messageQueueStub.processPending(device); @@ -172,7 +172,7 @@ describe('MessageQueue', () => { sendStub.throws(new Error('failure')); const spy = sandbox.spy(); - messageQueueStub.events.on('fail', spy); + messageQueueStub.events.on('sendFail', spy); const device = TestUtils.generateFakePubKey(); const message = TestUtils.generateChatMessage(); @@ -181,7 +181,7 @@ describe('MessageQueue', () => { const eventPromise = PromiseUtils.waitForTask< [RawMessage | OpenGroupMessage, Error] >(complete => { - messageQueueStub.events.once('fail', (...args) => { + messageQueueStub.events.once('sendFail', (...args) => { complete(args); }); }); @@ -341,7 +341,7 @@ describe('MessageQueue', () => { const message = TestUtils.generateOpenGroupMessage(); const eventPromise = PromiseUtils.waitForTask(complete => { - messageQueueStub.events.once('success', complete); + messageQueueStub.events.once('sendSuccess', complete); }, 2000); await messageQueueStub.sendToGroup(message); @@ -352,7 +352,7 @@ describe('MessageQueue', () => { sendToOpenGroupStub.resolves({ serverId: -1, serverTimestamp: -1 }); const message = TestUtils.generateOpenGroupMessage(); const eventPromise = PromiseUtils.waitForTask(complete => { - messageQueueStub.events.once('fail', complete); + messageQueueStub.events.once('sendFail', complete); }, 2000); await messageQueueStub.sendToGroup(message);