mirror of
https://github.com/signalapp/Signal-Desktop.git
synced 2026-07-04 12:25:13 +01:00
Jamie
588 lines
16 KiB
TypeScript
588 lines
16 KiB
TypeScript
// Copyright 2025 Signal Messenger, LLC
|
||
// SPDX-License-Identifier: AGPL-3.0-only
|
||
|
||
import type { PrimaryDevice } from '@signalapp/mock-server';
|
||
import { Proto } from '@signalapp/mock-server';
|
||
import { readFile } from 'node:fs/promises';
|
||
import { join } from 'node:path';
|
||
import createDebug from 'debug';
|
||
import type { Page } from 'playwright';
|
||
import assert from 'node:assert';
|
||
|
||
import { LONG_MESSAGE, IMAGE_JPEG } from '../../types/MIME.std.ts';
|
||
import * as durations from '../../util/durations/index.std.ts';
|
||
import { toNumber } from '../../util/toNumber.std.ts';
|
||
import type { App } from '../playwright.node.ts';
|
||
import { Bootstrap } from '../bootstrap.node.ts';
|
||
import {
|
||
sendTextMessage,
|
||
getTimelineMessageWithText,
|
||
} from '../helpers.node.ts';
|
||
|
||
export const debug = createDebug('mock:test:backfill');
|
||
|
||
const FIXTURES_PATH = join(__dirname, '..', '..', '..', 'fixtures');
|
||
|
||
const CAT_PATH = join(FIXTURES_PATH, 'cat-screenshot.png');
|
||
const SNOW_PATH = join(FIXTURES_PATH, 'snow.jpg');
|
||
|
||
const { Status } = Proto.SyncMessage.AttachmentBackfillResponse.AttachmentData;
|
||
|
||
function createResponse(
|
||
response: Proto.SyncMessage.AttachmentBackfillResponse.Params
|
||
): Proto.Content.Params {
|
||
return {
|
||
content: {
|
||
syncMessage: {
|
||
content: {
|
||
attachmentBackfillResponse: response,
|
||
},
|
||
read: null,
|
||
stickerPackOperation: null,
|
||
viewed: null,
|
||
padding: null,
|
||
},
|
||
},
|
||
pniSignatureMessage: null,
|
||
senderKeyDistributionMessage: null,
|
||
};
|
||
}
|
||
|
||
describe('attachment backfill', function (this: Mocha.Suite) {
|
||
this.timeout(durations.MINUTE);
|
||
|
||
let bootstrap: Bootstrap;
|
||
let app: App;
|
||
let page: Page;
|
||
let unknownContact: PrimaryDevice;
|
||
let textAttachment: Proto.AttachmentPointer.Params;
|
||
let catAttachment: Proto.AttachmentPointer.Params;
|
||
let snowAttachment: Proto.AttachmentPointer.Params;
|
||
|
||
beforeEach(async () => {
|
||
bootstrap = new Bootstrap({ contactCount: 1, unknownContactCount: 1 });
|
||
await bootstrap.init();
|
||
app = await bootstrap.link();
|
||
page = await app.getWindow();
|
||
|
||
const { unknownContacts } = bootstrap;
|
||
[unknownContact] = unknownContacts as [PrimaryDevice];
|
||
|
||
textAttachment = await bootstrap.encryptAndStoreAttachmentOnCDN(
|
||
Buffer.from('look at this pic, it is gorgeous!'),
|
||
LONG_MESSAGE
|
||
);
|
||
|
||
const plaintextCat = await readFile(CAT_PATH);
|
||
catAttachment = await bootstrap.encryptAndStoreAttachmentOnCDN(
|
||
plaintextCat,
|
||
IMAGE_JPEG
|
||
);
|
||
|
||
const plaintextSnow = await readFile(SNOW_PATH);
|
||
snowAttachment = await bootstrap.encryptAndStoreAttachmentOnCDN(
|
||
plaintextSnow,
|
||
IMAGE_JPEG
|
||
);
|
||
});
|
||
|
||
afterEach(async function (this: Mocha.Context) {
|
||
if (!bootstrap) {
|
||
return;
|
||
}
|
||
|
||
await bootstrap.maybeSaveLogs(this.currentTest, app);
|
||
await app.close();
|
||
await bootstrap.teardown();
|
||
});
|
||
|
||
it('should be requested on manual download', async () => {
|
||
const { phone, desktop } = bootstrap;
|
||
|
||
debug('sending a message with attachment that is 404 on CDN');
|
||
const timestamp = bootstrap.getTimestamp();
|
||
await sendTextMessage({
|
||
from: unknownContact,
|
||
to: desktop,
|
||
desktop,
|
||
text: 'look at this pic!',
|
||
attachments: [
|
||
{
|
||
...textAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'text-not-found',
|
||
},
|
||
},
|
||
{
|
||
...catAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'cat-not-found',
|
||
},
|
||
},
|
||
{
|
||
...snowAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'snow-not-found',
|
||
},
|
||
},
|
||
],
|
||
timestamp,
|
||
});
|
||
|
||
debug('opening conversation');
|
||
const leftPane = page.locator('#LeftPane');
|
||
|
||
const conversationListItem = leftPane.getByRole('button', {
|
||
name: 'Chat with Unknown contact',
|
||
});
|
||
await conversationListItem.getByText('Message Request').click();
|
||
|
||
debug('dowloading attachment');
|
||
const conversationStack = page.locator('.Inbox__conversation-stack');
|
||
const startDownload = conversationStack.getByRole('button', {
|
||
name: 'Start Download',
|
||
});
|
||
await startDownload.click();
|
||
|
||
debug('waiting for backfill request');
|
||
const { syncMessage } = await phone.waitForSyncMessage(entry => {
|
||
return entry.syncMessage.content?.attachmentBackfillRequest != null;
|
||
});
|
||
assert.ok(syncMessage.content?.attachmentBackfillRequest != null);
|
||
const request = syncMessage.content.attachmentBackfillRequest;
|
||
|
||
assert(request != null);
|
||
assert.deepEqual(
|
||
request.targetConversation?.identifier?.threadServiceIdBinary,
|
||
unknownContact.device.aciBinary
|
||
);
|
||
assert.deepEqual(
|
||
request.targetMessage?.author?.authorServiceIdBinary,
|
||
unknownContact.device.aciBinary
|
||
);
|
||
assert.strictEqual(
|
||
request?.targetMessage?.sentTimestamp == null
|
||
? null
|
||
: toNumber(request?.targetMessage?.sentTimestamp),
|
||
timestamp
|
||
);
|
||
|
||
// No download buttons
|
||
debug('waiting for spinner to become visible');
|
||
await startDownload.waitFor({ state: 'detached' });
|
||
const cancelDownload = conversationStack.getByRole('button', {
|
||
name: 'Cancel Download',
|
||
});
|
||
await cancelDownload.waitFor();
|
||
|
||
debug('sending pending backfill response');
|
||
await phone.sendRaw(
|
||
desktop,
|
||
createResponse({
|
||
targetConversation: request.targetConversation,
|
||
targetMessage: request.targetMessage,
|
||
data: {
|
||
attachments: {
|
||
longText: { data: { status: Status.PENDING } },
|
||
attachments: [
|
||
{ data: { status: Status.PENDING } },
|
||
{ data: { status: Status.PENDING } },
|
||
],
|
||
},
|
||
},
|
||
}),
|
||
{
|
||
timestamp: bootstrap.getTimestamp(),
|
||
}
|
||
);
|
||
|
||
debug('resolving long text');
|
||
await phone.sendRaw(
|
||
desktop,
|
||
createResponse({
|
||
targetConversation: request.targetConversation,
|
||
targetMessage: request.targetMessage,
|
||
data: {
|
||
attachments: {
|
||
longText: { data: { attachment: textAttachment } },
|
||
attachments: [
|
||
{ data: { status: Status.PENDING } },
|
||
{ data: { status: Status.PENDING } },
|
||
],
|
||
},
|
||
},
|
||
}),
|
||
{
|
||
timestamp: bootstrap.getTimestamp(),
|
||
}
|
||
);
|
||
|
||
await getTimelineMessageWithText(page, 'gorgeous').waitFor();
|
||
|
||
debug('resolving first attachment');
|
||
await phone.sendRaw(
|
||
desktop,
|
||
createResponse({
|
||
targetConversation: request.targetConversation,
|
||
targetMessage: request.targetMessage,
|
||
data: {
|
||
attachments: {
|
||
longText: { data: { attachment: textAttachment } },
|
||
attachments: [
|
||
{ data: { attachment: catAttachment } },
|
||
{ data: { status: Status.PENDING } },
|
||
],
|
||
},
|
||
},
|
||
}),
|
||
{
|
||
timestamp: bootstrap.getTimestamp(),
|
||
}
|
||
);
|
||
|
||
await conversationStack
|
||
.getByRole('button', {
|
||
name: 'Open this attachment in a larger view',
|
||
})
|
||
.first()
|
||
.waitFor();
|
||
|
||
debug('failing second attachment');
|
||
await phone.sendRaw(
|
||
desktop,
|
||
createResponse({
|
||
targetConversation: request.targetConversation,
|
||
targetMessage: request.targetMessage,
|
||
data: {
|
||
attachments: {
|
||
longText: { data: { attachment: textAttachment } },
|
||
attachments: [
|
||
{ data: { attachment: catAttachment } },
|
||
{ data: { status: Status.TERMINAL_ERROR } },
|
||
],
|
||
},
|
||
},
|
||
}),
|
||
{
|
||
timestamp: bootstrap.getTimestamp(),
|
||
}
|
||
);
|
||
|
||
await page.locator('.Toast >> "Download failed"').waitFor();
|
||
await cancelDownload.waitFor({ state: 'detached' });
|
||
await conversationStack
|
||
.getByRole('button', {
|
||
name: 'This media is not available',
|
||
})
|
||
.waitFor();
|
||
|
||
await conversationStack
|
||
.locator('.module-image__undownloadable-icon')
|
||
.waitFor();
|
||
});
|
||
|
||
it('should show modal on timeout', async () => {
|
||
const { desktop } = bootstrap;
|
||
|
||
debug('sending a message with attachment that is 404 on CDN');
|
||
const timestamp = bootstrap.getTimestamp();
|
||
await sendTextMessage({
|
||
from: unknownContact,
|
||
to: desktop,
|
||
desktop,
|
||
text: undefined,
|
||
attachments: [
|
||
{
|
||
...catAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'cat-not-found',
|
||
},
|
||
},
|
||
],
|
||
timestamp,
|
||
});
|
||
|
||
debug('opening conversation');
|
||
const leftPane = page.locator('#LeftPane');
|
||
|
||
const conversationListItem = leftPane.getByRole('button', {
|
||
name: 'Chat with Unknown contact',
|
||
});
|
||
await conversationListItem.getByText('Message Request').click();
|
||
|
||
debug('dowloading attachment');
|
||
const conversationStack = page.locator('.Inbox__conversation-stack');
|
||
const startDownload = conversationStack.getByRole('button', {
|
||
name: 'Start Download',
|
||
});
|
||
await startDownload.click();
|
||
|
||
debug('waiting for modal');
|
||
const modal = page.getByRole('alertdialog', {
|
||
name: 'Can’t download media',
|
||
});
|
||
await modal.waitFor();
|
||
await modal.locator('text=/internet connection/').waitFor();
|
||
});
|
||
|
||
it('should show modal on missing message', async () => {
|
||
const { phone, desktop } = bootstrap;
|
||
|
||
debug('sending a message with attachment that is 404 on CDN');
|
||
const timestamp = bootstrap.getTimestamp();
|
||
await sendTextMessage({
|
||
from: unknownContact,
|
||
to: desktop,
|
||
desktop,
|
||
text: undefined,
|
||
attachments: [
|
||
{
|
||
...catAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'cat-not-found',
|
||
},
|
||
},
|
||
],
|
||
timestamp,
|
||
});
|
||
|
||
debug('opening conversation');
|
||
const leftPane = page.locator('#LeftPane');
|
||
|
||
const conversationListItem = leftPane.getByRole('button', {
|
||
name: 'Chat with Unknown contact',
|
||
});
|
||
await conversationListItem.getByText('Message Request').click();
|
||
|
||
debug('downloading attachment');
|
||
const conversationStack = page.locator('.Inbox__conversation-stack');
|
||
const startDownload = conversationStack.getByRole('button', {
|
||
name: 'Start Download',
|
||
});
|
||
await startDownload.click();
|
||
|
||
debug('waiting for request');
|
||
const { syncMessage } = await phone.waitForSyncMessage(entry => {
|
||
return entry.syncMessage.content?.attachmentBackfillRequest != null;
|
||
});
|
||
assert.ok(syncMessage.content?.attachmentBackfillRequest != null);
|
||
const request = syncMessage.content.attachmentBackfillRequest;
|
||
|
||
assert(request != null);
|
||
assert.deepEqual(
|
||
request.targetConversation?.identifier?.threadServiceIdBinary,
|
||
unknownContact.device.aciBinary
|
||
);
|
||
assert.deepEqual(
|
||
request.targetMessage?.author?.authorServiceIdBinary,
|
||
unknownContact.device.aciBinary
|
||
);
|
||
assert.strictEqual(
|
||
request.targetMessage?.sentTimestamp == null
|
||
? null
|
||
: toNumber(request.targetMessage?.sentTimestamp),
|
||
timestamp
|
||
);
|
||
|
||
debug('sending not found response');
|
||
await phone.sendRaw(
|
||
desktop,
|
||
createResponse({
|
||
targetConversation: request.targetConversation,
|
||
targetMessage: request.targetMessage,
|
||
data: {
|
||
error:
|
||
Proto.SyncMessage.AttachmentBackfillResponse.Error
|
||
.MESSAGE_NOT_FOUND,
|
||
},
|
||
}),
|
||
{
|
||
timestamp: bootstrap.getTimestamp(),
|
||
}
|
||
);
|
||
|
||
debug('waiting for modal');
|
||
const modal = page.getByRole('alertdialog', {
|
||
name: 'Can’t download media',
|
||
});
|
||
await modal.waitFor();
|
||
await modal.locator('text=/no longer available/').waitFor();
|
||
});
|
||
|
||
it('should resolve sticker', async () => {
|
||
const { phone, desktop } = bootstrap;
|
||
|
||
debug('sending a message with attachment that is 404 on CDN');
|
||
const timestamp = bootstrap.getTimestamp();
|
||
await sendTextMessage({
|
||
from: unknownContact,
|
||
to: desktop,
|
||
desktop,
|
||
text: undefined,
|
||
sticker: {
|
||
packId: Buffer.from('ae8fedafda4768fd3384d4b3b9db963d', 'hex'),
|
||
packKey: Buffer.from(
|
||
'53f4aa8b95e1c2e75afab2328fe67eb6d7affbcd4f50cd4da89dfc325dbc73ca',
|
||
'hex'
|
||
),
|
||
stickerId: 1,
|
||
emoji: '🐈',
|
||
data: {
|
||
...catAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'cat-not-found',
|
||
},
|
||
},
|
||
},
|
||
timestamp,
|
||
});
|
||
|
||
debug('opening conversation');
|
||
const leftPane = page.locator('#LeftPane');
|
||
|
||
const conversationListItem = leftPane.getByRole('button', {
|
||
name: 'Chat with Unknown contact',
|
||
});
|
||
await conversationListItem.getByText('Message Request').click();
|
||
|
||
debug('dowloading attachment');
|
||
const conversationStack = page.locator('.Inbox__conversation-stack');
|
||
const startDownload = conversationStack.getByRole('button', {
|
||
name: 'Start Download',
|
||
});
|
||
await startDownload.click();
|
||
|
||
debug('waiting for backfill request');
|
||
const { syncMessage } = await phone.waitForSyncMessage(entry => {
|
||
return entry.syncMessage.content?.attachmentBackfillRequest != null;
|
||
});
|
||
|
||
assert.ok(syncMessage.content?.attachmentBackfillRequest != null);
|
||
const request = syncMessage.content.attachmentBackfillRequest;
|
||
|
||
assert.deepEqual(
|
||
request.targetConversation?.identifier?.threadServiceIdBinary,
|
||
unknownContact.device.aciBinary
|
||
);
|
||
assert.deepEqual(
|
||
request.targetMessage?.author?.authorServiceIdBinary,
|
||
unknownContact.device.aciBinary
|
||
);
|
||
assert.strictEqual(
|
||
request.targetMessage?.sentTimestamp == null
|
||
? null
|
||
: toNumber(request.targetMessage?.sentTimestamp),
|
||
timestamp
|
||
);
|
||
|
||
debug('sending pending backfill response');
|
||
await phone.sendRaw(
|
||
desktop,
|
||
createResponse({
|
||
targetConversation: request.targetConversation,
|
||
targetMessage: request.targetMessage,
|
||
data: {
|
||
attachments: {
|
||
attachments: [{ data: { status: Status.PENDING } }],
|
||
longText: null,
|
||
},
|
||
},
|
||
}),
|
||
{
|
||
timestamp: bootstrap.getTimestamp(),
|
||
}
|
||
);
|
||
|
||
debug('resolving sticker');
|
||
await phone.sendRaw(
|
||
desktop,
|
||
createResponse({
|
||
targetConversation: request.targetConversation,
|
||
targetMessage: request.targetMessage,
|
||
data: {
|
||
attachments: {
|
||
longText: null,
|
||
attachments: [
|
||
{
|
||
data: {
|
||
attachment: catAttachment,
|
||
},
|
||
},
|
||
],
|
||
},
|
||
},
|
||
}),
|
||
{
|
||
timestamp: bootstrap.getTimestamp(),
|
||
}
|
||
);
|
||
|
||
await conversationStack
|
||
.locator('.module-image-grid--with-sticker')
|
||
.waitFor();
|
||
});
|
||
|
||
it('should not request backfill on quote/preview', async () => {
|
||
const { desktop } = bootstrap;
|
||
|
||
debug('sending a message with attachment that is 404 on CDN');
|
||
const timestamp = bootstrap.getTimestamp();
|
||
await sendTextMessage({
|
||
from: unknownContact,
|
||
to: desktop,
|
||
desktop,
|
||
quote: {
|
||
id: BigInt(bootstrap.getTimestamp()),
|
||
authorAciBinary: unknownContact.device.aciRawUuid,
|
||
text: 'quote text',
|
||
attachments: [
|
||
{
|
||
contentType: IMAGE_JPEG,
|
||
fileName: 'snow.jpg',
|
||
thumbnail: {
|
||
...snowAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'snow-not-found',
|
||
},
|
||
},
|
||
},
|
||
],
|
||
type: Proto.DataMessage.Quote.Type.NORMAL,
|
||
bodyRanges: null,
|
||
authorAci: null,
|
||
},
|
||
preview: {
|
||
url: 'https://signal.org',
|
||
title: 'Signal',
|
||
image: {
|
||
...catAttachment,
|
||
attachmentIdentifier: {
|
||
cdnKey: 'cat-not-found',
|
||
},
|
||
},
|
||
description: null,
|
||
date: null,
|
||
},
|
||
text: 'https://signal.org',
|
||
timestamp,
|
||
});
|
||
|
||
debug('opening conversation');
|
||
const leftPane = page.locator('#LeftPane');
|
||
|
||
const conversationListItem = leftPane.getByRole('button', {
|
||
name: 'Chat with Unknown contact',
|
||
});
|
||
await conversationListItem.getByText('Message Request').click();
|
||
|
||
debug('dowloading attachment');
|
||
const conversationStack = page.locator('.Inbox__conversation-stack');
|
||
const startDownload = conversationStack.getByRole('button', {
|
||
name: 'Start Download',
|
||
});
|
||
await startDownload.click();
|
||
|
||
await page.locator('.Toast >> "Download failed"').waitFor();
|
||
});
|
||
});
|