@sockethub/server 5.0.0-alpha.21 → 5.0.0-alpha.22

package/README.md

@@ -155,15 +155,25 @@ verification event and exit.
 ### Command-line params
 
 ```
-  --help       : this help screen
-  --info       : displays some basic runtime info
+  --help, -h          : this help screen
+  --version, -v       : print the version and exit
+  --info              : displays some basic runtime info
 
-  --examples   : enabled examples page and serves helper files like jquery
+  --examples          : enabled examples page and serves helper files like jquery
 
-  --host       : hostname to bind to
-  --port       : port to bind to
+  --config, -c        : path to a config file
+  --write-config      : write a default config file and exit
+
+  --host              : hostname to bind to
+  --port              : port to bind to
+
+  --sentry-test       : send a verification event to Sentry and exit
+  --sentry-test-crash : report a synthetic fatal error to Sentry and exit
 ```
 
+`--help`, `--version` and `--write-config` answer without loading the config
+file or binding a port, so they work on a host already running Sockethub.
+
 ### Start
 
 Run with debug output and examples enabled:

package/dist/cli.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Argument handling for the flags that short-circuit startup.
+ *
+ * Deliberately free of imports from the config singleton: `--help` and
+ * `--version` must answer even when the config file in the working directory
+ * is missing or invalid, and must never reach the point of binding a port.
+ */
+export declare function renderHelp(): string;
+/**
+ * The short-circuit flag present in `argv`, if any. `--help` wins over
+ * `--version` when both are given.
+ */
+export declare function parseInfoFlag(argv: Array<string>): "help" | "version" | undefined;

package/dist/index.js

@@ -10029,6 +10029,18 @@ function errorMessage(value) {
 }
 var init_error = () => {};
 
+// src/version.ts
+import { createRequire as createRequire2 } from "node:module";
+function defaultSentryRelease() {
+  return `sockethub@${SOCKETHUB_VERSION}`;
+}
+var require2, packageJson, SOCKETHUB_VERSION;
+var init_version = __esm(() => {
+  require2 = createRequire2(import.meta.url);
+  packageJson = require2("../package.json");
+  SOCKETHUB_VERSION = packageJson.version;
+});
+
 // ../schemas/src/context.ts
 function buildCanonicalContext(platform) {
   const platformUrl = platform.startsWith("https://") ? platform : `${PLATFORM_CONTEXT_PREFIX}${platform}/v1.jsonld`;
@@ -16574,7 +16586,7 @@ var init_package = __esm(() => {
   package_default = {
     name: "@sockethub/schemas",
     description: "JSON schema files for validating Sockethub Activity Streams",
-    version: "3.0.0-alpha.21",
+    version: "3.0.0-alpha.22",
     type: "module",
     private: false,
     author: "Nick Jennings <nick@silverbucket.net>",
@@ -16644,7 +16656,7 @@ var init_package = __esm(() => {
       "ajv-formats": "^2.1.1",
       "ajv-formats-draft2019": "^1.6.1"
     },
-    gitHead: "683f7b2c0cda2eda05c845eb98827cf13d055eb4",
+    gitHead: "1630010f605e85cc548e3323cb9694fbe3a7a18a",
     types: "./dist/index.d.ts"
   };
 });
@@ -16961,6 +16973,11 @@ var init_sockethub_config = __esm(() => {
             default: 262144,
             description: "Maximum size in bytes of a single Socket.IO message."
           },
+          trustProxy: {
+            type: ["boolean", "number", "string"],
+            default: false,
+            description: "Express 'trust proxy' setting, deciding whether " + "'x-forwarded-for' is believed when determining a " + "client's IP for HTTP rate limiting. false trusts no " + "proxy; a number trusts that many hops; a string " + "takes an address, subnet or preset ('loopback'). " + "Only enable behind a reverse proxy that overwrites " + "the header. When left false while " + "credentialCheck.reconnectIpSource is 'proxy' and " + "credentialCheck.proxyHeader is 'x-forwarded-for', " + "one hop is trusted so both paths agree; a custom " + "proxyHeader requires setting this explicitly."
+          },
           cors: {
             type: "object",
             additionalProperties: false,
@@ -29228,6 +29245,11 @@ var init_config_schema = __esm(() => {
       env: "SOCKETHUB_MAX_PAYLOAD_BYTES",
       emptyEnvIsUnset: true
     },
+    "sockethub.trustProxy": {
+      format: "*",
+      env: "SOCKETHUB_TRUST_PROXY",
+      emptyEnvIsUnset: true
+    },
     "sockethub.cors.origin": {
       env: "SOCKETHUB_CORS_ORIGIN",
       arg: "cors.origin"
@@ -29411,7 +29433,7 @@ var init_debug_build = __esm(() => {
 
 // ../../node_modules/@sentry/core/build/esm/utils/version.js
 var SDK_VERSION = "10.70.0";
-var init_version = () => {};
+var init_version2 = () => {};
 
 // ../../node_modules/@sentry/core/build/esm/utils/worldwide.js
 var GLOBAL_OBJ;
@@ -29435,7 +29457,7 @@ function getGlobalSingleton(name, creator, obj = GLOBAL_OBJ) {
   return carrier[name] || (carrier[name] = creator());
 }
 var init_carrier = __esm(() => {
-  init_version();
+  init_version2();
   init_worldwide();
 });
 
@@ -34510,7 +34532,7 @@ function applySdkMetadata(options, name, names = [name], source = "npm") {
   }
 }
 var init_sdkMetadata = __esm(() => {
-  init_version();
+  init_version2();
 });
 
 // ../../node_modules/@sentry/core/build/esm/utils/traceData.js
@@ -42121,7 +42143,7 @@ var init_esm = __esm(() => {
   init_url();
   init_lru();
   init_propagationContext();
-  init_version();
+  init_version2();
   init_randomSafeContext();
   init_server_runtime_client();
   init_node_stack_trace();
@@ -55258,17 +55280,17 @@ function _getModules() {
 function getPackageJson() {
   try {
     const filePath = join3(process.cwd(), "package.json");
-    const packageJson = JSON.parse(readFileSync(filePath, "utf8"));
-    return packageJson;
+    const packageJson2 = JSON.parse(readFileSync(filePath, "utf8"));
+    return packageJson2;
   } catch {
     return {};
   }
 }
 function getModulesFromPackageJson() {
-  const packageJson = getPackageJson();
+  const packageJson2 = getPackageJson();
   return {
-    ...packageJson.dependencies,
-    ...packageJson.devDependencies
+    ...packageJson2.dependencies,
+    ...packageJson2.devDependencies
   };
 }
 var moduleCache, INTEGRATION_NAME15 = "Modules", _modulesIntegration = () => {
@@ -66514,18 +66536,6 @@ var init_sentry_config = __esm(() => {
   logger = createLogger("sentry:config");
 });
 
-// src/version.ts
-import { createRequire as createRequire2 } from "node:module";
-function defaultSentryRelease() {
-  return `sockethub@${SOCKETHUB_VERSION}`;
-}
-var require2, packageJson, SOCKETHUB_VERSION;
-var init_version2 = __esm(() => {
-  require2 = createRequire2(import.meta.url);
-  packageJson = require2("../package.json");
-  SOCKETHUB_VERSION = packageJson.version;
-});
-
 // ../../node_modules/@sentry/profiling-node/node_modules/@sentry/core/build/esm/utils/version.js
 var SDK_VERSION2 = "10.36.0";
 var init_version3 = () => {};
@@ -71448,7 +71458,9 @@ var init_esm7 = __esm(() => {
 // src/sentry.ts
 var exports_sentry = {};
 __export(exports_sentry, {
+  SENTRY_FLUSH_TIMEOUT_MS: () => SENTRY_FLUSH_TIMEOUT_MS,
   count: () => count2,
+  flush: () => flush3,
   gauge: () => gauge2,
   reportError: () => reportError,
   sendTestEvent: () => sendTestEvent,
@@ -71458,6 +71470,9 @@ function reportError(err) {
   logger2.warn("reporting error");
   captureException(err);
 }
+function flush3(timeoutMs = SENTRY_FLUSH_TIMEOUT_MS) {
+  return flush(timeoutMs);
+}
 function count2(name, value = 1, attributes = {}) {
   if (sentryConfig.enableMetrics) {
     exports_public_api.count(name, value, { attributes });
@@ -71494,13 +71509,13 @@ async function sendTestEvent() {
   captureMessage("Sockethub Sentry verification event", "info");
   return flush(5000);
 }
-var logger2, sentryConfig, integrations;
+var SENTRY_FLUSH_TIMEOUT_MS = 2000, logger2, sentryConfig, integrations;
 var init_sentry = __esm(async () => {
   init_esm5();
   init_src();
   init_observability();
   init_sentry_config();
-  init_version2();
+  init_version();
   logger2 = createLogger("sentry");
   sentryConfig = resolveSentryConfig();
   if (!sentryConfig.dsn) {
@@ -137916,7 +137931,7 @@ var require_package2 = __commonJS(function(exports, module) {
   module.exports = {
     name: "@sockethub/server",
     description: "A polyglot messaging service, server libraries",
-    version: "5.0.0-alpha.21",
+    version: "5.0.0-alpha.22",
     type: "module",
     private: false,
     author: "Nick Jennings <nick@silverbucket.net>",
@@ -137967,11 +137982,11 @@ var require_package2 = __commonJS(function(exports, module) {
     dependencies: {
       "@sentry/node": "^10.36.0",
       "@sentry/profiling-node": "10.36.0",
-      "@sockethub/client": "^5.0.0-alpha.21",
-      "@sockethub/data-layer": "^1.0.0-alpha.21",
-      "@sockethub/logger": "^1.0.0-alpha.21",
-      "@sockethub/schemas": "^3.0.0-alpha.21",
-      "@sockethub/util": "^1.0.0-alpha.9",
+      "@sockethub/client": "^5.0.0-alpha.22",
+      "@sockethub/data-layer": "^1.0.0-alpha.22",
+      "@sockethub/logger": "^1.0.0-alpha.22",
+      "@sockethub/schemas": "^3.0.0-alpha.22",
+      "@sockethub/util": "^1.0.0-alpha.10",
       chalk: "^5.6.2",
       convict: "^6.2.5",
       ejs: "^3.1.10",
@@ -138002,16 +138017,16 @@ var require_package2 = __commonJS(function(exports, module) {
       "web-streams-polyfill": "^3.3.3"
     },
     optionalDependencies: {
-      "@sockethub/examples": "^1.0.0-alpha.21",
-      "@sockethub/platform-caldav": "^1.0.0-alpha.5",
-      "@sockethub/platform-carddav": "^1.0.0-alpha.2",
-      "@sockethub/platform-dummy": "^3.0.0-alpha.21",
-      "@sockethub/platform-feeds": "^4.0.0-alpha.21",
-      "@sockethub/platform-irc": "^4.0.0-alpha.21",
-      "@sockethub/platform-metadata": "^1.0.1-alpha.16",
-      "@sockethub/platform-xmpp": "^5.0.0-alpha.21"
-    },
-    gitHead: "683f7b2c0cda2eda05c845eb98827cf13d055eb4",
+      "@sockethub/examples": "^1.0.0-alpha.22",
+      "@sockethub/platform-caldav": "^1.0.0-alpha.6",
+      "@sockethub/platform-carddav": "^1.0.0-alpha.3",
+      "@sockethub/platform-dummy": "^3.0.0-alpha.22",
+      "@sockethub/platform-feeds": "^4.0.0-alpha.22",
+      "@sockethub/platform-irc": "^4.0.0-alpha.22",
+      "@sockethub/platform-metadata": "^1.0.1-alpha.17",
+      "@sockethub/platform-xmpp": "^5.0.0-alpha.22"
+    },
+    gitHead: "1630010f605e85cc548e3323cb9694fbe3a7a18a",
     types: "./dist/index.d.ts"
   };
 });
@@ -196033,6 +196048,36 @@ var init_routes = __esm(() => {
   routes_default = routes;
 });
 
+// src/trust-proxy.ts
+function normalize5(value) {
+  if (typeof value === "boolean" || typeof value === "number") {
+    return value;
+  }
+  if (typeof value !== "string") {
+    return false;
+  }
+  const trimmed = value.trim();
+  if (trimmed === "" || trimmed === "false") {
+    return false;
+  }
+  if (trimmed === "true") {
+    return true;
+  }
+  if (/^\d+$/.test(trimmed)) {
+    return Number(trimmed);
+  }
+  return trimmed;
+}
+function resolveTrustProxy(configured, reconnectIpSource, proxyHeader) {
+  const normalized = normalize5(configured);
+  if (normalized !== false || reconnectIpSource !== "proxy") {
+    return normalized;
+  }
+  const header = typeof proxyHeader === "string" && proxyHeader.trim() !== "" ? proxyHeader.trim().toLowerCase() : EXPRESS_FORWARDED_HEADER;
+  return header === EXPRESS_FORWARDED_HEADER ? 1 : false;
+}
+var EXPRESS_FORWARDED_HEADER = "x-forwarded-for";
+
 // src/listener.ts
 import { existsSync as existsSync2, writeFileSync } from "node:fs";
 import * as HTTP from "node:http";
@@ -196134,6 +196179,11 @@ class Listener {
   }
   static initExpress() {
     const app = import_express3.default();
+    const trustProxy = resolveTrustProxy(config_default.get("sockethub:trustProxy"), config_default.get("credentialCheck:reconnectIpSource"), config_default.get("credentialCheck:proxyHeader"));
+    app.set("trust proxy", trustProxy);
+    if (trustProxy !== false) {
+      log9.info(`trusting proxy headers (trust proxy: ${trustProxy})`);
+    }
     app.set("view engine", "ejs");
     app.use(import_express3.default.urlencoded({ extended: true }));
     return app;
@@ -196156,7 +196206,7 @@ var init_listener = __esm(() => {
   init_config();
   init_cors();
   init_routes();
-  init_version2();
+  init_version();
   import_express3 = __toESM(require_express(), 1);
   require3 = createRequire5(import.meta.url);
   log9 = createLogger("server:listener");
@@ -198270,6 +198320,50 @@ init_src();
 init_error();
 import path5 from "node:path";
 
+// src/cli.ts
+init_version();
+function renderHelp() {
+  return `Sockethub v${SOCKETHUB_VERSION} — a protocol gateway for web applications
+
+Usage: sockethub [options]
+
+Options:
+  -c, --config <path>       Path to a config file (default: ./sockethub.config.json,
+                            or the SOCKETHUB_CONFIG environment variable)
+      --write-config [path] Write a default config file and exit ("-" for stdout,
+                            default: ./sockethub.config.json)
+      --host <host>         Address to bind (config: sockethub.host)
+      --port <port>         Port to bind (config: sockethub.port)
+      --redis.url <url>     Redis connection URL (config: redis.url)
+      --cors.origin <list>  Allowed CORS origin(s), comma-separated
+                            (config: sockethub.cors.origin)
+      --sentry.dsn <dsn>    Sentry DSN to report to (config: sentry.dsn)
+      --sentry-test         Send a test event to Sentry and exit, reporting
+                            whether it was accepted
+      --sentry-test-crash   Report a synthetic fatal error to Sentry and exit
+                            non-zero, exercising the crash-reporting path
+      --examples            Serve the bundled example pages
+      --info                Print runtime information
+  -v, --version             Print the version and exit
+  -h, --help                Print this help and exit
+
+Every config file setting can also be set by environment variable; see
+docs/configuration.md for the full list.
+`;
+}
+function parseInfoFlag(argv) {
+  if (argv.includes("--help") || argv.includes("-h")) {
+    return "help";
+  }
+  if (argv.includes("--version") || argv.includes("-v")) {
+    return "version";
+  }
+  return;
+}
+
+// src/index.ts
+init_version();
+
 // src/write-config.ts
 init_src2();
 init_config_schema();
@@ -198322,19 +198416,43 @@ function writeDefaultConfig(target) {
 var sentry = {
   reportError: (_err) => {}
 };
+async function reportFatal(err, code = 1) {
+  sentry.reportError(err);
+  try {
+    if (await sentry.flush?.() === false) {
+      console.error("fatal-error-flush timed out; event may be lost");
+    }
+  } catch (flushErr) {
+    console.error(`fatal-error-flush failed: ${toError(flushErr).message}`);
+  }
+  process.exit(code);
+}
 async function server() {
-  const writeConfigTarget = parseWriteConfigTarget(process.argv.slice(2));
+  const argv = process.argv.slice(2);
+  const infoFlag = parseInfoFlag(argv);
+  if (infoFlag === "help") {
+    process.stdout.write(renderHelp());
+    process.exitCode = 0;
+    return;
+  }
+  if (infoFlag === "version") {
+    console.log(SOCKETHUB_VERSION);
+    process.exitCode = 0;
+    return;
+  }
+  const writeConfigTarget = parseWriteConfigTarget(argv);
   if (writeConfigTarget !== undefined) {
     try {
       const message = writeDefaultConfig(writeConfigTarget);
       if (message) {
         console.log(message);
       }
-      process.exit(0);
+      process.exitCode = 0;
     } catch (err) {
       console.error(toError(err).message);
-      process.exit(1);
+      process.exitCode = 1;
     }
+    return;
   }
   const { default: config2 } = await Promise.resolve().then(() => (init_config(), exports_config));
   const loggingConfig = config2.get("logging");
@@ -198351,7 +198469,18 @@ async function server() {
     log13.info("initializing sentry");
     sentry = await init_sentry().then(() => exports_sentry);
   }
-  if (process.argv.includes("--sentry-test")) {
+  process.once("uncaughtException", (err) => {
+    const error4 = toError(err);
+    console.error(`${new Date().toUTCString()} UNCAUGHT EXCEPTION
+`, error4.stack);
+    reportFatal(error4);
+  });
+  process.once("unhandledRejection", (err) => {
+    console.error(`${new Date().toUTCString()} UNHANDLED REJECTION
+`, err);
+    reportFatal(toError(err));
+  });
+  if (argv.includes("--sentry-test")) {
     if (!sentry.sendTestEvent) {
       console.error("Sentry is not configured; no test event was sent");
       process.exit(1);
@@ -198360,27 +198489,22 @@ async function server() {
     console.log(sent ? "Sentry test event sent" : "Sentry test event failed");
     process.exit(sent ? 0 : 1);
   }
+  if (argv.includes("--sentry-test-crash")) {
+    if (!sentry.flush) {
+      console.error("Sentry is not configured; no crash was reported");
+      process.exit(1);
+    }
+    console.error("Reporting a synthetic fatal error to Sentry");
+    await reportFatal(new Error("Sockethub Sentry verification crash"));
+  }
   const { default: Sockethub2 } = await Promise.resolve().then(() => (init_sockethub(), exports_sockethub));
   try {
     sockethub = new Sockethub2;
   } catch (err) {
     const error4 = toError(err);
-    sentry.reportError(error4);
     console.error(error4);
-    process.exit(1);
+    await reportFatal(error4);
   }
-  process.once("uncaughtException", (err) => {
-    console.error(`${new Date().toUTCString()} UNCAUGHT EXCEPTION
-`, err.stack);
-    sentry.reportError(err);
-    process.exit(1);
-  });
-  process.once("unhandledRejection", (err) => {
-    console.error(`${new Date().toUTCString()} UNHANDLED REJECTION
-`, err);
-    sentry.reportError(toError(err));
-    process.exit(1);
-  });
   const gracefulShutdown = async (signal) => {
     console.log(`Received ${signal} signal. Shutting down sockethub...`);
     try {
@@ -198388,9 +198512,8 @@ async function server() {
       process.exit(0);
     } catch (err) {
       const error4 = toError(err);
-      sentry.reportError(error4);
       console.error(error4);
-      process.exit(1);
+      await reportFatal(error4);
     }
   };
   process.once("SIGTERM", () => {
@@ -198403,13 +198526,12 @@ async function server() {
     await sockethub.boot();
   } catch (err) {
     const error4 = toError(err);
-    sentry.reportError(error4);
     console.error(error4);
-    process.exit(1);
+    await reportFatal(error4);
   }
 }
 export {
   server
 };
 
-//# debugId=9D0CD875866E8E9864756E2164756E21
+//# debugId=E054626A88B96F6264756E2164756E21