@colony2/jobdb 0.0.1 → 0.0.8

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,139 @@
+# jobdb
+
+`jobdb` is a runtime server for durable jobs. The installed `jobdb` command
+serves the JobDB runtime REST API over HTTP using one of the available storage
+backends.
+
+Use the server when you want a standalone runtime process that workers and other
+clients can talk to over the remote runtime protocol.
+
+## Installation
+
+Install the CLI with npm:
+
+```bash
+npm install -g @colony2/jobdb
+```
+
+Verify the command is available:
+
+```bash
+jobdb --help
+```
+
+## Quick Start
+
+Run the default SQLite-backed server:
+
+```bash
+jobdb --listen 127.0.0.1:9047 --db jobdb.db
+```
+
+This starts the runtime API at `http://127.0.0.1:9047`. SQLite is the default
+backend and persists runtime state in `jobdb.db`; large artifacts are stored in a
+blob directory that defaults to `<db>.blobs`.
+
+The explicit SQLite subcommand is equivalent:
+
+```bash
+jobdb sqlite --listen 127.0.0.1:9047 --db jobdb.db
+```
+
+Stop the server with `Ctrl-C` or `SIGTERM`; the command shuts the HTTP server
+down before closing backend resources.
+
+## Backend Options
+
+### SQLite
+
+SQLite is the default embedded durable backend.
+
+```bash
+jobdb sqlite \
+  --listen 127.0.0.1:9047 \
+  --db ./jobdb.db \
+  --blob-dir ./jobdb.blobs
+```
+
+Flags:
+
+- `--db`: SQLite database path. Defaults to `jobdb.db`.
+- `--blob-dir`: directory for large artifacts. Defaults to `<db>.blobs`.
+- `--sqlite-dsn`: SQLite DSN. Overrides `--db` and `JOBDB_SQLITE_DSN`.
+- `--listen`: HTTP listen address. Defaults to `127.0.0.1:9047`.
+
+Environment:
+
+- `JOBDB_SQLITE_DSN`: SQLite DSN used when `--sqlite-dsn` is not set.
+
+### Toy
+
+The toy backend is in-memory. It is useful for local experiments and tests, not
+for durable execution.
+
+```bash
+jobdb toy --listen 127.0.0.1:9047
+```
+
+### Direct
+
+The direct backend uses Postgres-backed `pgwf` for job state and an embedded
+Strata daemon for chapter and artifact storage. It installs or verifies the
+`pgwf` schema on startup.
+
+```bash
+JOBDB_POSTGRES_DSN='postgres://user:pass@localhost:5432/jobdb?sslmode=disable' \
+  jobdb direct --listen 127.0.0.1:9047
+```
+
+Flags:
+
+- `--postgres-dsn`: Postgres DSN for `pgwf` state.
+- `--listen`: HTTP listen address. Defaults to `127.0.0.1:9047`.
+
+Environment:
+
+- `JOBDB_POSTGRES_DSN`: Postgres DSN used when `--postgres-dsn` is not set.
+
+## Runtime API
+
+The server exposes the JobDB runtime REST API. The wire contract is documented
+in [openapi/jobdb-runtime.yaml](openapi/jobdb-runtime.yaml).
+
+Go clients normally use the remote runtime adapter:
+
+```go
+runtime, err := remoteruntime.New("http://127.0.0.1:9047", nil)
+```
+
+See [pkg/jobdb/README.md](pkg/jobdb/README.md) for the Go runtime API, data
+types, and runtime package reference.
+
+## Go Workflow Workers
+
+Workflow workers are intentionally documented separately from the server. If you
+are writing job workers, task workers, or a process that runs worker loops, use
+the `pkg/workflow` package.
+
+See [pkg/workflow/README.md](pkg/workflow/README.md).
+
+## Development
+
+The CLI source lives in `cmd/jobdb`. To run it directly from a checkout:
+
+```bash
+go run ./cmd/jobdb --listen 127.0.0.1:9047 --db jobdb.db
+```
+
+Run the full test suite:
+
+```bash
+go test ./...
+```
+
+Useful references:
+
+- [pkg/jobdb/README.md](pkg/jobdb/README.md): runtime API, data types, and backend packages.
+- [pkg/workflow/README.md](pkg/workflow/README.md): workflow SDK, workers, and engines.
+- [docs/API-SURFACE.md](docs/API-SURFACE.md): supported public packages.
+- [docs/SPEC-OpenAPI-Runtime-Contract.md](docs/SPEC-OpenAPI-Runtime-Contract.md): runtime REST contract notes.

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.8",
+  "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.8_Darwin_arm64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.8/jobdb_0.0.8_Darwin_arm64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "480b53c0d81c78097f412e4436059cab1098c67e7ce3448838d276895db8a68b"
+      }
+    },
+    "darwin-x64": {
+      "name": "jobdb_0.0.8_Darwin_x86_64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.8/jobdb_0.0.8_Darwin_x86_64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "558e930d85bdb9b7599a6e67f546015e063ff969c681c9717ad6a7a13c50b63c"
+      }
+    },
+    "linux-arm64": {
+      "name": "jobdb_0.0.8_Linux_arm64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.8/jobdb_0.0.8_Linux_arm64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "89a52c995a080fb86357fc030378d7b1d402b8be1a69c32e368ae105058b68fc"
+      }
+    },
+    "linux-x64": {
+      "name": "jobdb_0.0.8_Linux_x86_64.tar.gz",
+      "url": "https://github.com/colony-2/jobdb/releases/download/v0.0.8/jobdb_0.0.8_Linux_x86_64.tar.gz",
+      "bins": [
+        "jobdb"
+      ],
+      "format": "tar.gz",
+      "checksum": {
+        "algorithm": "sha256",
+        "digest": "d8406e066f086dd6890d3f5e143cc5135d5d2dfa2fa18f1b37f2fb3bfe4e1611"
+      }
+    }
+  },
+  "engines": {
+    "node": "\u003e=14.0.0"
+  },
+  "keywords": [
+    "sandbox",
+    "docker",
+    "ai",
+    "agent",
+    "cli",
+    "security"
+  ]
+}

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));