@sockethub/server 5.0.0-alpha.10

package/src/middleware/expand-activity-stream.test.data.ts

@@ -0,0 +1,351 @@
+export default [
+    {
+        name: "not an object",
+        valid: false,
+        type: "message",
+        input: "hello world",
+        error: "Error: message received is not an object.",
+    },
+    {
+        name: "basic invalid type",
+        valid: true,
+        type: "credentials",
+        input: {
+            id: "foo",
+            type: "send",
+            context: "dummy",
+            actor: {
+                id: "dood@irc.freenode.net",
+                type: "person",
+                name: "dood",
+            },
+            target: {
+                id: "irc.freenode.net/service",
+                type: "person",
+                name: "service",
+            },
+            object: {
+                type: "credentials",
+            },
+        },
+        output: "same",
+    },
+    {
+        name: "basic valid type",
+        valid: true,
+        type: "credentials",
+        input: {
+            id: "foo",
+            type: "credentials",
+            context: "dummy",
+            actor: {
+                id: "dood@irc.freenode.net",
+                type: "person",
+                name: "dood",
+            },
+            target: {
+                id: "irc.freenode.net/service",
+                type: "person",
+                name: "service",
+            },
+            object: {
+                type: "credentials",
+            },
+        },
+        output: "same",
+    },
+    {
+        name: "new format",
+        valid: true,
+        type: "credentials",
+        input: {
+            type: "credentials",
+            context: "irc",
+            actor: {
+                id: "sh-9K3Vk@irc.freenode.net",
+                type: "person",
+                name: "sh-9K3Vk",
+                image: {
+                    height: 250,
+                    mediaType: "image/jpeg",
+                    url: "https://example.org/image.jpg",
+                    width: 250,
+                },
+                url: "https://sockethub.org",
+            },
+            object: {
+                type: "credentials",
+                nick: "sh-9K3Vk",
+                port: 6667,
+                secure: false,
+                server: "irc.freenode.net",
+            },
+        },
+        output: "same",
+    },
+    {
+        name: "no type specified",
+        valid: false,
+        type: "credentials",
+        input: {
+            actor: "hyper_rau@localhost",
+            context: "xmpp",
+            object: {
+                username: "hyper_rau",
+                password: "123",
+                server: "localhost",
+                port: 5222,
+                resource: "laptop",
+            },
+        },
+        error: "Error: activity stream must contain a type property.",
+    },
+    {
+        name: "expand unknown actor",
+        type: "message",
+        valid: "true",
+        input: {
+            context: "foo",
+            type: "bar",
+            actor: "foo@bar",
+            object: {
+                content: "bar",
+            },
+        },
+        output: {
+            context: "foo",
+            type: "bar",
+            actor: {
+                id: "foo@bar",
+            },
+            object: {
+                content: "bar",
+            },
+        },
+    },
+    {
+        name: "expand unknown actor 2",
+        type: "message",
+        valid: "true",
+        input: {
+            context: "foo",
+            type: "bar",
+            actor: "someone@example.org/resource",
+            object: {
+                content: "bar",
+            },
+        },
+        output: {
+            context: "foo",
+            type: "bar",
+            actor: {
+                id: "someone@example.org/resource",
+            },
+            object: {
+                content: "bar",
+            },
+        },
+    },
+    {
+        name: "expand unknown actor 2",
+        type: "message",
+        valid: "true",
+        input: {
+            context: "foo",
+            type: "bar",
+            actor: "xmpp:someone@example.org/resource",
+            object: {
+                content: "bar",
+            },
+        },
+        output: {
+            context: "foo",
+            type: "bar",
+            actor: {
+                id: "xmpp:someone@example.org/resource",
+            },
+            object: {
+                content: "bar",
+            },
+        },
+    },
+    {
+        name: "person",
+        type: "message",
+        valid: true,
+        input: {
+            context: "some context",
+            type: "some type",
+            actor: "blah",
+            object: {},
+        },
+        output: {
+            context: "some context",
+            type: "some type",
+            actor: {
+                id: "blah",
+                type: "person",
+                name: "dood",
+            },
+            object: {},
+        },
+    },
+    {
+        name: "person with extras",
+        valid: true,
+        type: "message",
+        input: {
+            context: "some context",
+            type: "some type",
+            actor: "blah2",
+            object: {},
+        },
+        output: {
+            context: "some context",
+            type: "some type",
+            actor: {
+                id: "blah2",
+                type: "person",
+                name: "bob",
+                hello: "there",
+                i: ["am", "extras"],
+            },
+            object: {},
+        },
+    },
+    {
+        name: "bad parent object",
+        valid: false,
+        type: "message",
+        input: {
+            string: "this is a string",
+            array: [
+                "this",
+                "is",
+                {
+                    an: "array",
+                },
+            ],
+            as: {
+                id: "blah",
+                type: "send",
+                context: "hello",
+                actor: {
+                    name: "dood",
+                },
+                target: {
+                    type: "person",
+                    name: "bob",
+                },
+                object: {
+                    type: "credentials",
+                },
+            },
+            noId: {
+                name: "dood",
+            },
+            noId2: {
+                type: "person",
+                name: "bob",
+            },
+            noDisplayName: {
+                id: "larg",
+            },
+        },
+        error: "Error: activity stream must contain a context property",
+    },
+    {
+        name: "no actor specified",
+        valid: false,
+        type: "message",
+        input: {
+            type: "some type",
+            context: "xmpp",
+            object: {
+                type: "error",
+                content: "error message",
+            },
+        },
+        error: "Error: activity stream must contain an actor property.",
+    },
+    {
+        name: "expand actor and target of unknowns",
+        valid: true,
+        type: "message",
+        input: {
+            actor: "irc://uuu@localhost",
+            type: "join",
+            context: "irc",
+            target: "irc://irc.dooder.net/a-room",
+        },
+        output: {
+            actor: {
+                id: "irc://uuu@localhost",
+            },
+            type: "join",
+            context: "irc",
+            target: {
+                id: "irc://irc.dooder.net/a-room",
+            },
+        },
+    },
+    {
+        name: "expand actor and target of unknowns",
+        valid: true,
+        type: "message",
+        input: {
+            actor: "hyper_rau@localhost",
+            type: "join",
+            context: "xmpp",
+            object: {},
+            target: "dooder",
+        },
+        output: {
+            actor: {
+                id: "hyper_rau@localhost",
+            },
+            type: "join",
+            context: "xmpp",
+            object: {},
+            target: {
+                id: "dooder",
+            },
+        },
+    },
+    {
+        name: "expand known person",
+        valid: true,
+        type: "message",
+        input: {
+            actor: "sh-9K3Vk@irc.freenode.net",
+            target: "blah3",
+            type: "send",
+            context: "irc",
+            object: {},
+        },
+        output: {
+            actor: {
+                id: "sh-9K3Vk@irc.freenode.net",
+                type: "person",
+                name: "sh-9K3Vk",
+                image: {
+                    height: 250,
+                    mediaType: "image/jpeg",
+                    url: "https://example.org/image.jpg",
+                    width: 250,
+                },
+                url: "https://sockethub.org",
+            },
+            target: {
+                id: "blah3",
+                type: "person",
+                name: "bob",
+                hello: "there",
+                i: ["am", "extras"],
+            },
+            type: "send",
+            context: "irc",
+            object: {},
+        },
+    },
+];

package/src/middleware/expand-activity-stream.test.ts

@@ -0,0 +1,77 @@
+import { describe, expect, it } from "bun:test";
+
+import expandActivityStream from "./expand-activity-stream.js";
+
+import { ASFactory } from "@sockethub/activity-streams";
+import asObjects from "./expand-activity-stream.test.data.js";
+import { ActivityStream } from "@sockethub/schemas";
+
+const activity = ASFactory();
+
+// register known activity objects
+[
+    {
+        id: "blah",
+        type: "person",
+        name: "dood",
+    },
+    {
+        id: "blah2",
+        type: "person",
+        name: "bob",
+        hello: "there",
+        i: ["am", "extras"],
+    },
+    {
+        id: "sh-9K3Vk@irc.freenode.net",
+        type: "person",
+        name: "sh-9K3Vk",
+        image: {
+            height: 250,
+            mediaType: "image/jpeg",
+            url: "https://example.org/image.jpg",
+            width: 250,
+        },
+        url: "https://sockethub.org",
+    },
+    {
+        id: "blah3",
+        type: "person",
+        name: "bob",
+        hello: "there",
+        i: ["am", "extras"],
+    },
+].forEach((obj) => {
+    activity.Object.create(obj);
+});
+
+describe("Middleware: Expand Activity Stream", () => {
+    describe("AS object expansion", () => {
+        asObjects.forEach((obj) => {
+            it(`${obj.type}: ${obj.name}, should ${
+                obj.valid ? "pass" : "fail"
+            }`, (done) => {
+                expandActivityStream(obj.input as ActivityStream, (msg) => {
+                    if (obj.output) {
+                        if (obj.output === "same") {
+                            // @ts-ignore
+                            expect(obj.input).toEqual(msg);
+                        } else {
+                            // @ts-ignore
+                            expect(obj.output).toEqual(msg);
+                        }
+                    }
+                    if (obj.valid) {
+                        expect(msg instanceof Error).toBeFalse();
+                    } else {
+                        expect(msg instanceof Error).toBeTrue();
+                        if (obj.error) {
+                            expect(obj.error).toEqual(msg.toString());
+                        }
+                    }
+                    done();
+                });
+            });
+        });
+    });
+});

package/src/middleware/expand-activity-stream.ts

@@ -0,0 +1,37 @@
+import { ASFactory, type ASFactoryOptions } from "@sockethub/activity-streams";
+import type { ActivityStream } from "@sockethub/schemas";
+
+import config from "../config.js";
+import type { MiddlewareChainInterface } from "../middleware.js";
+
+const asConfig = config.get(
+    "packageConfig:@sockethub/activity-streams",
+) as ASFactoryOptions;
+asConfig.warnOnUnknownObjectProperties = false;
+asConfig.failOnUnknownObjectProperties = false;
+
+const activity = ASFactory(asConfig);
+
+function ensureObject(msg: unknown) {
+    return !(typeof msg !== "object" || Array.isArray(msg));
+}
+
+export default function expandActivityStream(
+    msg: ActivityStream,
+    done: MiddlewareChainInterface,
+) {
+    if (!ensureObject(msg)) {
+        done(new Error("message received is not an object."));
+    } else if (typeof msg.context !== "string") {
+        done(new Error("activity stream must contain a context property"));
+    } else if (typeof msg.type !== "string") {
+        done(new Error("activity stream must contain a type property."));
+    } else {
+        const msgStream = activity.Stream(msg) as ActivityStream;
+        if (!msgStream.actor) {
+            done(new Error("activity stream must contain an actor property."));
+        } else {
+            done(msgStream);
+        }
+    }
+}

package/src/middleware/store-credentials.test.ts

@@ -0,0 +1,85 @@
+import { afterEach, beforeEach, describe, expect, it } from "bun:test";
+import * as sinon from "sinon";
+
+import type { CredentialsObject } from "@sockethub/schemas";
+import storeCredentials from "./store-credentials.js";
+
+const creds: CredentialsObject = {
+    type: "credentials",
+    context: "dummy",
+    actor: {
+        id: "dood@irc.freenode.net",
+        type: "person",
+        name: "dood",
+    },
+    target: {
+        id: "irc.freenode.net/service",
+        type: "person",
+        name: "service",
+    },
+    object: {
+        type: "credentials",
+    },
+};
+
+describe("Middleware: storeCredentials", () => {
+    let storeSuccess: any,
+        storeError: any,
+        saveErrorFake: any,
+        saveSuccessFake: any;
+
+    beforeEach(() => {
+        storeSuccess = {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            save: async (id: any, creds: any) => {
+                return Promise.resolve();
+            },
+        };
+        storeError = {
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            save: (id: any, creds: any): Promise<void> => {
+                throw new Error("some error");
+            },
+        };
+        saveSuccessFake = sinon.replace(
+            storeSuccess,
+            "save",
+            sinon.fake(storeSuccess.save),
+        );
+        saveErrorFake = sinon.replace(
+            storeError,
+            "save",
+            sinon.fake(storeError.save),
+        );
+    });
+
+    afterEach(() => {
+        sinon.reset();
+    });
+
+    it("returns a middleware handler", () => {
+        const sc = storeCredentials(storeSuccess);
+        expect(typeof sc).toEqual("function");
+        expect(saveSuccessFake.callCount).toEqual(0);
+    });
+
+    it("successfully stores credentials", (done) => {
+        const sc = storeCredentials(storeSuccess);
+        sc(creds as CredentialsObject, (err: any) => {
+            expect(saveSuccessFake.callCount).toEqual(1);
+            expect(saveSuccessFake.firstArg).toEqual(creds.actor.id);
+            expect(err).toEqual(creds);
+            done();
+        });
+    });
+
+    it("handle error while storing credentials", (done) => {
+        const sc = storeCredentials(storeError);
+        sc(creds as CredentialsObject, (err: any) => {
+            expect(saveErrorFake.callCount).toEqual(1);
+            expect(saveErrorFake.firstArg).toEqual(creds.actor.id);
+            expect(err.toString()).toEqual("Error: some error");
+            done();
+        });
+    });
+});

package/src/middleware/store-credentials.ts

@@ -0,0 +1,16 @@
+import type { CredentialsStoreInterface } from "@sockethub/data-layer";
+import type { CredentialsObject } from "@sockethub/schemas";
+
+import type { MiddlewareChainInterface } from "../middleware.js";
+
+export default function storeCredentials(store: CredentialsStoreInterface) {
+    return (creds: CredentialsObject, done: MiddlewareChainInterface) => {
+        try {
+            store.save(creds.actor.id, creds).then(() => {
+                done(creds);
+            });
+        } catch (err) {
+            done(err);
+        }
+    };
+}