@better-forge/runtime 0.1.0 → 0.1.1

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 BetterStatusPage contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 BetterStatusPage contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,9 +1,9 @@
-# @better-forge/runtime
-
-Application bootstrap: Fastify defaults, health, shutdown, update check, app lock and SSE.
-
-Request logs hide secrets: `redactQueryParams` replaces the value of those query parameters (names are compared after decoding), `redactPathTokenPrefixes` the path segment after a prefix such as `/links/`. `redactUrl` does the same for any URL.
-
-`createSse(limits)` serves live event streams. `SseLimits` caps the open anonymous streams in total and per address (`rateLimitKey` groups an IPv6 address by its /64), and the unsent bytes a client may hold before it is disconnected; signed-in streams are not counted. `rateLimitKey(ip)` is the key to use for any per-address limit.
-
-Status: skeleton. Depends on: `@better-forge/db`.
+# @better-forge/runtime
+
+Application bootstrap: Fastify defaults, health, shutdown, update check, app lock and SSE.
+
+Request logs hide secrets: `redactQueryParams` replaces the value of those query parameters (names are compared after decoding), `redactPathTokenPrefixes` the path segment after a prefix such as `/links/`. `redactUrl` does the same for any URL.
+
+`createSse(limits)` serves live event streams. `SseLimits` caps the open anonymous streams in total and per address (`rateLimitKey` groups an IPv6 address by its /64), and the unsent bytes a client may hold before it is disconnected; signed-in streams are not counted. `rateLimitKey(ip)` is the key to use for any per-address limit.
+
+Status: skeleton. Depends on: `@better-forge/db`.

package/package.json

@@ -1,65 +1,65 @@
-{
-  "name": "@better-forge/runtime",
-  "version": "0.1.0",
-  "description": "Application bootstrap: Fastify defaults, health, shutdown, update check, app lock and SSE.",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/BElluu/Better-Forge.git",
-    "directory": "packages/runtime"
-  },
-  "homepage": "https://github.com/BElluu/Better-Forge/tree/main/packages/runtime#readme",
-  "bugs": {
-    "url": "https://github.com/BElluu/Better-Forge/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "type": "module",
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    },
-    "./package.json": "./package.json"
-  },
-  "files": [
-    "dist",
-    "src",
-    "!src/**/*.test.*"
-  ],
-  "scripts": {
-    "build": "tsc -p tsconfig.json",
-    "dev": "tsc -p tsconfig.json --watch --preserveWatchOutput"
-  },
-  "peerDependencies": {
-    "@fastify/cookie": "^11.1.1",
-    "@fastify/cors": "^10.0.2",
-    "@fastify/jwt": "^10.1.0",
-    "@fastify/multipart": "^9.0.3",
-    "@fastify/rate-limit": "^10.3.0",
-    "@fastify/static": "^10.1.3",
-    "drizzle-orm": "^0.45.2",
-    "fastify": "^5.3.2"
-  },
-  "devDependencies": {
-    "@fastify/cookie": "^11.1.1",
-    "@fastify/cors": "^10.0.2",
-    "@fastify/jwt": "^10.1.0",
-    "@fastify/multipart": "^9.0.3",
-    "@fastify/rate-limit": "^10.3.0",
-    "@fastify/static": "^10.1.3",
-    "@types/node": "^26.6.2",
-    "drizzle-orm": "^0.45.2",
-    "fastify": "^5.3.2",
-    "typescript": "^5.7.3"
-  },
-  "dependencies": {
-    "@better-forge/db": "0.1.0"
-  },
-  "engines": {
-    "node": ">=26.10.0"
-  }
-}
+{
+  "name": "@better-forge/runtime",
+  "version": "0.1.1",
+  "description": "Application bootstrap: Fastify defaults, health, shutdown, update check, app lock and SSE.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/BElluu/Better-Forge.git",
+    "directory": "packages/runtime"
+  },
+  "homepage": "https://github.com/BElluu/Better-Forge/tree/main/packages/runtime#readme",
+  "bugs": {
+    "url": "https://github.com/BElluu/Better-Forge/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.*"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "dev": "tsc -p tsconfig.json --watch --preserveWatchOutput"
+  },
+  "peerDependencies": {
+    "@fastify/cookie": "^11.1.1",
+    "@fastify/cors": "^10.0.2",
+    "@fastify/jwt": "^10.1.0",
+    "@fastify/multipart": "^9.0.3",
+    "@fastify/rate-limit": "^10.3.0",
+    "@fastify/static": "^10.1.3",
+    "drizzle-orm": "^0.45.2",
+    "fastify": "^5.3.2"
+  },
+  "devDependencies": {
+    "@fastify/cookie": "^11.1.1",
+    "@fastify/cors": "^10.0.2",
+    "@fastify/jwt": "^10.1.0",
+    "@fastify/multipart": "^9.0.3",
+    "@fastify/rate-limit": "^10.3.0",
+    "@fastify/static": "^10.1.3",
+    "@types/node": "^26.6.2",
+    "drizzle-orm": "^0.45.2",
+    "fastify": "^5.3.2",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "@better-forge/db": "0.1.1"
+  },
+  "engines": {
+    "node": ">=26.10.0"
+  }
+}

package/src/appLock.ts

@@ -1,63 +1,63 @@
-import fs from 'node:fs'
-import path from 'node:path'
-import { currentProcessOwner, isOwnerAlive, type ProcessOwner } from './processLiveness.js'
-
-const FRESH_MS = 30_000
-
-/**
- * A stalled heartbeat (event loop blocked by a long synchronous task) still counts as running
- * while the recorded pid is alive — but only for this long, so a reused pid cannot block forever.
- */
-const LIVE_OWNER_MS = 10 * 60_000
-
-/**
- * The marker file that tells a restore or a second start that the application is running. `name` is how the
- * application is called in the refusal, `fileName` the marker inside `dir()` (evaluated on each use).
- */
-export function createAppLock(options: { name: string; fileName: string; dir: () => string }) {
-  const RUNNING_MESSAGE = `${options.name} is still running. Stop the application before restoring.`
-  const lockPath = (): string => path.join(options.dir(), options.fileName)
-
-  function readOwner(file: string): Partial<ProcessOwner> {
-    try { return JSON.parse(fs.readFileSync(file, 'utf8')) as Partial<ProcessOwner> }
-    catch { return {} }
-  }
-
-  /** Removes a marker whose owner is gone; throws while the app still looks alive. */
-  function clearStaleMarker(options: { checkOwner: boolean }): void {
-    const file = lockPath()
-    if (!fs.existsSync(file)) return
-    const age = Date.now() - fs.statSync(file).mtimeMs
-    const ownerAlive = isOwnerAlive(readOwner(file))
-    // A killed process (Ctrl+C on Windows, tsx watch restart) leaves a fresh marker; startup trusts a dead pid over the heartbeat.
-    if (age < FRESH_MS && (options.checkOwner || ownerAlive)) throw new Error(RUNNING_MESSAGE)
-    if (options.checkOwner && age < LIVE_OWNER_MS && ownerAlive) throw new Error(RUNNING_MESSAGE)
-    fs.rmSync(file, { force: true })
-  }
-
-  /** Used by restore: also refuses while the recorded app process is alive but its heartbeat has stalled. */
-  function assertAppStopped(): void {
-    clearStaleMarker({ checkOwner: true })
-  }
-
-  /** Startup uses the heartbeat only, so a restart after a crash is never blocked by an unrelated process that reused the pid. */
-  function acquireAppLock(): () => void {
-    clearStaleMarker({ checkOwner: false })
-    fs.mkdirSync(options.dir(), { recursive: true })
-    const file = lockPath()
-    fs.writeFileSync(file, JSON.stringify({ ...currentProcessOwner(), startedAt: Date.now() }), { flag: 'wx', mode: 0o600 })
-    const heartbeat = setInterval(() => {
-      try { fs.utimesSync(file, new Date(), new Date()) } catch { /* shutdown race */ }
-    }, 5_000)
-    heartbeat.unref()
-    let released = false
-    return () => {
-      if (released) return
-      released = true
-      clearInterval(heartbeat)
-      fs.rmSync(file, { force: true })
-    }
-  }
-
-  return { assertAppStopped, acquireAppLock }
-}
+import fs from 'node:fs'
+import path from 'node:path'
+import { currentProcessOwner, isOwnerAlive, type ProcessOwner } from './processLiveness.js'
+
+const FRESH_MS = 30_000
+
+/**
+ * A stalled heartbeat (event loop blocked by a long synchronous task) still counts as running
+ * while the recorded pid is alive — but only for this long, so a reused pid cannot block forever.
+ */
+const LIVE_OWNER_MS = 10 * 60_000
+
+/**
+ * The marker file that tells a restore or a second start that the application is running. `name` is how the
+ * application is called in the refusal, `fileName` the marker inside `dir()` (evaluated on each use).
+ */
+export function createAppLock(options: { name: string; fileName: string; dir: () => string }) {
+  const RUNNING_MESSAGE = `${options.name} is still running. Stop the application before restoring.`
+  const lockPath = (): string => path.join(options.dir(), options.fileName)
+
+  function readOwner(file: string): Partial<ProcessOwner> {
+    try { return JSON.parse(fs.readFileSync(file, 'utf8')) as Partial<ProcessOwner> }
+    catch { return {} }
+  }
+
+  /** Removes a marker whose owner is gone; throws while the app still looks alive. */
+  function clearStaleMarker(options: { checkOwner: boolean }): void {
+    const file = lockPath()
+    if (!fs.existsSync(file)) return
+    const age = Date.now() - fs.statSync(file).mtimeMs
+    const ownerAlive = isOwnerAlive(readOwner(file))
+    // A killed process (Ctrl+C on Windows, tsx watch restart) leaves a fresh marker; startup trusts a dead pid over the heartbeat.
+    if (age < FRESH_MS && (options.checkOwner || ownerAlive)) throw new Error(RUNNING_MESSAGE)
+    if (options.checkOwner && age < LIVE_OWNER_MS && ownerAlive) throw new Error(RUNNING_MESSAGE)
+    fs.rmSync(file, { force: true })
+  }
+
+  /** Used by restore: also refuses while the recorded app process is alive but its heartbeat has stalled. */
+  function assertAppStopped(): void {
+    clearStaleMarker({ checkOwner: true })
+  }
+
+  /** Startup uses the heartbeat only, so a restart after a crash is never blocked by an unrelated process that reused the pid. */
+  function acquireAppLock(): () => void {
+    clearStaleMarker({ checkOwner: false })
+    fs.mkdirSync(options.dir(), { recursive: true })
+    const file = lockPath()
+    fs.writeFileSync(file, JSON.stringify({ ...currentProcessOwner(), startedAt: Date.now() }), { flag: 'wx', mode: 0o600 })
+    const heartbeat = setInterval(() => {
+      try { fs.utimesSync(file, new Date(), new Date()) } catch { /* shutdown race */ }
+    }, 5_000)
+    heartbeat.unref()
+    let released = false
+    return () => {
+      if (released) return
+      released = true
+      clearInterval(heartbeat)
+      fs.rmSync(file, { force: true })
+    }
+  }
+
+  return { assertAppStopped, acquireAppLock }
+}