From e7ee2cc398dd1bf9d04c30ebacff85c113714d15 Mon Sep 17 00:00:00 2001 From: Hazelnoot Date: Mon, 12 May 2025 00:23:59 -0400 Subject: [PATCH] add configurable timeout for note translations --- locales/index.d.ts | 8 ++++++++ ...47023091463-add_meta_translationTimeout.js | 18 +++++++++++++++++ packages/backend/src/models/Meta.ts | 6 ++++++ .../src/server/api/endpoints/admin/meta.ts | 5 +++++ .../server/api/endpoints/admin/update-meta.ts | 5 +++++ .../server/api/endpoints/notes/translate.ts | 2 ++ .../src/pages/admin/external-services.vue | 20 ++++++++++++++++--- packages/misskey-js/src/autogen/types.ts | 2 ++ sharkey-locales/en-US.yml | 3 +++ 9 files changed, 66 insertions(+), 3 deletions(-) create mode 100644 packages/backend/migration/1747023091463-add_meta_translationTimeout.js diff --git a/locales/index.d.ts b/locales/index.d.ts index 59637f0bcf..e40f67a495 100644 --- a/locales/index.d.ts +++ b/locales/index.d.ts @@ -13045,6 +13045,14 @@ export interface Locale extends ILocale { * Note: the bubble timeline is hidden by default, and must be enabled via roles. */ "bubbleTimelineMustBeEnabled": string; + /** + * Translation timeout + */ + "translationTimeoutLabel": string; + /** + * Timeout in milliseconds for translation API requests (default 5000) + */ + "translationTimeoutCaption": string; } declare const locales: { [lang: string]: Locale; diff --git a/packages/backend/migration/1747023091463-add_meta_translationTimeout.js b/packages/backend/migration/1747023091463-add_meta_translationTimeout.js new file mode 100644 index 0000000000..cf291f8d74 --- /dev/null +++ b/packages/backend/migration/1747023091463-add_meta_translationTimeout.js @@ -0,0 +1,18 @@ +/* + * SPDX-FileCopyrightText: hazelnoot and other Sharkey contributors + * SPDX-License-Identifier: AGPL-3.0-only + */ + +export class AddMetaTranslationTimeout1747023091463 { + name = 'AddMetaTranslationTimeout1747023091463' + + async up(queryRunner) { + await queryRunner.query(`ALTER TABLE "meta" ADD "translationTimeout" integer NOT NULL DEFAULT '5000'`); + await queryRunner.query(`COMMENT ON COLUMN "meta"."translationTimeout" IS 'Timeout in milliseconds for translation API requests'`); + } + + async down(queryRunner) { + await queryRunner.query(`COMMENT ON COLUMN "meta"."translationTimeout" IS 'Timeout in milliseconds for translation API requests'`); + await queryRunner.query(`ALTER TABLE "meta" DROP COLUMN "translationTimeout"`); + } +} diff --git a/packages/backend/src/models/Meta.ts b/packages/backend/src/models/Meta.ts index 78b3175458..5292480142 100644 --- a/packages/backend/src/models/Meta.ts +++ b/packages/backend/src/models/Meta.ts @@ -382,6 +382,12 @@ export class MiMeta { }) public swPrivateKey: string | null; + @Column('integer', { + default: 5000, + comment: 'Timeout in milliseconds for translation API requests', + }) + public translationTimeout: number; + @Column('varchar', { length: 1024, nullable: true, diff --git a/packages/backend/src/server/api/endpoints/admin/meta.ts b/packages/backend/src/server/api/endpoints/admin/meta.ts index f059a3ed4d..13022f43a0 100644 --- a/packages/backend/src/server/api/endpoints/admin/meta.ts +++ b/packages/backend/src/server/api/endpoints/admin/meta.ts @@ -445,6 +445,10 @@ export const meta = { type: 'string', optional: false, nullable: true, }, + translationTimeout: { + type: 'number', + optional: false, nullable: false, + }, deeplAuthKey: { type: 'string', optional: false, nullable: true, @@ -723,6 +727,7 @@ export default class extends Endpoint { // eslint- objectStorageUseProxy: instance.objectStorageUseProxy, objectStorageSetPublicRead: instance.objectStorageSetPublicRead, objectStorageS3ForcePathStyle: instance.objectStorageS3ForcePathStyle, + translationTimeout: instance.translationTimeout, deeplAuthKey: instance.deeplAuthKey, deeplIsPro: instance.deeplIsPro, deeplFreeMode: instance.deeplFreeMode, diff --git a/packages/backend/src/server/api/endpoints/admin/update-meta.ts b/packages/backend/src/server/api/endpoints/admin/update-meta.ts index eb73c4b616..090681c134 100644 --- a/packages/backend/src/server/api/endpoints/admin/update-meta.ts +++ b/packages/backend/src/server/api/endpoints/admin/update-meta.ts @@ -103,6 +103,7 @@ export const paramDef = { type: 'string', }, }, + translationTimeout: { type: 'number' }, deeplAuthKey: { type: 'string', nullable: true }, deeplIsPro: { type: 'boolean' }, deeplFreeMode: { type: 'boolean' }, @@ -560,6 +561,10 @@ export default class extends Endpoint { // eslint- set.objectStorageS3ForcePathStyle = ps.objectStorageS3ForcePathStyle; } + if (ps.translationTimeout !== undefined) { + set.translationTimeout = ps.translationTimeout; + } + if (ps.deeplAuthKey !== undefined) { if (ps.deeplAuthKey === '') { set.deeplAuthKey = null; diff --git a/packages/backend/src/server/api/endpoints/notes/translate.ts b/packages/backend/src/server/api/endpoints/notes/translate.ts index 39119bc206..843a4ef01c 100644 --- a/packages/backend/src/server/api/endpoints/notes/translate.ts +++ b/packages/backend/src/server/api/endpoints/notes/translate.ts @@ -116,6 +116,7 @@ export default class extends Endpoint { // eslint- Accept: 'application/json, */*', }, body: params.toString(), + timeout: this.serverSettings.translationTimeout, }); if (this.serverSettings.deeplAuthKey) { const json = (await res.json()) as { @@ -165,6 +166,7 @@ export default class extends Endpoint { // eslint- format: 'text', api_key: this.serverSettings.libreTranslateKey ?? '', }), + timeout: this.serverSettings.translationTimeout, }); const json = (await res.json()) as { diff --git a/packages/frontend/src/pages/admin/external-services.vue b/packages/frontend/src/pages/admin/external-services.vue index 3cfc51af00..ced74a5df4 100644 --- a/packages/frontend/src/pages/admin/external-services.vue +++ b/packages/frontend/src/pages/admin/external-services.vue @@ -8,6 +8,11 @@ SPDX-License-Identifier: AGPL-3.0-only
+ + + + + @@ -57,7 +62,7 @@ SPDX-License-Identifier: AGPL-3.0-only