@fnndsc/porter 0.2.0

package/dist/sweep.d.ts

@@ -0,0 +1,31 @@
+/**
+ * @file The idle sweep: sessions nobody is on, ended after a day.
+ *
+ * A session with no wire open and nothing through the door for the idle
+ * span is ended — the process, never the identity's state directory, so
+ * the next login boots warm. The registry forgets it; a cookie that still
+ * names it sends its browser back through the door, where the password is
+ * checked again and the session started again.
+ *
+ * @module
+ */
+import type { SessionHost } from './host/sessionHost.js';
+import type { SessionRegistry, SessionEntry } from './registry.js';
+/**
+ * Ends every idle session once.
+ *
+ * @param registry - Who is on what, and since when.
+ * @param host - Where sessions run.
+ * @param idleMs - The span after which a session with nobody on it is ended.
+ * @param log - Told each session ended.
+ * @returns The keys ended.
+ */
+export declare function idleSweep_run(registry: SessionRegistry, host: Pick<SessionHost, 'evict'>, idleMs: number, log?: (line: string) => void): Promise<string[]>;
+/**
+ * The idle entries, for a listing or a test, without ending anything.
+ *
+ * @param registry - Who is on what.
+ * @param idleMs - The span.
+ * @returns The entries idle longer than the span.
+ */
+export declare function idle_list(registry: SessionRegistry, idleMs: number): SessionEntry[];

package/dist/sweep.js

@@ -0,0 +1,31 @@
+/**
+ * Ends every idle session once.
+ *
+ * @param registry - Who is on what, and since when.
+ * @param host - Where sessions run.
+ * @param idleMs - The span after which a session with nobody on it is ended.
+ * @param log - Told each session ended.
+ * @returns The keys ended.
+ */
+export async function idleSweep_run(registry, host, idleMs, log = () => undefined) {
+    const ended = [];
+    for (const entry of registry.idle_list(idleMs)) {
+        const idleFor = Math.round((Date.now() - entry.activeAt) / 60_000);
+        await host.evict(entry.identity);
+        registry.forget(entry.key);
+        ended.push(entry.key);
+        log(`ended ${entry.user}'s session after ${idleFor} min idle; the state directory stays`);
+    }
+    return ended;
+}
+/**
+ * The idle entries, for a listing or a test, without ending anything.
+ *
+ * @param registry - Who is on what.
+ * @param idleMs - The span.
+ * @returns The entries idle longer than the span.
+ */
+export function idle_list(registry, idleMs) {
+    return registry.idle_list(idleMs);
+}
+//# sourceMappingURL=sweep.js.map

package/dist/sweep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sweep.js","sourceRoot":"","sources":["../src/sweep.ts"],"names":[],"mappings":"AAcA;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CACjC,QAAyB,EACzB,IAAgC,EAChC,MAAc,EACd,MAA8B,GAAS,EAAE,CAAC,SAAS;IAEnD,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAW,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,CAAC;QAC3E,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QACjC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACtB,GAAG,CAAC,SAAS,KAAK,CAAC,IAAI,oBAAoB,OAAO,sCAAsC,CAAC,CAAC;IAC5F,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,SAAS,CAAC,QAAyB,EAAE,MAAc;IACjE,OAAO,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AACpC,CAAC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@fnndsc/porter",
+  "version": "0.2.0",
+  "description": "PORTER: the mise display manager — logs an operator in, finds or starts their calypso, and shows them to argus",
+  "type": "module",
+  "main": "dist/porter.js",
+  "bin": {
+    "porter": "dist/porter.js"
+  },
+  "scripts": {
+    "build": "rm -fr dist && tsc && chmod +x ./dist/porter.js",
+    "test": "NODE_OPTIONS='--experimental-vm-modules --disable-warning=ExperimentalWarning' jest --coverage",
+    "start": "node dist/porter.js"
+  },
+  "author": "Rudolph Pienaar",
+  "license": "MIT",
+  "dependencies": {
+    "@fastify/cookie": "^11.1.2",
+    "@fastify/formbody": "^9.0.0",
+    "@fastify/reply-from": "^12.6.5",
+    "@fnndsc/calypso": "^0.16.0",
+    "@fnndsc/chell": "^5.9.0",
+    "@fnndsc/menu": "^0.10.0",
+    "fastify": "^5.12.5",
+    "ws": "^8.18.0",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@jest/globals": "^30.2.0",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^22.0.0",
+    "@types/ws": "^8.5.12",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FNNDSC/mise.git",
+    "directory": "apps/porter"
+  },
+  "keywords": [
+    "chris",
+    "mise",
+    "porter",
+    "login",
+    "display-manager"
+  ]
+}