From a9cc9a72941b1e32053658206f7dad12e1cec4ee Mon Sep 17 00:00:00 2001 From: Audric Ackermann Date: Thu, 7 Apr 2022 14:47:54 +1000 Subject: [PATCH] add tests for attachment metadata --- ts/models/message.ts | 4 +- ts/session/utils/AttachmentsDownload.ts | 2 +- ts/shims/Signal.ts | 7 - ts/test/test-utils/utils/message.ts | 10 + .../initializeAttachmentMetadata_test.ts | 286 ++++++++++++++++++ .../message/initializeAttachmentMetadata.ts | 18 +- 6 files changed, 309 insertions(+), 18 deletions(-) delete mode 100644 ts/shims/Signal.ts create mode 100644 ts/test/types/initializeAttachmentMetadata_test.ts diff --git a/ts/models/message.ts b/ts/models/message.ts index 453481d16..e4267f936 100644 --- a/ts/models/message.ts +++ b/ts/models/message.ts @@ -100,7 +100,9 @@ export class MessageModel extends Backbone.Model { } autoBind(this); - window.contextMenuShown = false; + if (window) { + window.contextMenuShown = false; + } this.getMessageModelProps(); } diff --git a/ts/session/utils/AttachmentsDownload.ts b/ts/session/utils/AttachmentsDownload.ts index 240949fe9..8d2b78df7 100644 --- a/ts/session/utils/AttachmentsDownload.ts +++ b/ts/session/utils/AttachmentsDownload.ts @@ -218,7 +218,7 @@ async function _runJob(job: any) { hasAttachments, hasVisualMediaAttachments, hasFileAttachments, - } = await getAttachmentMetadata(found); + } = getAttachmentMetadata(found); found.set({ hasAttachments, hasVisualMediaAttachments, hasFileAttachments }); } diff --git a/ts/shims/Signal.ts b/ts/shims/Signal.ts deleted file mode 100644 index 937a0ae5a..000000000 --- a/ts/shims/Signal.ts +++ /dev/null @@ -1,7 +0,0 @@ -import { getPasswordHash } from '../../ts/data/data'; - -export async function hasPassword() { - const hash = await getPasswordHash(); - - return !!hash; -} diff --git a/ts/test/test-utils/utils/message.ts b/ts/test/test-utils/utils/message.ts index d1e2d9d7c..82a9e051e 100644 --- a/ts/test/test-utils/utils/message.ts +++ b/ts/test/test-utils/utils/message.ts @@ -8,6 +8,7 @@ import { OpenGroupMessageV2 } from '../../../session/apis/open_group_api/opengro import { TestUtils } from '..'; import { OpenGroupRequestCommonType } from '../../../session/apis/open_group_api/opengroupV2/ApiUtil'; import { OpenGroupVisibleMessage } from '../../../session/messages/outgoing/visibleMessage/OpenGroupVisibleMessage'; +import { MessageModel } from '../../../models/message'; export function generateVisibleMessage({ identifier, @@ -55,6 +56,15 @@ export function generateClosedGroupMessage(groupId?: string): ClosedGroupVisible }); } +export function generateFakeIncomingPrivateMessage(): MessageModel { + const convoId = TestUtils.generateFakePubKeyStr(); + return new MessageModel({ + conversationId: convoId, + source: convoId, + type: 'incoming', + }); +} + interface MockConversationParams { id?: string; members?: Array; diff --git a/ts/test/types/initializeAttachmentMetadata_test.ts b/ts/test/types/initializeAttachmentMetadata_test.ts new file mode 100644 index 000000000..7e03185e4 --- /dev/null +++ b/ts/test/types/initializeAttachmentMetadata_test.ts @@ -0,0 +1,286 @@ +import { expect } from 'chai'; +import { SignalService } from '../../protobuf'; +import { + getAttachmentMetadata, + hasFileAttachmentInMessage, + hasVisualMediaAttachmentInMessage, +} from '../../types/message/initializeAttachmentMetadata'; +import { generateFakeIncomingPrivateMessage, stubWindowLog } from '../test-utils/utils'; + +// tslint:disable-next-line: max-func-body-length +describe('initializeAttachmentMetadata', () => { + beforeEach(() => { + stubWindowLog(); + }); + describe('hasAttachmentInMessage', () => { + it('no attachments should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('empty list attachments should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment has undefined content type should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: undefined }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment has null content type should return true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: null }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.true; + }); + + it('first attachment is gif should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'image/gif' }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is gif should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'image/gif' }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is jpeg should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'image/jpeg' }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is png should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'image/png' }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is JPG should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'image/JPG' }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is PNG should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'image/PNG' }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is audio should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'audio/mp3' }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is flagged as voice message should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [ + { contentType: 'audio/mp3', flags: SignalService.AttachmentPointer.Flags.VOICE_MESSAGE }, + ], + }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment is flagged as voice message but no content type is false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [ + { contentType: undefined, flags: SignalService.AttachmentPointer.Flags.VOICE_MESSAGE }, + ], + }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment content type is audio and other is null should return true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ attachments: [{ contentType: 'audio/mp3' }, { contentType: null }] }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.true; + }); + + it('first attachment content type is audio and other is null should return true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'audio/mp3' }, { contentType: 'file/whatever' }], + }); + expect(hasFileAttachmentInMessage(msgModel)).to.be.true; + }); + }); + + describe('hasVisualMediaAttachmentInMessage', () => { + it('no attachments should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.false; + }); + + it('empty attachments list should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment type is undefined should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: undefined }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment type is null should return false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: null }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.false; + }); + + it('first attachment type is image/whatever should return true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'image/whatever' }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.true; + }); + + it('first attachment type is jpeg should return true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'image/jpeg' }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.true; + }); + + it('first attachment type is png should return true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'image/png' }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.true; + }); + + it('first attachment type is JPG should return true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'image/JPG' }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.true; + }); + + it('multiple attachments where one is not image and one is returns true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'audio/whatever' }, { contentType: 'image/JPG' }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.true; + }); + + it('multiple attachments where both are images returns true', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'image/whatever' }, { contentType: 'image/JPG' }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.true; + }); + + it('multiple attachments where none are images returns false', () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set({ + attachments: [{ contentType: 'audio/whatever' }, { contentType: 'audio/JPG' }], + }); + expect(hasVisualMediaAttachmentInMessage(msgModel)).to.be.false; + }); + }); + + describe('getAttachmentMetadata', () => { + it('no attachments should return false x3', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(0); + expect(mt.hasFileAttachments).to.be.eq(0); + expect(mt.hasVisualMediaAttachments).to.be.eq(0); + }); + + it('empty attachments [] should return false x3', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', []); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(0); + expect(mt.hasFileAttachments).to.be.eq(0); + expect(mt.hasVisualMediaAttachments).to.be.eq(0); + }); + + it('has one image attachment only', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', [{ contentType: 'image/jpeg' }]); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(1); + expect(mt.hasFileAttachments).to.be.eq(0); + expect(mt.hasVisualMediaAttachments).to.be.eq(1); + }); + + it('has two image attachment only', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', [{ contentType: 'image/jpeg' }, { contentType: 'image/jpeg' }]); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(1); + expect(mt.hasFileAttachments).to.be.eq(0); + expect(mt.hasVisualMediaAttachments).to.be.eq(1); + }); + + it('has one audio attachment only', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', [{ contentType: 'audio/mp3' }]); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(1); + expect(mt.hasFileAttachments).to.be.eq(0); + expect(mt.hasVisualMediaAttachments).to.be.eq(0); + }); + + it('has one file attachment only', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', [{ contentType: 'whatever' }]); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(1); + expect(mt.hasFileAttachments).to.be.eq(1); + expect(mt.hasVisualMediaAttachments).to.be.eq(0); + }); + + it('has two file attachment only', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', [{ contentType: 'whatever' }, { contentType: 'whatever' }]); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(1); + expect(mt.hasFileAttachments).to.be.eq(1); + expect(mt.hasVisualMediaAttachments).to.be.eq(0); + }); + + it('has two attachments with undefined contenttype', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', [{ contentType: undefined }, { contentType: undefined }]); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(1); + expect(mt.hasFileAttachments).to.be.eq(0); + expect(mt.hasVisualMediaAttachments).to.be.eq(0); + }); + + it('has two attachments with null contenttype', async () => { + const msgModel = generateFakeIncomingPrivateMessage(); + msgModel.set('attachments', [{ contentType: null }, { contentType: null }]); + const mt = await getAttachmentMetadata(msgModel); + expect(mt.hasAttachments).to.be.eq(1); + expect(mt.hasFileAttachments).to.be.eq(1); + expect(mt.hasVisualMediaAttachments).to.be.eq(0); + }); + }); +}); diff --git a/ts/types/message/initializeAttachmentMetadata.ts b/ts/types/message/initializeAttachmentMetadata.ts index 176dbb148..aa283ade2 100644 --- a/ts/types/message/initializeAttachmentMetadata.ts +++ b/ts/types/message/initializeAttachmentMetadata.ts @@ -1,23 +1,23 @@ import { MessageModel } from '../../models/message'; import * as Attachment from '../Attachment'; -const hasAttachment = (predicate: (value: Attachment.Attachment) => boolean) => ( +const hasAttachmentInMessage = (predicate: (value: Attachment.Attachment) => boolean) => ( message: MessageModel ): boolean => Boolean((message.get('attachments') || []).some(predicate)); -const hasFileAttachment = hasAttachment(Attachment.isFile); -const hasVisualMediaAttachment = hasAttachment(Attachment.isVisualMedia); +export const hasFileAttachmentInMessage = hasAttachmentInMessage(Attachment.isFile); +export const hasVisualMediaAttachmentInMessage = hasAttachmentInMessage(Attachment.isVisualMedia); -export const getAttachmentMetadata = async ( +export const getAttachmentMetadata = ( message: MessageModel -): Promise<{ +): { hasAttachments: 1 | 0; hasFileAttachments: 1 | 0; hasVisualMediaAttachments: 1 | 0; -}> => { - const hasAttachments = Boolean(message.get('attachments').length) ? 1 : 0; - const hasFileAttachments = hasFileAttachment(message) ? 1 : 0; - const hasVisualMediaAttachments = hasVisualMediaAttachment(message) ? 1 : 0; +} => { + const hasAttachments = Boolean((message.get('attachments') || []).length) ? 1 : 0; + const hasFileAttachments = hasFileAttachmentInMessage(message) ? 1 : 0; + const hasVisualMediaAttachments = hasVisualMediaAttachmentInMessage(message) ? 1 : 0; return { hasAttachments,