@colony2/jobdb 0.0.1 → 0.0.7

package/LICENSE

@@ -0,0 +1,184 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form,
+made available under the License, as indicated by a copyright notice that is
+included in or attached to the work (an example is provided in the Appendix
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original
+version of the Work and any modifications or additions to that Work or
+Derivative Works thereof, that is intentionally submitted to Licensor for
+inclusion in the Work by the copyright owner or by an individual or Legal Entity
+authorized to submit on behalf of the copyright owner. For the purposes of this
+definition, "submitted" means any form of electronic, verbal, or written
+communication sent to the Licensor or its representatives, including but not
+limited to communication on electronic mailing lists, source code control
+systems, and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but excluding
+communication that is conspicuously marked or otherwise designated in writing by
+the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this
+License, each Contributor hereby grants to You a perpetual, worldwide,
+non-exclusive, no-charge, royalty-free, irrevocable copyright license to
+reproduce, prepare Derivative Works of, publicly display, publicly perform,
+sublicense, and distribute the Work and such Derivative Works in Source or
+Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License,
+each Contributor hereby grants to You a perpetual, worldwide, non-exclusive,
+no-charge, royalty-free, irrevocable (except as stated in this section) patent
+license to make, have made, use, offer to sell, sell, import, and otherwise
+transfer the Work, where such license applies only to those patent claims
+licensable by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s) with the Work to
+which such Contribution(s) was submitted. If You institute patent litigation
+against any entity (including a cross-claim or counterclaim in a lawsuit)
+alleging that the Work or a Contribution incorporated within the Work
+constitutes direct or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate as of the date
+such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or
+Derivative Works thereof in any medium, with or without modifications, and in
+Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that
+You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You
+distribute, all copyright, patent, trademark, and attribution notices from the
+Source form of the Work, excluding those notices that do not pertain to any part
+of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then
+any Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any
+Contribution intentionally submitted for inclusion in the Work by You to the
+Licensor shall be under the terms and conditions of this License, without any
+additional terms or conditions. Notwithstanding the above, nothing herein shall
+supersede or modify the terms of any separate license agreement you may have
+executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names,
+trademarks, service marks, or product names of the Licensor, except as required
+for reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in
+writing, Licensor provides the Work (and each Contributor provides its
+Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied, including, without limitation, any warranties or
+conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any risks
+associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in
+tort (including negligence), contract, or otherwise, unless required by
+applicable law (such as deliberate and grossly negligent acts) or agreed to in
+writing, shall any Contributor be liable to You for damages, including any
+direct, indirect, special, incidental, or consequential damages of any character
+arising as a result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill, work stoppage,
+computer failure or malfunction, or any and all other commercial damages or
+losses), even if such Contributor has been advised of the possibility of such
+damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or
+Derivative Works thereof, You may choose to offer, and charge a fee for,
+acceptance of support, warranty, indemnity, or other liability obligations
+and/or rights consistent with this License. However, in accepting such
+obligations, You may act only on Your own behalf and on Your sole
+responsibility, not on behalf of any other Contributor, and only if You agree to
+indemnify, defend, and hold each Contributor harmless for any liability incurred
+by, or claims asserted against, such Contributor by reason of your accepting any
+such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate
+notice, with the fields enclosed by brackets "[]" replaced with your own
+identifying information. (Don't include the brackets!) The text should be
+enclosed in the appropriate comment syntax for the file format. We also
+recommend that a file or class name and description of purpose be included on
+the same "printed page" as the copyright notice for easier identification within
+third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,721 @@
+# jobdb
+
+A durable workflow library for Go that provides reliable, long-running workflow orchestration with built-in retry logic, timeout handling, and persistent state management.
+
+## What is jobdb?
+
+jobdb is a workflow orchestration library that helps you build reliable, distributed workflows. It handles the complexity of managing workflow state, retries, timeouts, and task coordination so you can focus on your business logic.
+
+**Key Features:**
+- **Durable Workflows**: Workflow state persists across failures and restarts
+- **Task Orchestration**: Break workflows into reusable task units
+- **Automatic Retries**: Configurable retry policies with exponential backoff
+- **Timeout Management**: Set invocation and total timeout limits
+- **Async Child Workflows**: Spawn and await child workflows
+- **Artifact Support**: Handle large files and binary data efficiently
+- **Multi-Tenant**: Built-in tenant isolation
+- **Job Querying**: List and filter jobs with flexible criteria
+- **Schedules**: First-class recurring jobs with pause/resume/archive support
+- **Embedded SQLite Runtime**: Durable local execution without external services
+- **Remote Runtime Protocol**: REST runtime adapter with tokenized lease operations
+
+## Installation
+
+```bash
+go get github.com/colony-2/jobdb
+```
+
+## Local Runtime CLI
+
+The repo includes a Cobra-based local runtime server at `cmd/jobdb`.
+
+Run the default SQLite-backed embedded runtime:
+
+```bash
+go run ./cmd/jobdb --listen 127.0.0.1:9047 --db jobdb.db
+```
+
+The SQLite runtime stores jobs, chapters, artifacts, leases, and schedules in a
+local SQLite database plus a blob directory.
+
+Run the in-memory toy runtime explicitly:
+
+```bash
+go run ./cmd/jobdb toy --listen 127.0.0.1:9047
+```
+
+For Go module migration details, including moving embedded direct-runtime users
+to SQLite, see
+[`docs/MIGRATION-SQLITE-EMBEDDED-RUNTIME.md`](docs/MIGRATION-SQLITE-EMBEDDED-RUNTIME.md).
+
+## Quick Start
+
+Here's a simple workflow that processes data through multiple tasks:
+
+```go
+package main
+
+import (
+    "context"
+    "log"
+
+    "github.com/colony-2/jobdb/pkg/jobdb"
+    toyruntime "github.com/colony-2/jobdb/pkg/jobdb/runtime/toy"
+)
+
+// Define a job worker (orchestrates tasks)
+type DataProcessingJob struct{}
+
+func (j DataProcessingJob) Name() string { return "data_processing" }
+
+func (j DataProcessingJob) Run(ctx jobdb.JobContext, input jobdb.JobData) (jobdb.JobData, error) {
+    // Execute tasks in sequence
+    result, err := ctx.DoTask(jobdb.DefaultRunPolicy(), "validate", input)
+    if err != nil {
+        return nil, err
+    }
+
+    result, err = ctx.DoTask(jobdb.DefaultRunPolicy(), "transform", result)
+    if err != nil {
+        return nil, err
+    }
+
+    return result, nil
+}
+
+// Define task workers
+type ValidateTask struct{}
+
+func (t ValidateTask) Name() string { return "validate" }
+
+func (t ValidateTask) Run(ctx jobdb.TaskContext, input jobdb.TaskData) (jobdb.TaskData, error) {
+    // Your validation logic here
+    return input, nil
+}
+
+type TransformTask struct{}
+
+func (t TransformTask) Name() string { return "transform" }
+
+func (t TransformTask) Run(ctx jobdb.TaskContext, input jobdb.TaskData) (jobdb.TaskData, error) {
+    // Your transformation logic here
+    return input, nil
+}
+
+func main() {
+    ctx := context.Background()
+    runtime := toyruntime.New()
+
+    // Build the engine
+    engine, err := jobdb.NewEngineBuilder().
+        WithRuntime(runtime).
+        WithWorkerTenantId("my-tenant").
+        PlusWorkers(DataProcessingJob{}, ValidateTask{}, TransformTask{}).
+        BuildEngine()
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    // Start the engine worker loop
+    go engine.Run(ctx)
+
+    // Start a job
+    input := jobdb.NewTaskDataOrPanic(map[string]interface{}{"value": 42})
+    jobKey, err := engine.SubmitJob(ctx, jobdb.SubmitJob{
+        TenantId: "my-tenant",
+        JobType:  "data_processing",
+        Data:     input,
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
+    log.Printf("Started job: %s", jobKey)
+}
+```
+
+## Core Concepts
+
+### Jobs vs Tasks
+
+- **Jobs** are the top-level workflows that orchestrate tasks. A job worker defines the workflow logic.
+- **Tasks** are individual units of work within a job. Task workers implement specific operations.
+
+Jobs use `JobContext` to execute tasks, wait, and spawn child workflows. Tasks receive `TaskContext` for execution context.
+
+### JobWorker Interface
+
+```go
+type JobWorker interface {
+    Name() string
+    Run(JobContext, JobData) (JobData, error)
+}
+```
+
+Your job worker orchestrates the workflow:
+
+```go
+func (j MyJob) Run(ctx jobdb.JobContext, input jobdb.JobData) (jobdb.JobData, error) {
+    // Execute tasks
+    result, err := ctx.DoTask(policy, "task-name", taskInput)
+    if err != nil {
+        return nil, err
+    }
+
+    // Wait/sleep
+    if err := ctx.AwaitDuration(jobdb.Duration(5 * time.Minute)); err != nil {
+        return nil, err
+    }
+
+    // Wait for another job in the same tenant
+    if err := ctx.AwaitJobs(childJobID); err != nil {
+        return nil, err
+    }
+
+    return result, nil
+}
+```
+
+### TaskWorker Interface
+
+```go
+type TaskWorker interface {
+    Name() string
+    Run(TaskContext, TaskData) (TaskData, error)
+}
+```
+
+Your task worker implements a specific operation:
+
+```go
+func (t MyTask) Run(ctx jobdb.TaskContext, input jobdb.TaskData) (jobdb.TaskData, error) {
+    // Access job context
+    ctx.Logger.Info("processing task", "job", ctx.JobKey, "step", ctx.Step)
+
+    // Wait if needed
+    ctx.AwaitDuration(jobdb.Duration(30 * time.Second))
+
+    // Return result
+    return jobdb.NewTaskData(result)
+}
+```
+
+## Working with Data
+
+### Creating TaskData
+
+```go
+// From a struct or map
+data, err := jobdb.NewTaskData(map[string]interface{}{
+    "userId": 123,
+    "action": "process",
+})
+
+// Panic version for tests/simple cases
+data := jobdb.NewTaskDataOrPanic(myStruct)
+
+// With artifacts
+data, err := jobdb.NewTaskData(payload, artifact1, artifact2)
+```
+
+### Reading TaskData
+
+```go
+func (t MyTask) Run(ctx jobdb.TaskContext, input jobdb.TaskData) (jobdb.TaskData, error) {
+    // Get raw JSON data
+    rawData, err := input.GetData()
+    if err != nil {
+        return nil, err
+    }
+
+    // Unmarshal into your struct
+    var payload MyPayload
+    if err := json.Unmarshal(rawData, &payload); err != nil {
+        return nil, err
+    }
+
+    // Access artifacts
+    artifacts, err := input.GetArtifacts()
+    if err != nil {
+        return nil, err
+    }
+
+    return jobdb.NewTaskData(result)
+}
+```
+
+## Working with Artifacts
+
+Artifacts represent file-like data that flows through workflows. They support lazy loading and automatic cleanup.
+
+### Creating Artifacts
+
+```go
+// From bytes (in-memory)
+artifact := jobdb.NewArtifactFromBytes("config.json", jsonBytes)
+
+// From a reader
+artifact := jobdb.NewArtifactFromReader("output.txt", reader, size)
+
+// From a file (auto-cleanup enabled)
+artifact, err := jobdb.NewArtifactFromFile("build.tar.gz", "/tmp/build.tar.gz")
+
+// From a file (no cleanup)
+artifact, err := jobdb.NewArtifactFromFileNoCleanup("data.csv", "/data/input.csv")
+
+// Custom artifact with full control
+artifact := jobdb.NewArtifact("custom.dat",
+    func() (io.ReadCloser, int64, error) {
+        // Your opener logic
+        f, _ := os.Open(path)
+        info, _ := f.Stat()
+        return f, info.Size(), nil
+    },
+    func() error {
+        // Your cleanup logic
+        return os.Remove(path)
+    },
+)
+```
+
+### Using Artifacts
+
+```go
+// Get artifact metadata
+name := artifact.Name()           // "output.tar.gz"
+size := artifact.Size()            // size in bytes
+
+// Stream artifact contents
+rc, err := artifact.Open()
+if err != nil {
+    return err
+}
+defer rc.Close()
+// ... read from rc
+
+// Write to a file
+err = artifact.SaveToFile(ctx, "/output/file.tar.gz")
+
+// Get full contents (use carefully for large files)
+data, err := artifact.Bytes(ctx)
+
+// Compute SHA256 hash
+hash, err := artifact.Sha256(ctx)
+```
+
+### Artifacts in Tasks
+
+```go
+func (t ProcessFileTask) Run(ctx jobdb.TaskContext, input jobdb.TaskData) (jobdb.TaskData, error) {
+    artifacts, err := input.GetArtifacts()
+    if err != nil {
+        return nil, err
+    }
+
+    // Process the first artifact
+    if len(artifacts) > 0 {
+        inputFile := artifacts[0]
+
+        // Save to local file for processing
+        tmpPath := "/tmp/input.dat"
+        if err := inputFile.SaveToFile(context.Background(), tmpPath); err != nil {
+            return nil, err
+        }
+
+        // Process the file...
+        processFile(tmpPath)
+
+        // Create output artifact
+        outputArtifact, err := jobdb.NewArtifactFromFile("output.dat", "/tmp/output.dat")
+        if err != nil {
+            return nil, err
+        }
+
+        return jobdb.NewTaskData(result, outputArtifact)
+    }
+
+    return input, nil
+}
+```
+
+## Retry and Timeout Policies
+
+### RunPolicy Configuration
+
+```go
+policy := jobdb.RunPolicy{
+    Retry: jobdb.RetryPolicy{
+        InitialInterval:    jobdb.Duration(100 * time.Millisecond),
+        BackoffCoefficient: 2.0,
+        MaximumInterval:    jobdb.Duration(30 * time.Second),
+        MaximumAttempts:    5,
+        NonRetryableErrorTypes: []string{"ValidationError"},
+    },
+    InvocationTimeout: jobdb.AsDuration(30 * time.Second),  // Per attempt
+    TotalTimeout:      jobdb.AsDuration(10 * time.Minute),  // Overall
+}
+
+result, err := ctx.DoTask(policy, "my-task", input)
+```
+
+### Default Policy
+
+```go
+// Use the default policy
+result, err := ctx.DoTask(jobdb.DefaultRunPolicy(), "my-task", input)
+
+// Default values:
+// - InvocationTimeout: 30 seconds
+// - TotalTimeout: 30 minutes
+// - InitialInterval: 100ms
+// - BackoffCoefficient: 2.0
+// - MaximumInterval: 30 seconds
+// - MaximumAttempts: 3
+```
+
+## Error Handling
+
+### Application Errors
+
+Regular errors returned from your workers are treated as application errors and will trigger retries according to the retry policy:
+
+```go
+func (t MyTask) Run(ctx jobdb.TaskContext, input jobdb.TaskData) (jobdb.TaskData, error) {
+    if err := validateInput(input); err != nil {
+        return nil, fmt.Errorf("validation failed: %w", err)
+    }
+    return result, nil
+}
+```
+
+### System Errors
+
+System errors represent infrastructure failures:
+
+```go
+if err := connectToDatabase(); err != nil {
+    return nil, jobdb.NewSystemError(jobdb.SystemErrorPayload{
+        Message:   "database connection failed",
+        Component: "database",
+        Code:      "connection_error",
+        Retryable: true,
+    })
+}
+```
+
+### Non-Retryable Errors
+
+Mark errors as non-retryable to stop retry attempts immediately:
+
+```go
+type ValidationError struct {
+    error
+}
+
+func (e ValidationError) NonRetryable() bool {
+    return true
+}
+
+// Usage
+if !isValid(input) {
+    return nil, ValidationError{errors.New("invalid input")}
+}
+```
+
+### Checking Error Types
+
+```go
+if jobdb.IsAppError(err) {
+    // Handle application error
+}
+
+if jobdb.IsSystemError(err) {
+    // Handle system error
+}
+```
+
+## Advanced Features
+
+### Awaiting Jobs
+
+Wait for previously submitted jobs before continuing:
+
+```go
+func (j ParentJob) Run(ctx jobdb.JobContext, input jobdb.JobData) (jobdb.JobData, error) {
+    if err := ctx.AwaitJobs(childJobID); err != nil {
+        return nil, err
+    }
+
+    return input, nil
+}
+```
+
+### Job Restart
+
+Restart a failed job from a specific step:
+
+```go
+newJobKey, err := engine.SubmitRestartJob(ctx, jobdb.SubmitRestartJob{
+    PriorJobKey:    failedJobKey,
+    LastStepToKeep: 5,  // Replay from step 6 onwards
+    ExtraTaskInput:  newInput,
+    ExtraTaskOutput: newOutput,
+})
+```
+
+### Job Cancellation
+
+```go
+err := engine.CancelJob(ctx, jobdb.CancelJob{
+    JobKey: jobKey,
+    Reason: "user requested cancellation",
+})
+```
+
+### Checking Job Status
+
+```go
+status, err := engine.CheckJobStatus(ctx, jobKey)
+
+switch status {
+case jobdb.JobStatusCompleted:
+    // Job finished successfully
+case jobdb.JobStatusActive:
+    // Job is running
+case jobdb.JobStatusCancelled:
+    // Job was cancelled
+case jobdb.JobStatusReady:
+    // Job is ready to run
+}
+```
+
+### Getting Job Results
+
+```go
+result, err := engine.GetJobResult(ctx, jobKey)
+if err == jobdb.ErrJobNotComplete {
+    // Job hasn't completed yet
+    return
+}
+
+// Use result
+data, _ := result.GetData()
+```
+
+### Listing Jobs
+
+```go
+resp, err := engine.ListJobs(ctx, jobdb.ListJobsRequest{
+    TenantIds:     []string{"my-tenant"},
+    Statuses:      []jobdb.JobStatus{jobdb.JobStatusActive, jobdb.JobStatusCompleted},
+    JobTypes:      []string{"data-processing"},
+    PageSize:      50,
+    PageToken:     "", // empty for first page
+})
+
+for _, job := range resp.Jobs {
+    log.Printf("Job %s: %s", job.JobKey, job.Status)
+}
+
+// Get next page
+if resp.NextPageToken != "" {
+    nextResp, err := engine.ListJobs(ctx, jobdb.ListJobsRequest{
+        PageToken: resp.NextPageToken,
+        // ... other filters
+    })
+}
+```
+
+### Schedules
+
+Schedules are runtime-owned recurring job definitions. A schedule target is the
+same shape as a job start: job type, input `TaskData`, run policy, and app
+metadata. The runtime stores the target, including an artifact snapshot, and
+materializes each occurrence as a normal app job.
+
+```go
+start := time.Now().UTC()
+
+info, err := engine.UpsertSchedule(ctx, jobdb.UpsertScheduleRequest{
+    TenantId:   "my-tenant",
+    ScheduleId: "daily-cleanup",
+    Trigger: jobdb.ScheduleTrigger{
+        Kind:     jobdb.ScheduleTriggerInterval,
+        Interval: 24 * time.Hour,
+        StartAt:  &start,
+    },
+    Target: jobdb.ScheduleTarget{
+        JobType:  "data-processing",
+        Data:     jobdb.JobData(jobdb.NewTaskDataOrPanic(map[string]any{"bucket": "reports"})),
+        Metadata: json.RawMessage(`{"owner":"analytics"}`),
+    },
+    OverlapPolicy: jobdb.ScheduleOverlapSerial,
+})
+if err != nil {
+    return err
+}
+
+log.Printf("next scheduled job: %s", info.NextJobKey)
+```
+
+The schedule API includes `GetSchedule`, `ListSchedules`, `PauseSchedule`,
+`ResumeSchedule`, `ArchiveSchedule`, `TriggerSchedule`, and
+`ListScheduleRuns`. With serial overlap policy, the runtime submits the next
+occurrence before app execution starts, but makes it wait for the previous
+occurrence to complete before it can be leased.
+
+### External Task Completion
+
+For tasks that require external input (e.g., human approval), you can complete them externally:
+
+```go
+// Find tasks waiting for capability
+handles, err := engine.FindTasksWaitingForCapability(ctx,
+    "approval-job",    // job type
+    "human-approval",  // task type
+    []string{"tenant-1"}, // tenants (nil for all)
+)
+
+for _, handle := range handles {
+    // Get task input
+    input, err := handle.Data()
+
+    // ... process externally ...
+
+    // Complete the task
+    output := jobdb.NewTaskDataOrPanic(approvalResult)
+    err = handle.Finish(ctx, output)
+}
+```
+
+## Engine Configuration
+
+### Builder Options
+
+```go
+runtime := toyruntime.New()
+
+engine, err := jobdb.NewEngineBuilder().
+    WithRuntime(runtime).                                  // Required
+    WithWorkerTenantId("tenant-1").                        // Required when running workers
+    WithMaxActive(10).                                      // Concurrent task limit
+    WithLogger(logger).                                     // Custom logger
+    WithAwaitRecycleThreshold(5 * time.Minute).            // Await recycle threshold
+    PlusWorkers(job1, task1, task2).                       // Register workers
+    PlusWorkers(job2, task3).                               // Add more workers
+    BuildEngine()
+```
+
+### Registering Workers
+
+#### At Engine Build Time
+
+Workers can be registered during engine construction:
+
+```go
+builder := jobdb.NewEngineBuilder().
+    WithRuntime(runtime).
+    WithWorkerTenantId("tenant-1")
+
+// Register a job with its tasks
+builder.PlusWorkers(
+    MyJobWorker{},
+    Task1{},
+    Task2{},
+)
+
+// Register another job
+builder.PlusWorkers(
+    AnotherJobWorker{},
+    Task3{},
+)
+
+engine, err := builder.BuildEngine()
+```
+
+#### After Engine Start (Dynamic Registration)
+
+Workers can also be registered after the engine has started:
+
+```go
+// Engine was built with WithWorkerTenantId("my-tenant") and is already running.
+go engine.Run(ctx)
+
+// Create a workset
+workset, err := jobdb.AsWorkSet(
+    NewJobWorker{},
+    NewTask1{},
+    NewTask2{},
+)
+if err != nil {
+    log.Fatal(err)
+}
+
+// Register dynamically
+err = engine.RegisterWorkers(workset)
+if err != nil {
+    log.Fatal(err)
+}
+
+// The engine can now process jobs of type NewJobWorker.Name()
+```
+
+This is useful for:
+- Plugin systems where workers are loaded dynamically
+- Multi-tenant systems where different tenants have different workflows
+- Hot-reloading worker implementations without restarting the engine
+
+### Running the Engine
+
+```go
+ctx := context.Background()
+
+// Run the engine worker loop (blocks)
+engine.Run(ctx)
+
+// Or run in background
+go engine.Run(ctx)
+
+// Cancel when done
+ctx, cancel := context.WithCancel(context.Background())
+defer cancel()
+
+go engine.Run(ctx)
+// ... do work ...
+cancel() // Gracefully stop the engine
+```
+
+Engines with registered workers must be built with `WithWorkerTenantId`.
+The worker loop polls only that tenant; run a separate engine for another
+tenant.
+
+## Best Practices
+
+1. **Keep Tasks Idempotent**: Tasks may be retried, so ensure they can safely run multiple times
+2. **Use Appropriate Timeouts**: Set realistic invocation and total timeouts based on expected task duration
+3. **Handle Large Data with Artifacts**: Use artifacts for files and binary data instead of embedding in TaskData
+4. **Log Generously**: Use `ctx.Logger` to log progress and debug issues
+5. **Design for Failure**: Workflows should gracefully handle task failures and retries
+6. **Clean Up Resources**: Implement proper cleanup in artifact handlers
+7. **Use Singleton Keys**: For jobs that should only run once (e.g., daily reports)
+8. **Monitor Job Status**: Use ListJobs and CheckJobStatus to monitor workflow health
+
+## Architecture Notes
+
+jobdb can run against several runtime backends:
+
+- **SQLite runtime**: Stores workflow state, leases, schedules, Strata row data,
+  and blobfs artifacts locally. This is the default embedded runtime and the
+  default `jobdb` mode.
+- **Postgres/Strata direct runtime**: Stores workflow state and coordinates
+  distributed execution through pgwf, with workflow data and artifacts in
+  Strata.
+- **Remote runtime**: Uses the same `WorkflowRuntime` API over REST. The server
+  owns lease tokens and schedule preflight; clients and workers stay generic.
+
+Multiple engine instances can run concurrently when the selected runtime backend
+supports shared coordination.
+
+## License
+
+See LICENSE file for details.

package/install.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+// This file was generated by GoReleaser. DO NOT EDIT.
+
+import { install } from "./lib.js";
+install();

package/lib.js

@@ -0,0 +1,259 @@
+// This file was generated by GoReleaser. DO NOT EDIT.
+import fs from "fs";
+import crypto from "crypto";
+import http from "http";
+import https from "https";
+import path from "path";
+import JSZip from "jszip";
+import { x as tarExtract } from "tar";
+import { ProxyAgent } from "proxy-agent";
+import { spawnSync } from "child_process";
+import { fileURLToPath } from "url";
+
+const { archives, name, version } = JSON.parse(
+	fs.readFileSync(new URL("./package.json", import.meta.url), "utf8"),
+);
+
+const agent = new ProxyAgent();
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const getArchive = () => {
+	let target = `${process.platform}-${process.arch}`;
+	const archive = archives[target];
+	if (!archive) {
+		throw new Error(`No archive available for ${target}`);
+	}
+	return archive;
+};
+
+const binDir = path.join(__dirname, "bin");
+
+async function extractTar(tarPath, binaries, dir, wrappedIn) {
+	try {
+		const filesToExtract = wrappedIn
+			? binaries.map((bin) =>
+				path.join(wrappedIn, bin).replace(/\\/g, "/"),
+			)
+			: binaries;
+
+		await tarExtract({
+			file: tarPath,
+			cwd: dir,
+			filter: (path) => filesToExtract.includes(path),
+		});
+
+		// If wrapped, move files from wrapped directory to bin directory
+		if (wrappedIn) {
+			const wrappedDir = path.join(dir, wrappedIn);
+			for (const binary of binaries) {
+				const srcPath = path.join(wrappedDir, binary);
+				const destPath = path.join(dir, binary);
+				if (fs.existsSync(srcPath)) {
+					fs.renameSync(srcPath, destPath);
+				}
+			}
+			// Clean up empty wrapped directory
+			try {
+				fs.rmSync(wrappedDir, { recursive: true, force: true });
+			} catch (err) {
+				// Ignore cleanup errors
+			}
+		}
+
+		console.log(`Successfully extracted ${binaries} to "${dir}"`);
+	} catch (err) {
+		throw new Error(`Extraction failed: ${err.message}`);
+	}
+}
+
+async function extractZip(zipPath, binaries, dir, wrappedIn) {
+	try {
+		const zipData = fs.readFileSync(zipPath);
+		const zip = await JSZip.loadAsync(zipData);
+
+		for (const binary of binaries) {
+			const binaryPath = wrappedIn
+				? path.join(wrappedIn, binary).replace(/\\/g, "/")
+				: binary;
+
+			if (!zip.files[binaryPath]) {
+				throw new Error(
+					`Error: ${binaryPath} does not exist in ${zipPath}`,
+				);
+			}
+
+			const content = await zip.files[binaryPath].async("nodebuffer");
+			if (!fs.existsSync(dir)) {
+				fs.mkdirSync(dir, { recursive: true });
+			}
+			const file = path.join(dir, binary);
+			fs.writeFileSync(file, content);
+			fs.chmodSync(file, "755");
+			console.log(`Successfully extracted "${binary}" to "${dir}"`);
+		}
+	} catch (err) {
+		throw new Error(`Extraction failed: ${err.message}`);
+	}
+}
+
+const run = async (bin) => {
+	await install();
+	if (process.platform === "win32") {
+		bin += ".exe";
+	}
+	const [, , ...args] = process.argv;
+	let result = spawnSync(path.join(binDir, bin), args, {
+		cwd: process.cwd(),
+		stdio: "inherit",
+	});
+	if (result.error) {
+		console.error(result.error);
+	}
+	return result.status;
+};
+
+const install = async () => {
+	try {
+		let archive = getArchive();
+		if (await exists(archive)) {
+			return;
+		}
+		let tmp = fs.mkdtempSync("archive-");
+		let archivePath = path.join(tmp, archive.name);
+		await download(archive.url, archivePath);
+		verify(archivePath, archive.checksum);
+
+		if (!fs.existsSync(binDir)) {
+			fs.mkdirSync(binDir);
+		}
+		switch (archive.format) {
+			case "binary":
+				const bin = path.join(binDir, archive.bins[0]);
+				fs.copyFileSync(archivePath, bin);
+				fs.chmodSync(bin, 0o755);
+				break;
+			case "zip":
+				await extractZip(
+					archivePath,
+					archive.bins,
+					binDir,
+					archive.wrappedIn,
+				);
+				break;
+			case "tar":
+			case "tar.gz":
+			case "tgz":
+				await extractTar(
+					archivePath,
+					archive.bins,
+					binDir,
+					archive.wrappedIn,
+				);
+				break;
+			case "tar.zst":
+			case "tzst":
+			case "tar.xz":
+			case "txz":
+			default:
+				throw new Error(`unsupported format: ${archive.format}`);
+		}
+		console.log(`Installed ${name} ${version} to ${binDir}`);
+	} catch (err) {
+		throw new Error(`Installation failed: ${err.message}`);
+	}
+};
+
+const verify = (filename, checksum) => {
+	if (checksum.algorithm == "" || checksum.digest == "") {
+		console.warn("Warning: No checksum provided for verification");
+		return;
+	}
+	let digest = crypto
+		.createHash(checksum.algorithm)
+		.update(fs.readFileSync(filename))
+		.digest("hex");
+	if (digest != checksum.digest) {
+		throw new Error(
+			`${filename}: ${checksum.algorithm} does not match, expected ${checksum.digest}, got ${digest}`,
+		);
+	}
+};
+
+const download = async (url, filename, maxRedirects = 10) => {
+	try {
+		console.log(`Downloading ${url} to ${filename}...`);
+		const dir = path.dirname(filename);
+		if (!fs.existsSync(dir)) {
+			fs.mkdirSync(dir, { recursive: true });
+		}
+
+		return new Promise((resolve, reject) => {
+			const parsedUrl = new URL(url);
+			const mod = parsedUrl.protocol === "https:" ? https : http;
+
+			const request = mod.get(url, { agent }, (response) => {
+				if (
+					response.statusCode >= 300 &&
+					response.statusCode < 400 &&
+					response.headers.location
+				) {
+					if (maxRedirects <= 0) {
+						reject(new Error("Too many redirects"));
+						return;
+					}
+					download(response.headers.location, filename, maxRedirects - 1)
+						.then(resolve)
+						.catch(reject);
+					return;
+				}
+
+				if (response.statusCode !== 200) {
+					reject(
+						new Error(
+							`HTTP ${response.statusCode}: ${response.statusMessage}`,
+						),
+					);
+					return;
+				}
+
+				const writer = fs.createWriteStream(filename);
+				response.pipe(writer);
+
+				writer.on("finish", () => {
+					console.log(`Download complete: ${filename}`);
+					resolve(dir);
+				});
+
+				writer.on("error", (err) => {
+					console.error(`Error writing file: ${err.message}`);
+					reject(err);
+				});
+			});
+
+			request.on("error", (err) => {
+				reject(new Error(`Request failed: ${err.message}`));
+			});
+
+			request.setTimeout(300000, () => {
+				request.destroy();
+				reject(new Error("Request timed out"));
+			});
+		});
+	} catch (err) {
+		throw new Error(`Download failed: ${err.message}`);
+	}
+};
+
+function exists(archive) {
+	if (!fs.existsSync(binDir)) {
+		return false;
+	}
+	return archive.bins.every((bin) => fs.existsSync(path.join(binDir, bin)));
+}
+
+export {
+	install,
+	run,
+	getArchive,
+	download,
+};

package/package.json

@@ -1,13 +1,92 @@
 {
   "name": "@colony2/jobdb",
-  "version": "0.0.1",
-  "description": "",
-  "main": "index.js",
+  "type": "module",
+  "version": "0.0.7",
+  "description": "jobdb job system",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "postinstall": "node install.js",
+    "run": "node run-jobdb.js"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "type": "commonjs"
-}
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/colony-2/jobdb.git"
+  },
+  "author": {
+    "email": "noreply@colony2.com",
+    "name": "Colony 2"
+  },
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/colony-2/jobdb/issues"
+  },
+  "homepage": "https://github.com/colony-2/jobdb",
+  "bin": {
+    "jobdb": "run-jobdb.js"
+  },
+  "dependencies": {
+    "jszip": "3.10.1",
+    "proxy-agent": "8.0.1",
+    "tar": "7.5.15"
+  },
+  "archives": {
+    "darwin-arm64": {
+      "name": "jobdb_0.0.7_Darwin_arm64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.7/jobdb_0.0.7_Darwin_arm64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "462f01b3754e85129d7564cf5e7dddc03e68539e535aff01de60db26277c78e2"
+      }
+    },
+    "darwin-x64": {
+      "name": "jobdb_0.0.7_Darwin_x86_64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.7/jobdb_0.0.7_Darwin_x86_64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "0982242b1a0aa33553c966e823c81bfd6161558d7500def7e5ba624cf93ce8c9"
+      }
+    },
+    "linux-arm64": {
+      "name": "jobdb_0.0.7_Linux_arm64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.7/jobdb_0.0.7_Linux_arm64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "d4086e3fd83f8e3eb9227a70fbd14954950600a16918042626c68a1e976a0545"
+      }
+    },
+    "linux-x64": {
+      "name": "jobdb_0.0.7_Linux_x86_64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.7/jobdb_0.0.7_Linux_x86_64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "d6eb564436f0a654f8355569db66588d60e21fcedd790601b437ca0712475495"
+      }
+    }
+  },
+  "keywords": [
+    "sandbox",
+    "docker",
+    "ai",
+    "agent",
+    "cli",
+    "security"
+  ],
+  "engines": {
+    "node": "\u003e=14.0.0"
+  }
+}

package/run-jobdb.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+
+// This file was generated by GoReleaser. DO NOT EDIT.
+
+import { run } from "./lib.js";
+run("jobdb").then((code) => process.exit(code));