Skip to content

perf(server): skip usage scans when access keys have no data limits #1712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
OskarEichler wants to merge 2 commits into
base: master
Choose a base branch
from
+54 −18
Open

perf(server): skip usage scans when access keys have no data limits #1712

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
626d492
perf(server): skip usage scans when access keys have no data limits
OskarEichler Aug 27, 2026
d53ee50
fix(server): serialize limit enforcement and retry failed updates
OskarEichler Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 54 additions & 18 deletions src/shadowbox/server/server_access_key.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,9 @@ export class ServerAccessKeyRepository implements AccessKeyRepository {
private static DATA_LIMITS_ENFORCEMENT_INTERVAL_MS = 60 * 60 * 1000; // 1h
private NEW_USER_ENCRYPTION_METHOD = 'chacha20-ietf-poly1305';
private accessKeys: ServerAccessKey[];
private enforcement?: Promise<void>;
private enforcementRequested = false;
private limitUpdatePending = false;

constructor(
private portForNewAccessKeys: number,
Expand All @@ -132,21 +135,22 @@ export class ServerAccessKeyRepository implements AccessKeyRepository {
// Starts the Shadowsocks server and exposes the access key configuration to the server.
// Periodically enforces access key limits.
async start(clock: Clock): Promise<void> {
const tryEnforceDataLimits = async () => {
try {
await this.enforceAccessKeyDataLimits();
} catch (e) {
logging.error(`Failed to enforce access key limits: ${e}`);
}
};
await tryEnforceDataLimits();
await this.tryEnforceDataLimits();
await this.updateServer();
clock.setInterval(
tryEnforceDataLimits,
() => this.tryEnforceDataLimits(),
ServerAccessKeyRepository.DATA_LIMITS_ENFORCEMENT_INTERVAL_MS
);
}

private async tryEnforceDataLimits(): Promise<void> {
try {
await this.enforceAccessKeyDataLimits();
} catch (e) {
logging.error(`Failed to enforce access key limits: ${e}`);
}
}

private isExistingAccessKeyId(id: AccessKeyId): boolean {
return this.accessKeys.some((key) => {
return key.id === id;
Expand Down Expand Up @@ -276,13 +280,13 @@ export class ServerAccessKeyRepository implements AccessKeyRepository {
setAccessKeyDataLimit(id: AccessKeyId, limit: DataLimit): void {
this.getAccessKey(id).dataLimit = limit;
this.saveAccessKeys();
this.enforceAccessKeyDataLimits();
void this.tryEnforceDataLimits();
}

removeAccessKeyDataLimit(id: AccessKeyId): void {
delete this.getAccessKey(id).dataLimit;
this.saveAccessKeys();
this.enforceAccessKeyDataLimits();
void this.tryEnforceDataLimits();
}

get defaultDataLimit(): DataLimit | undefined {
Expand All @@ -291,20 +295,48 @@ export class ServerAccessKeyRepository implements AccessKeyRepository {

setDefaultDataLimit(limit: DataLimit): void {
this._defaultDataLimit = limit;
this.enforceAccessKeyDataLimits();
void this.tryEnforceDataLimits();
}

removeDefaultDataLimit(): void {
delete this._defaultDataLimit;
this.enforceAccessKeyDataLimits();
void this.tryEnforceDataLimits();
}

// Compares access key usage with collected metrics, marking them as under or over limit.
// Updates access key data usage.
async enforceAccessKeyDataLimits() {
const metrics = new PrometheusManagerMetrics(this.prometheusClient);
const bytesTransferredById = (await metrics.getOutboundByteTransfer({hours: 30 * 24}))
.bytesTransferredByUserId;
enforceAccessKeyDataLimits(): Promise<void> {
this.enforcementRequested = true;
if (!this.enforcement) {
this.enforcement = this.runDataLimitEnforcement();
}
return this.enforcement;
}

private async runDataLimitEnforcement(): Promise<void> {
try {
do {
this.enforcementRequested = false;
await this.enforceDataLimitsOnce();
} while (this.enforcementRequested);
} finally {
this.enforcement = undefined;
}
}

private async enforceDataLimitsOnce(): Promise<void> {
// Unlimited keys don't need a 30-day Prometheus scan. Still run the loop
// below so removing the last limit re-enables any previously blocked keys.
const hasDataLimits = this.accessKeys.some(
(key) => (key.dataLimit ?? this._defaultDataLimit) !== undefined
);
const bytesTransferredById = hasDataLimits
? (
await new PrometheusManagerMetrics(this.prometheusClient).getOutboundByteTransfer({
hours: 30 * 24,
})
).bytesTransferredByUserId
: {};
let limitStatusChanged = false;
for (const accessKey of this.accessKeys) {
const usageBytes = bytesTransferredById[accessKey.id] ?? 0;
Expand All @@ -316,8 +348,12 @@ export class ServerAccessKeyRepository implements AccessKeyRepository {
accessKey.reachedDataLimit = usageBytes >= limitBytes;
limitStatusChanged = accessKey.reachedDataLimit !== oldReachedDataLimit || limitStatusChanged;
}
if (limitStatusChanged) {
this.limitUpdatePending = this.limitUpdatePending || limitStatusChanged;
if (this.limitUpdatePending) {
await this.updateServer();
// Keep this set on failure so the next enforcement retries the update
// even when the computed limit status itself has not changed.
this.limitUpdatePending = false;
}
}

Expand Down