@ontrails/core 0.2.0

package/src/schedule.ts

@@ -0,0 +1,326 @@
+import { ValidationError } from './errors.js';
+import type {
+  ActivationSource,
+  ActivationSourceMeta,
+} from './activation-source.js';
+
+type ScheduleInputDefault = Record<string, never>;
+
+export interface ScheduleSpec<TInput = unknown> {
+  readonly cron: string;
+  readonly input?: TInput | undefined;
+  readonly meta?: ActivationSourceMeta | undefined;
+  readonly timezone?: string | undefined;
+  /** Reserved for future schedule-specific design; trail versioning is trail-only. */
+  readonly version?: never;
+}
+
+export interface ScheduleSource<TInput = unknown> extends ActivationSource {
+  readonly cron: string;
+  readonly input: TInput;
+  readonly kind: 'schedule';
+  readonly meta?: ActivationSourceMeta | undefined;
+  readonly timezone?: string | undefined;
+}
+
+export interface ScheduleValidationIssue {
+  readonly field: 'cron' | 'input' | 'timezone';
+  readonly message: string;
+}
+
+const CRON_FIELD_BOUNDS = Object.freeze([
+  { max: 59, min: 0, name: 'minute' },
+  { max: 23, min: 0, name: 'hour' },
+  { max: 31, min: 1, name: 'day of month' },
+  { max: 12, min: 1, name: 'month' },
+  { max: 7, min: 0, name: 'day of week' },
+] as const);
+
+const EMPTY_INPUT = Object.freeze({}) as ScheduleInputDefault;
+
+const normalizeCron = (cron: string): string =>
+  cron.trim().replaceAll(/\s+/g, ' ');
+
+const isIntegerToken = (value: string): boolean => /^\d+$/.test(value);
+
+const parseIntegerToken = (value: string): number | undefined =>
+  isIntegerToken(value) ? Number.parseInt(value, 10) : undefined;
+
+const isNumberInRange = (
+  value: string,
+  bounds: (typeof CRON_FIELD_BOUNDS)[number]
+): boolean => {
+  const parsed = parseIntegerToken(value);
+  return parsed !== undefined && parsed >= bounds.min && parsed <= bounds.max;
+};
+
+const isCronAtomValid = (
+  atom: string,
+  bounds: (typeof CRON_FIELD_BOUNDS)[number]
+): boolean => {
+  if (atom === '*') {
+    return true;
+  }
+  if (isNumberInRange(atom, bounds)) {
+    return true;
+  }
+
+  const range = atom.split('-');
+  if (range.length !== 2) {
+    return false;
+  }
+  const [rangeStart, rangeEnd] = range;
+  if (rangeStart === undefined || rangeEnd === undefined) {
+    return false;
+  }
+  if (
+    !isNumberInRange(rangeStart, bounds) ||
+    !isNumberInRange(rangeEnd, bounds)
+  ) {
+    return false;
+  }
+  const start = Number.parseInt(rangeStart, 10);
+  const end = Number.parseInt(rangeEnd, 10);
+  return start <= end;
+};
+
+const isCronPartValid = (
+  part: string,
+  bounds: (typeof CRON_FIELD_BOUNDS)[number]
+): boolean => {
+  const stepped = part.split('/');
+  if (stepped.length > 2) {
+    return false;
+  }
+  const [atom, step] = stepped;
+  if (!atom || !isCronAtomValid(atom, bounds)) {
+    return false;
+  }
+  if (step === undefined) {
+    return true;
+  }
+  const parsedStep = parseIntegerToken(step);
+  return parsedStep !== undefined && parsedStep > 0;
+};
+
+const validateCronField = (
+  field: string,
+  bounds: (typeof CRON_FIELD_BOUNDS)[number]
+): string | undefined => {
+  if (field.length === 0) {
+    return `${bounds.name} field is empty`;
+  }
+  const parts = field.split(',');
+  return parts.every((part) => isCronPartValid(part, bounds))
+    ? undefined
+    : `${bounds.name} field is not a supported cron expression`;
+};
+
+const validateCron = (cron: unknown): ScheduleValidationIssue[] => {
+  if (typeof cron !== 'string' || cron.trim().length === 0) {
+    return [
+      { field: 'cron', message: 'Cron expression must be a non-empty string' },
+    ];
+  }
+
+  const normalized = normalizeCron(cron);
+  const fields = normalized.split(' ');
+  if (fields.length !== CRON_FIELD_BOUNDS.length) {
+    return [
+      {
+        field: 'cron',
+        message: 'Cron expression must contain exactly five fields',
+      },
+    ];
+  }
+
+  return fields.flatMap((field, index) => {
+    const bounds = CRON_FIELD_BOUNDS[index];
+    if (!bounds) {
+      return [];
+    }
+    const issue = validateCronField(field, bounds);
+    return issue === undefined
+      ? []
+      : [{ field: 'cron' as const, message: issue }];
+  });
+};
+
+const isTimezoneValid = (timezone: string): boolean => {
+  try {
+    new Intl.DateTimeFormat('en-US', { timeZone: timezone }).format();
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+const validateTimezone = (
+  timezone: unknown
+): readonly ScheduleValidationIssue[] => {
+  if (timezone === undefined) {
+    return [];
+  }
+  if (typeof timezone !== 'string' || timezone.trim().length === 0) {
+    return [
+      {
+        field: 'timezone',
+        message: 'Timezone must be a non-empty IANA timezone string',
+      },
+    ];
+  }
+  return isTimezoneValid(timezone.trim())
+    ? []
+    : [
+        {
+          field: 'timezone',
+          message: `Timezone "${timezone}" is not supported by Intl.DateTimeFormat`,
+        },
+      ];
+};
+
+const isNonJsonLeaf = (value: unknown): boolean => {
+  if (value === undefined) {
+    return true;
+  }
+  const kind = typeof value;
+  if (kind === 'function' || kind === 'symbol' || kind === 'bigint') {
+    return true;
+  }
+  return (
+    value instanceof Date ||
+    value instanceof RegExp ||
+    value instanceof Map ||
+    value instanceof Set
+  );
+};
+
+const containsNonSerializableLeaf = (
+  value: unknown,
+  seen: WeakSet<object>
+): boolean => {
+  if (isNonJsonLeaf(value)) {
+    return true;
+  }
+  if (value === null || typeof value !== 'object') {
+    return false;
+  }
+  if (seen.has(value)) {
+    return true;
+  }
+  seen.add(value);
+  if (Array.isArray(value)) {
+    return value.some((entry) => containsNonSerializableLeaf(entry, seen));
+  }
+  return Object.values(value).some((entry) =>
+    containsNonSerializableLeaf(entry, seen)
+  );
+};
+
+const validateInput = (input: unknown): readonly ScheduleValidationIssue[] => {
+  if (containsNonSerializableLeaf(input, new WeakSet<object>())) {
+    return [
+      {
+        field: 'input',
+        message: 'Schedule input must be JSON-serializable data',
+      },
+    ];
+  }
+  try {
+    JSON.stringify(input);
+    return [];
+  } catch {
+    return [
+      {
+        field: 'input',
+        message: 'Schedule input must be JSON-serializable data',
+      },
+    ];
+  }
+};
+
+const scheduleIssuesMessage = (
+  id: string,
+  issues: readonly ScheduleValidationIssue[]
+): string =>
+  `schedule("${id}") is invalid: ${issues.map((issue) => `${issue.field}: ${issue.message}`).join('; ')}`;
+
+const assertScheduleSpec = (
+  id: string,
+  spec: ScheduleSpec
+): {
+  readonly cron: string;
+  readonly input: unknown;
+  readonly timezone?: string | undefined;
+} => {
+  const input = spec.input === undefined ? EMPTY_INPUT : spec.input;
+  const timezone = spec.timezone?.trim();
+  const issues = [
+    ...validateCron(spec.cron),
+    ...validateTimezone(timezone),
+    ...validateInput(input),
+  ];
+
+  if (issues.length > 0) {
+    throw new ValidationError(scheduleIssuesMessage(id, issues), {
+      context: { issues },
+    });
+  }
+
+  return {
+    cron: normalizeCron(spec.cron),
+    input,
+    ...(timezone === undefined ? {} : { timezone }),
+  };
+};
+
+export const validateScheduleSource = (
+  source: ActivationSource
+): readonly ScheduleValidationIssue[] => {
+  if (source.kind !== 'schedule') {
+    return [];
+  }
+  const input = Object.hasOwn(source, 'input') ? source.input : EMPTY_INPUT;
+  return [
+    ...validateCron(source.cron),
+    ...validateTimezone(source.timezone),
+    ...validateInput(input),
+  ];
+};
+
+export function schedule<TInput>(
+  id: string,
+  spec: ScheduleSpec<TInput> & { readonly input: TInput }
+): ScheduleSource<TInput>;
+export function schedule(
+  id: string,
+  spec: ScheduleSpec
+): ScheduleSource<ScheduleInputDefault>;
+export function schedule<TInput>(
+  spec: ScheduleSpec<TInput> & { readonly id: string; readonly input: TInput }
+): ScheduleSource<TInput>;
+export function schedule(
+  spec: ScheduleSpec & { readonly id: string }
+): ScheduleSource<ScheduleInputDefault>;
+export function schedule<TInput>(
+  idOrSpec: string | (ScheduleSpec<TInput> & { readonly id: string }),
+  maybeSpec?: ScheduleSpec<TInput>
+): ScheduleSource<TInput | ScheduleInputDefault> {
+  const id = typeof idOrSpec === 'string' ? idOrSpec : idOrSpec.id;
+  // oxlint-disable-next-line no-non-null-assertion -- overload guarantees maybeSpec when idOrSpec is string
+  const spec = typeof idOrSpec === 'string' ? maybeSpec! : idOrSpec;
+  const normalized = assertScheduleSpec(id, spec);
+
+  return Object.freeze({
+    cron: normalized.cron,
+    id,
+    input: normalized.input as TInput | ScheduleInputDefault,
+    kind: 'schedule' as const,
+    ...(spec.meta === undefined
+      ? {}
+      : { meta: Object.freeze({ ...spec.meta }) }),
+    ...(normalized.timezone === undefined
+      ? {}
+      : { timezone: normalized.timezone }),
+  });
+}

package/src/serialization.ts

@@ -0,0 +1,265 @@
+/**
+ * Serialization utilities for @ontrails/core
+ *
+ * Safe JSON parsing/stringifying and error serialization/deserialization
+ * for transport across process boundaries.
+ */
+
+import type { ErrorCategory, TrailsError } from './errors.js';
+import {
+  AuthError,
+  CancelledError,
+  ConflictError,
+  ValidationError,
+  InternalError,
+  NetworkError,
+  NotFoundError,
+  PermissionError,
+  RateLimitError,
+  RetryExhaustedError,
+  TimeoutError,
+  WorkspaceShiftError,
+  errorClasses,
+  isTrailsError,
+} from './errors.js';
+import {
+  redactErrorContext,
+  redactErrorStack,
+  redactErrorString,
+} from './error-rendering.js';
+import { Result } from './result.js';
+
+// ---------------------------------------------------------------------------
+// SerializedError interface
+// ---------------------------------------------------------------------------
+
+export interface SerializedError {
+  readonly name: string;
+  readonly message: string;
+  readonly attempts?: number | undefined;
+  readonly category?: ErrorCategory | undefined;
+  readonly cause?: SerializedError | undefined;
+  readonly detour?: string | undefined;
+  readonly retryable?: boolean | undefined;
+  readonly retryAfter?: number | undefined;
+  readonly context?: Record<string, unknown> | undefined;
+  readonly stack?: string | undefined;
+}
+
+// ---------------------------------------------------------------------------
+// Internal helpers (defined before usage)
+// ---------------------------------------------------------------------------
+
+/** Build options object without including undefined context. */
+const buildOpts = (
+  context: Record<string, unknown> | undefined
+): {
+  context?: Record<string, unknown>;
+} => {
+  if (context !== undefined) {
+    return { context };
+  }
+  return {};
+};
+
+type ErrorFactory = (
+  message: string,
+  opts: { cause?: Error; context?: Record<string, unknown> },
+  retryAfter: number | undefined
+) => TrailsError;
+
+type FixedErrorConstructor = new (
+  message: string,
+  options?: { cause?: Error; context?: Record<string, unknown> }
+) => TrailsError;
+
+const errorFactories: Record<ErrorCategory, ErrorFactory> = {
+  auth: (msg, opts) => new AuthError(msg, opts),
+  cancelled: (msg, opts) => new CancelledError(msg, opts),
+  conflict: (msg, opts) => new ConflictError(msg, opts),
+  internal: (msg, opts) => new InternalError(msg, opts),
+  network: (msg, opts) => new NetworkError(msg, opts),
+  not_found: (msg, opts) => new NotFoundError(msg, opts),
+  permission: (msg, opts) => new PermissionError(msg, opts),
+  rate_limit: (msg, opts, retryAfter) => {
+    const rlOpts: { context?: Record<string, unknown>; retryAfter?: number } = {
+      ...opts,
+    };
+    if (retryAfter !== undefined) {
+      rlOpts.retryAfter = retryAfter;
+    }
+    return new RateLimitError(msg, rlOpts);
+  },
+  shift: (msg, opts) => new WorkspaceShiftError(msg, opts),
+  timeout: (msg, opts) => new TimeoutError(msg, opts),
+  validation: (msg, opts) => new ValidationError(msg, opts),
+};
+
+const createErrorByCategory = (
+  category: ErrorCategory,
+  message: string,
+  context: Record<string, unknown> | undefined,
+  retryAfter: number | undefined
+): TrailsError => {
+  const opts = buildOpts(context);
+  const factory = errorFactories[category] ?? errorFactories.internal;
+  return factory(message, opts, retryAfter);
+};
+
+/** Map fixed error class names to constructors for precise round-tripping. */
+const errorConstructorsByName: Readonly<Record<string, ErrorFactory>> =
+  Object.fromEntries(
+    errorClasses.flatMap((entry): [string, ErrorFactory][] => {
+      if (entry.category === 'dynamic') {
+        return [];
+      }
+      const ctor = entry.ctor as FixedErrorConstructor;
+      return [
+        [
+          entry.name,
+          (message, opts, retryAfter) => {
+            if (ctor === RateLimitError) {
+              const rateLimitOptions:
+                | {
+                    cause?: Error;
+                    context?: Record<string, unknown>;
+                    retryAfter?: number;
+                  }
+                | undefined =
+                opts.context === undefined &&
+                opts.cause === undefined &&
+                retryAfter === undefined
+                  ? undefined
+                  : {
+                      ...opts,
+                      ...(retryAfter === undefined ? {} : { retryAfter }),
+                    };
+              return new RateLimitError(message, rateLimitOptions);
+            }
+            return new ctor(message, opts);
+          },
+        ],
+      ];
+    })
+  );
+
+// ---------------------------------------------------------------------------
+// Error serialization
+// ---------------------------------------------------------------------------
+
+/** Extract structured data from an Error for transport. */
+export const serializeError = (error: Error): SerializedError => {
+  const result: SerializedError = {
+    message: redactErrorString(error.message),
+    name: error.name,
+    stack: redactErrorStack(error.stack),
+  };
+
+  if (isTrailsError(error)) {
+    return {
+      ...result,
+      category: error.category,
+      context: redactErrorContext(error.context),
+      ...(error instanceof RetryExhaustedError
+        ? {
+            attempts: error.attempts,
+            cause: serializeError(error.cause),
+            detour: error.detour,
+          }
+        : {}),
+      retryAfter:
+        error instanceof RateLimitError ? error.retryAfter : undefined,
+      retryable: error.retryable,
+    };
+  }
+
+  return result;
+};
+
+/** Reconstruct a TrailsError from serialized data. */
+export const deserializeError = (data: SerializedError): TrailsError => {
+  const opts = buildOpts(data.context);
+  if (data.name === 'RetryExhaustedError') {
+    const wrapped =
+      data.cause === undefined
+        ? createErrorByCategory(
+            data.category ?? 'internal',
+            data.message,
+            data.context,
+            data.retryAfter
+          )
+        : deserializeError(data.cause);
+    const error = new RetryExhaustedError(wrapped, {
+      attempts: data.attempts ?? 0,
+      detour: data.detour ?? 'unknown',
+    });
+    if (data.message !== error.message) {
+      error.message = data.message;
+    }
+    if (data.stack) {
+      error.stack = data.stack;
+    }
+    return error;
+  }
+  const nameFactory = errorConstructorsByName[data.name];
+
+  const error = nameFactory
+    ? nameFactory(data.message, opts, data.retryAfter)
+    : createErrorByCategory(
+        data.category ?? 'internal',
+        data.message,
+        data.context,
+        data.retryAfter
+      );
+
+  if (data.stack) {
+    error.stack = data.stack;
+  }
+
+  return error;
+};
+
+/** Stringify a value, returning a Result. Handles circular references. */
+export const safeStringify = (
+  value: unknown
+): Result<string, InternalError> => {
+  try {
+    // Track the current ancestor chain, not every object ever visited.
+    // This allows shared references in a DAG while still detecting cycles.
+    const stack: unknown[] = [];
+    const keys: string[] = [];
+
+    const json = JSON.stringify(value, function json(key, val: unknown) {
+      if (stack.length > 0) {
+        // `this` is the object that contains `key`. Trim the stack back
+        // to `this` so we only track the current ancestor path.
+        const thisIndex = stack.lastIndexOf(this as unknown);
+        stack.splice(thisIndex + 1);
+        keys.splice(thisIndex);
+      }
+
+      if (typeof val === 'object' && val !== null) {
+        if (stack.includes(val)) {
+          return '[Circular]';
+        }
+        stack.push(val);
+        keys.push(key);
+      }
+      return val;
+    });
+    if (json === undefined) {
+      return Result.err(
+        new InternalError('Value is not JSON-serializable', {
+          context: { type: typeof value },
+        })
+      );
+    }
+    return Result.ok(json);
+  } catch (error) {
+    return Result.err(
+      new InternalError('Failed to stringify value', {
+        cause: error instanceof Error ? error : new Error(String(error)),
+      })
+    );
+  }
+};