mirrors/signal-desktop
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 2 Wiki Activity Actions

Fix flakey mock test

Browse source
This commit is contained in:
Fedor Indutny 2023-04-19 09:13:48 -07:00 • committed by GitHub
parent 703a82c818
commit 9ce0746f5b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 185 additions and 139 deletions
Download patch file Download diff file Expand all files Collapse all files

317
ts/SignalProtocolStore.ts
View file

@ -241,6 +241,8 @@ export class SignalProtocolStore extends EventEmitter {
sessionQueues = new Map<SessionIdType, PQueue>(); sessionQueues = new Map<SessionIdType, PQueue>();
private readonly identityQueues = new Map<UUIDStringType, PQueue>();
private currentZone?: Zone; private currentZone?: Zone;
private currentZoneDepth = 0; private currentZoneDepth = 0;
@ -730,6 +732,27 @@ export class SignalProtocolStore extends EventEmitter {
return freshQueue; return freshQueue;
} }
// Identity Queue
private _createIdentityQueue(): PQueue {
return new PQueue({
concurrency: 1,
timeout: MINUTE * 30,
throwOnTimeout: true,
});
}
private _getIdentityQueue(uuid: UUID): PQueue {
const cachedQueue = this.identityQueues.get(uuid.toString());
if (cachedQueue) {
return cachedQueue;
}
const freshQueue = this._createIdentityQueue();
this.identityQueues.set(uuid.toString(), freshQueue);
return freshQueue;
}
// Sessions // Sessions
// Re-entrant session transaction routine. Only one session transaction could // Re-entrant session transaction routine. Only one session transaction could
@ -1686,94 +1709,97 @@ export class SignalProtocolStore extends EventEmitter {
nonblockingApproval = false; nonblockingApproval = false;
} }
const identityRecord = await this.getOrMigrateIdentityRecord( return this._getIdentityQueue(encodedAddress.uuid).add(async () => {
encodedAddress.uuid const identityRecord = await this.getOrMigrateIdentityRecord(
);
const id = encodedAddress.uuid.toString();
if (!identityRecord || !identityRecord.publicKey) {
// Lookup failed, or the current key was removed, so save this one.
log.info('saveIdentity: Saving new identity...');
await this._saveIdentityKey({
id,
publicKey,
firstUse: true,
timestamp: Date.now(),
verified: VerifiedStatus.DEFAULT,
nonblockingApproval,
});
this.checkPreviousKey(encodedAddress.uuid, publicKey, 'saveIdentity');
return false;
}
const identityKeyChanged = !constantTimeEqual(
identityRecord.publicKey,
publicKey
);
if (identityKeyChanged) {
const isOurIdentifier = window.textsecure.storage.user.isOurUuid(
encodedAddress.uuid encodedAddress.uuid
); );
if (isOurIdentifier && identityKeyChanged) { const id = encodedAddress.uuid.toString();
log.warn('saveIdentity: ignoring identity for ourselves'); const logId = `saveIdentity(${id})`;
if (!identityRecord || !identityRecord.publicKey) {
// Lookup failed, or the current key was removed, so save this one.
log.info(`${logId}: Saving new identity...`);
await this._saveIdentityKey({
id,
publicKey,
firstUse: true,
timestamp: Date.now(),
verified: VerifiedStatus.DEFAULT,
nonblockingApproval,
});
this.checkPreviousKey(encodedAddress.uuid, publicKey, 'saveIdentity');
return false; return false;
} }
log.info('saveIdentity: Replacing existing identity...'); const identityKeyChanged = !constantTimeEqual(
const previousStatus = identityRecord.verified; identityRecord.publicKey,
let verifiedStatus; publicKey
if ( );
previousStatus === VerifiedStatus.VERIFIED ||
previousStatus === VerifiedStatus.UNVERIFIED
) {
verifiedStatus = VerifiedStatus.UNVERIFIED;
} else {
verifiedStatus = VerifiedStatus.DEFAULT;
}
await this._saveIdentityKey({ if (identityKeyChanged) {
id, const isOurIdentifier = window.textsecure.storage.user.isOurUuid(
publicKey, encodedAddress.uuid
firstUse: false,
timestamp: Date.now(),
verified: verifiedStatus,
nonblockingApproval,
});
// See `addKeyChange` in `ts/models/conversations.ts` for sender key info
// update caused by this.
try {
this.emit('keychange', encodedAddress.uuid, 'saveIdentity - change');
} catch (error) {
log.error(
'saveIdentity: error triggering keychange:',
Errors.toLogFormat(error)
); );
if (isOurIdentifier && identityKeyChanged) {
log.warn(`${logId}: ignoring identity for ourselves`);
return false;
}
log.info(`${logId}: Replacing existing identity...`);
const previousStatus = identityRecord.verified;
let verifiedStatus;
if (
previousStatus === VerifiedStatus.VERIFIED ||
previousStatus === VerifiedStatus.UNVERIFIED
) {
verifiedStatus = VerifiedStatus.UNVERIFIED;
} else {
verifiedStatus = VerifiedStatus.DEFAULT;
}
await this._saveIdentityKey({
id,
publicKey,
firstUse: false,
timestamp: Date.now(),
verified: verifiedStatus,
nonblockingApproval,
});
// See `addKeyChange` in `ts/models/conversations.ts` for sender key info
// update caused by this.
try {
this.emit('keychange', encodedAddress.uuid, 'saveIdentity - change');
} catch (error) {
log.error(
`${logId}: error triggering keychange:`,
Errors.toLogFormat(error)
);
}
// Pass the zone to facilitate transactional session use in
// MessageReceiver.ts
await this.archiveSiblingSessions(encodedAddress, {
zone,
});
return true;
} }
if (this.isNonBlockingApprovalRequired(identityRecord)) {
log.info(`${logId}: Setting approval status...`);
// Pass the zone to facilitate transactional session use in identityRecord.nonblockingApproval = nonblockingApproval;
// MessageReceiver.ts await this._saveIdentityKey(identityRecord);
await this.archiveSiblingSessions(encodedAddress, {
zone,
});
return true; return false;
} }
if (this.isNonBlockingApprovalRequired(identityRecord)) {
log.info('saveIdentity: Setting approval status...');
identityRecord.nonblockingApproval = nonblockingApproval;
await this._saveIdentityKey(identityRecord);
return false; return false;
} });
return false;
} }
// https://github.com/signalapp/Signal-Android/blob/fc3db538bcaa38dc149712a483d3032c9c1f3998/app/src/main/java/org/thoughtcrime/securesms/crypto/storage/SignalBaseIdentityKeyStore.java#L257 // https://github.com/signalapp/Signal-Android/blob/fc3db538bcaa38dc149712a483d3032c9c1f3998/app/src/main/java/org/thoughtcrime/securesms/crypto/storage/SignalBaseIdentityKeyStore.java#L257
@ -1790,6 +1816,15 @@ export class SignalProtocolStore extends EventEmitter {
async saveIdentityWithAttributes( async saveIdentityWithAttributes(
uuid: UUID, uuid: UUID,
attributes: Partial<IdentityKeyType> attributes: Partial<IdentityKeyType>
): Promise<void> {
return this._getIdentityQueue(uuid).add(async () => {
return this.saveIdentityWithAttributesOnQueue(uuid, attributes);
});
}
private async saveIdentityWithAttributesOnQueue(
uuid: UUID,
attributes: Partial<IdentityKeyType>
): Promise<void> { ): Promise<void> {
if (uuid == null) { if (uuid == null) {
throw new Error('saveIdentityWithAttributes: uuid was undefined/null'); throw new Error('saveIdentityWithAttributes: uuid was undefined/null');
@ -1823,14 +1858,16 @@ export class SignalProtocolStore extends EventEmitter {
throw new Error('setApproval: Invalid approval status'); throw new Error('setApproval: Invalid approval status');
} }
const identityRecord = await this.getOrMigrateIdentityRecord(uuid); return this._getIdentityQueue(uuid).add(async () => {
const identityRecord = await this.getOrMigrateIdentityRecord(uuid);
if (!identityRecord) { if (!identityRecord) {
throw new Error(`setApproval: No identity record for ${uuid}`); throw new Error(`setApproval: No identity record for ${uuid}`);
} }
identityRecord.nonblockingApproval = nonblockingApproval; identityRecord.nonblockingApproval = nonblockingApproval;
await this._saveIdentityKey(identityRecord); await this._saveIdentityKey(identityRecord);
});
} }
// https://github.com/signalapp/Signal-Android/blob/fc3db538bcaa38dc149712a483d3032c9c1f3998/app/src/main/java/org/thoughtcrime/securesms/crypto/storage/SignalBaseIdentityKeyStore.java#L215 // https://github.com/signalapp/Signal-Android/blob/fc3db538bcaa38dc149712a483d3032c9c1f3998/app/src/main/java/org/thoughtcrime/securesms/crypto/storage/SignalBaseIdentityKeyStore.java#L215
@ -1847,19 +1884,23 @@ export class SignalProtocolStore extends EventEmitter {
throw new Error('setVerified: Invalid verified status'); throw new Error('setVerified: Invalid verified status');
} }
const identityRecord = await this.getOrMigrateIdentityRecord(uuid); return this._getIdentityQueue(uuid).add(async () => {
const identityRecord = await this.getOrMigrateIdentityRecord(uuid);
if (!identityRecord) { if (!identityRecord) {
throw new Error(`setVerified: No identity record for ${uuid.toString()}`); throw new Error(
} `setVerified: No identity record for ${uuid.toString()}`
);
}
if (validateIdentityKey(identityRecord)) { if (validateIdentityKey(identityRecord)) {
await this._saveIdentityKey({ await this._saveIdentityKey({
...identityRecord, ...identityRecord,
...extra, ...extra,
verified: verifiedStatus, verified: verifiedStatus,
}); });
} }
});
} }
async getVerified(uuid: UUID): Promise<number> { async getVerified(uuid: UUID): Promise<number> {
@ -1922,54 +1963,56 @@ export class SignalProtocolStore extends EventEmitter {
`Invalid verified status: ${verifiedStatus}` `Invalid verified status: ${verifiedStatus}`
); );
const identityRecord = await this.getOrMigrateIdentityRecord(uuid); return this._getIdentityQueue(uuid).add(async () => {
const hadEntry = identityRecord !== undefined; const identityRecord = await this.getOrMigrateIdentityRecord(uuid);
const keyMatches = Boolean( const hadEntry = identityRecord !== undefined;
identityRecord?.publicKey && const keyMatches = Boolean(
constantTimeEqual(publicKey, identityRecord.publicKey) identityRecord?.publicKey &&
); constantTimeEqual(publicKey, identityRecord.publicKey)
const statusMatches = );
keyMatches && verifiedStatus === identityRecord?.verified; const statusMatches =
keyMatches && verifiedStatus === identityRecord?.verified;
if (!keyMatches || !statusMatches) { if (!keyMatches || !statusMatches) {
await this.saveIdentityWithAttributes(uuid, { await this.saveIdentityWithAttributesOnQueue(uuid, {
publicKey, publicKey,
verified: verifiedStatus, verified: verifiedStatus,
firstUse: !hadEntry, firstUse: !hadEntry,
timestamp: Date.now(), timestamp: Date.now(),
nonblockingApproval: true, nonblockingApproval: true,
}); });
} }
if (!hadEntry) { if (!hadEntry) {
this.checkPreviousKey(uuid, publicKey, 'updateIdentityAfterSync'); this.checkPreviousKey(uuid, publicKey, 'updateIdentityAfterSync');
} else if (hadEntry && !keyMatches) { } else if (hadEntry && !keyMatches) {
try { try {
this.emit('keychange', uuid, 'updateIdentityAfterSync - change'); this.emit('keychange', uuid, 'updateIdentityAfterSync - change');
} catch (error) { } catch (error) {
log.error( log.error(
'updateIdentityAfterSync: error triggering keychange:', 'updateIdentityAfterSync: error triggering keychange:',
Errors.toLogFormat(error) Errors.toLogFormat(error)
); );
}
} }
}
// See: https://github.com/signalapp/Signal-Android/blob/fc3db538bcaa38dc149712a483d3032c9c1f3998/app/src/main/java/org/thoughtcrime/securesms/database/RecipientDatabase.kt#L921-L936 // See: https://github.com/signalapp/Signal-Android/blob/fc3db538bcaa38dc149712a483d3032c9c1f3998/app/src/main/java/org/thoughtcrime/securesms/database/RecipientDatabase.kt#L921-L936
if ( if (
verifiedStatus === VerifiedStatus.VERIFIED && verifiedStatus === VerifiedStatus.VERIFIED &&
(!hadEntry || identityRecord?.verified !== VerifiedStatus.VERIFIED) (!hadEntry || identityRecord?.verified !== VerifiedStatus.VERIFIED)
) { ) {
// Needs a notification. // Needs a notification.
return true; return true;
} }
if ( if (
verifiedStatus !== VerifiedStatus.VERIFIED && verifiedStatus !== VerifiedStatus.VERIFIED &&
hadEntry && hadEntry &&
identityRecord?.verified === VerifiedStatus.VERIFIED identityRecord?.verified === VerifiedStatus.VERIFIED
) { ) {
// Needs a notification. // Needs a notification.
return true; return true;
} }
return false; return false;
});
} }
isUntrusted(uuid: UUID, timestampThreshold = TIMESTAMP_THRESHOLD): boolean { isUntrusted(uuid: UUID, timestampThreshold = TIMESTAMP_THRESHOLD): boolean {

4
ts/models/conversations.ts
View file

@ -1032,7 +1032,9 @@ export class ConversationModel extends window.Backbone
} }
if (this.get('removalStage') === undefined) { if (this.get('removalStage') === undefined) {
log.warn(`${logId}: not removed`); if (!viaStorageServiceSync) {
log.warn(`${logId}: not removed`);
}
return; return;
} }

1
ts/services/profiles.ts
View file

@ -584,6 +584,7 @@ export async function updateIdentityKey(
false false
); );
if (changed) { if (changed) {
log.info(`updateIdentityKey(${uuid.toString()}): changed`);
// save identity will close all sessions except for .1, so we // save identity will close all sessions except for .1, so we
// must close that one manually. // must close that one manually.
const ourUuid = window.textsecure.storage.user.getCheckedUuid(); const ourUuid = window.textsecure.storage.user.getCheckedUuid();

2
ts/test-mock/pnp/accept_gv2_invite_test.ts
View file

@ -192,7 +192,7 @@ describe('pnp/accept gv2 invite', function needsName() {
debug('Checking final notification'); debug('Checking final notification');
await window await window
.locator( .locator(
'text=You accepted an invitation to the group from ' + '.SystemMessage >> text=You accepted an invitation to the group from ' +
`${second.profileName}.` `${second.profileName}.`
) )
.waitFor(); .waitFor();