ravenflow 0.4.0 → 0.4.2

package/dist/index.d.mts

@@ -1,6 +1,5 @@
-import { Job, ConnectionOptions, Queue } from 'bullmq';
+import { Job, ConnectionOptions } from 'bullmq';
 import pino from 'pino';
-import { Db } from 'mongodb';
 
 declare const CONTINUATION: unique symbol;
 interface Continuation<TPayload> {
@@ -133,125 +132,6 @@ interface QueuesRetentionConfig {
 }
 declare function defineConfig<const T extends RavenflowConfig>(config: T): T;
 
-declare class MongoConnection {
-    private readonly uri;
-    private client;
-    private database;
-    private connecting;
-    constructor(uri: string);
-    connect(): Promise<Db>;
-    close(): Promise<void>;
-    private openTheDatabase;
-    private forgetTheAttempt;
-}
-
-type ControlKey = `job:${string}`;
-
-interface ControlPublisher {
-    publish(key: ControlKey): Promise<void>;
-}
-declare class ControlChannel implements ControlPublisher {
-    private readonly connection;
-    private readonly logger;
-    private publisher;
-    private subscriber;
-    constructor(connection: ConnectionOptions, logger: Logger);
-    publish(key: ControlKey): Promise<void>;
-    subscribe(onInvalidate: (key: ControlKey) => void): Promise<void>;
-    close(): Promise<void>;
-    private deliver;
-    private listenOn;
-    private open;
-}
-
-declare const LEVERS: readonly ["executionPaused", "triggerPaused", "ingestPaused"];
-type Lever = (typeof LEVERS)[number];
-type JobControls = Record<Lever, boolean>;
-
-interface ControlReads {
-    read(jobName: string): Promise<JobControls>;
-}
-interface JobControlPlane extends ControlReads {
-    write(jobName: string, patch: Partial<JobControls>): Promise<void>;
-}
-
-interface LeverEntry {
-    key: ControlKey;
-    lever: Lever;
-    value: string;
-}
-interface StoredLever {
-    jobName: string;
-    lever: Lever;
-    value: string;
-}
-declare class ControlHash {
-    private readonly options;
-    private readonly logger;
-    private connection;
-    constructor(options: ConnectionOptions, logger: Logger);
-    readLevers(key: ControlKey): Promise<Map<Lever, string>>;
-    readEveryLever(): Promise<StoredLever[]>;
-    write(entry: LeverEntry): Promise<void>;
-    writeIfAbsent(entry: LeverEntry): Promise<boolean>;
-    close(): Promise<void>;
-    private get redis();
-}
-
-interface MirroredControls extends Partial<JobControls> {
-    _id: string;
-    updatedAt: Date;
-}
-interface ControlMirror {
-    mirrorJobControls(jobName: string, patch: Partial<JobControls>): Promise<void>;
-    listAll(): Promise<MirroredControls[]>;
-}
-
-type LiveControls = Map<string, JobControls>;
-
-interface RehydrationReport {
-    restored: number;
-    alreadyLive: number;
-    truncated: boolean;
-}
-
-interface ControlStoreParts {
-    hash: ControlHash;
-    publisher: ControlPublisher;
-    mirror: ControlMirror;
-    logger: Logger;
-}
-declare class ControlStore implements JobControlPlane {
-    private readonly parts;
-    constructor(parts: ControlStoreParts);
-    read(jobName: string): Promise<JobControls>;
-    write(jobName: string, patch: Partial<JobControls>): Promise<void>;
-    readAll(): Promise<LiveControls>;
-    rehydrate(): Promise<RehydrationReport>;
-    close(): Promise<void>;
-    private isPulled;
-    private writeLevers;
-    private announce;
-    private writeMirror;
-}
-
-declare class ControlPlane implements JobControlPlane {
-    private readonly parts;
-    private readonly cache;
-    constructor(parts: {
-        store: ControlStore;
-        channel: ControlChannel;
-        logger: Logger;
-    });
-    read(jobName: string): Promise<JobControls>;
-    write(jobName: string, patch: Partial<JobControls>): Promise<void>;
-    rehydrate(): Promise<void>;
-    close(): Promise<void>;
-    private closeQuietly;
-}
-
-type QueuesByName = Record<string, Queue>;
-
 interface SpoolPurgeReport {
     dropped: number;
     inFlight: number;
@@ -301,23 +181,21 @@ interface SpoolFedControls extends ExecutionControls, TriggerControls, IngestCon
     purgeBacklog(): Promise<SpoolPurgeReport>;
 }
 
-declare class RavenflowClient<TConfig extends RavenflowConfig = RavenflowConfig> {
+interface RavenflowClient<TConfig extends RavenflowConfig = RavenflowConfig> {
     readonly jobs: JobsProxy<TConfig["jobs"]>;
-    protected readonly redisConnectionOptions: ConnectionOptions;
-    protected readonly mongoUri: string;
-    protected readonly mongo: MongoConnection;
-    protected readonly config: TConfig;
-    protected readonly controlPlane: ControlPlane;
-    protected readonly queues: QueuesByName;
-    protected readonly logger: Logger;
-    constructor(config: TConfig, options: {
-        redis: ConnectionOptions;
-        mongo: string;
-    });
     close(): Promise<void>;
 }
+interface RavenflowClientOptions {
+    redis: ConnectionOptions;
+    mongo: string;
+}
+
+declare function createRavenflowClient<TConfig extends RavenflowConfig>(config: TConfig, options: RavenflowClientOptions): RavenflowClient<TConfig>;
 
-declare function createRavenflowClient<TConfig extends RavenflowConfig>(config: TConfig, options: ConstructorParameters<typeof RavenflowClient>[1]): RavenflowClient<TConfig>;
+interface RavenflowWorker {
+    start(): Promise<void>;
+    close(): Promise<void>;
+}
 
 interface RavenflowWorkerOptions {
     redis: ConnectionOptions;
@@ -331,33 +209,6 @@ interface WithdrawalOptions {
     onWithdraw?: (reason: string) => void | Promise<void>;
 }
 
-declare class RavenflowWorker {
-    private readonly config;
-    private readonly options;
-    private readonly jobs;
-    private readonly logger;
-    private serving;
-    private starting;
-    private closing;
-    constructor(config: RavenflowConfig, options: RavenflowWorkerOptions);
-    start(): Promise<void>;
-    close(): Promise<void>;
-    private serveOrStop;
-    private stopServing;
-    private refuseASecondStart;
-    private openServing;
-    private buildControlPlaneReader;
-    private buildJobResultsRecorder;
-    private buildJobResultsAggregator;
-    private buildSpoolFeeder;
-    private buildMongoWatch;
-    private beginAWithdrawal;
-    private serve;
-    private openRecorder;
-    private sayJobResultsAreNotRecorded;
-    private takeJobs;
-}
-
 declare function createRavenflowWorker(config: RavenflowConfig, options: RavenflowWorkerOptions): RavenflowWorker;
 
-export { type JobDefinition, RavenflowClient, type RavenflowConfig, RavenflowWorker, type RavenflowWorkerOptions, createRavenflowClient, createRavenflowWorker, defineConfig, defineJob };
+export { type ClockFedJob, type JobDefinition, type RavenflowClient, type RavenflowConfig, type RavenflowWorker, type RavenflowWorkerOptions, type SpoolFedJob, createRavenflowClient, createRavenflowWorker, defineConfig, defineJob };

package/dist/index.d.ts

@@ -1,6 +1,5 @@
-import { Job, ConnectionOptions, Queue } from 'bullmq';
+import { Job, ConnectionOptions } from 'bullmq';
 import pino from 'pino';
-import { Db } from 'mongodb';
 
 declare const CONTINUATION: unique symbol;
 interface Continuation<TPayload> {
@@ -133,125 +132,6 @@ interface QueuesRetentionConfig {
 }
 declare function defineConfig<const T extends RavenflowConfig>(config: T): T;
 
-declare class MongoConnection {
-    private readonly uri;
-    private client;
-    private database;
-    private connecting;
-    constructor(uri: string);
-    connect(): Promise<Db>;
-    close(): Promise<void>;
-    private openTheDatabase;
-    private forgetTheAttempt;
-}
-
-type ControlKey = `job:${string}`;
-
-interface ControlPublisher {
-    publish(key: ControlKey): Promise<void>;
-}
-declare class ControlChannel implements ControlPublisher {
-    private readonly connection;
-    private readonly logger;
-    private publisher;
-    private subscriber;
-    constructor(connection: ConnectionOptions, logger: Logger);
-    publish(key: ControlKey): Promise<void>;
-    subscribe(onInvalidate: (key: ControlKey) => void): Promise<void>;
-    close(): Promise<void>;
-    private deliver;
-    private listenOn;
-    private open;
-}
-
-declare const LEVERS: readonly ["executionPaused", "triggerPaused", "ingestPaused"];
-type Lever = (typeof LEVERS)[number];
-type JobControls = Record<Lever, boolean>;
-
-interface ControlReads {
-    read(jobName: string): Promise<JobControls>;
-}
-interface JobControlPlane extends ControlReads {
-    write(jobName: string, patch: Partial<JobControls>): Promise<void>;
-}
-
-interface LeverEntry {
-    key: ControlKey;
-    lever: Lever;
-    value: string;
-}
-interface StoredLever {
-    jobName: string;
-    lever: Lever;
-    value: string;
-}
-declare class ControlHash {
-    private readonly options;
-    private readonly logger;
-    private connection;
-    constructor(options: ConnectionOptions, logger: Logger);
-    readLevers(key: ControlKey): Promise<Map<Lever, string>>;
-    readEveryLever(): Promise<StoredLever[]>;
-    write(entry: LeverEntry): Promise<void>;
-    writeIfAbsent(entry: LeverEntry): Promise<boolean>;
-    close(): Promise<void>;
-    private get redis();
-}
-
-interface MirroredControls extends Partial<JobControls> {
-    _id: string;
-    updatedAt: Date;
-}
-interface ControlMirror {
-    mirrorJobControls(jobName: string, patch: Partial<JobControls>): Promise<void>;
-    listAll(): Promise<MirroredControls[]>;
-}
-
-type LiveControls = Map<string, JobControls>;
-
-interface RehydrationReport {
-    restored: number;
-    alreadyLive: number;
-    truncated: boolean;
-}
-
-interface ControlStoreParts {
-    hash: ControlHash;
-    publisher: ControlPublisher;
-    mirror: ControlMirror;
-    logger: Logger;
-}
-declare class ControlStore implements JobControlPlane {
-    private readonly parts;
-    constructor(parts: ControlStoreParts);
-    read(jobName: string): Promise<JobControls>;
-    write(jobName: string, patch: Partial<JobControls>): Promise<void>;
-    readAll(): Promise<LiveControls>;
-    rehydrate(): Promise<RehydrationReport>;
-    close(): Promise<void>;
-    private isPulled;
-    private writeLevers;
-    private announce;
-    private writeMirror;
-}
-
-declare class ControlPlane implements JobControlPlane {
-    private readonly parts;
-    private readonly cache;
-    constructor(parts: {
-        store: ControlStore;
-        channel: ControlChannel;
-        logger: Logger;
-    });
-    read(jobName: string): Promise<JobControls>;
-    write(jobName: string, patch: Partial<JobControls>): Promise<void>;
-    rehydrate(): Promise<void>;
-    close(): Promise<void>;
-    private closeQuietly;
-}
-
-type QueuesByName = Record<string, Queue>;
-
 interface SpoolPurgeReport {
     dropped: number;
     inFlight: number;
@@ -301,23 +181,21 @@ interface SpoolFedControls extends ExecutionControls, TriggerControls, IngestCon
     purgeBacklog(): Promise<SpoolPurgeReport>;
 }
 
-declare class RavenflowClient<TConfig extends RavenflowConfig = RavenflowConfig> {
+interface RavenflowClient<TConfig extends RavenflowConfig = RavenflowConfig> {
     readonly jobs: JobsProxy<TConfig["jobs"]>;
-    protected readonly redisConnectionOptions: ConnectionOptions;
-    protected readonly mongoUri: string;
-    protected readonly mongo: MongoConnection;
-    protected readonly config: TConfig;
-    protected readonly controlPlane: ControlPlane;
-    protected readonly queues: QueuesByName;
-    protected readonly logger: Logger;
-    constructor(config: TConfig, options: {
-        redis: ConnectionOptions;
-        mongo: string;
-    });
     close(): Promise<void>;
 }
+interface RavenflowClientOptions {
+    redis: ConnectionOptions;
+    mongo: string;
+}
+
+declare function createRavenflowClient<TConfig extends RavenflowConfig>(config: TConfig, options: RavenflowClientOptions): RavenflowClient<TConfig>;
 
-declare function createRavenflowClient<TConfig extends RavenflowConfig>(config: TConfig, options: ConstructorParameters<typeof RavenflowClient>[1]): RavenflowClient<TConfig>;
+interface RavenflowWorker {
+    start(): Promise<void>;
+    close(): Promise<void>;
+}
 
 interface RavenflowWorkerOptions {
     redis: ConnectionOptions;
@@ -331,33 +209,6 @@ interface WithdrawalOptions {
     onWithdraw?: (reason: string) => void | Promise<void>;
 }
 
-declare class RavenflowWorker {
-    private readonly config;
-    private readonly options;
-    private readonly jobs;
-    private readonly logger;
-    private serving;
-    private starting;
-    private closing;
-    constructor(config: RavenflowConfig, options: RavenflowWorkerOptions);
-    start(): Promise<void>;
-    close(): Promise<void>;
-    private serveOrStop;
-    private stopServing;
-    private refuseASecondStart;
-    private openServing;
-    private buildControlPlaneReader;
-    private buildJobResultsRecorder;
-    private buildJobResultsAggregator;
-    private buildSpoolFeeder;
-    private buildMongoWatch;
-    private beginAWithdrawal;
-    private serve;
-    private openRecorder;
-    private sayJobResultsAreNotRecorded;
-    private takeJobs;
-}
-
 declare function createRavenflowWorker(config: RavenflowConfig, options: RavenflowWorkerOptions): RavenflowWorker;
 
-export { type JobDefinition, RavenflowClient, type RavenflowConfig, RavenflowWorker, type RavenflowWorkerOptions, createRavenflowClient, createRavenflowWorker, defineConfig, defineJob };
+export { type ClockFedJob, type JobDefinition, type RavenflowClient, type RavenflowConfig, type RavenflowWorker, type RavenflowWorkerOptions, type SpoolFedJob, createRavenflowClient, createRavenflowWorker, defineConfig, defineJob };