Fix legacy call-history messages without a callId
Co-authored-by: Scott Nonnenberg <scott@signal.org>
This commit is contained in:
Jamie Kyle
Jamie Kyle
parent
6f0401b847
commit
ef0a3de636
17 changed files with 831 additions and 426 deletions
|
|
@ -21,7 +21,7 @@ describe('SQL/updateToSchemaVersion88', () => {
|
|||
|
||||
beforeEach(() => {
|
||||
db = new SQL(':memory:');
|
||||
updateToVersion(db, 87);
|
||||
updateToVersion(db, 86);
|
||||
|
||||
insertData(db, 'items', [
|
||||
{
|
||||
|
|
|
|||
404
ts/test-node/sql/migration_89_test.ts
Normal file
404
ts/test-node/sql/migration_89_test.ts
Normal file
|
|
@ -0,0 +1,404 @@
|
|||
// Copyright 2023 Signal Messenger, LLC
|
||||
// SPDX-License-Identifier: AGPL-3.0-only
|
||||
|
||||
import { assert } from 'chai';
|
||||
import type { Database } from '@signalapp/better-sqlite3';
|
||||
import SQL from '@signalapp/better-sqlite3';
|
||||
import { v4 as generateGuid } from 'uuid';
|
||||
|
||||
import { jsonToObject, sql } from '../../sql/util';
|
||||
import { CallMode } from '../../types/Calling';
|
||||
import type { CallHistoryDetails } from '../../types/CallDisposition';
|
||||
import {
|
||||
CallDirection,
|
||||
CallType,
|
||||
DirectCallStatus,
|
||||
GroupCallStatus,
|
||||
callHistoryDetailsSchema,
|
||||
} from '../../types/CallDisposition';
|
||||
import type {
|
||||
CallHistoryDetailsFromDiskType,
|
||||
MessageWithCallHistoryDetails,
|
||||
} from '../../sql/migrations/89-call-history';
|
||||
import { getCallIdFromEra } from '../../util/callDisposition';
|
||||
import { isValidUuid } from '../../util/isValidUuid';
|
||||
import { updateToVersion } from './helpers';
|
||||
import type { MessageType } from '../../sql/Interface';
|
||||
|
||||
describe('SQL/updateToSchemaVersion89', () => {
|
||||
let db: Database;
|
||||
|
||||
beforeEach(() => {
|
||||
db = new SQL(':memory:');
|
||||
updateToVersion(db, 88);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
db.close();
|
||||
});
|
||||
|
||||
function getDirectCallHistoryDetails(options: {
|
||||
callId: string | null;
|
||||
noCallMode?: boolean;
|
||||
wasDeclined?: boolean;
|
||||
}): CallHistoryDetailsFromDiskType {
|
||||
return {
|
||||
callId: options.callId ?? undefined,
|
||||
callMode: options.noCallMode ? undefined : CallMode.Direct,
|
||||
wasDeclined: options.wasDeclined ?? false,
|
||||
wasIncoming: false,
|
||||
wasVideoCall: false,
|
||||
acceptedTime: undefined,
|
||||
endedTime: undefined,
|
||||
};
|
||||
}
|
||||
|
||||
function getGroupCallHistoryDetails(options: {
|
||||
eraId: string;
|
||||
noCallMode?: boolean;
|
||||
}): CallHistoryDetailsFromDiskType {
|
||||
return {
|
||||
eraId: options.eraId,
|
||||
callMode: options.noCallMode ? undefined : CallMode.Group,
|
||||
creatorUuid: generateGuid(),
|
||||
startedTime: Date.now(),
|
||||
};
|
||||
}
|
||||
|
||||
function createCallHistoryMessage(options: {
|
||||
messageId: string;
|
||||
conversationId: string;
|
||||
callHistoryDetails: CallHistoryDetailsFromDiskType;
|
||||
}): MessageWithCallHistoryDetails {
|
||||
const message: MessageWithCallHistoryDetails = {
|
||||
id: options.messageId,
|
||||
type: 'call-history',
|
||||
conversationId: options.conversationId,
|
||||
sent_at: Date.now() - 10,
|
||||
received_at: Date.now() - 10,
|
||||
timestamp: Date.now() - 10,
|
||||
callHistoryDetails: options.callHistoryDetails,
|
||||
};
|
||||
|
||||
const json = JSON.stringify(message);
|
||||
|
||||
const [query, params] = sql`
|
||||
INSERT INTO messages
|
||||
(id, conversationId, type, json)
|
||||
VALUES
|
||||
(
|
||||
${message.id},
|
||||
${message.conversationId},
|
||||
${message.type},
|
||||
${json}
|
||||
)
|
||||
`;
|
||||
|
||||
db.prepare(query).run(params);
|
||||
|
||||
return message;
|
||||
}
|
||||
|
||||
function createConversation(type: 'private' | 'group') {
|
||||
const id = generateGuid();
|
||||
const serviceId = type === 'private' ? generateGuid() : null;
|
||||
const groupId = type === 'group' ? generateGuid() : null;
|
||||
|
||||
const [query, params] = sql`
|
||||
INSERT INTO conversations
|
||||
(id, type, serviceId, groupId)
|
||||
VALUES
|
||||
(${id}, ${type}, ${serviceId}, ${groupId});
|
||||
`;
|
||||
|
||||
db.prepare(query).run(params);
|
||||
|
||||
return { id, serviceId, groupId };
|
||||
}
|
||||
|
||||
function getAllCallHistory() {
|
||||
const [selectHistoryQuery] = sql`
|
||||
SELECT * FROM callsHistory;
|
||||
`;
|
||||
return db
|
||||
.prepare(selectHistoryQuery)
|
||||
.all()
|
||||
.map(row => {
|
||||
return callHistoryDetailsSchema.parse(row);
|
||||
});
|
||||
}
|
||||
|
||||
it('pulls out call history messages into the new table', () => {
|
||||
updateToVersion(db, 88);
|
||||
|
||||
const conversation1 = createConversation('private');
|
||||
const conversation2 = createConversation('group');
|
||||
|
||||
const callId1 = '123';
|
||||
const eraId2 = 'abc';
|
||||
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation1.id,
|
||||
callHistoryDetails: getDirectCallHistoryDetails({
|
||||
callId: callId1,
|
||||
}),
|
||||
});
|
||||
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation2.id,
|
||||
callHistoryDetails: getGroupCallHistoryDetails({
|
||||
eraId: eraId2,
|
||||
}),
|
||||
});
|
||||
|
||||
updateToVersion(db, 89);
|
||||
|
||||
const callHistory = getAllCallHistory();
|
||||
|
||||
assert.strictEqual(callHistory.length, 2);
|
||||
assert.strictEqual(callHistory[0].callId, callId1);
|
||||
assert.strictEqual(callHistory[1].callId, getCallIdFromEra(eraId2));
|
||||
});
|
||||
|
||||
it('migrates older messages without a callId', () => {
|
||||
updateToVersion(db, 88);
|
||||
|
||||
const conversation = createConversation('private');
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation.id,
|
||||
callHistoryDetails: getDirectCallHistoryDetails({
|
||||
callId: null, // no id
|
||||
}),
|
||||
});
|
||||
|
||||
updateToVersion(db, 89);
|
||||
|
||||
const callHistory = getAllCallHistory();
|
||||
|
||||
assert.strictEqual(callHistory.length, 1);
|
||||
assert.isTrue(isValidUuid(callHistory[0].callId));
|
||||
});
|
||||
|
||||
it('migrates older messages without a callMode', () => {
|
||||
updateToVersion(db, 88);
|
||||
|
||||
const conversation1 = createConversation('private');
|
||||
const conversation2 = createConversation('group');
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation1.id,
|
||||
callHistoryDetails: getDirectCallHistoryDetails({
|
||||
callId: null, // no id
|
||||
noCallMode: true,
|
||||
}),
|
||||
});
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation2.id,
|
||||
callHistoryDetails: getGroupCallHistoryDetails({
|
||||
eraId: 'abc',
|
||||
noCallMode: true,
|
||||
}),
|
||||
});
|
||||
|
||||
updateToVersion(db, 89);
|
||||
|
||||
const callHistory = getAllCallHistory();
|
||||
|
||||
assert.strictEqual(callHistory.length, 2);
|
||||
assert.strictEqual(callHistory[0].mode, CallMode.Direct);
|
||||
assert.strictEqual(callHistory[1].mode, CallMode.Group);
|
||||
});
|
||||
|
||||
it('handles unique constraint violations', () => {
|
||||
updateToVersion(db, 88);
|
||||
|
||||
const conversation = createConversation('private');
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation.id, // same conversation
|
||||
callHistoryDetails: getDirectCallHistoryDetails({
|
||||
callId: '123', // same callId
|
||||
}),
|
||||
});
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation.id, // same conversation
|
||||
callHistoryDetails: getDirectCallHistoryDetails({
|
||||
callId: '123', // same callId
|
||||
}),
|
||||
});
|
||||
|
||||
updateToVersion(db, 89);
|
||||
|
||||
const callHistory = getAllCallHistory();
|
||||
assert.strictEqual(callHistory.length, 1);
|
||||
});
|
||||
|
||||
it('normalizes peerId to conversation.serviceId or conversation.groupId', () => {
|
||||
updateToVersion(db, 88);
|
||||
|
||||
const conversation1 = createConversation('private');
|
||||
const conversation2 = createConversation('group');
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation1.id,
|
||||
callHistoryDetails: getDirectCallHistoryDetails({
|
||||
callId: '123',
|
||||
}),
|
||||
});
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation2.id,
|
||||
callHistoryDetails: getGroupCallHistoryDetails({
|
||||
eraId: 'abc',
|
||||
}),
|
||||
});
|
||||
|
||||
updateToVersion(db, 89);
|
||||
|
||||
const callHistory = getAllCallHistory();
|
||||
assert.strictEqual(callHistory.length, 2);
|
||||
assert.strictEqual(callHistory[0].peerId, conversation1.serviceId);
|
||||
assert.strictEqual(callHistory[1].peerId, conversation2.groupId);
|
||||
});
|
||||
|
||||
describe('clients with schema version 87', () => {
|
||||
function createCallHistoryTable() {
|
||||
const [query] = sql`
|
||||
CREATE TABLE callsHistory (
|
||||
callId TEXT PRIMARY KEY,
|
||||
peerId TEXT NOT NULL, -- conversation id (legacy) | uuid | groupId | roomId
|
||||
ringerId TEXT DEFAULT NULL, -- ringer uuid
|
||||
mode TEXT NOT NULL, -- enum "Direct" | "Group"
|
||||
type TEXT NOT NULL, -- enum "Audio" | "Video" | "Group"
|
||||
direction TEXT NOT NULL, -- enum "Incoming" | "Outgoing
|
||||
-- Direct: enum "Pending" | "Missed" | "Accepted" | "Deleted"
|
||||
-- Group: enum "GenericGroupCall" | "OutgoingRing" | "Ringing" | "Joined" | "Missed" | "Declined" | "Accepted" | "Deleted"
|
||||
status TEXT NOT NULL,
|
||||
timestamp INTEGER NOT NULL,
|
||||
UNIQUE (callId, peerId) ON CONFLICT FAIL
|
||||
);
|
||||
`;
|
||||
db.exec(query);
|
||||
}
|
||||
|
||||
function insertCallHistory(callHistory: CallHistoryDetails) {
|
||||
const [query, params] = sql`
|
||||
INSERT INTO callsHistory (
|
||||
callId,
|
||||
peerId,
|
||||
ringerId,
|
||||
mode,
|
||||
type,
|
||||
direction,
|
||||
status,
|
||||
timestamp
|
||||
) VALUES (
|
||||
${callHistory.callId},
|
||||
${callHistory.peerId},
|
||||
${callHistory.ringerId},
|
||||
${callHistory.mode},
|
||||
${callHistory.type},
|
||||
${callHistory.direction},
|
||||
${callHistory.status},
|
||||
${callHistory.timestamp}
|
||||
);
|
||||
`;
|
||||
db.prepare(query).run(params);
|
||||
}
|
||||
|
||||
function getMessages() {
|
||||
const [query] = sql`
|
||||
SELECT json FROM messages;
|
||||
`;
|
||||
return db
|
||||
.prepare(query)
|
||||
.all()
|
||||
.map(row => {
|
||||
return jsonToObject<MessageType>(row.json);
|
||||
});
|
||||
}
|
||||
|
||||
it('migrates existing peerId to conversation.serviceId or conversation.groupId', () => {
|
||||
updateToVersion(db, 88);
|
||||
|
||||
createCallHistoryTable();
|
||||
|
||||
const conversation1 = createConversation('private');
|
||||
const conversation2 = createConversation('group');
|
||||
|
||||
insertCallHistory({
|
||||
callId: '123',
|
||||
peerId: conversation1.id,
|
||||
ringerId: null,
|
||||
mode: CallMode.Direct,
|
||||
type: CallType.Audio,
|
||||
direction: CallDirection.Incoming,
|
||||
status: DirectCallStatus.Accepted,
|
||||
timestamp: Date.now(),
|
||||
});
|
||||
insertCallHistory({
|
||||
callId: 'abc',
|
||||
peerId: conversation2.id,
|
||||
ringerId: null,
|
||||
mode: CallMode.Group,
|
||||
type: CallType.Group,
|
||||
direction: CallDirection.Incoming,
|
||||
status: GroupCallStatus.Accepted,
|
||||
timestamp: Date.now(),
|
||||
});
|
||||
|
||||
updateToVersion(db, 89);
|
||||
|
||||
const callHistory = getAllCallHistory();
|
||||
assert.strictEqual(callHistory.length, 2);
|
||||
assert.strictEqual(callHistory[0].peerId, conversation1.serviceId);
|
||||
assert.strictEqual(callHistory[1].peerId, conversation2.groupId);
|
||||
});
|
||||
|
||||
it('migrates duplicate call history where the first was already migrated', () => {
|
||||
updateToVersion(db, 88);
|
||||
|
||||
createCallHistoryTable();
|
||||
|
||||
const conversation = createConversation('private');
|
||||
|
||||
insertCallHistory({
|
||||
callId: '123',
|
||||
peerId: conversation.id,
|
||||
ringerId: null,
|
||||
mode: CallMode.Direct,
|
||||
type: CallType.Audio,
|
||||
direction: CallDirection.Incoming,
|
||||
status: DirectCallStatus.Pending,
|
||||
timestamp: Date.now() - 1000,
|
||||
});
|
||||
|
||||
createCallHistoryMessage({
|
||||
messageId: generateGuid(),
|
||||
conversationId: conversation.id,
|
||||
callHistoryDetails: getDirectCallHistoryDetails({
|
||||
callId: '123',
|
||||
wasDeclined: true,
|
||||
}),
|
||||
});
|
||||
|
||||
updateToVersion(db, 89);
|
||||
|
||||
const callHistory = getAllCallHistory();
|
||||
|
||||
assert.strictEqual(callHistory.length, 1);
|
||||
assert.strictEqual(callHistory[0].status, DirectCallStatus.Declined);
|
||||
|
||||
const messages = getMessages();
|
||||
assert.strictEqual(messages.length, 1);
|
||||
assert.strictEqual(messages[0].type, 'call-history');
|
||||
assert.strictEqual(messages[0].callId, '123');
|
||||
assert.notProperty(messages[0], 'callHistoryDetails');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
@ -17,9 +17,6 @@ import { objectToJSON, sql, sqlJoin } from '../../sql/util';
|
|||
import { BodyRange } from '../../types/BodyRange';
|
||||
import type { AciString } from '../../types/ServiceId';
|
||||
import { generateAci } from '../../types/ServiceId';
|
||||
import { callHistoryDetailsSchema } from '../../types/CallDisposition';
|
||||
import { CallMode } from '../../types/Calling';
|
||||
import type { MessageAttributesType } from '../../model-types.d';
|
||||
import { updateToVersion } from './helpers';
|
||||
|
||||
const OUR_UUID = generateGuid();
|
||||
|
|
@ -3565,162 +3562,4 @@ describe('SQL migrations test', () => {
|
|||
);
|
||||
});
|
||||
});
|
||||
|
||||
describe('updateToSchemaVersion87', () => {
|
||||
it('pulls out call history messages into the new table', () => {
|
||||
updateToVersion(db, 86);
|
||||
|
||||
const message1Id = generateGuid();
|
||||
const message2Id = generateGuid();
|
||||
const conversationId = generateGuid();
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- using old types
|
||||
const message1: MessageAttributesType & { callHistoryDetails: any } = {
|
||||
id: message1Id,
|
||||
type: 'call-history',
|
||||
conversationId,
|
||||
sent_at: Date.now() - 10,
|
||||
received_at: Date.now() - 10,
|
||||
timestamp: Date.now() - 10,
|
||||
callHistoryDetails: {
|
||||
callId: '123',
|
||||
callMode: CallMode.Direct,
|
||||
wasDeclined: false,
|
||||
wasDeleted: false,
|
||||
wasIncoming: false,
|
||||
wasVideoCall: false,
|
||||
acceptedTime: Date.now(),
|
||||
endedTime: undefined,
|
||||
},
|
||||
};
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- using old types
|
||||
const message2: MessageAttributesType & { callHistoryDetails: any } = {
|
||||
id: message2Id,
|
||||
type: 'call-history',
|
||||
conversationId,
|
||||
sent_at: Date.now(),
|
||||
received_at: Date.now(),
|
||||
timestamp: Date.now(),
|
||||
callHistoryDetails: {
|
||||
callMode: CallMode.Group,
|
||||
creatorUuid: generateGuid(),
|
||||
eraId: (0x123).toString(16),
|
||||
startedTime: Date.now(),
|
||||
},
|
||||
};
|
||||
|
||||
const [insertQuery, insertParams] = sql`
|
||||
INSERT INTO messages (
|
||||
id,
|
||||
conversationId,
|
||||
type,
|
||||
json
|
||||
)
|
||||
VALUES
|
||||
(
|
||||
${message1Id},
|
||||
${conversationId},
|
||||
${message1.type},
|
||||
${JSON.stringify(message1)}
|
||||
),
|
||||
(
|
||||
${message2Id},
|
||||
${conversationId},
|
||||
${message2.type},
|
||||
${JSON.stringify(message2)}
|
||||
);
|
||||
`;
|
||||
|
||||
db.prepare(insertQuery).run(insertParams);
|
||||
|
||||
updateToVersion(db, 87);
|
||||
|
||||
const [selectHistoryQuery] = sql`
|
||||
SELECT * FROM callsHistory;
|
||||
`;
|
||||
|
||||
const rows = db.prepare(selectHistoryQuery).all();
|
||||
|
||||
for (const row of rows) {
|
||||
callHistoryDetailsSchema.parse(row);
|
||||
}
|
||||
});
|
||||
|
||||
it('handles unique constraint violations', () => {
|
||||
updateToVersion(db, 86);
|
||||
|
||||
const message1Id = generateGuid();
|
||||
const message2Id = generateGuid();
|
||||
const conversationId = generateGuid();
|
||||
const callHistoryDetails = {
|
||||
callId: '123',
|
||||
callMode: CallMode.Direct,
|
||||
wasDeclined: false,
|
||||
wasDeleted: false,
|
||||
wasIncoming: false,
|
||||
wasVideoCall: false,
|
||||
acceptedTime: Date.now(),
|
||||
endedTime: undefined,
|
||||
};
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- using old types
|
||||
const message1: MessageAttributesType & { callHistoryDetails: any } = {
|
||||
id: message1Id,
|
||||
type: 'call-history',
|
||||
conversationId,
|
||||
sent_at: Date.now() - 10,
|
||||
received_at: Date.now() - 10,
|
||||
timestamp: Date.now() - 10,
|
||||
callHistoryDetails,
|
||||
};
|
||||
|
||||
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- using old types
|
||||
const message2: MessageAttributesType & { callHistoryDetails: any } = {
|
||||
id: message2Id,
|
||||
type: 'call-history',
|
||||
conversationId,
|
||||
sent_at: Date.now(),
|
||||
received_at: Date.now(),
|
||||
timestamp: Date.now(),
|
||||
callHistoryDetails,
|
||||
};
|
||||
|
||||
const [insertQuery, insertParams] = sql`
|
||||
INSERT INTO messages (
|
||||
id,
|
||||
conversationId,
|
||||
type,
|
||||
json
|
||||
)
|
||||
VALUES
|
||||
(
|
||||
${message1Id},
|
||||
${conversationId},
|
||||
${message1.type},
|
||||
${JSON.stringify(message1)}
|
||||
),
|
||||
(
|
||||
${message2Id},
|
||||
${conversationId},
|
||||
${message2.type},
|
||||
${JSON.stringify(message2)}
|
||||
);
|
||||
`;
|
||||
|
||||
db.prepare(insertQuery).run(insertParams);
|
||||
|
||||
updateToVersion(db, 87);
|
||||
|
||||
const [selectHistoryQuery] = sql`
|
||||
SELECT * FROM callsHistory;
|
||||
`;
|
||||
|
||||
const rows = db.prepare(selectHistoryQuery).all();
|
||||
for (const row of rows) {
|
||||
callHistoryDetailsSchema.parse(row);
|
||||
}
|
||||
assert.strictEqual(rows.length, 1);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue