aboutsummaryrefslogtreecommitdiffstats
path: root/packages/plugins/queue-restate/src/index.ts
blob: fa636f878925f7cdff186f001221ba1d15452cb1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
import * as restate from "@restatedev/restate-sdk";
import * as restateClient from "@restatedev/restate-sdk-clients";

import type { PluginProvider } from "@karakeep/shared/plugins";
import type {
  EnqueueOptions,
  Queue,
  QueueClient,
  QueueOptions,
  Runner,
  RunnerFuncs,
  RunnerOptions,
} from "@karakeep/shared/queueing";
import logger from "@karakeep/shared/logger";

import { AdminClient } from "./admin";
import { envConfig } from "./env";
import { idProvider } from "./idProvider";
import { semaphore } from "./semaphore";
import { buildRestateService } from "./service";

class RestateQueueWrapper<T> implements Queue<T> {
  constructor(
    private readonly _name: string,
    private readonly client: restateClient.Ingress,
    private readonly adminClient: AdminClient,
    public readonly opts: QueueOptions,
  ) {}

  name(): string {
    return this._name;
  }

  async enqueue(
    payload: T,
    options?: EnqueueOptions,
  ): Promise<string | undefined> {
    interface MyService {
      run: (
        ctx: restate.Context,
        data: {
          payload: T;
          priority: number;
          groupId?: string;
          queuedIdempotencyKey?: string;
        },
      ) => Promise<void>;
    }
    const cl = this.client.serviceSendClient<MyService>({ name: this.name() });
    const res = await cl.run(
      {
        payload,
        priority: options?.priority ?? 0,
        groupId: options?.groupId,
        queuedIdempotencyKey: options?.idempotencyKey,
      },
      restateClient.rpc.sendOpts({
        delay: options?.delayMs
          ? {
              milliseconds: options.delayMs,
            }
          : undefined,
      }),
    );
    return res.invocationId;
  }

  async stats(): Promise<{
    pending: number;
    pending_retry: number;
    running: number;
    failed: number;
  }> {
    const res = await this.adminClient.getStats(this.name());
    return {
      pending: res.pending + res.ready,
      pending_retry: res["backing-off"] + res.paused + res.suspended,
      running: res.running,
      failed: 0,
    };
  }

  async cancelAllNonRunning(): Promise<number> {
    throw new Error("Method not implemented.");
  }
}

class RestateRunnerWrapper<T> implements Runner<T> {
  constructor(
    private readonly wf: restate.ServiceDefinition<
      string,
      {
        run: (ctx: restate.Context, data: T) => Promise<void>;
      }
    >,
  ) {}

  async run(): Promise<void> {
    // No-op for restate
  }

  async stop(): Promise<void> {
    // No-op for restate
  }

  async runUntilEmpty(): Promise<void> {
    throw new Error("Method not implemented.");
  }

  get def(): restate.WorkflowDefinition<string, unknown> {
    return this.wf;
  }
}

class RestateQueueClient implements QueueClient {
  private client: restateClient.Ingress;
  private adminClient: AdminClient;
  private queues = new Map<string, RestateQueueWrapper<unknown>>();
  private services = new Map<string, RestateRunnerWrapper<unknown>>();

  constructor() {
    this.client = restateClient.connect({
      url: envConfig.RESTATE_INGRESS_ADDR,
    });
    this.adminClient = new AdminClient(envConfig.RESTATE_ADMIN_ADDR);
  }

  async prepare(): Promise<void> {
    // No-op for restate
  }

  async start(): Promise<void> {
    const port = await restate.serve({
      port: envConfig.RESTATE_LISTEN_PORT ?? 0,
      services: [
        ...[...this.services.values()].map((svc) => svc.def),
        semaphore,
        idProvider,
      ],
      identityKeys: envConfig.RESTATE_PUB_KEY
        ? [envConfig.RESTATE_PUB_KEY]
        : undefined,
      logger: (meta, msg) => {
        if (meta.context) {
          // No need to log invocation logs
        } else {
          logger.log(meta.level, `[restate] ${msg}`);
        }
      },
    });
    logger.info(`Restate listening on port ${port}`);
  }

  createQueue<T>(name: string, opts: QueueOptions): Queue<T> {
    if (this.queues.has(name)) {
      throw new Error(`Queue ${name} already exists`);
    }
    const wrapper = new RestateQueueWrapper<T>(
      name,
      this.client,
      this.adminClient,
      opts,
    );
    this.queues.set(name, wrapper);
    return wrapper;
  }

  createRunner<T, R = void>(
    queue: Queue<T>,
    funcs: RunnerFuncs<T, R>,
    opts: RunnerOptions<T>,
  ): Runner<T> {
    const name = queue.name();
    let wrapper = this.services.get(name);
    if (wrapper) {
      throw new Error(`Queue ${name} already exists`);
    }
    const svc = new RestateRunnerWrapper<T>(
      buildRestateService(queue, funcs, opts, queue.opts),
    );
    this.services.set(name, svc);
    return svc;
  }

  async shutdown(): Promise<void> {
    // No-op for sqlite
  }
}

export class RestateQueueProvider implements PluginProvider<QueueClient> {
  private client: QueueClient | null = null;

  static isConfigured(): boolean {
    return envConfig.RESTATE_LISTEN_PORT !== undefined;
  }

  async getClient(): Promise<QueueClient | null> {
    if (!this.client) {
      const client = new RestateQueueClient();
      this.client = client;
    }
    return this.client;
  }
}