@oatscenter/trellis 0.100.0-rc.1

package/service/runtime/internal_jobs/types.d.ts

@@ -0,0 +1,246 @@
+import { type StaticDecode, Type } from "typebox";
+export declare const JobContextSchema: Type.TObject<{
+    requestId: Type.TString;
+    traceId: Type.TString;
+    traceparent: Type.TString;
+    tracestate: Type.TOptional<Type.TString>;
+}>;
+export type JobContext = StaticDecode<typeof JobContextSchema>;
+export declare const JobTriggerSchema: Type.TObject<{
+    kind: Type.TUnion<[Type.TLiteral<"schedule">, Type.TLiteral<"operation">, Type.TLiteral<"rpc">, Type.TLiteral<"event">, Type.TLiteral<"manualReplay">, Type.TLiteral<"serviceCode">, Type.TLiteral<"parentJob">]>;
+    id: Type.TOptional<Type.TString>;
+    subject: Type.TOptional<Type.TString>;
+    operationId: Type.TOptional<Type.TString>;
+    parentJobId: Type.TOptional<Type.TString>;
+    traceId: Type.TOptional<Type.TString>;
+    requestId: Type.TOptional<Type.TString>;
+}>;
+export type JobTrigger = StaticDecode<typeof JobTriggerSchema>;
+export declare const JobLineageSchema: Type.TObject<{
+    parentJobId: Type.TOptional<Type.TString>;
+    rootJobId: Type.TOptional<Type.TString>;
+    operationId: Type.TOptional<Type.TString>;
+    relatedKeys: Type.TOptional<Type.TArray<Type.TString>>;
+}>;
+export type JobLineage = StaticDecode<typeof JobLineageSchema>;
+export declare const PreparedJobSubmissionSchema: Type.TObject<{
+    submissionId: Type.TString;
+    mode: Type.TUnion<[Type.TLiteral<"create">, Type.TLiteral<"submit">]>;
+    service: Type.TString;
+    queue: Type.TString;
+    jobId: Type.TString;
+    payload: Type.TUnknown;
+    createdAt: Type.TString;
+    context: Type.TObject<{
+        requestId: Type.TString;
+        traceId: Type.TString;
+        traceparent: Type.TString;
+        tracestate: Type.TOptional<Type.TString>;
+    }>;
+    trigger: Type.TOptional<Type.TObject<{
+        kind: Type.TUnion<[Type.TLiteral<"schedule">, Type.TLiteral<"operation">, Type.TLiteral<"rpc">, Type.TLiteral<"event">, Type.TLiteral<"manualReplay">, Type.TLiteral<"serviceCode">, Type.TLiteral<"parentJob">]>;
+        id: Type.TOptional<Type.TString>;
+        subject: Type.TOptional<Type.TString>;
+        operationId: Type.TOptional<Type.TString>;
+        parentJobId: Type.TOptional<Type.TString>;
+        traceId: Type.TOptional<Type.TString>;
+        requestId: Type.TOptional<Type.TString>;
+    }>>;
+    lineage: Type.TOptional<Type.TObject<{
+        parentJobId: Type.TOptional<Type.TString>;
+        rootJobId: Type.TOptional<Type.TString>;
+        operationId: Type.TOptional<Type.TString>;
+        relatedKeys: Type.TOptional<Type.TArray<Type.TString>>;
+    }>>;
+}>;
+export type PreparedJobSubmission<TPayload = unknown> = Omit<StaticDecode<typeof PreparedJobSubmissionSchema>, "payload"> & {
+    payload: TPayload;
+};
+export declare const JobWaitTargetSchema: Type.TObject<{
+    kind: Type.TUnion<[Type.TLiteral<"job">, Type.TLiteral<"operation">, Type.TLiteral<"external">]>;
+    id: Type.TOptional<Type.TString>;
+    operationId: Type.TOptional<Type.TString>;
+    service: Type.TOptional<Type.TString>;
+    system: Type.TOptional<Type.TString>;
+    type: Type.TOptional<Type.TString>;
+    operation: Type.TOptional<Type.TString>;
+    key: Type.TOptional<Type.TString>;
+    label: Type.TOptional<Type.TString>;
+}>;
+export type JobWaitTarget = StaticDecode<typeof JobWaitTargetSchema>;
+export declare const JobWaitEdgeSchema: Type.TObject<{
+    id: Type.TString;
+    target: Type.TObject<{
+        kind: Type.TUnion<[Type.TLiteral<"job">, Type.TLiteral<"operation">, Type.TLiteral<"external">]>;
+        id: Type.TOptional<Type.TString>;
+        operationId: Type.TOptional<Type.TString>;
+        service: Type.TOptional<Type.TString>;
+        system: Type.TOptional<Type.TString>;
+        type: Type.TOptional<Type.TString>;
+        operation: Type.TOptional<Type.TString>;
+        key: Type.TOptional<Type.TString>;
+        label: Type.TOptional<Type.TString>;
+    }>;
+    startedAt: Type.TString;
+    label: Type.TOptional<Type.TString>;
+}>;
+export type JobWaitEdge = StaticDecode<typeof JobWaitEdgeSchema>;
+export declare const JobStateSchema: Type.TUnion<[Type.TLiteral<"pending">, Type.TLiteral<"active">, Type.TLiteral<"retry">, Type.TLiteral<"completed">, Type.TLiteral<"failed">, Type.TLiteral<"cancelled">, Type.TLiteral<"expired">, Type.TLiteral<"skipped">, Type.TLiteral<"stale">, Type.TLiteral<"dead">, Type.TLiteral<"dismissed">]>;
+export type JobState = StaticDecode<typeof JobStateSchema>;
+export declare const JobLogEntrySchema: Type.TObject<{
+    timestamp: Type.TString;
+    level: Type.TUnion<[Type.TLiteral<"info">, Type.TLiteral<"warn">, Type.TLiteral<"error">]>;
+    message: Type.TString;
+}>;
+export type JobLogEntry = StaticDecode<typeof JobLogEntrySchema>;
+export declare const JobProgressSchema: Type.TObject<{
+    step: Type.TOptional<Type.TString>;
+    message: Type.TOptional<Type.TString>;
+    current: Type.TOptional<Type.TInteger>;
+    total: Type.TOptional<Type.TInteger>;
+}>;
+export type JobProgress = StaticDecode<typeof JobProgressSchema>;
+export declare const JobSchema: Type.TObject<{
+    id: Type.TString;
+    service: Type.TString;
+    type: Type.TString;
+    state: Type.TUnion<[Type.TLiteral<"pending">, Type.TLiteral<"active">, Type.TLiteral<"retry">, Type.TLiteral<"completed">, Type.TLiteral<"failed">, Type.TLiteral<"cancelled">, Type.TLiteral<"expired">, Type.TLiteral<"skipped">, Type.TLiteral<"stale">, Type.TLiteral<"dead">, Type.TLiteral<"dismissed">]>;
+    context: Type.TObject<{
+        requestId: Type.TString;
+        traceId: Type.TString;
+        traceparent: Type.TString;
+        tracestate: Type.TOptional<Type.TString>;
+    }>;
+    payload: Type.TUnknown;
+    result: Type.TOptional<Type.TUnknown>;
+    createdAt: Type.TString;
+    updatedAt: Type.TString;
+    startedAt: Type.TOptional<Type.TString>;
+    completedAt: Type.TOptional<Type.TString>;
+    tries: Type.TInteger;
+    maxTries: Type.TInteger;
+    lastError: Type.TOptional<Type.TString>;
+    deadline: Type.TOptional<Type.TString>;
+    progress: Type.TOptional<Type.TObject<{
+        step: Type.TOptional<Type.TString>;
+        message: Type.TOptional<Type.TString>;
+        current: Type.TOptional<Type.TInteger>;
+        total: Type.TOptional<Type.TInteger>;
+    }>>;
+    logs: Type.TOptional<Type.TArray<Type.TObject<{
+        timestamp: Type.TString;
+        level: Type.TUnion<[Type.TLiteral<"info">, Type.TLiteral<"warn">, Type.TLiteral<"error">]>;
+        message: Type.TString;
+    }>>>;
+    trigger: Type.TOptional<Type.TObject<{
+        kind: Type.TUnion<[Type.TLiteral<"schedule">, Type.TLiteral<"operation">, Type.TLiteral<"rpc">, Type.TLiteral<"event">, Type.TLiteral<"manualReplay">, Type.TLiteral<"serviceCode">, Type.TLiteral<"parentJob">]>;
+        id: Type.TOptional<Type.TString>;
+        subject: Type.TOptional<Type.TString>;
+        operationId: Type.TOptional<Type.TString>;
+        parentJobId: Type.TOptional<Type.TString>;
+        traceId: Type.TOptional<Type.TString>;
+        requestId: Type.TOptional<Type.TString>;
+    }>>;
+    lineage: Type.TOptional<Type.TObject<{
+        parentJobId: Type.TOptional<Type.TString>;
+        rootJobId: Type.TOptional<Type.TString>;
+        operationId: Type.TOptional<Type.TString>;
+        relatedKeys: Type.TOptional<Type.TArray<Type.TString>>;
+    }>>;
+    waitingOn: Type.TOptional<Type.TArray<Type.TObject<{
+        id: Type.TString;
+        target: Type.TObject<{
+            kind: Type.TUnion<[Type.TLiteral<"job">, Type.TLiteral<"operation">, Type.TLiteral<"external">]>;
+            id: Type.TOptional<Type.TString>;
+            operationId: Type.TOptional<Type.TString>;
+            service: Type.TOptional<Type.TString>;
+            system: Type.TOptional<Type.TString>;
+            type: Type.TOptional<Type.TString>;
+            operation: Type.TOptional<Type.TString>;
+            key: Type.TOptional<Type.TString>;
+            label: Type.TOptional<Type.TString>;
+        }>;
+        startedAt: Type.TString;
+        label: Type.TOptional<Type.TString>;
+    }>>>;
+}>;
+export type Job<TPayload = unknown, TResult = unknown> = Omit<StaticDecode<typeof JobSchema>, "payload" | "result"> & {
+    payload: TPayload;
+    result?: TResult;
+};
+export declare const JobEventSchema: Type.TObject<{
+    jobId: Type.TString;
+    service: Type.TString;
+    jobType: Type.TString;
+    eventType: Type.TUnion<[Type.TLiteral<"created">, Type.TLiteral<"started">, Type.TLiteral<"retry">, Type.TLiteral<"progress">, Type.TLiteral<"logged">, Type.TLiteral<"completed">, Type.TLiteral<"failed">, Type.TLiteral<"cancelled">, Type.TLiteral<"expired">, Type.TLiteral<"skipped">, Type.TLiteral<"stale">, Type.TLiteral<"heartbeat">, Type.TLiteral<"staleCompletionIgnored">, Type.TLiteral<"retried">, Type.TLiteral<"dead">, Type.TLiteral<"dismissed">, Type.TLiteral<"waiting">, Type.TLiteral<"resumed">]>;
+    state: Type.TUnion<[Type.TLiteral<"pending">, Type.TLiteral<"active">, Type.TLiteral<"retry">, Type.TLiteral<"completed">, Type.TLiteral<"failed">, Type.TLiteral<"cancelled">, Type.TLiteral<"expired">, Type.TLiteral<"skipped">, Type.TLiteral<"stale">, Type.TLiteral<"dead">, Type.TLiteral<"dismissed">]>;
+    previousState: Type.TOptional<Type.TUnion<[Type.TLiteral<"pending">, Type.TLiteral<"active">, Type.TLiteral<"retry">, Type.TLiteral<"completed">, Type.TLiteral<"failed">, Type.TLiteral<"cancelled">, Type.TLiteral<"expired">, Type.TLiteral<"skipped">, Type.TLiteral<"stale">, Type.TLiteral<"dead">, Type.TLiteral<"dismissed">]>>;
+    context: Type.TObject<{
+        requestId: Type.TString;
+        traceId: Type.TString;
+        traceparent: Type.TString;
+        tracestate: Type.TOptional<Type.TString>;
+    }>;
+    tries: Type.TInteger;
+    maxTries: Type.TOptional<Type.TInteger>;
+    error: Type.TOptional<Type.TString>;
+    progress: Type.TOptional<Type.TObject<{
+        step: Type.TOptional<Type.TString>;
+        message: Type.TOptional<Type.TString>;
+        current: Type.TOptional<Type.TInteger>;
+        total: Type.TOptional<Type.TInteger>;
+    }>>;
+    logs: Type.TOptional<Type.TArray<Type.TObject<{
+        timestamp: Type.TString;
+        level: Type.TUnion<[Type.TLiteral<"info">, Type.TLiteral<"warn">, Type.TLiteral<"error">]>;
+        message: Type.TString;
+    }>>>;
+    payload: Type.TOptional<Type.TUnknown>;
+    result: Type.TOptional<Type.TUnknown>;
+    deadline: Type.TOptional<Type.TString>;
+    trigger: Type.TOptional<Type.TObject<{
+        kind: Type.TUnion<[Type.TLiteral<"schedule">, Type.TLiteral<"operation">, Type.TLiteral<"rpc">, Type.TLiteral<"event">, Type.TLiteral<"manualReplay">, Type.TLiteral<"serviceCode">, Type.TLiteral<"parentJob">]>;
+        id: Type.TOptional<Type.TString>;
+        subject: Type.TOptional<Type.TString>;
+        operationId: Type.TOptional<Type.TString>;
+        parentJobId: Type.TOptional<Type.TString>;
+        traceId: Type.TOptional<Type.TString>;
+        requestId: Type.TOptional<Type.TString>;
+    }>>;
+    lineage: Type.TOptional<Type.TObject<{
+        parentJobId: Type.TOptional<Type.TString>;
+        rootJobId: Type.TOptional<Type.TString>;
+        operationId: Type.TOptional<Type.TString>;
+        relatedKeys: Type.TOptional<Type.TArray<Type.TString>>;
+    }>>;
+    waitEdge: Type.TOptional<Type.TObject<{
+        id: Type.TString;
+        target: Type.TObject<{
+            kind: Type.TUnion<[Type.TLiteral<"job">, Type.TLiteral<"operation">, Type.TLiteral<"external">]>;
+            id: Type.TOptional<Type.TString>;
+            operationId: Type.TOptional<Type.TString>;
+            service: Type.TOptional<Type.TString>;
+            system: Type.TOptional<Type.TString>;
+            type: Type.TOptional<Type.TString>;
+            operation: Type.TOptional<Type.TString>;
+            key: Type.TOptional<Type.TString>;
+            label: Type.TOptional<Type.TString>;
+        }>;
+        startedAt: Type.TString;
+        label: Type.TOptional<Type.TString>;
+    }>>;
+    timestamp: Type.TString;
+}>;
+export type JobEvent<TPayload = unknown, TResult = unknown> = Omit<StaticDecode<typeof JobEventSchema>, "payload" | "result"> & {
+    payload?: TPayload;
+    result?: TResult;
+};
+export declare const WorkerHeartbeatSchema: Type.TObject<{
+    service: Type.TString;
+    jobType: Type.TString;
+    instanceId: Type.TString;
+    concurrency: Type.TOptional<Type.TInteger>;
+    version: Type.TOptional<Type.TString>;
+    timestamp: Type.TString;
+}>;
+export type WorkerHeartbeat = StaticDecode<typeof WorkerHeartbeatSchema>;

package/service/runtime/internal_jobs/types.js

@@ -0,0 +1,163 @@
+import { Type } from "typebox";
+export const JobContextSchema = Type.Object({
+    requestId: Type.String({ minLength: 1 }),
+    traceId: Type.String({ pattern: "^[0-9a-f]{32}$" }),
+    traceparent: Type.String({
+        pattern: "^[0-9a-f]{2}-[0-9a-f]{32}-[0-9a-f]{16}-[0-9a-f]{2}$",
+    }),
+    tracestate: Type.Optional(Type.String({ minLength: 1 })),
+});
+export const JobTriggerSchema = Type.Object({
+    kind: Type.Union([
+        Type.Literal("schedule"),
+        Type.Literal("operation"),
+        Type.Literal("rpc"),
+        Type.Literal("event"),
+        Type.Literal("manualReplay"),
+        Type.Literal("serviceCode"),
+        Type.Literal("parentJob"),
+    ]),
+    id: Type.Optional(Type.String({ minLength: 1 })),
+    subject: Type.Optional(Type.String({ minLength: 1 })),
+    operationId: Type.Optional(Type.String({ minLength: 1 })),
+    parentJobId: Type.Optional(Type.String({ minLength: 1 })),
+    traceId: Type.Optional(Type.String({ pattern: "^[0-9a-f]{32}$" })),
+    requestId: Type.Optional(Type.String({ minLength: 1 })),
+});
+export const JobLineageSchema = Type.Object({
+    parentJobId: Type.Optional(Type.String({ minLength: 1 })),
+    rootJobId: Type.Optional(Type.String({ minLength: 1 })),
+    operationId: Type.Optional(Type.String({ minLength: 1 })),
+    relatedKeys: Type.Optional(Type.Array(Type.String({ minLength: 1 }))),
+});
+export const PreparedJobSubmissionSchema = Type.Object({
+    submissionId: Type.String({ minLength: 1 }),
+    mode: Type.Union([Type.Literal("create"), Type.Literal("submit")]),
+    service: Type.String({ minLength: 1 }),
+    queue: Type.String({ minLength: 1 }),
+    jobId: Type.String({ minLength: 1 }),
+    payload: Type.Unknown(),
+    createdAt: Type.String({ format: "date-time" }),
+    context: JobContextSchema,
+    trigger: Type.Optional(JobTriggerSchema),
+    lineage: Type.Optional(JobLineageSchema),
+});
+export const JobWaitTargetSchema = Type.Object({
+    kind: Type.Union([
+        Type.Literal("job"),
+        Type.Literal("operation"),
+        Type.Literal("external"),
+    ]),
+    id: Type.Optional(Type.String({ minLength: 1 })),
+    operationId: Type.Optional(Type.String({ minLength: 1 })),
+    service: Type.Optional(Type.String({ minLength: 1 })),
+    system: Type.Optional(Type.String({ minLength: 1 })),
+    type: Type.Optional(Type.String({ minLength: 1 })),
+    operation: Type.Optional(Type.String({ minLength: 1 })),
+    key: Type.Optional(Type.String({ minLength: 1 })),
+    label: Type.Optional(Type.String({ minLength: 1 })),
+});
+export const JobWaitEdgeSchema = Type.Object({
+    id: Type.String({ minLength: 1 }),
+    target: JobWaitTargetSchema,
+    startedAt: Type.String({ format: "date-time" }),
+    label: Type.Optional(Type.String({ minLength: 1 })),
+});
+export const JobStateSchema = Type.Union([
+    Type.Literal("pending"),
+    Type.Literal("active"),
+    Type.Literal("retry"),
+    Type.Literal("completed"),
+    Type.Literal("failed"),
+    Type.Literal("cancelled"),
+    Type.Literal("expired"),
+    Type.Literal("skipped"),
+    Type.Literal("stale"),
+    Type.Literal("dead"),
+    Type.Literal("dismissed"),
+]);
+export const JobLogEntrySchema = Type.Object({
+    timestamp: Type.String({ format: "date-time" }),
+    level: Type.Union([
+        Type.Literal("info"),
+        Type.Literal("warn"),
+        Type.Literal("error"),
+    ]),
+    message: Type.String(),
+});
+export const JobProgressSchema = Type.Object({
+    step: Type.Optional(Type.String()),
+    message: Type.Optional(Type.String()),
+    current: Type.Optional(Type.Integer({ minimum: 0 })),
+    total: Type.Optional(Type.Integer({ minimum: 0 })),
+});
+export const JobSchema = Type.Object({
+    id: Type.String({ minLength: 1 }),
+    service: Type.String({ minLength: 1 }),
+    type: Type.String({ minLength: 1 }),
+    state: JobStateSchema,
+    context: JobContextSchema,
+    payload: Type.Unknown(),
+    result: Type.Optional(Type.Unknown()),
+    createdAt: Type.String({ format: "date-time" }),
+    updatedAt: Type.String({ format: "date-time" }),
+    startedAt: Type.Optional(Type.String({ format: "date-time" })),
+    completedAt: Type.Optional(Type.String({ format: "date-time" })),
+    tries: Type.Integer({ minimum: 0 }),
+    maxTries: Type.Integer({ minimum: 1 }),
+    lastError: Type.Optional(Type.String()),
+    deadline: Type.Optional(Type.String({ format: "date-time" })),
+    progress: Type.Optional(JobProgressSchema),
+    logs: Type.Optional(Type.Array(JobLogEntrySchema)),
+    trigger: Type.Optional(JobTriggerSchema),
+    lineage: Type.Optional(JobLineageSchema),
+    waitingOn: Type.Optional(Type.Array(JobWaitEdgeSchema)),
+});
+export const JobEventSchema = Type.Object({
+    jobId: Type.String({ minLength: 1 }),
+    service: Type.String({ minLength: 1 }),
+    jobType: Type.String({ minLength: 1 }),
+    eventType: Type.Union([
+        Type.Literal("created"),
+        Type.Literal("started"),
+        Type.Literal("retry"),
+        Type.Literal("progress"),
+        Type.Literal("logged"),
+        Type.Literal("completed"),
+        Type.Literal("failed"),
+        Type.Literal("cancelled"),
+        Type.Literal("expired"),
+        Type.Literal("skipped"),
+        Type.Literal("stale"),
+        Type.Literal("heartbeat"),
+        Type.Literal("staleCompletionIgnored"),
+        Type.Literal("retried"),
+        Type.Literal("dead"),
+        Type.Literal("dismissed"),
+        Type.Literal("waiting"),
+        Type.Literal("resumed"),
+    ]),
+    state: JobStateSchema,
+    previousState: Type.Optional(JobStateSchema),
+    context: JobContextSchema,
+    tries: Type.Integer({ minimum: 0 }),
+    maxTries: Type.Optional(Type.Integer({ minimum: 1 })),
+    error: Type.Optional(Type.String()),
+    progress: Type.Optional(JobProgressSchema),
+    logs: Type.Optional(Type.Array(JobLogEntrySchema)),
+    payload: Type.Optional(Type.Unknown()),
+    result: Type.Optional(Type.Unknown()),
+    deadline: Type.Optional(Type.String({ format: "date-time" })),
+    trigger: Type.Optional(JobTriggerSchema),
+    lineage: Type.Optional(JobLineageSchema),
+    waitEdge: Type.Optional(JobWaitEdgeSchema),
+    timestamp: Type.String({ format: "date-time" }),
+});
+export const WorkerHeartbeatSchema = Type.Object({
+    service: Type.String({ minLength: 1 }),
+    jobType: Type.String({ minLength: 1 }),
+    instanceId: Type.String({ minLength: 1 }),
+    concurrency: Type.Optional(Type.Integer({ minimum: 1 })),
+    version: Type.Optional(Type.String({ minLength: 1 })),
+    timestamp: Type.String({ format: "date-time" }),
+});

package/service/runtime/logger.d.ts

@@ -0,0 +1,2 @@
+import type { LoggerLike } from "../../globals.ts";
+export declare const serviceRuntimeLogger: LoggerLike;

package/service/runtime/logger.js

@@ -0,0 +1,7 @@
+import { pino } from "pino";
+import { getEnv } from "../../env.js";
+const level = getEnv("PINO_LEVEL") || "info";
+export const serviceRuntimeLogger = pino({
+    level,
+    base: { library: "@oatscenter/trellis" },
+});

package/service/runtime/runtime.d.ts

@@ -0,0 +1,16 @@
+import type { NatsConnection } from "@nats-io/nats-core";
+export type NatsConnectOpts = {
+    servers: string | string[];
+    token?: string;
+    inboxPrefix?: string;
+    authenticator?: unknown;
+    maxReconnectAttempts?: number;
+    waitOnFirstConnect?: boolean;
+} & Record<string, unknown>;
+export type NatsConnectFn = (opts: NatsConnectOpts) => Promise<NatsConnection>;
+/** Initializes telemetry for a service runtime. */
+export type InitTelemetryFn = (serviceName: string) => void;
+export type TrellisServiceRuntimeDeps = {
+    connect: NatsConnectFn;
+    initTelemetry?: InitTelemetryFn;
+};

package/service/runtime/runtime.js

@@ -0,0 +1 @@
+export {};