From 2b919c4eb0dddd668a7f541122d54f191a0872c3 Mon Sep 17 00:00:00 2001 From: PrivateGER Date: Tue, 25 Feb 2025 22:07:59 +0100 Subject: [PATCH 1/5] Optionally enable websocket compression --- .config/example.yml | 4 ++++ packages/backend/src/config.ts | 5 +++++ packages/backend/src/server/api/StreamingApiServerService.ts | 5 +++++ 3 files changed, 14 insertions(+) diff --git a/.config/example.yml b/.config/example.yml index d199544589..1caaf87eab 100644 --- a/.config/example.yml +++ b/.config/example.yml @@ -421,3 +421,7 @@ checkActivityPubGetSignature: false # How long to save each log entry before deleting it. # Default: 2592000000 (1 week) #maxAge: 2592000000 + +# Transparently compress every websocket message on clients that support it. +# Trades server CPU usage for reduced bandwidth usage and a faster frontend on the client. +websocketCompression: false diff --git a/packages/backend/src/config.ts b/packages/backend/src/config.ts index c571c227a1..b09a144a4f 100644 --- a/packages/backend/src/config.ts +++ b/packages/backend/src/config.ts @@ -136,6 +136,8 @@ type Source = { preSave?: boolean; maxAge?: number; }; + + websocketCompression?: boolean; }; export type Config = { @@ -252,6 +254,8 @@ export type Config = { preSave: boolean; maxAge: number; }; + + websocketCompression?: boolean; }; export type FulltextSearchProvider = 'sqlLike' | 'sqlPgroonga' | 'meilisearch' | 'sqlTsvector'; @@ -400,6 +404,7 @@ export function loadConfig(): Config { preSave: config.activityLogging?.preSave ?? false, maxAge: config.activityLogging?.maxAge ?? (1000 * 60 * 60 * 24 * 30), }, + websocketCompression: config.websocketCompression, }; } diff --git a/packages/backend/src/server/api/StreamingApiServerService.ts b/packages/backend/src/server/api/StreamingApiServerService.ts index 6e7abcfae6..4eb11f2956 100644 --- a/packages/backend/src/server/api/StreamingApiServerService.ts +++ b/packages/backend/src/server/api/StreamingApiServerService.ts @@ -26,6 +26,7 @@ import MainStreamConnection from './stream/Connection.js'; import { ChannelsService } from './stream/ChannelsService.js'; import type * as http from 'node:http'; import type { IEndpointMeta } from './endpoints.js'; +import type {Config} from "@/config.js"; @Injectable() export class StreamingApiServerService { @@ -49,6 +50,9 @@ export class StreamingApiServerService { private channelFollowingService: ChannelFollowingService, private rateLimiterService: SkRateLimiterService, private loggerService: LoggerService, + + @Inject(DI.config) + private config: Config, ) { } @@ -74,6 +78,7 @@ export class StreamingApiServerService { public attach(server: http.Server): void { this.#wss = new WebSocket.WebSocketServer({ noServer: true, + perMessageDeflate: this.config.websocketCompression ?? false, }); server.on('upgrade', async (request, socket, head) => { From 9ed9ed86aff235ed2da8deda2703d8df8d93db70 Mon Sep 17 00:00:00 2001 From: PrivateGER Date: Tue, 25 Feb 2025 23:53:53 +0100 Subject: [PATCH 2/5] override compression from env vars --- packages/backend/src/config.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/backend/src/config.ts b/packages/backend/src/config.ts index b09a144a4f..5698f0b69e 100644 --- a/packages/backend/src/config.ts +++ b/packages/backend/src/config.ts @@ -539,7 +539,7 @@ function applyEnvOverrides(config: Source) { // these are all the settings that can be overridden - _apply_top([['url', 'port', 'address', 'socket', 'chmodSocket', 'disableHsts', 'id', 'dbReplications']]); + _apply_top([['url', 'port', 'address', 'socket', 'chmodSocket', 'disableHsts', 'id', 'dbReplications', 'websocketCompression']]); _apply_top(['db', ['host', 'port', 'db', 'user', 'pass', 'disableCache']]); _apply_top(['dbSlaves', Array.from((config.dbSlaves ?? []).keys()), ['host', 'port', 'db', 'user', 'pass']]); _apply_top([ From 15e9c0a57613c48b4dd47fe43b88e9b38388c19a Mon Sep 17 00:00:00 2001 From: PrivateGER Date: Wed, 26 Feb 2025 12:04:38 +0100 Subject: [PATCH 3/5] Add warning about memory fragmentation --- .config/example.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.config/example.yml b/.config/example.yml index 1caaf87eab..59d0708877 100644 --- a/.config/example.yml +++ b/.config/example.yml @@ -424,4 +424,6 @@ checkActivityPubGetSignature: false # Transparently compress every websocket message on clients that support it. # Trades server CPU usage for reduced bandwidth usage and a faster frontend on the client. +# If you're not using jemalloc, this may cause memory fragmentation and performance issues! (https://www.npmjs.com/package/ws#websocket-compression) +# jemalloc is used by default in the Sharkey Docker image and may be set up manually otherwise: https://github.com/jemalloc/jemalloc/wiki/getting-started websocketCompression: false From aa6bc9c9d0b66bff4ff7dedc96fd9bc347abc284 Mon Sep 17 00:00:00 2001 From: PrivateGER Date: Wed, 26 Feb 2025 12:13:13 +0100 Subject: [PATCH 4/5] linter fix --- packages/backend/src/server/api/StreamingApiServerService.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/backend/src/server/api/StreamingApiServerService.ts b/packages/backend/src/server/api/StreamingApiServerService.ts index 4eb11f2956..f292c48306 100644 --- a/packages/backend/src/server/api/StreamingApiServerService.ts +++ b/packages/backend/src/server/api/StreamingApiServerService.ts @@ -26,7 +26,7 @@ import MainStreamConnection from './stream/Connection.js'; import { ChannelsService } from './stream/ChannelsService.js'; import type * as http from 'node:http'; import type { IEndpointMeta } from './endpoints.js'; -import type {Config} from "@/config.js"; +import type { Config } from "@/config.js"; @Injectable() export class StreamingApiServerService { From c08c8502e3d88489625ed4c702d8213e2d62dcdd Mon Sep 17 00:00:00 2001 From: PrivateGER Date: Tue, 18 Mar 2025 14:21:31 +0100 Subject: [PATCH 5/5] adjust compression fallback --- packages/backend/src/config.ts | 2 +- packages/backend/src/server/api/StreamingApiServerService.ts | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/backend/src/config.ts b/packages/backend/src/config.ts index 5698f0b69e..ce66df11f9 100644 --- a/packages/backend/src/config.ts +++ b/packages/backend/src/config.ts @@ -404,7 +404,7 @@ export function loadConfig(): Config { preSave: config.activityLogging?.preSave ?? false, maxAge: config.activityLogging?.maxAge ?? (1000 * 60 * 60 * 24 * 30), }, - websocketCompression: config.websocketCompression, + websocketCompression: config.websocketCompression ?? false, }; } diff --git a/packages/backend/src/server/api/StreamingApiServerService.ts b/packages/backend/src/server/api/StreamingApiServerService.ts index f292c48306..0954744f81 100644 --- a/packages/backend/src/server/api/StreamingApiServerService.ts +++ b/packages/backend/src/server/api/StreamingApiServerService.ts @@ -78,7 +78,7 @@ export class StreamingApiServerService { public attach(server: http.Server): void { this.#wss = new WebSocket.WebSocketServer({ noServer: true, - perMessageDeflate: this.config.websocketCompression ?? false, + perMessageDeflate: this.config.websocketCompression, }); server.on('upgrade', async (request, socket, head) => {