Add a command for removing linked devices that do not support SPQR

This commit is contained in:
Jon Chambers
2026-03-26 11:02:03 -04:00
committed by Jon Chambers
parent 8c3dd7aa48
commit a741edd80f
3 changed files with 193 additions and 0 deletions

View File

@@ -294,6 +294,7 @@ import org.whispersystems.textsecuregcm.workers.RemoveExpiredAccountsCommand;
import org.whispersystems.textsecuregcm.workers.RemoveExpiredBackupsCommand;
import org.whispersystems.textsecuregcm.workers.RemoveExpiredLinkedDevicesCommand;
import org.whispersystems.textsecuregcm.workers.RemoveExpiredUsernameHoldsCommand;
import org.whispersystems.textsecuregcm.workers.RemoveNonSpqrLinkedDevicesCommand;
import org.whispersystems.textsecuregcm.workers.RemoveOrphanedPreKeyPagesCommand;
import org.whispersystems.textsecuregcm.workers.ScheduledApnPushNotificationSenderServiceCommand;
import org.whispersystems.textsecuregcm.workers.ServerVersionCommand;
@@ -356,6 +357,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
bootstrap.addCommand(new UnlinkDevicesWithIdlePrimaryCommand(Clock.systemUTC()));
bootstrap.addCommand(new NotifyIdleDevicesCommand());
bootstrap.addCommand(new ClearIssuedReceiptRedemptionsCommand());
bootstrap.addCommand(new RemoveNonSpqrLinkedDevicesCommand());
bootstrap.addCommand(new ProcessScheduledJobsServiceCommand("process-idle-device-notification-jobs",
"Processes scheduled jobs to send notifications to idle devices",

View File

@@ -0,0 +1,93 @@
/*
* Copyright 2026 Signal Messenger, LLC
* SPDX-License-Identifier: AGPL-3.0-only
*/
package org.whispersystems.textsecuregcm.workers;
import io.micrometer.core.instrument.Counter;
import io.micrometer.core.instrument.Metrics;
import net.sourceforge.argparse4j.inf.Subparser;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.whispersystems.textsecuregcm.identity.IdentityType;
import org.whispersystems.textsecuregcm.metrics.MetricsUtil;
import org.whispersystems.textsecuregcm.storage.Account;
import org.whispersystems.textsecuregcm.storage.AccountsManager;
import org.whispersystems.textsecuregcm.storage.DeviceCapability;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.util.function.Tuples;
import reactor.util.retry.Retry;
import java.time.Duration;
public class RemoveNonSpqrLinkedDevicesCommand extends AbstractSinglePassCrawlAccountsCommand {
static final String MAX_CONCURRENCY_ARGUMENT = "maxConcurrency";
static final String DRY_RUN_ARGUMENT = "dryRun";
private static final String REMOVE_DEVICE_COUNTER_NAME =
MetricsUtil.name(RemoveNonSpqrLinkedDevicesCommand.class, "removeLinkedDevice");
private static final Logger logger = LoggerFactory.getLogger(RemoveNonSpqrLinkedDevicesCommand.class);
public RemoveNonSpqrLinkedDevicesCommand() {
super("remove-non-spqr-linked-devices", "Removes linked devices that do not support SPQR");
}
@Override
public void configure(final Subparser subparser) {
super.configure(subparser);
subparser.addArgument("--max-concurrency")
.type(Integer.class)
.dest(MAX_CONCURRENCY_ARGUMENT)
.required(false)
.setDefault(32)
.help("Max concurrency for DynamoDB operations");
subparser.addArgument("--dry-run")
.type(Boolean.class)
.dest(DRY_RUN_ARGUMENT)
.required(false)
.setDefault(true)
.help("If true, don't actually remove linked devices");
}
@Override
protected void crawlAccounts(final Flux<Account> accounts) {
final int maxConcurrency = getNamespace().getInt(MAX_CONCURRENCY_ARGUMENT);
final boolean dryRun = getNamespace().getBoolean(DRY_RUN_ARGUMENT);
final AccountsManager accountsManager = getCommandDependencies().accountsManager();
final Counter removeDeviceCounterName =
Metrics.counter(REMOVE_DEVICE_COUNTER_NAME, "dryRun", String.valueOf(dryRun));
accounts
.flatMap(account -> Flux.fromIterable(account.getDevices())
.filter(device -> !device.isPrimary())
.filter(device -> !device.hasCapability(DeviceCapability.SPARSE_POST_QUANTUM_RATCHET))
.map(device -> Tuples.of(account, device.getId())))
.flatMap(accountAndDeviceId -> {
final Mono<Void> removeDeviceMono = dryRun
? Mono.empty()
: Mono.fromRunnable(() -> accountsManager.removeDevice(accountAndDeviceId.getT1(), accountAndDeviceId.getT2()))
.retryWhen(Retry.backoff(3, Duration.ofSeconds(1)))
.onErrorResume(throwable -> {
logger.warn("Failed to remove device: {}:{}",
accountAndDeviceId.getT1().getIdentifier(IdentityType.ACI),
accountAndDeviceId.getT2(),
throwable);
return Mono.empty();
})
.then();
return removeDeviceMono
.doOnSuccess(_ -> removeDeviceCounterName.increment());
}, maxConcurrency)
.then()
.block();
}
}

View File

@@ -0,0 +1,98 @@
/*
* Copyright 2026 Signal Messenger, LLC
* SPDX-License-Identifier: AGPL-3.0-only
*/
package org.whispersystems.textsecuregcm.workers;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyNoInteractions;
import static org.mockito.Mockito.verifyNoMoreInteractions;
import static org.mockito.Mockito.when;
import java.util.List;
import java.util.Map;
import net.sourceforge.argparse4j.inf.Namespace;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;
import org.whispersystems.textsecuregcm.storage.Account;
import org.whispersystems.textsecuregcm.storage.AccountsManager;
import org.whispersystems.textsecuregcm.storage.Device;
import org.whispersystems.textsecuregcm.storage.DeviceCapability;
import reactor.core.publisher.Flux;
class RemoveNonSpqrLinkedDevicesCommandTest {
private static class TestRemoveNonSpqrLinkedDevicesCommand extends RemoveNonSpqrLinkedDevicesCommand {
private final CommandDependencies commandDependencies;
private final Namespace namespace;
public TestRemoveNonSpqrLinkedDevicesCommand(final boolean isDryRun) {
commandDependencies = mock(CommandDependencies.class);
when(commandDependencies.accountsManager()).thenReturn(mock(AccountsManager.class));
namespace = new Namespace(Map.of(
RemoveNonSpqrLinkedDevicesCommand.DRY_RUN_ARGUMENT, isDryRun,
RemoveNonSpqrLinkedDevicesCommand.MAX_CONCURRENCY_ARGUMENT, 16));
}
@Override
protected CommandDependencies getCommandDependencies() {
return commandDependencies;
}
@Override
protected Namespace getNamespace() {
return namespace;
}
}
@ParameterizedTest
@ValueSource(booleans = {true, false})
void crawlAccounts(final boolean dryRun) {
final Device primaryDeviceWithSpqr = buildMockDevice(true, true);
final Device primaryDeviceWithoutSpqr = buildMockDevice(true, false);
final Device linkedDeviceWithSpqr = buildMockDevice(false, true);
final Device linkedDeviceWithoutSpqr = buildMockDevice(false, false);
final Account accountWithNonSpqrPrimary = mock(Account.class);
when(accountWithNonSpqrPrimary.getDevices())
.thenReturn(List.of(primaryDeviceWithoutSpqr));
final Account accountWithSpqrLinkedDevice = mock(Account.class);
when(accountWithSpqrLinkedDevice.getDevices())
.thenReturn(List.of(primaryDeviceWithSpqr, linkedDeviceWithSpqr));
final Account accountWithNonSpqrLinkedDevice = mock(Account.class);
when(accountWithNonSpqrLinkedDevice.getDevices())
.thenReturn(List.of(primaryDeviceWithSpqr, linkedDeviceWithoutSpqr));
final RemoveNonSpqrLinkedDevicesCommand removeNonSpqrLinkedDevicesCommand =
new TestRemoveNonSpqrLinkedDevicesCommand(dryRun);
removeNonSpqrLinkedDevicesCommand.crawlAccounts(Flux.just(
accountWithNonSpqrPrimary, accountWithSpqrLinkedDevice, accountWithNonSpqrLinkedDevice));
final AccountsManager accountsManager =
removeNonSpqrLinkedDevicesCommand.getCommandDependencies().accountsManager();
if (dryRun) {
verifyNoInteractions(accountsManager);
} else {
verify(accountsManager).removeDevice(accountWithNonSpqrLinkedDevice, linkedDeviceWithoutSpqr.getId());
verifyNoMoreInteractions(accountsManager);
}
}
private Device buildMockDevice(final boolean isPrimary, final boolean supportsSpqr) {
final Device device = mock(Device.class);
when(device.isPrimary()).thenReturn(isPrimary);
when(device.getId()).thenReturn(isPrimary ? Device.PRIMARY_ID : Device.PRIMARY_ID + 1);
when(device.hasCapability(DeviceCapability.SPARSE_POST_QUANTUM_RATCHET)).thenReturn(supportsSpqr);
return device;
}
}