Skip to content

A free and open source instant messaging and VoIP chat app built for friends, groups, and communities.

TypeScript fluxerfluxerapp

feat(api): no inactivity deletion for lifetime and pass holders

Hampus875b1d7958bb
diff --git a/fluxer_api/src/api/user/services/UserDeletionEligibilityService.ts b/fluxer_api/src/api/user/services/UserDeletionEligibilityService.ts
index 4653d84bb..042970396 100644
--- a/fluxer_api/src/api/user/services/UserDeletionEligibilityService.ts
+++ b/fluxer_api/src/api/user/services/UserDeletionEligibilityService.ts
@@ -2,18 +2,25 @@
import type {UserID} from '@app/api/BrandedTypes';
import {Config} from '@app/api/Config';
+import {getCachedAccountsConfig} from '@app/api/instance/AccountsConfigCache';
import type {User} from '@app/api/models/User';
+import type {OperatorPassRepository} from '@app/api/operator_pass/OperatorPassRepository';
import {isTemporarilyBanned} from '@app/api/user/UserHelpers';
import {getValidTimestamp, parseStoredTimestamp} from '@app/api/utils/TimestampUtils';
-import {UserFlags} from '@fluxer/constants/src/UserConstants';
+import {UserFlags, UserPremiumTypes} from '@fluxer/constants/src/UserConstants';
import type {IKVProvider} from '@pkgs/kv_client/src/IKVProvider';
import {ms, seconds} from 'itty-time';
-const INACTIVITY_WARNING_TTL_DAYS = 30;
+const INACTIVITY_WARNING_KEY_EXTRA_DAYS = 5;
const INACTIVITY_WARNING_PREFIX = 'inactivity_warning_sent';
+export type OperatorPassHolderLookup = Pick<OperatorPassRepository, 'findOperatorPass'>;
+
export class UserDeletionEligibilityService {
- constructor(private readonly kvClient: IKVProvider) {}
+ constructor(
+ private readonly kvClient: IKVProvider,
+ private readonly operatorPassLookup: OperatorPassHolderLookup | null = null,
+ ) {}
async isEligibleForInactivityDeletion(user: User): Promise<boolean> {
if (user.isBot) {
@@ -36,12 +43,32 @@ export class UserDeletionEligibilityService {
}
const inactivityThresholdMs = this.getInactivityThresholdMs();
const lastActiveAt = getValidTimestamp(user.lastActiveAt, `Last activity timestamp for user ${user.id}`);
- return Date.now() - lastActiveAt >= inactivityThresholdMs;
+ if (Date.now() - lastActiveAt < inactivityThresholdMs) {
+ return false;
+ }
+ return !(await this.isProtectedByOperatorPass(user));
+ }
+
+ async isProtectedFromSystemDeletion(user: User): Promise<boolean> {
+ return isTemporarilyBanned(user) || (await this.isProtectedByOperatorPass(user));
+ }
+
+ private async isProtectedByOperatorPass(user: User): Promise<boolean> {
+ if (Config.instance.selfHosted) {
+ return false;
+ }
+ if (user.premiumType === UserPremiumTypes.LIFETIME) {
+ return true;
+ }
+ if (!this.operatorPassLookup) {
+ return false;
+ }
+ return (await this.operatorPassLookup.findOperatorPass(user.id)) !== null;
}
async markWarningSent(userId: UserID): Promise<void> {
const key = this.getWarningKey(userId);
- const ttlSeconds = seconds(`${INACTIVITY_WARNING_TTL_DAYS + 5} days`);
+ const ttlSeconds = seconds(`${this.getWarningLeadDays() + INACTIVITY_WARNING_KEY_EXTRA_DAYS} days`);
const timestamp = Date.now().toString();
await this.kvClient.setex(key, ttlSeconds, timestamp);
}
@@ -52,7 +79,7 @@ export class UserDeletionEligibilityService {
return exists === 1;
}
- async getWarningSentTimestamp(userId: UserID): Promise<number | null> {
+ private async getWarningSentTimestamp(userId: UserID): Promise<number | null> {
const key = this.getWarningKey(userId);
return parseStoredTimestamp(await this.kvClient.get(key), `Inactivity warning timestamp for user ${userId}`);
}
@@ -63,13 +90,16 @@ export class UserDeletionEligibilityService {
return false;
}
const timeSinceWarningMs = Date.now() - timestamp;
- const gracePeriodMs = INACTIVITY_WARNING_TTL_DAYS * ms('1 day');
+ const gracePeriodMs = this.getWarningLeadDays() * ms('1 day');
return timeSinceWarningMs >= gracePeriodMs;
}
private getInactivityThresholdMs(): number {
- const thresholdDays = Config.inactivityDeletionThresholdDays ?? 365 * 2;
- return thresholdDays * ms('1 day');
+ return getCachedAccountsConfig().inactivity_deletion.inactive_days * ms('1 day');
+ }
+
+ private getWarningLeadDays(): number {
+ return getCachedAccountsConfig().inactivity_deletion.warning_lead_days;
}
private getWarningKey(userId: UserID): string {
diff --git a/fluxer_api/src/api/user/tests/InactivityDeletion.test.ts b/fluxer_api/src/api/user/tests/InactivityDeletion.test.ts
index e6b208c41..7aaf4b663 100644
--- a/fluxer_api/src/api/user/tests/InactivityDeletion.test.ts
+++ b/fluxer_api/src/api/user/tests/InactivityDeletion.test.ts
@@ -2,11 +2,13 @@
import {createTestAccount, loginAccount} from '@app/api/auth/tests/AuthTestUtils';
import {createUserID} from '@app/api/BrandedTypes';
+import {getInstanceConfigRepository} from '@app/api/middleware/ServiceSingletons';
import {type ApiTestHarness, createApiTestHarness} from '@app/api/test/ApiTestHarness';
import {HTTP_STATUS} from '@app/api/test/TestConstants';
import {createBuilder, createBuilderWithoutAuth} from '@app/api/test/TestRequestBuilder';
import {UserRepository} from '@app/api/user/repositories/UserRepository';
import {expectDataExists} from '@app/api/user/tests/UserTestUtils';
+import {CleanupModes} from '@fluxer/constants/src/AccountConfigConstants';
import {DeletionReasons} from '@fluxer/constants/src/Core';
import type {MockKVProvider} from '@pkgs/kv_client/src/testing/MockKVProvider';
import {afterEach, beforeEach, describe, expect, test} from 'vitest';
@@ -141,6 +143,39 @@ describe('Inactivity Deletion', () => {
const dataStatus = await expectDataExists(harness, account.userId);
expect(dataStatus.userExists).toBe(true);
});
+ test('a configured threshold below two years warns accounts idle that long', async () => {
+ await getInstanceConfigRepository().updateAccountsConfig({inactivity_deletion: {inactive_days: 200}});
+ const account = await createTestAccount(harness);
+ await setUserActivity(harness, account.userId, new Date(Date.now() - 300 * 24 * 60 * 60 * 1000));
+ const result = await processInactivityDeletions(harness);
+ expect(result.warnings_sent).toBe(1);
+ expect(result.deletions_scheduled).toBe(0);
+ });
+ test('turning inactivity deletion off leaves long idle accounts alone', async () => {
+ await getInstanceConfigRepository().updateAccountsConfig({inactivity_deletion: {mode: CleanupModes.OFF}});
+ const account = await createTestAccount(harness);
+ await setUserActivity(harness, account.userId, new Date(Date.now() - 3 * 365 * 24 * 60 * 60 * 1000));
+ await harness.kvProvider.setex(
+ `inactivity_warning_sent:${account.userId}`,
+ 35 * 24 * 60 * 60,
+ String(Date.now() - 31 * 24 * 60 * 60 * 1000),
+ );
+ const result = await processInactivityDeletions(harness);
+ expect(result.warnings_sent).toBe(0);
+ expect(result.deletions_scheduled).toBe(0);
+ });
+ test('the time between the warning and the deletion comes from the config', async () => {
+ await getInstanceConfigRepository().updateAccountsConfig({inactivity_deletion: {warning_lead_days: 10}});
+ const account = await createTestAccount(harness);
+ await setUserActivity(harness, account.userId, new Date(Date.now() - 3 * 365 * 24 * 60 * 60 * 1000));
+ await harness.kvProvider.setex(
+ `inactivity_warning_sent:${account.userId}`,
+ 15 * 24 * 60 * 60,
+ String(Date.now() - 11 * 24 * 60 * 60 * 1000),
+ );
+ const result = await processInactivityDeletions(harness);
+ expect(result.deletions_scheduled).toBe(1);
+ });
test('a page issues one batched activity lookup instead of per-user reads', async () => {
const kvProvider = harness.kvProvider as MockKVProvider;
const accounts = [