@resonatehq/sdk 0.11.4 → 0.11.5

package/dist/src/resonate.d.ts

@@ -24,7 +24,6 @@ export declare class Resonate {
     private clock;
     private pid;
     private ttl;
-    private idPrefix;
     private core;
     private codec;
     private network;
@@ -57,10 +56,8 @@ export declare class Resonate {
      * @param options.logger - Custom logger implementation. Defaults to {@link ConsoleLogger}.
      * @param options.encryptor - Payload encryptor. Defaults to {@link NoopEncryptor}.
      * @param options.network - Custom network implementation. Defaults to `undefined`.
-     * @param options.prefix - ID prefix applied to generated IDs. Defaults to
-     *   `process.env.RESONATE_PREFIX` when set.
      */
-    constructor({ url, group, pid, ttl, token, timeout, verbose, logLevel, logger, encryptor, network, prefix, }?: {
+    constructor({ url, group, pid, ttl, token, timeout, verbose, logLevel, logger, encryptor, network, }?: {
         url?: string;
         group?: string;
         pid?: string;
@@ -72,7 +69,6 @@ export declare class Resonate {
         logger?: Logger;
         encryptor?: Encryptor;
         network?: Network;
-        prefix?: string;
     });
     /**
      * Registers a function with Resonate for execution and version control.

package/dist/src/resonate.js

@@ -4,6 +4,7 @@ import { Core } from "./core.js";
 import { NoopEncryptor } from "./encryptor.js";
 import exceptions, { ResonateTimeoutException } from "./exceptions.js";
 import { AsyncHeartbeat, NoopHeartbeat } from "./heartbeat.js";
+import { validateRootId } from "./ids.js";
 import { ConsoleLogger } from "./logger.js";
 import { HttpNetwork, PollMessageSource } from "./network/http.js";
 import { LocalNetwork } from "./network/local.js";
@@ -18,7 +19,6 @@ export class Resonate {
     clock;
     pid;
     ttl;
-    idPrefix;
     core;
     codec;
     network;
@@ -51,15 +51,11 @@ export class Resonate {
      * @param options.logger - Custom logger implementation. Defaults to {@link ConsoleLogger}.
      * @param options.encryptor - Payload encryptor. Defaults to {@link NoopEncryptor}.
      * @param options.network - Custom network implementation. Defaults to `undefined`.
-     * @param options.prefix - ID prefix applied to generated IDs. Defaults to
-     *   `process.env.RESONATE_PREFIX` when set.
      */
-    constructor({ url = undefined, group = "default", pid = undefined, ttl = 1 * util.MIN, token = undefined, timeout = undefined, verbose = false, logLevel = undefined, logger = undefined, encryptor = undefined, network = undefined, prefix = undefined, } = {}) {
+    constructor({ url = undefined, group = "default", pid = undefined, ttl = 1 * util.MIN, token = undefined, timeout = undefined, verbose = false, logLevel = undefined, logger = undefined, encryptor = undefined, network = undefined, } = {}) {
         this.clock = new WallClock();
         this.ttl = ttl;
         this.codec = new Codec(encryptor ?? new NoopEncryptor());
-        const resolvedPrefix = prefix ?? getEnv("RESONATE_PREFIX");
-        this.idPrefix = resolvedPrefix ? `${resolvedPrefix}:` : "";
         // Resolve logger: explicit logger > ConsoleLogger with resolved level
         // logLevel takes precedence over verbose; verbose: true -> "debug"
         const resolvedLogLevel = logLevel ?? (verbose ? "debug" : "warn");
@@ -106,7 +102,7 @@ export class Resonate {
         }
         this.registry = new Registry();
         this.dependencies = new Map();
-        this.optsBuilder = new OptionsBuilder({ match: this.network.match.bind(this.network), idPrefix: this.idPrefix });
+        this.optsBuilder = new OptionsBuilder({ match: this.network.match.bind(this.network) });
         this.core = new Core({
             pid: this.pid,
             ttl: this.ttl,
@@ -179,7 +175,11 @@ export class Resonate {
         if (!registered) {
             throw exceptions.REGISTRY_FUNCTION_NOT_REGISTERED(typeof funcOrName === "string" ? funcOrName : funcOrName.name, opts.version);
         }
-        id = `${this.idPrefix}${id}`;
+        // Validated at the call site that named the workflow, rather than
+        // surfacing later as an opaque 400 from the server: the id becomes the
+        // origin of its whole lineage, so ':' is rejected outright ('.' is only
+        // read below the origin).
+        validateRootId(id);
         util.assert(registered.version > 0, "function version must be greater than zero");
         const { promise, task } = await this.taskCreate({
             kind: "task.create",
@@ -204,10 +204,10 @@ export class Resonate {
                         },
                         tags: {
                             ...opts.tags,
+                            // A genuine top-level root is its own lineage origin, so
+                            // origin == branch == parent == id here. Every descendant id
+                            // extends it as `{id}:{lineage}`.
                             "resonate:origin": id,
-                            // A genuine top-level root is its own lineage origin AND its own
-                            // id-generation prefix; the prefix then propagates down unchanged.
-                            "resonate:prefix": id,
                             "resonate:branch": id,
                             "resonate:parent": id,
                             "resonate:scope": "global",
@@ -234,7 +234,7 @@ export class Resonate {
         if (typeof funcOrName === "function" && !registered) {
             throw exceptions.REGISTRY_FUNCTION_NOT_REGISTERED(funcOrName.name, opts.version);
         }
-        id = `${this.idPrefix}${id}`;
+        validateRootId(id);
         const func = registered ? registered.name : funcOrName;
         const version = registered ? registered.version : opts.version || 1;
         const promise = await this.promiseCreate({
@@ -254,10 +254,10 @@ export class Resonate {
                 },
                 tags: {
                     ...opts.tags,
+                    // A genuine top-level root is its own lineage origin, so
+                    // origin == branch == parent == id here. Every descendant id
+                    // extends it as `{id}:{lineage}`.
                     "resonate:origin": id,
-                    // A genuine top-level root is its own lineage origin AND its own
-                    // id-generation prefix; the prefix then propagates down unchanged.
-                    "resonate:prefix": id,
                     "resonate:branch": id,
                     "resonate:parent": id,
                     "resonate:scope": "global",
@@ -280,7 +280,15 @@ export class Resonate {
             args: args,
             version: registered ? registered.version : opts.version || 1,
         });
-        await this.schedules.create(name, cron, `${this.idPrefix}{{.id}}.{{.timestamp}}`, opts.timeout, {
+        // Each firing creates a root promise named from this id, so the schedule
+        // name is bound by the same rules as a run/rpc id. The server stamps the
+        // *whole* templated id onto the fired promise's resonate:origin tag, so
+        // the template must join with a plain '-': a ':' would hide the timestamp
+        // below the origin, collapsing every firing onto one lineage. A '.' is
+        // fine now — it is only read below the origin — but '-' keeps the
+        // timestamp clearly distinct from any dots in the schedule name.
+        validateRootId(name);
+        await this.schedules.create(name, cron, "{{.id}}-{{.timestamp}}", opts.timeout, {
             promiseHeaders: headers,
             promiseData: data,
             promiseTags: { ...opts.tags, "resonate:target": opts.target },
@@ -290,7 +298,8 @@ export class Resonate {
         };
     }
     async get(id) {
-        id = `${this.idPrefix}${id}`;
+        // get is a lookup, not a create: it takes any id, including a child's
+        // (e.g. "wf:1.2"), so it deliberately does NOT validate.
         const promise = await this.promiseGet({
             kind: "promise.get",
             head: { corrId: randomUUID(), version: util.VERSION },
@@ -384,6 +393,14 @@ export class Resonate {
             try {
                 const res = await this.send(req);
                 if (!isSuccess(res)) {
+                    // Listener registration can be retried for transient server pressure,
+                    // but semantic client errors cannot become valid by waiting.
+                    if (res.head.status !== 429 && res.head.status !== 500) {
+                        throw exceptions.SERVER_ERROR(res.data, false, {
+                            code: res.head.status,
+                            message: res.data,
+                        });
+                    }
                     await delay(retryDelay);
                     continue;
                 }
@@ -419,8 +436,12 @@ export class Resonate {
         };
         return {
             id: promise.id,
-            done: () => this.promiseRegisterListener(registerListenerReq).then((res) => res.state !== "pending"),
-            result: () => this.promiseRegisterListener(registerListenerReq).then((res) => this.subscribe(promise.id, res)),
+            done: () => promise.state === "pending"
+                ? this.promiseRegisterListener(registerListenerReq).then((res) => res.state !== "pending")
+                : Promise.resolve(true),
+            result: () => promise.state === "pending"
+                ? this.promiseRegisterListener(registerListenerReq).then((res) => this.subscribe(promise.id, res))
+                : this.subscribe(promise.id, promise),
         };
     }
     onMessage(msg) {

package/dist/src/util.d.ts

@@ -18,7 +18,7 @@ export declare function isUrl(str: string): boolean;
 export declare function base64Encode(str: string): string;
 export declare function base64Decode(str: string): string;
 export declare function semverLessThan(a: string, b: string): boolean;
-export declare function detachedId(prefix: string, seqid: string): string;
+export declare function detachedId(origin: string, seqid: string): string;
 export declare function getCallerInfo(): string;
 export declare function executeWithRetry(ctx: InnerContext, func: Func, args: any[], logger: Logger): Promise<Result<any, any>>;
 export declare function buildEffects(send: Send, codec: Codec, fence: {

package/dist/src/util.js

@@ -1,4 +1,5 @@
 import exceptions from "./exceptions.js";
+import { joinId } from "./ids.js";
 import { isSuccess, } from "./network/types.js";
 import { RESONATE_OPTIONS } from "./options.js";
 import { randomUUID } from "./platform.js";
@@ -82,12 +83,15 @@ function cyrb53(input, seed = 0) {
     h2 ^= Math.imul(h1 ^ (h1 >>> 13), 3266489909);
     return 4294967296 * (2097151 & h2) + (h1 >>> 0);
 }
-export function detachedId(prefix, seqid) {
-    // `${prefix}.d${hash}` -- the `d` marks the segment as a detached child (vs an
-    // rfi child's numeric `.${seq}`). `prefix` is the id-generation prefix
-    // (resonate:prefix), set once at the top and propagated down unchanged, so
-    // recursive detached ids stay bounded at one segment past the prefix.
-    return `${prefix}.d${cyrb53(seqid).toString(16).padStart(14, "0")}`;
+export function detachedId(origin, seqid) {
+    // `${origin}:d${hash}` -- the `d` marks the segment as a detached child (vs a
+    // child's numeric `.${seq}`). `origin` is the lineage origin, set once at the
+    // top and propagated down unchanged forever, so recursive detached ids stay
+    // bounded at one segment past the origin instead of growing a segment per
+    // level. The child keeps the parent's origin rather than re-rooting onto its
+    // own id: the server derives the origin as everything before the first `:`
+    // and requires every id in a lineage to start with `{origin}:`.
+    return joinId(origin, `d${cyrb53(seqid).toString(16).padStart(14, "0")}`);
 }
 export function getCallerInfo() {
     const err = new Error();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resonatehq/sdk",
-  "version": "0.11.4",
+  "version": "0.11.5",
   "description": "TypeScript SDK for Resonate",
   "author": "Resonate Developers",
   "license": "Apache-2.0",