Skip to content

A self-hostable bookmark-everything app (links, notes and images) with AI-based automatic tagging and full text search

fix: make queue registration idempotent

Mohamed Bassem6f1201332654
diff --git a/packages/plugins/queue-liteque/src/index.ts b/packages/plugins/queue-liteque/src/index.ts
index 48c4ed59..9eb1f3d6 100644
--- a/packages/plugins/queue-liteque/src/index.ts
+++ b/packages/plugins/queue-liteque/src/index.ts
@@ -19,7 +19,10 @@ import type {
RunnerOptions,
} from "@karakeep/shared/queueing";
import serverConfig from "@karakeep/shared/config";
-import { QueueRetryAfterError } from "@karakeep/shared/queueing";
+import {
+ QueueRetryAfterError,
+ queueOptionsEqual,
+} from "@karakeep/shared/queueing";
class LitequeQueueWrapper<T> implements Queue<T> {
constructor(
@@ -75,8 +78,12 @@ class LitequeQueueClient implements QueueClient {
}
createQueue<T>(name: string, options: QueueOptions): Queue<T> {
- if (this.queues.has(name)) {
- throw new Error(`Queue ${name} already exists`);
+ const existing = this.queues.get(name);
+ if (existing) {
+ if (!queueOptionsEqual(existing.opts, options)) {
+ throw new Error(`Queue ${name} already exists with different options`);
+ }
+ return existing as LitequeQueueWrapper<T>;
}
const lq = new LQ<T>(name, this.db, {
defaultJobArgs: { numRetries: options.defaultJobArgs.numRetries },
diff --git a/packages/plugins/queue-restate/src/index.ts b/packages/plugins/queue-restate/src/index.ts
index 33c86fa7..08951f53 100644
--- a/packages/plugins/queue-restate/src/index.ts
+++ b/packages/plugins/queue-restate/src/index.ts
@@ -12,6 +12,7 @@ import type {
RunnerOptions,
} from "@karakeep/shared/queueing";
import logger from "@karakeep/shared/logger";
+import { queueOptionsEqual } from "@karakeep/shared/queueing";
import { envConfig } from "./env";
import { idProvider } from "./idProvider";
@@ -173,8 +174,12 @@ class RestateQueueClient implements QueueClient {
}
createQueue<T>(name: string, opts: QueueOptions): Queue<T> {
- if (this.queues.has(name)) {
- throw new Error(`Queue ${name} already exists`);
+ const existing = this.queues.get(name);
+ if (existing) {
+ if (!queueOptionsEqual(existing.opts, opts)) {
+ throw new Error(`Queue ${name} already exists with different options`);
+ }
+ return existing as RestateQueueWrapper<T>;
}
const wrapper = new RestateQueueWrapper<T>(name, this.client, opts);
this.queues.set(name, wrapper);
diff --git a/packages/shared/queueing.ts b/packages/shared/queueing.ts
index d1f4bcef..8001d16d 100644
--- a/packages/shared/queueing.ts
+++ b/packages/shared/queueing.ts
@@ -31,6 +31,16 @@ export interface QueueOptions {
keepFailedJobs: boolean;
}
+export function queueOptionsEqual(
+ left: QueueOptions,
+ right: QueueOptions,
+): boolean {
+ return (
+ left.defaultJobArgs.numRetries === right.defaultJobArgs.numRetries &&
+ left.keepFailedJobs === right.keepFailedJobs
+ );
+}
+
export interface DequeuedJob<T> {
id: string;
data: T;