trustgraph/ts/packages/base/src/backend/nats.ts

363 lines
12 KiB
TypeScript
Raw Normal View History

2026-04-05 21:09:33 -05:00
/**
* NATS JetStream backend implementation.
*
* Replaces Pulsar as the message broker. NATS JetStream provides
* at-least-once delivery, consumer groups, and replay matching
* the QoS levels used by the Python Pulsar backend.
*
* Python reference: trustgraph-base/trustgraph/base/pulsar_backend.py
*/
import {
connect,
type NatsConnection,
type JetStreamClient,
type JetStreamManager,
2026-04-05 22:44:45 -05:00
type Consumer as NatsJsConsumer,
headers,
2026-04-05 21:09:33 -05:00
type JsMsg,
type JetStreamPublishOptions,
2026-04-05 21:09:33 -05:00
StringCodec,
AckPolicy,
2026-04-05 22:44:45 -05:00
DeliverPolicy,
2026-04-05 21:09:33 -05:00
} from "nats";
2026-06-02 00:22:04 -05:00
import { Effect } from "effect";
import * as Predicate from "effect/Predicate";
2026-05-12 08:06:58 -05:00
import * as S from "effect/Schema";
2026-04-05 21:09:33 -05:00
import type {
PubSubBackend,
BackendProducer,
BackendConsumer,
CreateProducerOptions,
CreateConsumerOptions,
Message,
} from "./types.js";
2026-06-02 00:22:04 -05:00
import { pubSubError } from "../errors.js";
2026-04-05 21:09:33 -05:00
const sc = StringCodec();
2026-06-01 20:26:47 -05:00
interface NatsMessage<T> extends Message<T> {
2026-04-05 22:44:45 -05:00
/** Exposed so acknowledge/negativeAcknowledge can access the raw JsMsg */
readonly _jsMsg: JsMsg;
2026-06-01 20:26:47 -05:00
}
2026-04-05 21:09:33 -05:00
2026-06-01 20:26:47 -05:00
function makeNatsMessage<T>(msg: JsMsg, decoded: T): NatsMessage<T> {
return {
_jsMsg: msg,
value: () => decoded,
properties: () => {
const headers = msg.headers;
const props: Record<string, string> = {};
if (headers !== undefined) {
for (const [key, values] of headers) {
const value = values[0];
if (value !== undefined) {
props[key] = value;
}
2026-05-12 08:06:58 -05:00
}
2026-04-05 21:09:33 -05:00
}
2026-06-01 20:26:47 -05:00
return props;
},
};
2026-04-05 21:09:33 -05:00
}
2026-06-02 00:22:04 -05:00
const hasJsMsg = Predicate.hasProperty("_jsMsg");
function isAckableJsMsg(value: unknown): value is Pick<JsMsg, "ack" | "nak"> {
if (!Predicate.isObject(value)) return false;
if (!Predicate.hasProperty(value, "ack")) return false;
if (!Predicate.hasProperty(value, "nak")) return false;
return typeof value.ack === "function" && typeof value.nak === "function";
}
function isNatsMessage<T>(message: Message<T>): message is NatsMessage<T> {
return hasJsMsg(message) && isAckableJsMsg(message._jsMsg);
}
2026-06-01 20:26:47 -05:00
function makeNatsProducer<T>(
js: JetStreamClient,
subject: string,
2026-06-02 00:22:04 -05:00
schema?: S.Codec<T, unknown>,
2026-06-01 20:26:47 -05:00
): BackendProducer<T> {
const makePublishOptions = (
properties: Record<string, string> | undefined,
): Effect.Effect<Partial<JetStreamPublishOptions>, ReturnType<typeof pubSubError>> => {
if (properties === undefined || Object.keys(properties).length === 0) {
return Effect.succeed({});
}
return Effect.try({
try: () => {
const hdrs = headers();
for (const [key, val] of Object.entries(properties)) {
hdrs.append(key, val);
}
return { headers: hdrs };
},
catch: (error) => pubSubError(`headers:${subject}`, error),
});
};
2026-06-01 20:26:47 -05:00
return {
2026-06-02 00:22:04 -05:00
send: (message, properties) =>
Effect.runPromise(
Effect.gen(function* () {
const encoded = schema !== undefined
? yield* S.encodeUnknownEffect(schema)(message).pipe(
Effect.mapError((error) => pubSubError(`encode:${subject}`, error)),
)
: message;
const json = yield* S.encodeUnknownEffect(S.UnknownFromJsonString)(encoded).pipe(
Effect.mapError((error) => pubSubError(`encode-json:${subject}`, error)),
);
const data = sc.encode(json);
const opts = yield* makePublishOptions(properties);
2026-06-02 00:22:04 -05:00
yield* Effect.tryPromise({
try: () => js.publish(subject, data, opts),
catch: (error) => pubSubError(`publish:${subject}`, error),
});
}),
),
// NATS publishes are flushed on the connection level.
flush: () => Promise.resolve(),
// No per-producer cleanup needed for NATS.
close: () => Promise.resolve(),
2026-06-01 20:26:47 -05:00
};
2026-04-05 21:09:33 -05:00
}
2026-06-01 20:26:47 -05:00
interface InitializableBackendConsumer<T> extends BackendConsumer<T> {
readonly init: () => Promise<void>;
2026-04-05 21:09:33 -05:00
}
2026-06-01 20:26:47 -05:00
function makeNatsConsumer<T>(
js: JetStreamClient,
jsm: JetStreamManager,
subject: string,
subscription: string,
initialPosition: "latest" | "earliest",
streamName: string,
2026-06-02 00:22:04 -05:00
schema?: S.Codec<T, unknown>,
2026-06-01 20:26:47 -05:00
): InitializableBackendConsumer<T> {
let consumer: NatsJsConsumer | null = null;
return {
2026-06-02 00:22:04 -05:00
init: () =>
Effect.runPromise(
Effect.gen(function* () {
const existing = yield* Effect.tryPromise({
try: () => js.consumers.get(streamName, subscription),
catch: (error) => pubSubError(`get-consumer:${streamName}:${subscription}`, error),
}).pipe(
Effect.catch(() =>
Effect.gen(function* () {
const deliverPolicy =
initialPosition === "earliest"
? DeliverPolicy.All
: DeliverPolicy.New;
yield* Effect.tryPromise({
try: () =>
jsm.consumers.add(streamName, {
durable_name: subscription,
ack_policy: AckPolicy.Explicit,
deliver_policy: deliverPolicy,
filter_subject: subject,
}),
catch: (error) => pubSubError(`add-consumer:${streamName}:${subscription}`, error),
});
return yield* Effect.tryPromise({
try: () => js.consumers.get(streamName, subscription),
catch: (error) => pubSubError(`get-consumer:${streamName}:${subscription}`, error),
});
}),
),
);
consumer = existing;
}),
),
receive: (timeoutMs = 2000) =>
Effect.runPromise(
Effect.gen(function* () {
const current = consumer;
if (current === null) {
return yield* pubSubError("receive", "Consumer not initialized");
}
// Pull a single message with a timeout using the pull-based API.
// consumer.next() returns a JsMsg or null when the timeout expires.
const msg = yield* Effect.tryPromise({
try: () => current.next({ expires: timeoutMs }),
catch: (error) => pubSubError(`receive:${subject}`, error),
});
if (msg === null) return null;
const parsed = yield* S.decodeUnknownEffect(S.UnknownFromJsonString)(sc.decode(msg.data)).pipe(
Effect.mapError((error) => pubSubError(`decode-json:${subject}`, error)),
);
const decoded = schema !== undefined
? yield* S.decodeUnknownEffect(schema)(parsed).pipe(
Effect.mapError((error) => pubSubError(`decode-schema:${subject}`, error)),
)
: yield* S.decodeUnknownEffect(S.Any)(parsed).pipe(
Effect.mapError((error) => pubSubError(`decode-any:${subject}`, error)),
);
return makeNatsMessage(msg, decoded);
}),
),
acknowledge: (message) =>
Effect.runPromise(
Effect.gen(function* () {
if (!isNatsMessage(message)) {
return yield* pubSubError(`acknowledge:${subject}`, "Message was not produced by NATS backend");
}
yield* Effect.try({
try: () => {
message._jsMsg.ack();
},
catch: (error) => pubSubError(`acknowledge:${subject}`, error),
2026-06-02 00:22:04 -05:00
});
}),
),
negativeAcknowledge: (message) =>
Effect.runPromise(
Effect.gen(function* () {
if (!isNatsMessage(message)) {
return yield* pubSubError(
`negative-acknowledge:${subject}`,
"Message was not produced by NATS backend",
);
}
yield* Effect.try({
try: () => {
message._jsMsg.nak();
},
catch: (error) => pubSubError(`negative-acknowledge:${subject}`, error),
2026-06-02 00:22:04 -05:00
});
}),
),
unsubscribe: () => {
2026-06-01 20:26:47 -05:00
// The pull-based consumer does not have a persistent subscription to drain.
// Clearing the reference is sufficient; the durable consumer persists server-side.
consumer = null;
2026-06-02 00:22:04 -05:00
return Promise.resolve();
2026-06-01 20:26:47 -05:00
},
2026-06-02 00:22:04 -05:00
close: () => {
2026-06-01 20:26:47 -05:00
consumer = null;
2026-06-02 00:22:04 -05:00
return Promise.resolve();
2026-06-01 20:26:47 -05:00
},
};
}
2026-04-05 21:09:33 -05:00
2026-06-01 20:26:47 -05:00
export function makeNatsBackend(url = "nats://localhost:4222"): PubSubBackend {
let connection: NatsConnection | null = null;
let js: JetStreamClient | null = null;
let jsm: JetStreamManager | null = null;
const initializedStreams = new Set<string>();
2026-06-02 00:22:04 -05:00
const ensureConnected = Effect.fn("NatsBackend.ensureConnected")(function* () {
2026-06-01 20:26:47 -05:00
if (connection === null) {
2026-06-02 00:22:04 -05:00
const conn = yield* Effect.tryPromise({
try: () => connect({ servers: url }),
catch: (error) => pubSubError("connect", error),
});
connection = conn;
js = conn.jetstream();
jsm = yield* Effect.tryPromise({
try: () => conn.jetstreamManager(),
catch: (error) => pubSubError("jetstream-manager", error),
});
2026-04-05 21:09:33 -05:00
}
2026-06-02 00:22:04 -05:00
});
2026-04-05 21:09:33 -05:00
/**
* Ensure the stream for a given subject exists with a wildcard filter.
* E.g. subject "tg.flow.config-request" stream "tg_flow" with subjects ["tg.flow.>"]
*/
2026-06-02 00:22:04 -05:00
const ensureStream = Effect.fn("NatsBackend.ensureStream")(function* (subject: string) {
const parts = subject.split(".");
const streamName = parts.slice(0, 2).join("_");
2026-06-01 20:26:47 -05:00
if (initializedStreams.has(streamName)) return streamName;
const wildcardSubject = `${parts.slice(0, 2).join(".")}.>`;
2026-06-01 20:26:47 -05:00
const manager = jsm;
2026-06-02 00:22:04 -05:00
if (manager === null) return yield* pubSubError("ensure-stream", "NATS backend not connected");
yield* Effect.tryPromise({
try: () => manager.streams.info(streamName),
catch: (error) => pubSubError(`stream-info:${streamName}`, error),
}).pipe(
Effect.catch(() =>
Effect.tryPromise({
try: () =>
manager.streams.add({
name: streamName,
subjects: [wildcardSubject],
}),
catch: (error) => pubSubError(`stream-add:${streamName}`, error),
}),
),
);
2026-06-01 20:26:47 -05:00
initializedStreams.add(streamName);
return streamName;
2026-06-02 00:22:04 -05:00
});
2026-06-01 20:26:47 -05:00
return {
2026-06-02 00:22:04 -05:00
createProducer: <T>(options: CreateProducerOptions<T>) =>
Effect.runPromise(
Effect.gen(function* () {
yield* ensureConnected();
yield* ensureStream(options.topic);
const client = js;
if (client === null) return yield* pubSubError("create-producer", "NATS backend not connected");
return makeNatsProducer<T>(client, options.topic, options.schema);
}),
),
createConsumer: <T>(options: CreateConsumerOptions<T>) =>
Effect.runPromise(
Effect.gen(function* () {
yield* ensureConnected();
const streamName = yield* ensureStream(options.topic);
const client = js;
const manager = jsm;
if (client === null || manager === null) {
return yield* pubSubError("create-consumer", "NATS backend not connected");
}
const consumer = makeNatsConsumer<T>(
client,
manager,
options.topic,
options.subscription,
options.initialPosition ?? "latest",
streamName,
options.schema,
);
yield* Effect.tryPromise({
try: () => consumer.init(),
catch: (error) => pubSubError(`init-consumer:${options.topic}`, error),
});
return consumer;
}),
),
close: () =>
Effect.runPromise(
Effect.gen(function* () {
const conn = connection;
if (conn !== null) {
yield* Effect.tryPromise({
try: () => conn.drain(),
catch: (error) => pubSubError("close", error),
});
connection = null;
js = null;
jsm = null;
}
}),
),
2026-06-01 20:26:47 -05:00
};
2026-04-05 21:09:33 -05:00
}