More descriptive notification/left pane text
This commit is contained in:
Evan Hahn
Scott Nonnenberg
parent
8290881bd8
commit
496a90efbb
4 changed files with 658 additions and 245 deletions
|
|
@ -1,4 +1,4 @@
|
|||
/* global ConversationController, i18n, Whisper, textsecure */
|
||||
/* global ConversationController, i18n, Signal, Whisper, textsecure */
|
||||
|
||||
'use strict';
|
||||
|
||||
|
|
@ -14,35 +14,494 @@ const source = '+1 415-555-5555';
|
|||
const me = '+14155555556';
|
||||
const ourUuid = window.getGuid();
|
||||
|
||||
describe('MessageCollection', () => {
|
||||
before(async () => {
|
||||
await clearDatabase();
|
||||
ConversationController.reset();
|
||||
await ConversationController.load();
|
||||
textsecure.storage.put('number_id', `${me}.2`);
|
||||
textsecure.storage.put('uuid_id', `${ourUuid}.2`);
|
||||
});
|
||||
after(() => {
|
||||
textsecure.storage.put('number_id', null);
|
||||
textsecure.storage.put('uuid_id', null);
|
||||
return clearDatabase();
|
||||
});
|
||||
before(async () => {
|
||||
await clearDatabase();
|
||||
ConversationController.reset();
|
||||
await ConversationController.load();
|
||||
textsecure.storage.put('number_id', `${me}.2`);
|
||||
textsecure.storage.put('uuid_id', `${ourUuid}.2`);
|
||||
});
|
||||
after(() => {
|
||||
textsecure.storage.put('number_id', null);
|
||||
textsecure.storage.put('uuid_id', null);
|
||||
return clearDatabase();
|
||||
});
|
||||
|
||||
it('gets outgoing contact', () => {
|
||||
describe('Message', () => {
|
||||
function createMessage(attrs) {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
const message = messages.add(attributes);
|
||||
message.getContact();
|
||||
});
|
||||
return messages.add(attrs);
|
||||
}
|
||||
|
||||
it('gets incoming contact', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
const message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
describe('getContact', () => {
|
||||
it('gets outgoing contact', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
const message = messages.add(attributes);
|
||||
message.getContact();
|
||||
});
|
||||
|
||||
it('gets incoming contact', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
const message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
});
|
||||
message.getContact();
|
||||
});
|
||||
message.getContact();
|
||||
});
|
||||
|
||||
describe('isIncoming', () => {
|
||||
it('checks if is incoming message', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.notOk(message.isIncoming());
|
||||
message = messages.add({ type: 'incoming' });
|
||||
assert.ok(message.isIncoming());
|
||||
});
|
||||
});
|
||||
|
||||
describe('isOutgoing', () => {
|
||||
it('checks if is outgoing message', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.ok(message.isOutgoing());
|
||||
message = messages.add({ type: 'incoming' });
|
||||
assert.notOk(message.isOutgoing());
|
||||
});
|
||||
});
|
||||
|
||||
describe('isGroupUpdate', () => {
|
||||
it('checks if is group update', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.notOk(message.isGroupUpdate());
|
||||
|
||||
message = messages.add({ group_update: true });
|
||||
assert.ok(message.isGroupUpdate());
|
||||
});
|
||||
});
|
||||
|
||||
// Note that some of this method's behavior is untested:
|
||||
// - Call history
|
||||
// - Contacts
|
||||
// - Expiration timer updates
|
||||
// - Key changes
|
||||
// - Profile changes
|
||||
// - Stickers
|
||||
describe('getNotificationData', () => {
|
||||
it('handles unsupported messages', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
supportedVersionAtReceive: 0,
|
||||
requiredProtocolVersion: Infinity,
|
||||
}).getNotificationData(),
|
||||
{ text: 'Unsupported message' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles erased tap-to-view messages', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
isViewOnce: true,
|
||||
isErased: true,
|
||||
}).getNotificationData(),
|
||||
{ text: 'View-once Media' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles tap-to-view photos', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
isViewOnce: true,
|
||||
isErased: false,
|
||||
attachments: [
|
||||
{
|
||||
contentType: 'image/png',
|
||||
},
|
||||
],
|
||||
}).getNotificationData(),
|
||||
{ text: 'View-once Photo', emoji: '📷' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles tap-to-view videos', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
isViewOnce: true,
|
||||
isErased: false,
|
||||
attachments: [
|
||||
{
|
||||
contentType: 'video/mp4',
|
||||
},
|
||||
],
|
||||
}).getNotificationData(),
|
||||
{ text: 'View-once Video', emoji: '🎥' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles non-media tap-to-view file types', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
isViewOnce: true,
|
||||
isErased: false,
|
||||
attachments: [
|
||||
{
|
||||
contentType: 'text/plain',
|
||||
},
|
||||
],
|
||||
}).getNotificationData(),
|
||||
{ text: 'Media Message', emoji: '📎' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles group updates where you left the group', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
group_update: {
|
||||
left: 'You',
|
||||
},
|
||||
}).getNotificationData(),
|
||||
{ text: 'You left the group.' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles group updates where someone left the group', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: {
|
||||
left: 'Alice',
|
||||
},
|
||||
}).getNotificationData(),
|
||||
{ text: 'Alice left the group.' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles empty group updates with a generic message', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source: 'Alice',
|
||||
group_update: {},
|
||||
}).getNotificationData(),
|
||||
{ text: 'Alice updated the group.' }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles group name updates by you', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source: me,
|
||||
group_update: { name: 'blerg' },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text: "You updated the group. Group name is now 'blerg'.",
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles group name updates by someone else', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { name: 'blerg' },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text: "+1 415-555-5555 updated the group. Group name is now 'blerg'.",
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles group avatar updates', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { avatarUpdated: true },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text: '+1 415-555-5555 updated the group. Group avatar was updated.',
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles you joining the group', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: [me] },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text: '+1 415-555-5555 updated the group. You joined the group.',
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles someone else joining the group', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob'] },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text: '+1 415-555-5555 updated the group. Bob joined the group.',
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles multiple people joining the group', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob', 'Alice', 'Eve'] },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text:
|
||||
'+1 415-555-5555 updated the group. Bob, Alice, Eve joined the group.',
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles multiple people joining the group, including you', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob', me, 'Alice', 'Eve'] },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text:
|
||||
'+1 415-555-5555 updated the group. Bob, Alice, Eve joined the group. You joined the group.',
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles multiple changes to group properties', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob'], name: 'blerg' },
|
||||
}).getNotificationData(),
|
||||
{
|
||||
text:
|
||||
"+1 415-555-5555 updated the group. Bob joined the group. Group name is now 'blerg'.",
|
||||
}
|
||||
);
|
||||
});
|
||||
|
||||
it('handles a session ending', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
flags: true,
|
||||
}).getNotificationData(),
|
||||
{ text: i18n('sessionEnded') }
|
||||
);
|
||||
});
|
||||
|
||||
it('handles incoming message errors', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
errors: [{}],
|
||||
}).getNotificationData(),
|
||||
{ text: i18n('incomingError') }
|
||||
);
|
||||
});
|
||||
|
||||
const attachmentTestCases = [
|
||||
{
|
||||
title: 'GIF',
|
||||
attachment: {
|
||||
contentType: 'image/gif',
|
||||
},
|
||||
expectedText: 'GIF',
|
||||
expectedEmoji: '🎡',
|
||||
},
|
||||
{
|
||||
title: 'photo',
|
||||
attachment: {
|
||||
contentType: 'image/png',
|
||||
},
|
||||
expectedText: 'Photo',
|
||||
expectedEmoji: '📷',
|
||||
},
|
||||
{
|
||||
title: 'video',
|
||||
attachment: {
|
||||
contentType: 'video/mp4',
|
||||
},
|
||||
expectedText: 'Video',
|
||||
expectedEmoji: '🎥',
|
||||
},
|
||||
{
|
||||
title: 'voice message',
|
||||
attachment: {
|
||||
contentType: 'audio/ogg',
|
||||
flags: textsecure.protobuf.AttachmentPointer.Flags.VOICE_MESSAGE,
|
||||
},
|
||||
expectedText: 'Voice Message',
|
||||
expectedEmoji: '🎤',
|
||||
},
|
||||
{
|
||||
title: 'audio message',
|
||||
attachment: {
|
||||
contentType: 'audio/ogg',
|
||||
fileName: 'audio.ogg',
|
||||
},
|
||||
expectedText: 'Audio Message',
|
||||
expectedEmoji: '🔈',
|
||||
},
|
||||
{
|
||||
title: 'plain text',
|
||||
attachment: {
|
||||
contentType: 'text/plain',
|
||||
},
|
||||
expectedText: 'File',
|
||||
expectedEmoji: '📎',
|
||||
},
|
||||
{
|
||||
title: 'unspecified-type',
|
||||
attachment: {
|
||||
contentType: null,
|
||||
},
|
||||
expectedText: 'File',
|
||||
expectedEmoji: '📎',
|
||||
},
|
||||
];
|
||||
attachmentTestCases.forEach(
|
||||
({ title, attachment, expectedText, expectedEmoji }) => {
|
||||
it(`handles single ${title} attachments`, () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
attachments: [attachment],
|
||||
}).getNotificationData(),
|
||||
{ text: expectedText, emoji: expectedEmoji }
|
||||
);
|
||||
});
|
||||
|
||||
it(`handles multiple attachments where the first is a ${title}`, () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
attachments: [
|
||||
attachment,
|
||||
{
|
||||
contentType: 'text/html',
|
||||
},
|
||||
],
|
||||
}).getNotificationData(),
|
||||
{ text: expectedText, emoji: expectedEmoji }
|
||||
);
|
||||
});
|
||||
|
||||
it(`respects the caption for ${title} attachments`, () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
attachments: [attachment],
|
||||
body: 'hello world',
|
||||
}).getNotificationData(),
|
||||
{ text: 'hello world', emoji: expectedEmoji }
|
||||
);
|
||||
});
|
||||
}
|
||||
);
|
||||
|
||||
it('handles a "plain" message', () => {
|
||||
assert.deepEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
body: 'hello world',
|
||||
}).getNotificationData(),
|
||||
{ text: 'hello world' }
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('getNotificationText', () => {
|
||||
// Sinon isn't included in the Electron test setup so we do this.
|
||||
beforeEach(function beforeEach() {
|
||||
this.oldIsLinux = Signal.OS.isLinux;
|
||||
});
|
||||
|
||||
afterEach(function afterEach() {
|
||||
Signal.OS.isLinux = this.oldIsLinux;
|
||||
});
|
||||
|
||||
it("returns a notification's text", () => {
|
||||
assert.strictEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
body: 'hello world',
|
||||
}).getNotificationText(),
|
||||
'hello world'
|
||||
);
|
||||
});
|
||||
|
||||
it("shows a notification's emoji on non-Linux", () => {
|
||||
Signal.OS.isLinux = () => false;
|
||||
|
||||
assert.strictEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
attachments: [
|
||||
{
|
||||
contentType: 'image/png',
|
||||
},
|
||||
],
|
||||
}).getNotificationText(),
|
||||
'📷 Photo'
|
||||
);
|
||||
});
|
||||
|
||||
it('hides emoji on Linux', () => {
|
||||
Signal.OS.isLinux = () => true;
|
||||
|
||||
assert.strictEqual(
|
||||
createMessage({
|
||||
type: 'incoming',
|
||||
source,
|
||||
attachments: [
|
||||
{
|
||||
contentType: 'image/png',
|
||||
},
|
||||
],
|
||||
}).getNotificationText(),
|
||||
'Photo'
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('isEndSession', () => {
|
||||
it('checks if it is end of the session', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.notOk(message.isEndSession());
|
||||
|
||||
message = messages.add({ type: 'incoming', source, flags: true });
|
||||
assert.ok(message.isEndSession());
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('MessageCollection', () => {
|
||||
it('should be ordered oldest to newest', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
// Timestamps
|
||||
|
|
@ -61,173 +520,4 @@ describe('MessageCollection', () => {
|
|||
// Compare timestamps
|
||||
assert(firstTimestamp < secondTimestamp);
|
||||
});
|
||||
|
||||
it('checks if is incoming message', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.notOk(message.isIncoming());
|
||||
message = messages.add({ type: 'incoming' });
|
||||
assert.ok(message.isIncoming());
|
||||
});
|
||||
|
||||
it('checks if is outgoing message', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.ok(message.isOutgoing());
|
||||
message = messages.add({ type: 'incoming' });
|
||||
assert.notOk(message.isOutgoing());
|
||||
});
|
||||
|
||||
it('checks if is group update', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.notOk(message.isGroupUpdate());
|
||||
|
||||
message = messages.add({ group_update: true });
|
||||
assert.ok(message.isGroupUpdate());
|
||||
});
|
||||
|
||||
it('returns an accurate description', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'hi',
|
||||
'If no group updates or end session flags, return message body.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
group_update: {},
|
||||
source: 'Alice',
|
||||
type: 'incoming',
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'Alice updated the group.',
|
||||
'Empty group updates - generic message.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { left: 'Alice' },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'Alice left the group.',
|
||||
'Notes one person leaving the group.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source: me,
|
||||
group_update: { left: 'You' },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'You left the group.',
|
||||
'Notes that you left the group.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { name: 'blerg' },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
"+1 415-555-5555 updated the group. Group name is now 'blerg'.",
|
||||
'Returns sender and name change.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source: me,
|
||||
group_update: { name: 'blerg' },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
"You updated the group. Group name is now 'blerg'.",
|
||||
'Includes "you" as sender along with group name change.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { avatarUpdated: true },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'+1 415-555-5555 updated the group. Group avatar was updated.',
|
||||
'Includes sender and avatar update.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: [me] },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'+1 415-555-5555 updated the group. You joined the group.',
|
||||
'Includes both sender and person added with join.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob'] },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'+1 415-555-5555 updated the group. Bob joined the group.',
|
||||
'Returns a single notice if only group_updates.joined changes.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob', 'Alice', 'Eve'] },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'+1 415-555-5555 updated the group. Bob, Alice, Eve joined the group.',
|
||||
'Notes when >1 person joins the group.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob', me, 'Alice', 'Eve'] },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
'+1 415-555-5555 updated the group. Bob, Alice, Eve joined the group. You joined the group.',
|
||||
'Splits "You" out when multiple people are added along with you.'
|
||||
);
|
||||
|
||||
message = messages.add({
|
||||
type: 'incoming',
|
||||
source,
|
||||
group_update: { joined: ['Bob'], name: 'blerg' },
|
||||
});
|
||||
assert.equal(
|
||||
message.getDescription(),
|
||||
"+1 415-555-5555 updated the group. Bob joined the group. Group name is now 'blerg'.",
|
||||
'Notes when there are multiple changes to group_updates properties.'
|
||||
);
|
||||
|
||||
message = messages.add({ type: 'incoming', source, flags: true });
|
||||
assert.equal(message.getDescription(), i18n('sessionEnded'));
|
||||
});
|
||||
|
||||
it('checks if it is end of the session', () => {
|
||||
const messages = new Whisper.MessageCollection();
|
||||
let message = messages.add(attributes);
|
||||
assert.notOk(message.isEndSession());
|
||||
|
||||
message = messages.add({ type: 'incoming', source, flags: true });
|
||||
assert.ok(message.isEndSession());
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue