@sockethub/server 5.0.0-alpha.3 → 5.0.0-alpha.6

package/src/listener.ts

@@ -1,13 +1,18 @@
-import debug from 'debug';
-import bodyParser from 'body-parser';
-import express from 'express';
-import * as HTTP from 'http';
-import { Server } from 'socket.io';
+import { existsSync, writeFileSync } from "node:fs";
+import * as HTTP from "node:http";
+import { createRequire } from "node:module";
+import path from "node:path";
+import bodyParser from "body-parser";
+import debug from "debug";
+import express from "express";
+import rateLimit from "express-rate-limit";
+import { Server } from "socket.io";
 
-import config from './config';
-import routes from './routes';
+import config from "./config.js";
+import routes from "./routes.js";
+const require = createRequire(import.meta.url);
 
-const log = debug('sockethub:server:listener');
+const log = debug("sockethub:server:listener");
 
 /**
  * Handles the initialization and access of Sockethub resources.
@@ -17,63 +22,152 @@ const log = debug('sockethub:server:listener');
  *  - Socket.io (bidirectional websocket communication)
  */
 class Listener {
-  io: Server;
-  http: HTTP.Server;
-
-  /**
-   * Starts the services needed for Sockethub to operate. After this command completes,
-   * the `http` and `io` class properties will be set.
-   */
-  start() {
-    // initialize express and socket.io objects
-    const app = Listener.initExpress();
-    this.http = new HTTP.Server(app);
-    this.io = new Server(this.http, {
-      path: config.get('sockethub:path'),
-      cors: {
-        origin: "*",
-        methods: [ "GET", "POST" ]
-      }
-    });
-    routes.setup(app);
-    this.startHttp();
-  }
-
-  private startHttp() {
-    this.http.listen(config.get('sockethub:port'), config.get('sockethub:host'), () => {
-      log(`sockethub listening on ` +
-        `http://${config.get('sockethub:host')}:${config.get('sockethub:port')}`);
-    });
-  };
-
-  private static initExpress() {
-    let app = express();
-    // templating engines
-    app.set('view engine', 'ejs');
-    // use bodyParser
-    app.use(bodyParser.urlencoded({extended: true}));
-    app.use(bodyParser.json());
-    return app;
-  }
+    io: Server;
+    http: HTTP.Server;
+
+    /**
+     * Starts the services needed for Sockethub to operate. After this command completes,
+     * the `http` and `io` class properties will be set.
+     */
+    start() {
+        // initialize express and socket.io objects
+        const app = Listener.initExpress();
+        this.http = new HTTP.Server(app);
+        this.io = new Server(this.http, {
+            path: config.get("sockethub:path") as string,
+            cors: {
+                origin: "*",
+                methods: ["GET", "POST"],
+            },
+        });
+
+        routes.setup(app);
+
+        if (config.get("examples")) {
+            this.addExamplesRoutes(app);
+        }
+
+        this.startHttp();
+    }
+
+    /**
+     * Resolves the path to the examples static files from @sockethub/examples package.
+     * Returns null if the package is not installed.
+     */
+    private resolveExamplesPath(): string | null {
+        try {
+            const examplesPkgPath = require.resolve(
+                "@sockethub/examples/package.json",
+            );
+            const examplesDir = path.join(
+                path.dirname(examplesPkgPath),
+                "build",
+            );
+            if (existsSync(examplesDir)) {
+                log(
+                    `examples resolved from @sockethub/examples: ${examplesDir}`,
+                );
+                return examplesDir;
+            }
+            log(
+                `@sockethub/examples found but build directory missing: ${examplesDir}`,
+            );
+            return null;
+        } catch {
+            return null;
+        }
+    }
+
+    private addExamplesRoutes(app) {
+        const examplesPath = this.resolveExamplesPath();
+
+        if (!examplesPath) {
+            console.error(
+                "\n❌ Error: --examples flag requires @sockethub/examples package\n\n" +
+                    "The examples package is not installed. To use the examples feature, install it:\n\n" +
+                    "  bun add @sockethub/examples\n\n" +
+                    "Or run sockethub without the --examples flag.\n",
+            );
+            process.exit(1);
+        }
+
+        // Set up rate limiter to prevent DoS attacks on file system access
+        const limiter = rateLimit({
+            windowMs: 1 * 60 * 1000, // 1 minute
+            max: 60, // max 60 requests per windowMs
+            standardHeaders: true,
+            legacyHeaders: false,
+        });
+
+        // Write runtime config for the examples app
+        writeFileSync(
+            path.join(examplesPath, "config.json"),
+            JSON.stringify({
+                sockethub: config.get("sockethub"),
+                public: config.get("public"),
+            }),
+        );
+
+        app.use(express.static(examplesPath));
+
+        const examplesIndex = path.join(examplesPath, "index.html");
+        app.get("*", limiter, (req, res) => {
+            res.sendFile(examplesIndex);
+        });
+
+        log(
+            `examples served at http://${config.get("sockethub:host")}:${config.get(
+                "sockethub:port",
+            )}`,
+        );
+    }
+
+    private startHttp() {
+        this.http.listen(
+            config.get("sockethub:port"),
+            config.get("sockethub:host") as number,
+            () => {
+                log(
+                    `sockethub listening on ws://${config.get("sockethub:host")}:${config.get(
+                        "sockethub:port",
+                    )}`,
+                );
+            },
+        );
+    }
+
+    private static initExpress() {
+        const app = express();
+        // templating engines
+        app.set("view engine", "ejs");
+        // use bodyParser
+        app.use(bodyParser.urlencoded({ extended: true }));
+        app.use(bodyParser.json());
+        return app;
+    }
 }
 
 const listener = new Listener();
 
+interface EmitFunction {
+    (type: string, data: unknown);
+}
+
 export interface SocketInstance {
-  id: string;
-  emit: Function;
+    id: string;
+    emit: EmitFunction;
 }
 
 export async function getSocket(sessionId: string): Promise<SocketInstance> {
-  const sockets: Array<SocketInstance> = await listener.io.fetchSockets();
-  return new Promise((resolve, reject) => {
-    for (let socket of sockets) {
-      if (sessionId === socket.id) {
-        return resolve(socket);
-      }
-    }
-    return reject(`unable to find socket for sessionId ${sessionId}`);
-  });
+    const sockets: Array<SocketInstance> = await listener.io.fetchSockets();
+    return new Promise((resolve, reject) => {
+        for (const socket of sockets) {
+            if (sessionId === socket.id) {
+                return resolve(socket);
+            }
+        }
+        return reject(`unable to find socket for sessionId ${sessionId}`);
+    });
 }
 
 export default listener;

package/src/middleware/create-activity-object.test.ts

@@ -1,10 +1,30 @@
-import createActivityObject from "./create-activity-object";
+import { describe, expect, it } from "bun:test";
+import createActivityObject from "./create-activity-object.js";
 
-describe('Middleware: createActivityObject', () => {
-  it('Calls activity.Object.create with incoming data', (done) => {
-    // @ts-ignore
-    createActivityObject({foo: 'bar'}, (msg) => {
-      done();
+describe("Middleware: createActivityObject", () => {
+    it("Calls activity.Object.create and fails with invalid property", async () => {
+        expect(() => {
+            createActivityObject({ foo: "bar" }, (o) => {
+                expect(o).not.toEqual({ foo: "bar" });
+            });
+        }).toThrow("ActivityStreams validation failed: the \"object\" property requires an 'id' property. Example: { id: \"user@example.com\", type: \"person\" }");
     });
-  });
-});
+    it("Calls activity.Object.create with incoming data", async () => {
+        createActivityObject(
+            {
+                id: "test",
+                context: "foo",
+                type: "bar",
+                content: "some text",
+            },
+            (o) => {
+                expect(o).toEqual({
+                    id: "test",
+                    context: "foo",
+                    type: "bar",
+                    content: "some text",
+                });
+            },
+        );
+    });
+});

package/src/middleware/create-activity-object.ts

@@ -1,13 +1,22 @@
-import ActivityStreams from '@sockethub/activity-streams';
-import config from "../config";
-const activity = ActivityStreams(config.get('activity-streams:opts'));
+import { ASFactory } from "@sockethub/activity-streams";
+import type { ActivityObject } from "@sockethub/schemas";
+
+import config from "../config.js";
+import type { MiddlewareChainInterface } from "../middleware.js";
+
+const activity = ASFactory(
+    config.get("packageConfig:@sockethub/activity-streams"),
+);
 
 /**
- * A simple middleware wrapper for the activity-streams Object.create method.
+ * A simple middleware wrapper for the activity-streams `Object.create` method.
  * @param obj
  * @param done
  */
-export default function createActivityObject(obj: any, done: Function) {
-  activity.Object.create(obj);
-  done(obj);
-}
+export default function createActivityObject(
+    obj: ActivityObject,
+    done: MiddlewareChainInterface,
+) {
+    activity.Object.create(obj);
+    done(obj);
+}