Support device name change sync message
Co-authored-by: trevor-signal <131492920+trevor-signal@users.noreply.github.com>
This commit is contained in:
parent
227d80e441
commit
f5b6852f39
9 changed files with 190 additions and 12 deletions
|
@ -701,6 +701,11 @@ message SyncMessage {
|
||||||
repeated AttachmentDelete attachmentDeletes = 4;
|
repeated AttachmentDelete attachmentDeletes = 4;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
message DeviceNameChange {
|
||||||
|
reserved /*name*/ 1;
|
||||||
|
optional uint32 deviceId = 2;
|
||||||
|
}
|
||||||
|
|
||||||
optional Sent sent = 1;
|
optional Sent sent = 1;
|
||||||
optional Contacts contacts = 2;
|
optional Contacts contacts = 2;
|
||||||
reserved /* groups */ 3;
|
reserved /* groups */ 3;
|
||||||
|
@ -723,6 +728,7 @@ message SyncMessage {
|
||||||
optional CallLinkUpdate callLinkUpdate = 20;
|
optional CallLinkUpdate callLinkUpdate = 20;
|
||||||
optional CallLogEvent callLogEvent = 21;
|
optional CallLogEvent callLogEvent = 21;
|
||||||
optional DeleteForMe deleteForMe = 22;
|
optional DeleteForMe deleteForMe = 22;
|
||||||
|
optional DeviceNameChange deviceNameChange = 23;
|
||||||
}
|
}
|
||||||
|
|
||||||
message AttachmentPointer {
|
message AttachmentPointer {
|
||||||
|
|
|
@ -199,6 +199,10 @@ import { getParametersForRedux, loadAll } from './services/allLoaders';
|
||||||
import { checkFirstEnvelope } from './util/checkFirstEnvelope';
|
import { checkFirstEnvelope } from './util/checkFirstEnvelope';
|
||||||
import { BLOCKED_UUIDS_ID } from './textsecure/storage/Blocked';
|
import { BLOCKED_UUIDS_ID } from './textsecure/storage/Blocked';
|
||||||
import { ReleaseNotesFetcher } from './services/releaseNotesFetcher';
|
import { ReleaseNotesFetcher } from './services/releaseNotesFetcher';
|
||||||
|
import {
|
||||||
|
maybeQueueDeviceNameFetch,
|
||||||
|
onDeviceNameChangeSync,
|
||||||
|
} from './util/onDeviceNameChangeSync';
|
||||||
|
|
||||||
export function isOverHourIntoPast(timestamp: number): boolean {
|
export function isOverHourIntoPast(timestamp: number): boolean {
|
||||||
return isNumber(timestamp) && isOlderThan(timestamp, HOUR);
|
return isNumber(timestamp) && isOlderThan(timestamp, HOUR);
|
||||||
|
@ -697,6 +701,10 @@ export async function startApp(): Promise<void> {
|
||||||
'deleteForMeSync',
|
'deleteForMeSync',
|
||||||
queuedEventListener(onDeleteForMeSync, false)
|
queuedEventListener(onDeleteForMeSync, false)
|
||||||
);
|
);
|
||||||
|
messageReceiver.addEventListener(
|
||||||
|
'deviceNameChangeSync',
|
||||||
|
queuedEventListener(onDeviceNameChangeSync, false)
|
||||||
|
);
|
||||||
|
|
||||||
if (!window.storage.get('defaultConversationColor')) {
|
if (!window.storage.get('defaultConversationColor')) {
|
||||||
drop(
|
drop(
|
||||||
|
@ -1924,6 +1932,12 @@ export async function startApp(): Promise<void> {
|
||||||
Errors.toLogFormat(error)
|
Errors.toLogFormat(error)
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Ensure we have the correct device name locally (allowing us to get eventually
|
||||||
|
// consistent with primary, in case we failed to process a deviceNameChangeSync
|
||||||
|
// for some reason). We do this after calling `maybeUpdateDeviceName` to ensure
|
||||||
|
// that the device name on server is encrypted.
|
||||||
|
drop(maybeQueueDeviceNameFetch());
|
||||||
}
|
}
|
||||||
|
|
||||||
if (firstRun === true && !areWePrimaryDevice) {
|
if (firstRun === true && !areWePrimaryDevice) {
|
||||||
|
|
|
@ -315,6 +315,7 @@ export default class AccountManager extends EventTarget {
|
||||||
|
|
||||||
if (base64) {
|
if (base64) {
|
||||||
await this.server.updateDeviceName(base64);
|
await this.server.updateDeviceName(base64);
|
||||||
|
await window.textsecure.storage.user.setDeviceNameEncrypted();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -113,6 +113,7 @@ import {
|
||||||
DecryptionErrorEvent,
|
DecryptionErrorEvent,
|
||||||
DeleteForMeSyncEvent,
|
DeleteForMeSyncEvent,
|
||||||
DeliveryEvent,
|
DeliveryEvent,
|
||||||
|
DeviceNameChangeSyncEvent,
|
||||||
EmptyEvent,
|
EmptyEvent,
|
||||||
EnvelopeQueuedEvent,
|
EnvelopeQueuedEvent,
|
||||||
EnvelopeUnsealedEvent,
|
EnvelopeUnsealedEvent,
|
||||||
|
@ -701,6 +702,11 @@ export default class MessageReceiver
|
||||||
handler: (ev: DeleteForMeSyncEvent) => void
|
handler: (ev: DeleteForMeSyncEvent) => void
|
||||||
): void;
|
): void;
|
||||||
|
|
||||||
|
public override addEventListener(
|
||||||
|
name: 'deviceNameChangeSync',
|
||||||
|
handler: (ev: DeviceNameChangeSyncEvent) => void
|
||||||
|
): void;
|
||||||
|
|
||||||
public override addEventListener(name: string, handler: EventHandler): void {
|
public override addEventListener(name: string, handler: EventHandler): void {
|
||||||
return super.addEventListener(name, handler);
|
return super.addEventListener(name, handler);
|
||||||
}
|
}
|
||||||
|
@ -3191,6 +3197,12 @@ export default class MessageReceiver
|
||||||
if (syncMessage.deleteForMe) {
|
if (syncMessage.deleteForMe) {
|
||||||
return this.handleDeleteForMeSync(envelope, syncMessage.deleteForMe);
|
return this.handleDeleteForMeSync(envelope, syncMessage.deleteForMe);
|
||||||
}
|
}
|
||||||
|
if (syncMessage.deviceNameChange) {
|
||||||
|
return this.handleDeviceNameChangeSync(
|
||||||
|
envelope,
|
||||||
|
syncMessage.deviceNameChange
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
this.removeFromCache(envelope);
|
this.removeFromCache(envelope);
|
||||||
const envelopeId = getEnvelopeId(envelope);
|
const envelopeId = getEnvelopeId(envelope);
|
||||||
|
@ -3817,6 +3829,39 @@ export default class MessageReceiver
|
||||||
log.info('handleDeleteForMeSync: finished');
|
log.info('handleDeleteForMeSync: finished');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private async handleDeviceNameChangeSync(
|
||||||
|
envelope: ProcessedEnvelope,
|
||||||
|
deviceNameChange: Proto.SyncMessage.IDeviceNameChange
|
||||||
|
): Promise<void> {
|
||||||
|
const logId = `MessageReceiver.handleDeviceNameChangeSync: ${getEnvelopeId(envelope)}`;
|
||||||
|
log.info(logId);
|
||||||
|
|
||||||
|
logUnexpectedUrgentValue(envelope, 'deviceNameChangeSync');
|
||||||
|
|
||||||
|
const { deviceId } = deviceNameChange;
|
||||||
|
const localDeviceId = parseIntOrThrow(
|
||||||
|
this.storage.user.getDeviceId(),
|
||||||
|
'MessageReceiver.handleDeviceNameChangeSync: localDeviceId'
|
||||||
|
);
|
||||||
|
|
||||||
|
if (deviceId == null) {
|
||||||
|
log.warn(logId, 'deviceId was falsey');
|
||||||
|
this.removeFromCache(envelope);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (deviceId !== localDeviceId) {
|
||||||
|
log.info(logId, 'meant for other device:', deviceId);
|
||||||
|
this.removeFromCache(envelope);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const deviceNameChangeEvent = new DeviceNameChangeSyncEvent(
|
||||||
|
this.removeFromCache.bind(this, envelope)
|
||||||
|
);
|
||||||
|
await this.dispatchAndWait(logId, deviceNameChangeEvent);
|
||||||
|
}
|
||||||
|
|
||||||
private async handleContacts(
|
private async handleContacts(
|
||||||
envelope: ProcessedEnvelope,
|
envelope: ProcessedEnvelope,
|
||||||
contactSyncProto: Proto.SyncMessage.IContacts
|
contactSyncProto: Proto.SyncMessage.IContacts
|
||||||
|
|
|
@ -862,6 +862,19 @@ export type GetAccountForUsernameResultType = z.infer<
|
||||||
typeof getAccountForUsernameResultZod
|
typeof getAccountForUsernameResultZod
|
||||||
>;
|
>;
|
||||||
|
|
||||||
|
const getDevicesResultZod = z.object({
|
||||||
|
devices: z.array(
|
||||||
|
z.object({
|
||||||
|
id: z.number(),
|
||||||
|
name: z.string().nullish(), // primary devices may not have a name
|
||||||
|
lastSeen: z.number().nullish(),
|
||||||
|
created: z.number().nullish(),
|
||||||
|
})
|
||||||
|
),
|
||||||
|
});
|
||||||
|
|
||||||
|
export type GetDevicesResultType = z.infer<typeof getDevicesResultZod>;
|
||||||
|
|
||||||
export type GetIceServersResultType = Readonly<{
|
export type GetIceServersResultType = Readonly<{
|
||||||
relays?: ReadonlyArray<IceServerGroupType>;
|
relays?: ReadonlyArray<IceServerGroupType>;
|
||||||
}>;
|
}>;
|
||||||
|
@ -874,15 +887,6 @@ export type IceServerGroupType = Readonly<{
|
||||||
hostname?: string;
|
hostname?: string;
|
||||||
}>;
|
}>;
|
||||||
|
|
||||||
export type GetDevicesResultType = ReadonlyArray<
|
|
||||||
Readonly<{
|
|
||||||
id: number;
|
|
||||||
name: string;
|
|
||||||
lastSeen: number;
|
|
||||||
created: number;
|
|
||||||
}>
|
|
||||||
>;
|
|
||||||
|
|
||||||
export type GetSenderCertificateResultType = Readonly<{ certificate: string }>;
|
export type GetSenderCertificateResultType = Readonly<{ certificate: string }>;
|
||||||
|
|
||||||
export type MakeProxiedRequestResultType =
|
export type MakeProxiedRequestResultType =
|
||||||
|
@ -1376,6 +1380,7 @@ export type WebAPIType = {
|
||||||
getAccountForUsername: (
|
getAccountForUsername: (
|
||||||
options: GetAccountForUsernameOptionsType
|
options: GetAccountForUsernameOptionsType
|
||||||
) => Promise<GetAccountForUsernameResultType>;
|
) => Promise<GetAccountForUsernameResultType>;
|
||||||
|
getDevices: () => Promise<GetDevicesResultType>;
|
||||||
getProfileUnauth: (
|
getProfileUnauth: (
|
||||||
serviceId: ServiceIdString,
|
serviceId: ServiceIdString,
|
||||||
options: ProfileFetchUnauthRequestOptions
|
options: ProfileFetchUnauthRequestOptions
|
||||||
|
@ -1847,6 +1852,7 @@ export function initialize({
|
||||||
getBackupUploadForm,
|
getBackupUploadForm,
|
||||||
getBadgeImageFile,
|
getBadgeImageFile,
|
||||||
getConfig,
|
getConfig,
|
||||||
|
getDevices,
|
||||||
getGroup,
|
getGroup,
|
||||||
getGroupAvatar,
|
getGroupAvatar,
|
||||||
getGroupCredentials,
|
getGroupCredentials,
|
||||||
|
@ -2935,6 +2941,15 @@ export function initialize({
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async function getDevices() {
|
||||||
|
const result = await _ajax({
|
||||||
|
call: 'devices',
|
||||||
|
httpType: 'GET',
|
||||||
|
responseType: 'json',
|
||||||
|
});
|
||||||
|
return parseUnknown(getDevicesResultZod, result);
|
||||||
|
}
|
||||||
|
|
||||||
async function updateDeviceName(deviceName: string) {
|
async function updateDeviceName(deviceName: string) {
|
||||||
await _ajax({
|
await _ajax({
|
||||||
call: 'updateDeviceName',
|
call: 'updateDeviceName',
|
||||||
|
|
|
@ -493,6 +493,12 @@ export class CallLinkUpdateSyncEvent extends ConfirmableEvent {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export class DeviceNameChangeSyncEvent extends ConfirmableEvent {
|
||||||
|
constructor(confirm: ConfirmCallback) {
|
||||||
|
super('deviceNameChangeSync', confirm);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
const messageToDeleteSchema = z.union([
|
const messageToDeleteSchema = z.union([
|
||||||
z.object({
|
z.object({
|
||||||
type: z.literal('aci').readonly(),
|
type: z.literal('aci').readonly(),
|
||||||
|
|
|
@ -153,6 +153,10 @@ export class User {
|
||||||
return this.storage.get('device_name');
|
return this.storage.get('device_name');
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public async setDeviceName(name: string): Promise<void> {
|
||||||
|
return this.storage.put('device_name', name);
|
||||||
|
}
|
||||||
|
|
||||||
public async setDeviceNameEncrypted(): Promise<void> {
|
public async setDeviceNameEncrypted(): Promise<void> {
|
||||||
return this.storage.put('deviceNameEncrypted', true);
|
return this.storage.put('deviceNameEncrypted', true);
|
||||||
}
|
}
|
||||||
|
@ -175,9 +179,7 @@ export class User {
|
||||||
this.storage.put('uuid_id', `${aci}.${deviceId}`),
|
this.storage.put('uuid_id', `${aci}.${deviceId}`),
|
||||||
this.storage.put('password', password),
|
this.storage.put('password', password),
|
||||||
this.setPni(pni),
|
this.setPni(pni),
|
||||||
deviceName
|
deviceName ? this.setDeviceName(deviceName) : Promise.resolve(),
|
||||||
? this.storage.put('device_name', deviceName)
|
|
||||||
: Promise.resolve(),
|
|
||||||
]);
|
]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -69,6 +69,7 @@ export const sendTypesEnum = z.enum([
|
||||||
'callEventSync',
|
'callEventSync',
|
||||||
'callLinkUpdateSync',
|
'callLinkUpdateSync',
|
||||||
'callLogEventSync',
|
'callLogEventSync',
|
||||||
|
'deviceNameChangeSync',
|
||||||
|
|
||||||
// No longer used, all non-urgent
|
// No longer used, all non-urgent
|
||||||
'legacyGroupChange',
|
'legacyGroupChange',
|
||||||
|
|
88
ts/util/onDeviceNameChangeSync.ts
Normal file
88
ts/util/onDeviceNameChangeSync.ts
Normal file
|
@ -0,0 +1,88 @@
|
||||||
|
// Copyright 2024 Signal Messenger, LLC
|
||||||
|
// SPDX-License-Identifier: AGPL-3.0-only
|
||||||
|
|
||||||
|
import PQueue from 'p-queue';
|
||||||
|
import type { DeviceNameChangeSyncEvent } from '../textsecure/messageReceiverEvents';
|
||||||
|
import { MINUTE } from './durations';
|
||||||
|
import { strictAssert } from './assert';
|
||||||
|
import { parseIntOrThrow } from './parseIntOrThrow';
|
||||||
|
import * as log from '../logging/log';
|
||||||
|
import { toLogFormat } from '../types/errors';
|
||||||
|
import { drop } from './drop';
|
||||||
|
|
||||||
|
const deviceNameFetchQueue = new PQueue({
|
||||||
|
concurrency: 1,
|
||||||
|
timeout: 5 * MINUTE,
|
||||||
|
throwOnTimeout: true,
|
||||||
|
});
|
||||||
|
|
||||||
|
export async function onDeviceNameChangeSync(
|
||||||
|
event: DeviceNameChangeSyncEvent
|
||||||
|
): Promise<void> {
|
||||||
|
const { confirm } = event;
|
||||||
|
|
||||||
|
const maybeQueueAndThenConfirm = async () => {
|
||||||
|
await maybeQueueDeviceNameFetch();
|
||||||
|
confirm();
|
||||||
|
};
|
||||||
|
|
||||||
|
drop(maybeQueueAndThenConfirm());
|
||||||
|
}
|
||||||
|
|
||||||
|
export async function maybeQueueDeviceNameFetch(): Promise<void> {
|
||||||
|
if (deviceNameFetchQueue.size >= 1) {
|
||||||
|
log.info('maybeQueueDeviceNameFetch: skipping; fetch already queued');
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await deviceNameFetchQueue.add(fetchAndUpdateDeviceName);
|
||||||
|
} catch (e) {
|
||||||
|
log.error(
|
||||||
|
'maybeQueueDeviceNameFetch: error when fetching device name',
|
||||||
|
toLogFormat(e)
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async function fetchAndUpdateDeviceName() {
|
||||||
|
strictAssert(window.textsecure.server, 'WebAPI must be initialized');
|
||||||
|
const { devices } = await window.textsecure.server.getDevices();
|
||||||
|
const localDeviceId = parseIntOrThrow(
|
||||||
|
window.textsecure.storage.user.getDeviceId(),
|
||||||
|
'fetchAndUpdateDeviceName: localDeviceId'
|
||||||
|
);
|
||||||
|
const ourDevice = devices.find(device => device.id === localDeviceId);
|
||||||
|
strictAssert(ourDevice, 'ourDevice must be returned from devices endpoint');
|
||||||
|
|
||||||
|
const newNameEncrypted = ourDevice.name;
|
||||||
|
|
||||||
|
if (!newNameEncrypted) {
|
||||||
|
log.error('fetchAndUpdateDeviceName: device had empty name');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
let newName: string;
|
||||||
|
try {
|
||||||
|
newName = await window
|
||||||
|
.getAccountManager()
|
||||||
|
.decryptDeviceName(newNameEncrypted);
|
||||||
|
} catch (e) {
|
||||||
|
const deviceNameWasEncrypted =
|
||||||
|
window.textsecure.storage.user.getDeviceNameEncrypted();
|
||||||
|
log.error(
|
||||||
|
`fetchAndUpdateDeviceName: failed to decrypt device name. Was encrypted local state: ${deviceNameWasEncrypted}`
|
||||||
|
);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const existingName = window.storage.user.getDeviceName();
|
||||||
|
if (newName === existingName) {
|
||||||
|
log.info('fetchAndUpdateDeviceName: new name matches existing name');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
await window.storage.user.setDeviceName(newName);
|
||||||
|
log.info(
|
||||||
|
'fetchAndUpdateDeviceName: successfully updated new device name locally'
|
||||||
|
);
|
||||||
|
}
|
Loading…
Reference in a new issue