@rivetkit/redis/src/coordinate/driver.ts

_Lightweight Libraries for Backends_

import type { ActorKey } from "@rivetkit/core";
import type { NodeMessage } from "./node/protocol";

export type NodeMessageCallback = (message: NodeMessage) => void;

export interface GetActorLeaderOutput {
	/** Undefined if not initialized. */
	actor?: {
		leaderNodeId?: string;
	};
}

export interface StartActorAndAcquireLeaseOutput {
	/** Undefined if not initialized. */
	actor?: {
		name?: string;
		key?: ActorKey;
		leaderNodeId?: string;
	};
}

export interface ExtendLeaseOutput {
	leaseValid: boolean;
}

export interface AttemptAcquireLease {
	newLeaderNodeId: string;
}

export interface CoordinateDriver {
	// MARK: Node communication
	createNodeSubscriber(
		selfNodeId: string,
		callback: NodeMessageCallback,
	): Promise<void>;
	publishToNode(targetNodeId: string, message: NodeMessage): Promise<void>;

	// MARK: Actor lifecycle
	getActorLeader(actorId: string): Promise<GetActorLeaderOutput>;
	startActorAndAcquireLease(
		actorId: string,
		selfNodeId: string,
		leaseDuration: number,
	): Promise<StartActorAndAcquireLeaseOutput>;
	extendLease(
		actorId: string,
		selfNodeId: string,
		leaseDuration: number,
	): Promise<ExtendLeaseOutput>;
	attemptAcquireLease(
		actorId: string,
		selfNodeId: string,
		leaseDuration: number,
	): Promise<AttemptAcquireLease>;
	releaseLease(actorId: string, nodeId: string): Promise<void>;
}