@fnndsc/salsa 3.9.0 → 3.10.0

package/dist/vfs/providers/workflows.js

@@ -0,0 +1,172 @@
+"use strict";
+/**
+ * @file `/proc/workflows` — instantiated pipelines, beside the jobs they own.
+ *
+ * A CUBE workflow is a pipeline that was run: it names the pipeline and owns
+ * the plugin instances the run created. That is runtime state, which is why it
+ * lives under `/proc` alongside `/proc/jobs` rather than under `/bin` with the
+ * pipeline definitions.
+ *
+ * A workflow is a relation, so it projects as a directory of links — the
+ * `pipeline` entry points into `/bin`, and each entry under `jobs/` points into
+ * `/proc/jobs`. Nothing here duplicates a job's own representation; following a
+ * link arrives at the one `/proc/jobs` already provides.
+ *
+ * Links are lazy: a listing states that a link exists without paying to resolve
+ * it, and `linkTarget_resolve` is called only when something actually follows
+ * one.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowsVfsProvider = void 0;
+const cumin_1 = require("@fnndsc/cumin");
+const index_js_1 = require("../../workflows/index.js");
+/** The prefix this provider answers for. */
+const PREFIX = '/proc/workflows';
+/** Entries every workflow directory carries. */
+const WORKFLOW_ENTRIES = ['pipeline', 'jobs', 'title'];
+/**
+ * Reads a field from a workflow row, tolerating the shapes CUBE reports.
+ *
+ * @param row - One workflow row.
+ * @param field - The field to read.
+ * @returns The value as a string, or an empty string when absent.
+ */
+function field_text(row, field) {
+    const value = row[field];
+    return value === undefined || value === null ? '' : String(value);
+}
+/**
+ * Splits a path below this provider's prefix into its segments.
+ *
+ * @param path - An absolute path under `/proc/workflows`.
+ * @returns The segments after the prefix, empty at the root.
+ */
+function segments_below(path) {
+    return path.slice(PREFIX.length).split('/').filter(Boolean);
+}
+/**
+ * Projects CUBE workflows as `/proc/workflows`.
+ */
+class WorkflowsVfsProvider {
+    /** @inheritdoc */
+    prefix = PREFIX;
+    /** @inheritdoc */
+    async list(path) {
+        const parts = segments_below(path);
+        if (parts.length === 0) {
+            return this.workflows_list();
+        }
+        if (parts.length === 1) {
+            return (0, cumin_1.Ok)(WORKFLOW_ENTRIES.map((name) => ({
+                name,
+                type: name === 'jobs' ? 'dir' : (name === 'pipeline' ? 'link' : 'file'),
+                size: 0,
+                owner: '',
+                date: '',
+            })));
+        }
+        if (parts.length === 2 && parts[1] === 'jobs') {
+            return this.jobs_list(Number(parts[0]));
+        }
+        cumin_1.errorStack.stack_push('error', `${path} is not a workflow path.`);
+        return (0, cumin_1.Err)();
+    }
+    /** @inheritdoc */
+    async cp(_src, _dest, _options) {
+        // A workflow is a record of a run. Copying one would assert that a
+        // computation happened twice.
+        cumin_1.errorStack.stack_push('error', 'A workflow records a run; it cannot be copied.');
+        return false;
+    }
+    /** @inheritdoc */
+    async read(path) {
+        const parts = segments_below(path);
+        if (parts.length !== 2 || parts[1] !== 'title') {
+            cumin_1.errorStack.stack_push('error', `${path} is not a readable workflow file.`);
+            return (0, cumin_1.Err)();
+        }
+        const rows = await this.rows_get();
+        const row = rows.find((entry) => field_text(entry, 'id') === parts[0]);
+        if (!row) {
+            cumin_1.errorStack.stack_push('error', `No workflow ${parts[0]}.`);
+            return (0, cumin_1.Err)();
+        }
+        return (0, cumin_1.Ok)(`${field_text(row, 'title')}\n`);
+    }
+    /**
+     * Resolves a workflow's `pipeline` link to its definition under `/bin`.
+     *
+     * @param path - The link's absolute path.
+     * @returns The target path, or an error when the workflow is unknown.
+     */
+    async linkTarget_resolve(path) {
+        const parts = segments_below(path);
+        if (parts.length !== 2 || parts[1] !== 'pipeline') {
+            cumin_1.errorStack.stack_push('error', `${path} is not a workflow link.`);
+            return (0, cumin_1.Err)();
+        }
+        const rows = await this.rows_get();
+        const row = rows.find((entry) => field_text(entry, 'id') === parts[0]);
+        if (!row) {
+            cumin_1.errorStack.stack_push('error', `No workflow ${parts[0]}.`);
+            return (0, cumin_1.Err)();
+        }
+        return (0, cumin_1.Ok)(`/bin/${field_text(row, 'pipeline_name')}`);
+    }
+    /**
+     * Fetches every workflow visible to this session.
+     *
+     * @returns The workflow rows, empty when the fetch failed.
+     */
+    async rows_get() {
+        const data = await (0, index_js_1.workflows_listAll)();
+        return data?.tableData ?? [];
+    }
+    /**
+     * Lists the workflows themselves, one directory each.
+     *
+     * @returns The listing.
+     */
+    async workflows_list() {
+        const rows = await this.rows_get();
+        return (0, cumin_1.Ok)(rows.map((row) => ({
+            name: field_text(row, 'id'),
+            type: 'dir',
+            size: 0,
+            owner: field_text(row, 'owner_username'),
+            date: field_text(row, 'creation_date'),
+            title: field_text(row, 'title'),
+            id: Number(field_text(row, 'id')),
+        })));
+    }
+    /**
+     * Lists one workflow's plugin instances as links into `/proc/jobs`.
+     *
+     * @param workflowId - The workflow whose instances to list.
+     * @returns The listing.
+     */
+    async jobs_list(workflowId) {
+        const rows = await this.rows_get();
+        const row = rows.find((entry) => Number(field_text(entry, 'id')) === workflowId);
+        if (!row) {
+            cumin_1.errorStack.stack_push('error', `No workflow ${workflowId}.`);
+            return (0, cumin_1.Err)();
+        }
+        const ids = Array.isArray(row['plugin_instances'])
+            ? row['plugin_instances'].map(Number).filter((id) => !Number.isNaN(id))
+            : [];
+        return (0, cumin_1.Ok)(ids.map((id) => ({
+            name: String(id),
+            type: 'link',
+            size: 0,
+            owner: field_text(row, 'owner_username'),
+            date: '',
+            target: `/proc/jobs/${id}`,
+            id,
+        })));
+    }
+}
+exports.WorkflowsVfsProvider = WorkflowsVfsProvider;
+//# sourceMappingURL=workflows.js.map

package/dist/vfs/providers/workflows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflows.js","sourceRoot":"","sources":["../../../src/vfs/providers/workflows.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;AAEH,yCAMuB;AAEvB,uDAA6D;AAE7D,4CAA4C;AAC5C,MAAM,MAAM,GAAW,iBAAiB,CAAC;AAEzC,gDAAgD;AAChD,MAAM,gBAAgB,GAAsB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAE1E;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,GAA4B,EAAE,KAAa;IAC7D,MAAM,KAAK,GAAY,GAAG,CAAC,KAAK,CAAC,CAAC;IAClC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,SAAS,cAAc,CAAC,IAAY;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;AAC9D,CAAC;AAED;;GAEG;AACH,MAAa,oBAAoB;IAC/B,kBAAkB;IACX,MAAM,GAAW,MAAM,CAAC;IAE/B,kBAAkB;IACX,KAAK,CAAC,IAAI,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAa,cAAc,CAAC,IAAI,CAAC,CAAC;QAE7C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC;QAC/B,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,OAAO,IAAA,UAAE,EAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,IAAY,EAAW,EAAE,CAAC,CAAC;gBACzD,IAAI;gBACJ,IAAI,EAAE,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC;gBACvE,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,EAAE;gBACT,IAAI,EAAE,EAAE;aACT,CAAC,CAAC,CAAC,CAAC;QACP,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,MAAM,EAAE,CAAC;YAC9C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1C,CAAC;QAED,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,0BAA0B,CAAC,CAAC;QAClE,OAAO,IAAA,WAAG,GAAE,CAAC;IACf,CAAC;IAED,kBAAkB;IACX,KAAK,CAAC,EAAE,CAAC,IAAY,EAAE,KAAa,EAAE,QAAmB;QAC9D,mEAAmE;QACnE,8BAA8B;QAC9B,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,gDAAgD,CAAC,CAAC;QACjF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kBAAkB;IACX,KAAK,CAAC,IAAI,CAAC,IAAY;QAC5B,MAAM,KAAK,GAAa,cAAc,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,OAAO,EAAE,CAAC;YAC/C,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,mCAAmC,CAAC,CAAC;YAC3E,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;QACD,MAAM,IAAI,GAA8B,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9D,MAAM,GAAG,GACP,IAAI,CAAC,IAAI,CAAC,CAAC,KAA8B,EAAW,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/F,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAC3D,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;QACD,OAAO,IAAA,UAAE,EAAC,GAAG,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,kBAAkB,CAAC,IAAY;QAC1C,MAAM,KAAK,GAAa,cAAc,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;YAClD,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,IAAI,0BAA0B,CAAC,CAAC;YAClE,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;QACD,MAAM,IAAI,GAA8B,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9D,MAAM,GAAG,GACP,IAAI,CAAC,IAAI,CAAC,CAAC,KAA8B,EAAW,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/F,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;YAC3D,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;QACD,OAAO,IAAA,UAAE,EAAC,QAAQ,UAAU,CAAC,GAAG,EAAE,eAAe,CAAC,EAAE,CAAC,CAAC;IACxD,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,QAAQ;QACpB,MAAM,IAAI,GAAgC,MAAM,IAAA,4BAAiB,GAAE,CAAC;QACpE,OAAO,IAAI,EAAE,SAAS,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,cAAc;QAC1B,MAAM,IAAI,GAA8B,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9D,OAAO,IAAA,UAAE,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAA4B,EAAW,EAAE,CAAC,CAAC;YAC7D,IAAI,EAAE,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC;YAC3B,IAAI,EAAE,KAAK;YACX,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,gBAAgB,CAAC;YACxC,IAAI,EAAE,UAAU,CAAC,GAAG,EAAE,eAAe,CAAC;YACtC,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC;YAC/B,EAAE,EAAE,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;SAClC,CAAC,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,SAAS,CAAC,UAAkB;QACxC,MAAM,IAAI,GAA8B,MAAM,IAAI,CAAC,QAAQ,EAAE,CAAC;QAC9D,MAAM,GAAG,GACP,IAAI,CAAC,IAAI,CAAC,CAAC,KAA8B,EAAW,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC;QACzG,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,eAAe,UAAU,GAAG,CAAC,CAAC;YAC7D,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;QACD,MAAM,GAAG,GAAa,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC;YAC1D,CAAC,CAAE,GAAG,CAAC,kBAAkB,CAAe,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC,EAAU,EAAW,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACvG,CAAC,CAAC,EAAE,CAAC;QACP,OAAO,IAAA,UAAE,EAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EAAU,EAAW,EAAE,CAAC,CAAC;YAC1C,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;YAChB,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,CAAC;YACP,KAAK,EAAE,UAAU,CAAC,GAAG,EAAE,gBAAgB,CAAC;YACxC,IAAI,EAAE,EAAE;YACR,MAAM,EAAE,cAAc,EAAE,EAAE;YAC1B,EAAE;SACH,CAAC,CAAC,CAAC,CAAC;IACP,CAAC;CACF;AAlID,oDAkIC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fnndsc/salsa",
-  "version": "3.9.0",
+  "version": "3.10.0",
   "description": "Shared Application Logic and Service Assets for ChRIS",
   "repository": {
     "type": "git",
@@ -59,7 +59,7 @@
     "inflight": "npm:@aashutoshrathi/word-wrap@^1.2.6"
   },
   "dependencies": {
-    "@fnndsc/cumin": "^3.14.0",
+    "@fnndsc/cumin": "^3.15.0",
     "axios": "^1.6.8",
     "ws": "^8.21.0"
   }