@pkcprotocol/pkc-js 0.0.11

package/dist/node/test/node/hanging-test/scenarios/comment-update.scenario.js

@@ -0,0 +1,22 @@
+import { resolveWhenConditionIsTrue } from "../../../test-util.js";
+import { createScenarioContext, defineHangingScenario } from "./hanging-test-util.js";
+/**
+ * Template scenario showing the shape expected by the hanging test harness.
+ * Replace the placeholder steps with the flow you want to exercise before
+ * checking for lingering resources. Make sure any asynchronous work is awaited
+ * so the destroy call can flush everything properly.
+ */
+export default defineHangingScenario({
+    id: "comment-update",
+    description: "Fetch community, update a comment and destroy pkc",
+    run: async ({ configCode }) => {
+        const communityAddress = "12D3KooWN5rLmRJ8fWMwTtkDN7w2RgPPGRM4mtWTnfbjpi1Sh7zR";
+        const { pkc, config } = await createScenarioContext(configCode);
+        const community = await pkc.getCommunity({ address: communityAddress });
+        const post = await pkc.createComment({ cid: community.lastPostCid });
+        await post.update();
+        await resolveWhenConditionIsTrue({ toUpdate: post, predicate: async () => typeof post.updatedAt === "number" });
+        await pkc.destroy();
+    }
+});
+//# sourceMappingURL=comment-update.scenario.js.map

package/dist/node/test/node/hanging-test/scenarios/comment-update.scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment-update.scenario.js","sourceRoot":"","sources":["../../../../../../src/test/node/hanging-test/scenarios/comment-update.scenario.ts"],"names":[],"mappings":"AAAA,OAAO,EAAqB,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACtF,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEtF;;;;;GAKG;AACH,eAAe,qBAAqB,CAAC;IACjC,EAAE,EAAE,gBAAgB;IACpB,WAAW,EAAE,mDAAmD;IAChE,GAAG,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;QAC1B,MAAM,gBAAgB,GAAG,sDAAsD,CAAC;QAChF,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAEhE,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAExE,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,SAAS,CAAC,WAAY,EAAE,CAAC,CAAC;QACtE,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,0BAA0B,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,IAAI,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC,CAAC;QAEhH,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;CACJ,CAAC,CAAC"}

package/dist/node/test/node/hanging-test/scenarios/community-start.scenario.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Template scenario showing the shape expected by the hanging test harness.
+ * Replace the placeholder steps with the flow you want to exercise before
+ * checking for lingering resources. Make sure any asynchronous work is awaited
+ * so the destroy call can flush everything properly.
+ */
+declare const _default: import("./hanging-test-util.js").HangingScenarioDefinition;
+export default _default;

package/dist/node/test/node/hanging-test/scenarios/community-start.scenario.js

@@ -0,0 +1,23 @@
+import { resolveWhenConditionIsTrue } from "../../../test-util.js";
+import { createScenarioContext, defineHangingScenario } from "./hanging-test-util.js";
+/**
+ * Template scenario showing the shape expected by the hanging test harness.
+ * Replace the placeholder steps with the flow you want to exercise before
+ * checking for lingering resources. Make sure any asynchronous work is awaited
+ * so the destroy call can flush everything properly.
+ */
+export default defineHangingScenario({
+    id: "community-start",
+    description: "start a community and destroy pkc",
+    run: async ({ configCode }) => {
+        const allowedConfigCodes = ["local-kubo-rpc", "remote-pkc-rpc"];
+        if (!allowedConfigCodes.includes(configCode))
+            return;
+        const { pkc, config } = await createScenarioContext(configCode);
+        const community = await pkc.createCommunity();
+        await community.start();
+        await resolveWhenConditionIsTrue({ toUpdate: community, predicate: async () => typeof community.updatedAt === "number" });
+        await pkc.destroy();
+    }
+});
+//# sourceMappingURL=community-start.scenario.js.map

package/dist/node/test/node/hanging-test/scenarios/community-start.scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"community-start.scenario.js","sourceRoot":"","sources":["../../../../../../src/test/node/hanging-test/scenarios/community-start.scenario.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEtF;;;;;GAKG;AACH,eAAe,qBAAqB,CAAC;IACjC,EAAE,EAAE,iBAAiB;IACrB,WAAW,EAAE,mCAAmC;IAChD,GAAG,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;QAC1B,MAAM,kBAAkB,GAAG,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;QAChE,IAAI,CAAC,kBAAkB,CAAC,QAAQ,CAAC,UAAU,CAAC;YAAE,OAAO;QACrD,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAEhE,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,eAAe,EAAE,CAAC;QAE9C,MAAM,SAAS,CAAC,KAAK,EAAE,CAAC;QACxB,MAAM,0BAA0B,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,SAAS,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC,CAAC;QAE1H,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;CACJ,CAAC,CAAC"}

package/dist/node/test/node/hanging-test/scenarios/community-update.scenario.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Template scenario showing the shape expected by the hanging test harness.
+ * Replace the placeholder steps with the flow you want to exercise before
+ * checking for lingering resources. Make sure any asynchronous work is awaited
+ * so the destroy call can flush everything properly.
+ */
+declare const _default: import("./hanging-test-util.js").HangingScenarioDefinition;
+export default _default;

package/dist/node/test/node/hanging-test/scenarios/community-update.scenario.js

@@ -0,0 +1,21 @@
+import { resolveWhenConditionIsTrue } from "../../../test-util.js";
+import { createScenarioContext, defineHangingScenario } from "./hanging-test-util.js";
+/**
+ * Template scenario showing the shape expected by the hanging test harness.
+ * Replace the placeholder steps with the flow you want to exercise before
+ * checking for lingering resources. Make sure any asynchronous work is awaited
+ * so the destroy call can flush everything properly.
+ */
+export default defineHangingScenario({
+    id: "community-update",
+    description: "update a community and destroy pkc",
+    run: async ({ configCode }) => {
+        const communityAddress = "12D3KooWN5rLmRJ8fWMwTtkDN7w2RgPPGRM4mtWTnfbjpi1Sh7zR";
+        const { pkc, config } = await createScenarioContext(configCode);
+        const community = await pkc.createCommunity({ address: communityAddress });
+        await community.update();
+        await resolveWhenConditionIsTrue({ toUpdate: community, predicate: async () => typeof community.updatedAt === "number" });
+        await pkc.destroy();
+    }
+});
+//# sourceMappingURL=community-update.scenario.js.map

package/dist/node/test/node/hanging-test/scenarios/community-update.scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"community-update.scenario.js","sourceRoot":"","sources":["../../../../../../src/test/node/hanging-test/scenarios/community-update.scenario.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEtF;;;;;GAKG;AACH,eAAe,qBAAqB,CAAC;IACjC,EAAE,EAAE,kBAAkB;IACtB,WAAW,EAAE,oCAAoC;IACjD,GAAG,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;QAC1B,MAAM,gBAAgB,GAAG,sDAAsD,CAAC;QAChF,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAEhE,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC,EAAE,OAAO,EAAE,gBAAgB,EAAE,CAAC,CAAC;QAE3E,MAAM,SAAS,CAAC,MAAM,EAAE,CAAC;QACzB,MAAM,0BAA0B,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC,OAAO,SAAS,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC,CAAC;QAE1H,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;CACJ,CAAC,CAAC"}

package/dist/node/test/node/hanging-test/scenarios/destroy-only.scenario.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Baseline scenario that simply exercises the PKC lifecycle.
+ * The scenario itself is responsible for destroying the instance so the test
+ * harness can measure whether anything keeps the process or worker alive.
+ */
+declare const _default: import("./hanging-test-util.js").HangingScenarioDefinition;
+export default _default;

package/dist/node/test/node/hanging-test/scenarios/destroy-only.scenario.js

@@ -0,0 +1,15 @@
+import { createScenarioContext, defineHangingScenario } from "./hanging-test-util.js";
+/**
+ * Baseline scenario that simply exercises the PKC lifecycle.
+ * The scenario itself is responsible for destroying the instance so the test
+ * harness can measure whether anything keeps the process or worker alive.
+ */
+export default defineHangingScenario({
+    id: "destroy-only",
+    description: "instantiate a PKC client and destroy it",
+    run: async ({ configCode }) => {
+        const { pkc } = await createScenarioContext(configCode);
+        await pkc.destroy();
+    }
+});
+//# sourceMappingURL=destroy-only.scenario.js.map

package/dist/node/test/node/hanging-test/scenarios/destroy-only.scenario.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"destroy-only.scenario.js","sourceRoot":"","sources":["../../../../../../src/test/node/hanging-test/scenarios/destroy-only.scenario.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAEtF;;;;GAIG;AACH,eAAe,qBAAqB,CAAC;IACjC,EAAE,EAAE,cAAc;IAClB,WAAW,EAAE,yCAAyC;IACtD,GAAG,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE;QAC1B,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,qBAAqB,CAAC,UAAU,CAAC,CAAC;QAExD,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;CACJ,CAAC,CAAC"}

package/dist/node/test/node/hanging-test/scenarios/hanging-test-util.d.ts

@@ -0,0 +1,30 @@
+import type { PKC } from "../../../../pkc/pkc.js";
+/**
+ * Arguments supplied to each hanging-test scenario from the test harness.
+ * `configCode` maps to one of the entries returned by
+ * `getAvailablePKCConfigsToTestAgainst`.
+ */
+export interface HangingScenarioArgs {
+    configCode: string;
+}
+/**
+ * Resolved context after looking up the config and instantiating a PKC
+ * instance. Scenarios should call `createScenarioContext` and make sure to
+ * `await pkc.destroy()` in a finally block once their work is done.
+ */
+export interface HangingScenarioContext {
+    pkc: PKC;
+    config: {
+        name: string;
+        testConfigCode: string;
+    };
+}
+export type HangingScenario = (args: HangingScenarioArgs) => Promise<void>;
+export interface HangingScenarioDefinition {
+    id: string;
+    description: string;
+    run: HangingScenario;
+}
+export declare function defineHangingScenario(definition: HangingScenarioDefinition): HangingScenarioDefinition;
+export declare function resolveHangingScenarioModule(moduleNamespace: unknown, moduleId: string): HangingScenarioDefinition;
+export declare function createScenarioContext(configCode: string): Promise<HangingScenarioContext>;

package/dist/node/test/node/hanging-test/scenarios/hanging-test-util.js

@@ -0,0 +1,46 @@
+import { getAvailablePKCConfigsToTestAgainst } from "../../../test-util.js";
+export function defineHangingScenario(definition) {
+    if (!definition || typeof definition !== "object") {
+        throw new Error("defineHangingScenario: definition must be an object");
+    }
+    const { id, description, run } = definition;
+    if (typeof id !== "string" || !id.trim()) {
+        throw new Error("defineHangingScenario: id is required");
+    }
+    if (typeof description !== "string" || !description.trim()) {
+        throw new Error("defineHangingScenario: description is required");
+    }
+    if (typeof run !== "function") {
+        throw new Error("defineHangingScenario: run must be a function");
+    }
+    const normalizedDefinition = {
+        id: id.trim(),
+        description: description.trim(),
+        run
+    };
+    return normalizedDefinition;
+}
+export function resolveHangingScenarioModule(moduleNamespace, moduleId) {
+    const candidate = moduleNamespace?.default ?? moduleNamespace?.scenario ?? moduleNamespace?.hangingScenario ?? null;
+    if (!candidate) {
+        throw new Error(`Hanging scenario module "${moduleId}" does not export a default, "scenario", or "hangingScenario" definition`);
+    }
+    return defineHangingScenario(candidate);
+}
+export async function createScenarioContext(configCode) {
+    const configs = getAvailablePKCConfigsToTestAgainst();
+    const config = configs.find((candidate) => candidate.testConfigCode === configCode);
+    if (!config) {
+        const available = configs.map((candidate) => candidate.testConfigCode).join(", ");
+        throw new Error(`Unknown PKC config code "${configCode}". Available configs: ${available}`);
+    }
+    const pkc = await config.pkcInstancePromise({ forceMockPubsub: true });
+    return {
+        pkc,
+        config: {
+            name: config.name,
+            testConfigCode: config.testConfigCode
+        }
+    };
+}
+//# sourceMappingURL=hanging-test-util.js.map

package/dist/node/test/node/hanging-test/scenarios/hanging-test-util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hanging-test-util.js","sourceRoot":"","sources":["../../../../../../src/test/node/hanging-test/scenarios/hanging-test-util.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mCAAmC,EAAE,MAAM,uBAAuB,CAAC;AAgC5E,MAAM,UAAU,qBAAqB,CAAC,UAAqC;IACvE,IAAI,CAAC,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;IAC3E,CAAC;IAED,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,UAAU,CAAC;IAC5C,IAAI,OAAO,EAAE,KAAK,QAAQ,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;QACvC,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC7D,CAAC;IACD,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;QACzD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;IACtE,CAAC;IACD,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE,CAAC;QAC5B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACrE,CAAC;IAED,MAAM,oBAAoB,GAA8B;QACpD,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE;QACb,WAAW,EAAE,WAAW,CAAC,IAAI,EAAE;QAC/B,GAAG;KACN,CAAC;IAEF,OAAO,oBAAoB,CAAC;AAChC,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,eAAwB,EAAE,QAAgB;IACnF,MAAM,SAAS,GACV,eAAuB,EAAE,OAAO,IAAK,eAAuB,EAAE,QAAQ,IAAK,eAAuB,EAAE,eAAe,IAAI,IAAI,CAAC;IAEjI,IAAI,CAAC,SAAS,EAAE,CAAC;QACb,MAAM,IAAI,KAAK,CAAC,4BAA4B,QAAQ,0EAA0E,CAAC,CAAC;IACpI,CAAC;IAED,OAAO,qBAAqB,CAAC,SAAsC,CAAC,CAAC;AACzE,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAAC,UAAkB;IAC1D,MAAM,OAAO,GAAG,mCAAmC,EAAE,CAAC;IACtD,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,cAAc,KAAK,UAAU,CAAC,CAAC;IACpF,IAAI,CAAC,MAAM,EAAE,CAAC;QACV,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClF,MAAM,IAAI,KAAK,CAAC,4BAA4B,UAAU,yBAAyB,SAAS,EAAE,CAAC,CAAC;IAChG,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,kBAAkB,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC,CAAC;IACvE,OAAO;QACH,GAAG;QACH,MAAM,EAAE;YACJ,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,cAAc,EAAE,MAAM,CAAC,cAAc;SACxC;KACJ,CAAC;AACN,CAAC"}