@mblaney/holster 2.1.1 → 2.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mblaney/holster",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Holster is a service that allows synchronising data between devices using Node, Deno, Bun or the browser.",
   "type": "module",
   "main": "index.js",
@@ -14,11 +14,15 @@
     "type-check": "tsc -p tsconfig.json",
     "type-check:tests": "tsc -p tsconfig.test.json"
   },
+  "bin": {
+    "holster-user-storage": "utils/user-storage.js"
+  },
   "files": [
     "src",
     "ts/src",
     "build",
-    "dist"
+    "dist",
+    "utils"
   ],
   "keywords": [],
   "author": "Malcolm Blaney",

package/src/wire.js

@@ -297,19 +297,23 @@ const Wire = opt => {
       `[HOLSTER] Per-user storage limits enabled (${userCount} user${userCount !== 1 ? "s" : ""}, default: ${defLimitStr})`,
     )
     const sorted = [...userStorage.entries()].sort(([, a], [, b]) => b - a)
-    const formatUser = pub => {
+    const logUser = pub => {
       const total = userStorage.get(pub) ?? 0
       const limit = userLimits.get(pub) ?? defaultLimit
       const limitStr = limit === 0 ? "blocked" : formatBytes(limit)
-      return `  ${pub} — used: ${formatBytes(total)} / limit: ${limitStr}`
+      console.log(
+        `  ${pub.slice(0, 16)}... used: ${formatBytes(total)} / limit: ${limitStr}`,
+      )
     }
     if (userCount <= 5) {
-      sorted.forEach(([pub]) => console.log(formatUser(pub)))
+      sorted.forEach(([pub]) => logUser(pub))
     } else {
       console.log("  Top 5 by storage used:")
-      sorted.slice(0, 5).forEach(([pub]) => console.log(formatUser(pub)))
-      console.log(`  Run \`node examples/user-storage.js\` to view all users`)
+      sorted.slice(0, 5).forEach(([pub]) => logUser(pub))
     }
+    console.log(
+      "  Run `npx holster-user-storage` to view full keys and all users",
+    )
   }
 
   // The check function is required because user data must provide a public key

package/ts/src/wire.ts

@@ -353,19 +353,23 @@ const Wire = (opt: HolsterOptions): WireAPI => {
       `[HOLSTER] Per-user storage limits enabled (${userCount} user${userCount !== 1 ? "s" : ""}, default: ${defLimitStr})`,
     )
     const sorted = [...userStorage.entries()].sort(([, a], [, b]) => b - a)
-    const formatUser = (pub: string): string => {
+    const logUser = (pub: string): void => {
       const total = userStorage.get(pub) ?? 0
       const limit = userLimits.get(pub) ?? defaultLimit
       const limitStr = limit === 0 ? "blocked" : formatBytes(limit)
-      return `  ${pub} — used: ${formatBytes(total)} / limit: ${limitStr}`
+      console.log(
+        `  ${pub.slice(0, 16)}... used: ${formatBytes(total)} / limit: ${limitStr}`,
+      )
     }
     if (userCount <= 5) {
-      sorted.forEach(([pub]) => console.log(formatUser(pub)))
+      sorted.forEach(([pub]) => logUser(pub))
     } else {
       console.log("  Top 5 by storage used:")
-      sorted.slice(0, 5).forEach(([pub]) => console.log(formatUser(pub)))
-      console.log(`  Run \`node examples/user-storage.js\` to view all users`)
+      sorted.slice(0, 5).forEach(([pub]) => logUser(pub))
     }
+    console.log(
+      "  Run `npx holster-user-storage` to view full keys and all users",
+    )
   }
 
   const check = async (

package/utils/user-storage.js

@@ -0,0 +1,86 @@
+#!/usr/bin/env node
+// Displays per-user storage stats for a Holster relay with userLimit enabled.
+// Usage: node utils/user-storage.js [dir] [--limit N] [--offset N]
+
+import {readFileSync, existsSync} from "node:fs"
+import {resolve} from "node:path"
+
+const args = process.argv.slice(2)
+const dir = resolve(args.find(a => !a.startsWith("--")) || ".")
+
+if (!existsSync(dir)) {
+  console.error(`Error: directory not found: ${dir}`)
+  process.exit(1)
+}
+
+const getFlag = (name, defaultVal) => {
+  const idx = args.indexOf(`--${name}`)
+  if (idx === -1) return defaultVal
+  const val = parseInt(args[idx + 1], 10)
+  return isNaN(val) ? defaultVal : val
+}
+
+const limit = getFlag("limit", 10)
+const offset = getFlag("offset", 0)
+
+const readJSON = file => {
+  try {
+    return {data: JSON.parse(readFileSync(`${dir}/${file}`, "utf8"))}
+  } catch (err) {
+    if (err.code === "ENOENT") return {missing: true}
+    return {error: err.message}
+  }
+}
+
+const formatBytes = bytes => {
+  if (bytes < 1024) return `${bytes} B`
+  if (bytes < 1048576) return `${(bytes / 1024).toFixed(1)} KB`
+  if (bytes < 1073741824) return `${(bytes / 1048576).toFixed(1)} MB`
+  return `${(bytes / 1073741824).toFixed(1)} GB`
+}
+
+const DEFAULT_STORAGE_LIMIT = 1 // MB
+
+const userStorage = readJSON(".user_storage.json")
+const userLimit = readJSON(".user_limit.json")
+
+console.log(`Per-user storage report for ${dir}:`)
+
+if (userStorage.missing) {
+  console.log("  No user storage recorded yet.")
+} else if (userStorage.error) {
+  console.error(`  Error reading .user_storage.json: ${userStorage.error}`)
+  process.exit(1)
+}
+
+if (userLimit.missing) {
+  console.log("  No per-user limits defined.")
+} else if (userLimit.error) {
+  console.error(`  Error reading .user_limit.json: ${userLimit.error}`)
+  process.exit(1)
+}
+
+const users = Object.entries(userStorage.data || {})
+  .map(([pub, total]) => {
+    return {pub, total}
+  })
+  .sort((a, b) => b.total - a.total)
+
+const page = users.slice(offset, offset + limit)
+
+console.log(`  Total users: ${users.length}`)
+if (page.length > 0) {
+  console.log(
+    `  Showing full public keys for ${page.length} user${page.length !== 1 ? "s" : ""} (offset: ${offset}, limit: ${limit})`,
+  )
+}
+
+const data = userLimit.data || {}
+for (const {pub, total} of page) {
+  const pubLimit =
+    typeof data[pub] === "number" ? data[pub] : DEFAULT_STORAGE_LIMIT
+  const limitStr =
+    pubLimit === 0 ? "0 B (blocked)" : formatBytes(pubLimit * 1048576)
+  console.log(`  ${pub}`)
+  console.log(`    used: ${formatBytes(total)} / limit: ${limitStr}`)
+}