mirror of
https://github.com/signalapp/Signal-Server.git
synced 2025-12-05 01:10:13 +00:00
Add a command for unlinking devices linked to an account whose primary device is idle
This commit is contained in:
Jon Chambers
@@ -291,6 +291,7 @@ import org.whispersystems.textsecuregcm.workers.ServerVersionCommand;
|
||||
import org.whispersystems.textsecuregcm.workers.SetRequestLoggingEnabledTask;
|
||||
import org.whispersystems.textsecuregcm.workers.SetUserDiscoverabilityCommand;
|
||||
import org.whispersystems.textsecuregcm.workers.UnlinkDeviceCommand;
|
||||
import org.whispersystems.textsecuregcm.workers.UnlinkDevicesWithIdlePrimaryCommand;
|
||||
import org.whispersystems.textsecuregcm.workers.ZkParamsCommand;
|
||||
import org.whispersystems.websocket.WebSocketResourceProviderFactory;
|
||||
import org.whispersystems.websocket.setup.WebSocketEnvironment;
|
||||
@@ -343,6 +344,7 @@ public class WhisperServerService extends Application<WhisperServerConfiguration
|
||||
bootstrap.addCommand(new BackupMetricsCommand(Clock.systemUTC()));
|
||||
bootstrap.addCommand(new BackupUsageRecalculationCommand());
|
||||
bootstrap.addCommand(new RemoveExpiredLinkedDevicesCommand());
|
||||
bootstrap.addCommand(new UnlinkDevicesWithIdlePrimaryCommand(Clock.systemUTC()));
|
||||
bootstrap.addCommand(new NotifyIdleDevicesCommand());
|
||||
bootstrap.addCommand(new ClearIssuedReceiptRedemptionsCommand());
|
||||
|
||||
|
||||
@@ -105,7 +105,7 @@ public class ExperimentEnrollmentManager {
|
||||
}).orElse(false);
|
||||
}
|
||||
|
||||
private boolean isEnrolled(final Object entity, final int enrollmentPercentage, final String experimentName) {
|
||||
private static boolean isEnrolled(final Object entity, final int enrollmentPercentage, final String experimentName) {
|
||||
final int enrollmentHash = ((entity.hashCode() ^ experimentName.hashCode()) & Integer.MAX_VALUE) % 100;
|
||||
|
||||
return enrollmentHash < enrollmentPercentage;
|
||||
|
||||
@@ -0,0 +1,135 @@
|
||||
/*
|
||||
* Copyright 2025 Signal Messenger, LLC
|
||||
* SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
package org.whispersystems.textsecuregcm.workers;
|
||||
|
||||
import com.google.common.annotations.VisibleForTesting;
|
||||
import io.micrometer.core.instrument.Counter;
|
||||
import io.micrometer.core.instrument.Metrics;
|
||||
import java.time.Clock;
|
||||
import java.time.Duration;
|
||||
import java.time.Instant;
|
||||
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 reactor.core.publisher.Flux;
|
||||
import reactor.core.publisher.Mono;
|
||||
import reactor.util.function.Tuples;
|
||||
import reactor.util.retry.Retry;
|
||||
|
||||
public class UnlinkDevicesWithIdlePrimaryCommand extends AbstractSinglePassCrawlAccountsCommand {
|
||||
|
||||
private final Clock clock;
|
||||
|
||||
@VisibleForTesting
|
||||
static final String DRY_RUN_ARGUMENT = "dry-run";
|
||||
|
||||
@VisibleForTesting
|
||||
static final String MAX_CONCURRENCY_ARGUMENT = "max-concurrency";
|
||||
|
||||
@VisibleForTesting
|
||||
static final String PRIMARY_IDLE_DAYS_ARGUMENT = "primary-idle-days";
|
||||
|
||||
@VisibleForTesting
|
||||
static final String ENROLLMENT_PERCENTAGE_ARGUMENT = "enrollment-percentage";
|
||||
|
||||
@VisibleForTesting
|
||||
static final int DEFAULT_PRIMARY_IDLE_DAYS = 90;
|
||||
|
||||
private static final String UNLINK_DEVICE_COUNTER_NAME =
|
||||
MetricsUtil.name(UnlinkDevicesWithIdlePrimaryCommand.class, "unlinkDevice");
|
||||
|
||||
private static final Logger logger = LoggerFactory.getLogger(UnlinkDevicesWithIdlePrimaryCommand.class);
|
||||
|
||||
public UnlinkDevicesWithIdlePrimaryCommand(final Clock clock) {
|
||||
super("unlink-devices-with-idle-primary", "Unlinks linked devices if the account's primary device is idle");
|
||||
|
||||
this.clock = clock;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void configure(final Subparser subparser) {
|
||||
subparser.addArgument("--dry-run")
|
||||
.type(Boolean.class)
|
||||
.dest(DRY_RUN_ARGUMENT)
|
||||
.required(false)
|
||||
.setDefault(true)
|
||||
.help("If true, don't actually delete accounts");
|
||||
|
||||
subparser.addArgument("--max-concurrency")
|
||||
.type(Integer.class)
|
||||
.dest(MAX_CONCURRENCY_ARGUMENT)
|
||||
.setDefault(16)
|
||||
.help("Max concurrency for DynamoDB operations");
|
||||
|
||||
subparser.addArgument("--primary-idle-days")
|
||||
.type(Integer.class)
|
||||
.dest(PRIMARY_IDLE_DAYS_ARGUMENT)
|
||||
.required(false)
|
||||
.setDefault(DEFAULT_PRIMARY_IDLE_DAYS)
|
||||
.help("The number of inactivity after which a primary device is considered idle");
|
||||
|
||||
subparser.addArgument("--enrollment-percentage")
|
||||
.type(Integer.class)
|
||||
.dest(ENROLLMENT_PERCENTAGE_ARGUMENT)
|
||||
.required(true)
|
||||
.help("The percentage of eligible accounts from which to unlink devices");
|
||||
|
||||
super.configure(subparser);
|
||||
}
|
||||
|
||||
@Override
|
||||
protected void crawlAccounts(final Flux<Account> accounts) {
|
||||
final boolean isDryRun = getNamespace().getBoolean(DRY_RUN_ARGUMENT);
|
||||
final int enrollmentPercentage = getNamespace().getInt(ENROLLMENT_PERCENTAGE_ARGUMENT);
|
||||
final Duration idleDurationThreshold = Duration.ofDays(getNamespace().getInt(PRIMARY_IDLE_DAYS_ARGUMENT));
|
||||
|
||||
final AccountsManager accountsManager = getCommandDependencies().accountsManager();
|
||||
|
||||
final Counter unlinkDeviceCounter =
|
||||
Metrics.counter(UNLINK_DEVICE_COUNTER_NAME, "dryRun", String.valueOf(isDryRun));
|
||||
|
||||
final Instant currentTime = clock.instant();
|
||||
|
||||
accounts
|
||||
.filter(account -> isEnrolled(account, enrollmentPercentage))
|
||||
.filter(account -> isPrimaryDeviceIdle(account, currentTime, idleDurationThreshold))
|
||||
.flatMap(accountWithIdlePrimaryDevice -> Flux.fromIterable(accountWithIdlePrimaryDevice.getDevices())
|
||||
.filter(device -> !device.isPrimary())
|
||||
.map(linkedDevice -> Tuples.of(accountWithIdlePrimaryDevice, linkedDevice.getId())))
|
||||
.flatMap(accountAndLinkedDeviceId -> {
|
||||
final Mono<Account> unlinkDeviceMono = isDryRun
|
||||
? Mono.empty()
|
||||
: Mono.fromFuture(() -> accountsManager.removeDevice(accountAndLinkedDeviceId.getT1(), accountAndLinkedDeviceId.getT2()));
|
||||
|
||||
return unlinkDeviceMono
|
||||
.doOnSuccess(ignored -> unlinkDeviceCounter.increment())
|
||||
.retryWhen(Retry.backoff(3, Duration.ofSeconds(1)).maxBackoff(Duration.ofSeconds(4)))
|
||||
.onErrorResume(throwable -> {
|
||||
logger.warn("Failed to unlink device to delete account {}:{}", accountAndLinkedDeviceId.getT1().getIdentifier(
|
||||
IdentityType.ACI), accountAndLinkedDeviceId.getT2(), throwable);
|
||||
|
||||
return Mono.empty();
|
||||
});
|
||||
})
|
||||
.then()
|
||||
.block();
|
||||
}
|
||||
|
||||
private static boolean isPrimaryDeviceIdle(final Account account, final Instant currentTime, final Duration idleDurationThreshold) {
|
||||
final Duration durationSincePrimaryLastSeen =
|
||||
Duration.between(Instant.ofEpochMilli(account.getPrimaryDevice().getLastSeen()), currentTime);
|
||||
|
||||
return durationSincePrimaryLastSeen.compareTo(idleDurationThreshold) > 0;
|
||||
}
|
||||
|
||||
private static boolean isEnrolled(final Account account, final int enrollmentPercentage) {
|
||||
return (account.getIdentifier(IdentityType.ACI).hashCode() & Integer.MAX_VALUE) % 100 < enrollmentPercentage;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,204 @@
|
||||
/*
|
||||
* Copyright 2025 Signal Messenger, LLC
|
||||
* SPDX-License-Identifier: AGPL-3.0-only
|
||||
*/
|
||||
|
||||
package org.whispersystems.textsecuregcm.workers;
|
||||
|
||||
import static org.mockito.ArgumentMatchers.any;
|
||||
import static org.mockito.ArgumentMatchers.anyByte;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.verify;
|
||||
import static org.mockito.Mockito.verifyNoMoreInteractions;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
import java.time.Clock;
|
||||
import java.time.Duration;
|
||||
import java.time.Instant;
|
||||
import java.time.ZoneId;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.UUID;
|
||||
import java.util.concurrent.CompletableFuture;
|
||||
import net.sourceforge.argparse4j.inf.Namespace;
|
||||
import org.junit.Test;
|
||||
import org.junit.jupiter.params.ParameterizedTest;
|
||||
import org.junit.jupiter.params.provider.ValueSource;
|
||||
import org.whispersystems.textsecuregcm.identity.IdentityType;
|
||||
import org.whispersystems.textsecuregcm.storage.Account;
|
||||
import org.whispersystems.textsecuregcm.storage.AccountsManager;
|
||||
import org.whispersystems.textsecuregcm.storage.Device;
|
||||
import reactor.core.publisher.Flux;
|
||||
|
||||
class UnlinkDevicesWithIdlePrimaryCommandTest {
|
||||
|
||||
private static final Clock CLOCK = Clock.fixed(Instant.now(), ZoneId.systemDefault());
|
||||
|
||||
private static class TestUnlinkDevicesWithIdlePrimaryCommand extends UnlinkDevicesWithIdlePrimaryCommand {
|
||||
|
||||
private final CommandDependencies commandDependencies;
|
||||
private final Namespace namespace;
|
||||
|
||||
public TestUnlinkDevicesWithIdlePrimaryCommand(final Clock clock,
|
||||
final AccountsManager accountsManager,
|
||||
final boolean isDryRun,
|
||||
final int enrollmentPercentage) {
|
||||
|
||||
super(clock);
|
||||
|
||||
commandDependencies = mock(CommandDependencies.class);
|
||||
when(commandDependencies.accountsManager()).thenReturn(accountsManager);
|
||||
|
||||
namespace = new Namespace(Map.of(
|
||||
UnlinkDevicesWithIdlePrimaryCommand.DRY_RUN_ARGUMENT, isDryRun,
|
||||
UnlinkDevicesWithIdlePrimaryCommand.ENROLLMENT_PERCENTAGE_ARGUMENT, enrollmentPercentage,
|
||||
UnlinkDevicesWithIdlePrimaryCommand.MAX_CONCURRENCY_ARGUMENT, 16,
|
||||
UnlinkDevicesWithIdlePrimaryCommand.PRIMARY_IDLE_DAYS_ARGUMENT, UnlinkDevicesWithIdlePrimaryCommand.DEFAULT_PRIMARY_IDLE_DAYS
|
||||
));
|
||||
}
|
||||
|
||||
@Override
|
||||
protected CommandDependencies getCommandDependencies() {
|
||||
return commandDependencies;
|
||||
}
|
||||
|
||||
@Override
|
||||
protected Namespace getNamespace() {
|
||||
return namespace;
|
||||
}
|
||||
}
|
||||
|
||||
@ParameterizedTest
|
||||
@ValueSource(booleans = {true, false})
|
||||
void crawlAccounts(final boolean isDryRun) {
|
||||
final AccountsManager accountsManager = mock(AccountsManager.class);
|
||||
when(accountsManager.removeDevice(any(), anyByte()))
|
||||
.thenReturn(CompletableFuture.completedFuture(null));
|
||||
|
||||
final Duration idleDeviceLastSeenDuration =
|
||||
Duration.ofDays(UnlinkDevicesWithIdlePrimaryCommand.DEFAULT_PRIMARY_IDLE_DAYS).plus(Duration.ofDays(1));
|
||||
|
||||
final Duration activeDeviceLastSeenDuration =
|
||||
Duration.ofDays(UnlinkDevicesWithIdlePrimaryCommand.DEFAULT_PRIMARY_IDLE_DAYS).minus(Duration.ofDays(1));
|
||||
|
||||
final Account accountWithIdlePrimaryAndNoLinkedDevice = mock(Account.class);
|
||||
{
|
||||
when(accountWithIdlePrimaryAndNoLinkedDevice.getIdentifier(IdentityType.ACI)).thenReturn(UUID.randomUUID());
|
||||
|
||||
final Device primaryDevice =
|
||||
generateMockDevice(Device.PRIMARY_ID, idleDeviceLastSeenDuration);
|
||||
|
||||
when(accountWithIdlePrimaryAndNoLinkedDevice.getPrimaryDevice()).thenReturn(primaryDevice);
|
||||
when(accountWithIdlePrimaryAndNoLinkedDevice.getDevices()).thenReturn(List.of(primaryDevice));
|
||||
}
|
||||
|
||||
final Account accountWithActivePrimaryAndLinkedDevice = mock(Account.class);
|
||||
{
|
||||
when(accountWithActivePrimaryAndLinkedDevice.getIdentifier(IdentityType.ACI)).thenReturn(UUID.randomUUID());
|
||||
|
||||
final Device primaryDevice =
|
||||
generateMockDevice(Device.PRIMARY_ID, activeDeviceLastSeenDuration);
|
||||
|
||||
final Device linkedDevice = generateMockDevice((byte) (Device.PRIMARY_ID + 1), activeDeviceLastSeenDuration);
|
||||
|
||||
when(accountWithActivePrimaryAndLinkedDevice.getPrimaryDevice()).thenReturn(primaryDevice);
|
||||
when(accountWithActivePrimaryAndLinkedDevice.getDevices()).thenReturn(List.of(primaryDevice, linkedDevice));
|
||||
}
|
||||
|
||||
final byte linkedDeviceId = Device.PRIMARY_ID + 2;
|
||||
|
||||
final Account accountWithIdlePrimaryAndLinkedDevice = mock(Account.class);
|
||||
{
|
||||
when(accountWithIdlePrimaryAndLinkedDevice.getIdentifier(IdentityType.ACI)).thenReturn(UUID.randomUUID());
|
||||
|
||||
final Device primaryDevice =
|
||||
generateMockDevice(Device.PRIMARY_ID, idleDeviceLastSeenDuration);
|
||||
|
||||
final Device linkedDevice = generateMockDevice(linkedDeviceId, activeDeviceLastSeenDuration);
|
||||
|
||||
when(accountWithIdlePrimaryAndLinkedDevice.getPrimaryDevice()).thenReturn(primaryDevice);
|
||||
when(accountWithIdlePrimaryAndLinkedDevice.getDevices()).thenReturn(List.of(primaryDevice, linkedDevice));
|
||||
}
|
||||
|
||||
final UnlinkDevicesWithIdlePrimaryCommand unlinkDevicesWithIdlePrimaryCommand =
|
||||
new TestUnlinkDevicesWithIdlePrimaryCommand(CLOCK, accountsManager, isDryRun, 100);
|
||||
|
||||
unlinkDevicesWithIdlePrimaryCommand.crawlAccounts(Flux.just(accountWithIdlePrimaryAndNoLinkedDevice,
|
||||
accountWithActivePrimaryAndLinkedDevice,
|
||||
accountWithIdlePrimaryAndLinkedDevice));
|
||||
|
||||
if (!isDryRun) {
|
||||
verify(accountsManager).removeDevice(accountWithIdlePrimaryAndLinkedDevice, linkedDeviceId);
|
||||
}
|
||||
|
||||
verifyNoMoreInteractions(accountsManager);
|
||||
}
|
||||
|
||||
@Test
|
||||
void crawlAccountsPartialEnrollment() {
|
||||
final AccountsManager accountsManager = mock(AccountsManager.class);
|
||||
when(accountsManager.removeDevice(any(), anyByte()))
|
||||
.thenReturn(CompletableFuture.completedFuture(null));
|
||||
|
||||
final UUID enrolledAccountIdentifier = randomUUIDWithEnrollmentHash(1);
|
||||
final UUID unenrolledAccountIdentifier = randomUUIDWithEnrollmentHash(25);
|
||||
|
||||
final byte linkedDeviceId = Device.PRIMARY_ID + 1;
|
||||
|
||||
final Duration idleDeviceLastSeenDuration =
|
||||
Duration.ofDays(UnlinkDevicesWithIdlePrimaryCommand.DEFAULT_PRIMARY_IDLE_DAYS).plus(Duration.ofDays(1));
|
||||
|
||||
final Account enrolledAccount = mock(Account.class);
|
||||
{
|
||||
when(enrolledAccount.getIdentifier(IdentityType.ACI)).thenReturn(enrolledAccountIdentifier);
|
||||
|
||||
final Device primaryDevice =
|
||||
generateMockDevice(Device.PRIMARY_ID, idleDeviceLastSeenDuration);
|
||||
|
||||
final Device linkedDevice = generateMockDevice(linkedDeviceId, idleDeviceLastSeenDuration);
|
||||
|
||||
when(enrolledAccount.getPrimaryDevice()).thenReturn(primaryDevice);
|
||||
when(enrolledAccount.getDevices()).thenReturn(List.of(primaryDevice, linkedDevice));
|
||||
}
|
||||
|
||||
final Account unenrolledAccount = mock(Account.class);
|
||||
{
|
||||
when(unenrolledAccount.getIdentifier(IdentityType.ACI)).thenReturn(unenrolledAccountIdentifier);
|
||||
|
||||
final Device primaryDevice =
|
||||
generateMockDevice(Device.PRIMARY_ID, idleDeviceLastSeenDuration);
|
||||
|
||||
final Device linkedDevice = generateMockDevice(linkedDeviceId, idleDeviceLastSeenDuration);
|
||||
|
||||
when(unenrolledAccount.getPrimaryDevice()).thenReturn(primaryDevice);
|
||||
when(unenrolledAccount.getDevices()).thenReturn(List.of(primaryDevice, linkedDevice));
|
||||
}
|
||||
|
||||
final UnlinkDevicesWithIdlePrimaryCommand unlinkDevicesWithIdlePrimaryCommand =
|
||||
new TestUnlinkDevicesWithIdlePrimaryCommand(CLOCK, accountsManager, false, 10);
|
||||
|
||||
unlinkDevicesWithIdlePrimaryCommand.crawlAccounts(Flux.just(enrolledAccount, unenrolledAccount));
|
||||
|
||||
verify(accountsManager).removeDevice(enrolledAccount, linkedDeviceId);
|
||||
verifyNoMoreInteractions(accountsManager);
|
||||
}
|
||||
|
||||
private static UUID randomUUIDWithEnrollmentHash(final int enrollmentHash) {
|
||||
UUID uuid;
|
||||
|
||||
do {
|
||||
uuid = UUID.randomUUID();
|
||||
} while ((uuid.hashCode() & Integer.MAX_VALUE) % 100 != enrollmentHash);
|
||||
|
||||
return uuid;
|
||||
}
|
||||
|
||||
private static Device generateMockDevice(final byte deviceId, final Duration primaryIdleDuration) {
|
||||
final Device device = mock(Device.class);
|
||||
when(device.getId()).thenReturn(deviceId);
|
||||
when(device.isPrimary()).thenReturn(deviceId == Device.PRIMARY_ID);
|
||||
when(device.getLastSeen()).thenReturn(CLOCK.instant().minus(primaryIdleDuration).toEpochMilli());
|
||||
|
||||
return device;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user