| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629 |
- /**
- * Unit tests for WhatsApp-native bridge payload helpers.
- *
- * These tests avoid importing bridge.js because that file starts an HTTP
- * server and Baileys socket at module load. Keep the helper module pure.
- */
- import { strict as assert } from 'node:assert';
- import { createHash } from 'node:crypto';
- import { mkdtempSync } from 'node:fs';
- import { tmpdir } from 'node:os';
- import path from 'node:path';
- import { getAggregateVotesInPollMessage } from '@whiskeysockets/baileys';
- import {
- addMentions,
- buildPollPayload,
- buildTextSendPayload,
- createBoundedMessageStore,
- extractBridgeEvent,
- inboundReadReceiptKeys,
- mediaPayloadForFile,
- pollCreationMessageFromPayload,
- pollUpdateForAggregation,
- } from './bridge_helpers.js';
- // -- inbound read receipts ------------------------------------------------
- {
- const groupKey = {
- id: 'incoming-group-1',
- remoteJid: '120363001234567890@g.us',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- };
- assert.deepEqual(inboundReadReceiptKeys({ key: groupKey, enabled: false }), []);
- assert.deepEqual(
- inboundReadReceiptKeys({ key: { ...groupKey, fromMe: true }, enabled: true }),
- [],
- );
- const receiptKeys = inboundReadReceiptKeys({ key: groupKey, enabled: true });
- assert.equal(receiptKeys.length, 1);
- assert.equal(receiptKeys[0], groupKey);
- assert.equal(receiptKeys[0].participant, groupKey.participant);
- console.log(' ✓ inbound read receipts preserve the original group message key');
- }
- // -- quoted outbound text -------------------------------------------------
- {
- const store = createBoundedMessageStore(2);
- store.remember({
- key: {
- id: 'inbound-1',
- remoteJid: '15551234567@s.whatsapp.net',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- },
- message: { conversation: 'original text' },
- });
- const { content, options } = buildTextSendPayload('reply text', {
- chatId: '15551234567@s.whatsapp.net',
- replyTo: 'inbound-1',
- messageStore: store,
- });
- assert.deepEqual(content, { text: 'reply text' });
- assert.equal(options.quoted.key.id, 'inbound-1');
- assert.equal(options.quoted.message.conversation, 'original text');
- console.log(' ✓ text replies include Baileys quoted message when resolvable');
- }
- {
- const store = createBoundedMessageStore(2);
- const { content, options } = buildTextSendPayload('plain text', {
- chatId: '15551234567@s.whatsapp.net',
- replyTo: 'missing-id',
- messageStore: store,
- });
- assert.deepEqual(content, { text: 'plain text' });
- assert.deepEqual(options, {});
- console.log(' ✓ unresolved replyTo falls back to plain text');
- }
- {
- const mentions = ['15550001111@s.whatsapp.net'];
- const { content } = buildTextSendPayload('hello @15550001111', { mentions });
- const media = addMentions({ image: Buffer.from('png'), caption: 'hello @15550001111' }, mentions);
- assert.deepEqual(content.mentions, mentions);
- assert.deepEqual(media.mentions, mentions);
- console.log(' ✓ outbound text and media payloads preserve native mention JIDs');
- }
- // -- inbound quote/media/native metadata --------------------------------
- {
- const event = await extractBridgeEvent({
- msg: {
- key: {
- id: 'incoming-1',
- remoteJid: '15551234567@s.whatsapp.net',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- },
- pushName: 'Tester',
- messageTimestamp: 123,
- message: {
- extendedTextMessage: {
- text: 'approved',
- contextInfo: {
- stanzaId: 'outbound-1',
- participant: '15559998888@s.whatsapp.net',
- remoteJid: '15551234567@s.whatsapp.net',
- quotedMessage: { conversation: 'approve deploy?' },
- },
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- botIds: ['15559998888@s.whatsapp.net'],
- downloadMedia: async () => Buffer.from(''),
- });
- assert.equal(event.quotedMessageId, 'outbound-1');
- assert.equal(event.quotedParticipant, '15559998888@s.whatsapp.net');
- assert.equal(event.quotedRemoteJid, '15551234567@s.whatsapp.net');
- assert.equal(event.quotedText, 'approve deploy?');
- assert.deepEqual(event.readReceiptKey, {
- id: 'incoming-1',
- remoteJid: '15551234567@s.whatsapp.net',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- });
- assert.equal(event.hasQuotedMessage, true);
- assert.equal(event.body, 'approved');
- console.log(' ✓ inbound quoted metadata includes quoted text');
- }
- // -- reply to uncaptioned quoted media resolves the cached original file --
- {
- // contextInfo.quotedMessage only ever carries a thumbnail-sized stub for
- // media (or nothing for an uncaptioned attachment) — extractBridgeEvent
- // must fall back to lookupQuotedMedia to find the original cached file.
- const event = await extractBridgeEvent({
- msg: {
- key: {
- id: 'incoming-2',
- remoteJid: '15551234567@s.whatsapp.net',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- },
- pushName: 'Tester',
- messageTimestamp: 123,
- message: {
- extendedTextMessage: {
- text: 'did you save this?',
- contextInfo: {
- stanzaId: 'original-image-1',
- participant: '15550001111@s.whatsapp.net',
- remoteJid: '15551234567@s.whatsapp.net',
- // Real WhatsApp traffic: an uncaptioned quoted image carries no
- // usable text, just a thumbnail-only imageMessage stub.
- quotedMessage: { imageMessage: {} },
- },
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- botIds: [],
- downloadMedia: async () => Buffer.from(''),
- lookupQuotedMedia: (chatId, messageId) => {
- assert.equal(chatId, '15551234567@s.whatsapp.net');
- assert.equal(messageId, 'original-image-1');
- return { hasMedia: true, mediaType: 'image', mediaUrls: ['/cache/image/img_original.jpg'] };
- },
- });
- assert.deepEqual(event.quotedMediaUrls, ['/cache/image/img_original.jpg']);
- assert.equal(event.quotedMediaType, 'image');
- assert.equal(event.quotedText, 'sent an image');
- console.log(' ✓ reply to uncaptioned quoted image resolves cached original file');
- }
- // -- bare quote-reply (no own text/media) still resolves quoted media -----
- {
- // A reply with no caption of its own (e.g. a bare quote of an uncaptioned
- // image) has empty own body/media, so bridge.js's empty-message guard must
- // consult quotedMediaUrls rather than only event.body/event.hasMedia, or
- // the reply is dropped even though extractBridgeEvent resolved real content.
- const event = await extractBridgeEvent({
- msg: {
- key: {
- id: 'incoming-4',
- remoteJid: '15551234567@s.whatsapp.net',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- },
- pushName: 'Tester',
- messageTimestamp: 123,
- message: {
- extendedTextMessage: {
- text: '',
- contextInfo: {
- stanzaId: 'original-image-2',
- participant: '15550001111@s.whatsapp.net',
- remoteJid: '15551234567@s.whatsapp.net',
- quotedMessage: { imageMessage: {} },
- },
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- botIds: [],
- downloadMedia: async () => Buffer.from(''),
- lookupQuotedMedia: () => ({ hasMedia: true, mediaType: 'image', mediaUrls: ['/cache/image/img_original.jpg'] }),
- });
- assert.equal(event.body, '');
- assert.equal(event.hasMedia, false);
- assert.deepEqual(event.quotedMediaUrls, ['/cache/image/img_original.jpg']);
- console.log(' ✓ bare quote-reply with no own content still carries resolved quoted media');
- }
- // -- quoted media lookup miss leaves quoted fields empty (no crash) -------
- {
- const event = await extractBridgeEvent({
- msg: {
- key: {
- id: 'incoming-3',
- remoteJid: '15551234567@s.whatsapp.net',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- },
- messageTimestamp: 123,
- message: {
- extendedTextMessage: {
- text: 'thanks',
- contextInfo: {
- stanzaId: 'long-gone-message',
- participant: '15550001111@s.whatsapp.net',
- remoteJid: '15551234567@s.whatsapp.net',
- quotedMessage: { imageMessage: {} },
- },
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- botIds: [],
- downloadMedia: async () => Buffer.from(''),
- lookupQuotedMedia: () => null,
- });
- assert.deepEqual(event.quotedMediaUrls, []);
- assert.equal(event.quotedMediaType, '');
- console.log(' ✓ quoted media cache miss leaves quoted media fields empty');
- }
- {
- const event = await extractBridgeEvent({
- msg: {
- key: { id: 'doc-1', remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: {
- documentMessage: {
- caption: 'see attached',
- fileName: 'report.pdf',
- mimetype: 'application/pdf',
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- downloadMedia: async () => Buffer.from('pdf'),
- writeMediaFile: async () => '/tmp/report.pdf',
- });
- assert.equal(event.hasMedia, true);
- assert.equal(event.mediaType, 'document');
- assert.equal(event.mime, 'application/pdf');
- assert.equal(event.fileName, 'report.pdf');
- assert.equal(event.nativeType, 'documentMessage');
- assert.deepEqual(event.mediaUrls, ['/tmp/report.pdf']);
- console.log(' ✓ inbound document metadata preserves MIME and filename');
- }
- {
- const cacheDir = mkdtempSync(path.join(tmpdir(), 'hermes-wa-doc-'));
- const event = await extractBridgeEvent({
- msg: {
- key: { id: 'doc-2', remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: {
- documentMessage: {
- caption: 'see attached',
- fileName: 'report',
- mimetype: 'application/pdf',
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- downloadMedia: async () => Buffer.from('pdf'),
- cacheDirs: { document: cacheDir },
- });
- assert.equal(event.mediaUrls.length, 1);
- assert.ok(event.mediaUrls[0].endsWith('_report.pdf'), event.mediaUrls[0]);
- console.log(' ✓ MIME extension is preserved when document filename has none');
- }
- {
- const event = await extractBridgeEvent({
- msg: {
- key: { id: 'loc-1', remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: {
- locationMessage: {
- name: 'HQ',
- degreesLatitude: 41.015,
- degreesLongitude: 28.979,
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- });
- assert.equal(event.mediaType, 'location');
- assert.equal(event.body, '[Location: HQ 41.015,28.979]');
- assert.deepEqual(event.nativeMetadata.location, {
- name: 'HQ',
- address: '',
- latitude: 41.015,
- longitude: 28.979,
- isLive: false,
- });
- console.log(' ✓ native location messages get text fallback and metadata');
- }
- {
- const event = await extractBridgeEvent({
- msg: {
- key: { id: 'poll-1', remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: {
- pollCreationMessage: {
- name: 'Approve deploy?',
- options: [{ optionName: 'Approve' }, { optionName: 'Deny' }],
- selectableOptionsCount: 1,
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- });
- assert.equal(event.mediaType, 'poll');
- assert.equal(event.body, '[Poll: Approve deploy? Options: Approve, Deny]');
- assert.deepEqual(event.nativeMetadata.poll.options, ['Approve', 'Deny']);
- console.log(' ✓ poll creation messages get text fallback and metadata');
- }
- // -- outbound media/poll helpers -----------------------------------------
- {
- const payload = mediaPayloadForFile({
- buffer: Buffer.from('gif89a'),
- filePath: '/tmp/loop.gif',
- mediaType: 'image',
- caption: 'loop',
- });
- assert.ok(payload.image, 'pure helper fallback keeps raw GIF as image bytes');
- assert.equal(payload.gifPlayback, undefined);
- assert.equal(payload.mimetype, 'image/gif');
- assert.equal(payload.caption, 'loop');
- console.log(' ✓ local GIF helper fallback stays truthful; live bridge converts to gifPlayback when possible');
- }
- {
- const payload = buildPollPayload({
- question: 'Proceed?',
- options: ['Approve', 'Deny'],
- selectableCount: 1,
- });
- assert.equal(payload.poll.name, 'Proceed?');
- assert.deepEqual(payload.poll.values, ['Approve', 'Deny']);
- assert.equal(payload.poll.selectableCount, 1);
- assert.equal(Buffer.isBuffer(payload.poll.messageSecret), true);
- assert.equal(payload.poll.messageSecret.length, 32);
- assert.deepEqual(pollCreationMessageFromPayload(payload), {
- messageContextInfo: {
- messageSecret: payload.poll.messageSecret,
- },
- pollCreationMessageV3: {
- name: 'Proceed?',
- options: [{ optionName: 'Approve' }, { optionName: 'Deny' }],
- selectableOptionsCount: 1,
- },
- });
- console.log(' ✓ poll payload primitive carries a cacheable vote secret');
- }
- {
- const pollCreation = {
- key: {
- id: 'poll-creation',
- remoteJid: '15551234567@s.whatsapp.net',
- fromMe: true,
- },
- message: {
- messageContextInfo: {
- messageSecret: Buffer.from('0123456789abcdef0123456789abcdef'),
- },
- pollCreationMessageV3: {
- name: 'Proceed?',
- options: [{ optionName: 'Approve' }, { optionName: 'Deny' }],
- selectableOptionsCount: 1,
- },
- },
- };
- const voteKey = {
- id: 'vote-message',
- remoteJid: '15551234567@s.whatsapp.net',
- participant: '15550001111@s.whatsapp.net',
- fromMe: false,
- };
- const encryptedVote = {
- encPayload: Buffer.from('payload'),
- encIv: Buffer.from('iv'),
- };
- const attempts = [];
- const pollUpdate = pollUpdateForAggregation({
- pollUpdateMessage: {
- pollCreationMessageKey: pollCreation.key,
- vote: encryptedVote,
- senderTimestampMs: 123,
- },
- pollUpdateMessageKey: voteKey,
- pollCreation,
- decryptPollVote: (vote, ctx) => {
- attempts.push({ pollCreatorJid: ctx.pollCreatorJid, voterJid: ctx.voterJid });
- assert.equal(vote, encryptedVote);
- assert.equal(ctx.pollMsgId, 'poll-creation');
- assert.equal(ctx.pollEncKey, pollCreation.message.messageContextInfo.messageSecret);
- if (ctx.pollCreatorJid !== 'creator-lid@lid') {
- throw new Error('wrong creator jid');
- }
- assert.equal(ctx.voterJid, '15550001111@s.whatsapp.net');
- return {
- selectedOptions: [createHash('sha256').update(Buffer.from('Approve')).digest()],
- };
- },
- getKeyAuthor: (key, meId = 'me') => (key?.fromMe ? meId : key?.participant || key?.remoteJid || ''),
- meId: 'classic-me@s.whatsapp.net',
- pollCreatorJids: ['classic-me@s.whatsapp.net', 'creator-lid@lid'],
- });
- assert.deepEqual(attempts.map(item => item.pollCreatorJid), ['classic-me@s.whatsapp.net', 'creator-lid@lid']);
- assert.equal(pollUpdate.pollUpdateMessageKey.id, 'vote-message');
- assert.equal(pollUpdate.senderTimestampMs, 123);
- const aggregation = getAggregateVotesInPollMessage({
- message: pollCreation.message,
- pollUpdates: [pollUpdate],
- });
- assert.deepEqual(
- aggregation.map(option => ({ name: option.name, voters: option.voters })),
- [
- { name: 'Approve', voters: ['15550001111@s.whatsapp.net'] },
- { name: 'Deny', voters: [] },
- ],
- );
- console.log(' ✓ encrypted poll upserts are wrapped into Baileys aggregation shape');
- }
- // -- media download failure containment (port of nanoclaw#2895) -----------
- {
- // A throwing downloadMedia (expired CDN URL) must not reject out of
- // extractBridgeEvent — before this guard the whole upsert batch died and
- // the message was silently dropped.
- const event = await extractBridgeEvent({
- msg: {
- key: { id: 'img-fail-1', remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: { imageMessage: { caption: '', mimetype: 'image/jpeg' } },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15551234567@s.whatsapp.net',
- senderNumber: '15551234567',
- downloadMedia: async () => { throw new Error('Failed to fetch stream from https://mmg.whatsapp.net/x'); },
- cacheDirs: { image: mkdtempSync(path.join(tmpdir(), 'wa-media-')) },
- });
- assert.equal(event.hasMedia, true);
- assert.equal(event.mediaUrls.length, 0);
- assert.equal(event.body, '[image could not be downloaded]');
- console.log(' ✓ failed media download is contained and surfaced in body');
- }
- {
- // Captioned message keeps the caption and appends the failure note.
- const event = await extractBridgeEvent({
- msg: {
- key: { id: 'doc-fail-1', remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: { documentMessage: { caption: 'see attached', fileName: 'q.pdf', mimetype: 'application/pdf' } },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15551234567@s.whatsapp.net',
- senderNumber: '15551234567',
- downloadMedia: async () => { throw new Error('boom'); },
- cacheDirs: { document: mkdtempSync(path.join(tmpdir(), 'wa-media-')) },
- });
- assert.equal(event.body, 'see attached\n[document could not be downloaded]');
- assert.equal(event.mediaUrls.length, 0);
- console.log(' ✓ captioned failed download keeps caption and appends note');
- }
- // -- quoted message envelopes --------------------------------------------
- {
- // WhatsApp wraps disappearing (ephemeral), view-once and re-shared
- // document messages in envelope types. The quote extractor must see
- // through them, or a reply to such a message keeps its quoted ID but
- // loses the quoted text entirely (#106066).
- for (const [fixture, quotedMessage] of [
- ['plain conversation', { conversation: 'Example appointment at 11:40' }],
- ['ephemeral-wrapped', {
- ephemeralMessage: { message: { conversation: 'Example appointment at 11:40' } },
- }],
- ['view-once wrapped', {
- viewOnceMessageV2: { message: { conversation: 'Example appointment at 11:40' } },
- }],
- ['document-with-caption envelope', {
- documentWithCaptionMessage: {
- message: { documentMessage: { caption: 'the signed contract', fileName: 'contract.pdf' } },
- },
- }],
- ['extended text inside ephemeral', {
- ephemeralMessage: {
- message: { extendedTextMessage: { text: 'Example appointment at 11:40' } },
- },
- }],
- ]) {
- const event = await extractBridgeEvent({
- msg: {
- key: { id: `reply-${fixture}`, remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: {
- extendedTextMessage: {
- text: 'confirmed',
- contextInfo: {
- stanzaId: 'original-id',
- participant: '15559998888@s.whatsapp.net',
- quotedMessage,
- },
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- botIds: ['15559998888@s.whatsapp.net'],
- downloadMedia: async () => Buffer.from(''),
- });
- assert.equal(event.quotedMessageId, 'original-id', fixture);
- assert.equal(event.hasQuotedMessage, true, fixture);
- if (fixture === 'document-with-caption envelope') {
- assert.equal(event.quotedText, 'the signed contract', fixture);
- } else {
- assert.equal(event.quotedText, 'Example appointment at 11:40', fixture);
- }
- }
- console.log(' ✓ quoted message text survives ephemeral/view-once/document envelopes');
- }
- {
- // Nested envelopes (ephemeral wrapping viewOnce wrapping the payload) and
- // the second envelope position: quoted text must resolve there as well.
- const quotedMessage = {
- ephemeralMessage: {
- message: {
- viewOnceMessageV2: {
- message: { extendedTextMessage: { text: 'Example appointment at 11:40' } },
- },
- },
- },
- };
- const event = await extractBridgeEvent({
- msg: {
- key: { id: 'reply-nested', remoteJid: '15551234567@s.whatsapp.net', fromMe: false },
- messageTimestamp: 123,
- message: {
- ephemeralMessage: {
- message: {
- extendedTextMessage: {
- text: 'confirmed',
- contextInfo: { stanzaId: 'original-id', participant: '15559998888@s.whatsapp.net', quotedMessage },
- },
- },
- },
- },
- },
- chatId: '15551234567@s.whatsapp.net',
- senderId: '15550001111@s.whatsapp.net',
- senderNumber: '15550001111',
- botIds: ['15559998888@s.whatsapp.net'],
- downloadMedia: async () => Buffer.from(''),
- });
- assert.equal(event.quotedMessageId, 'original-id');
- assert.equal(event.hasQuotedMessage, true);
- assert.equal(event.quotedText, 'Example appointment at 11:40');
- console.log(' ✓ nested envelopes: quote text resolves through both layers');
- }
- console.log('\n✅ All WhatsApp native bridge helper tests passed.');
|