@resonatehq/sdk 0.5.3 → 0.6.0

package/dist/resonate.js

@@ -23,43 +23,32 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResonateBase = void 0;
+exports.InvocationHandle = exports.Context = exports.Resonate = void 0;
 const json_1 = require("./core/encoders/json");
+const errors_1 = require("./core/errors");
 const logger_1 = require("./core/loggers/logger");
 const options_1 = require("./core/options");
-const promises = __importStar(require("./core/promises/promises"));
-const retry_1 = require("./core/retries/retry");
+const durablePromises = __importStar(require("./core/promises/promises"));
+const retryPolicies = __importStar(require("./core/retry"));
+const retry_1 = require("./core/retry");
 const schedules = __importStar(require("./core/schedules/schedules"));
 const local_1 = require("./core/stores/local");
 const remote_1 = require("./core/stores/remote");
 const utils = __importStar(require("./core/utils"));
-/////////////////////////////////////////////////////////////////////
-// Resonate
-/////////////////////////////////////////////////////////////////////
-class ResonateBase {
-    functions = {};
+const utils_1 = require("./core/utils");
+class Resonate {
+    #registeredFunctions = {};
+    #invocationHandles;
+    #interval;
+    store;
+    logger;
+    defaultInvocationOptions;
     promises;
     schedules;
-    pid;
-    poll;
-    timeout;
-    tags;
-    encoder;
-    logger;
-    retry;
-    store;
-    interval;
     constructor({ auth = undefined, encoder = new json_1.JSONEncoder(), heartbeat = 15000, // 15s
-    logger = new logger_1.Logger(), pid = utils.randomId(), poll = 5000, // 5s
-    retry = retry_1.Retry.exponential(), store = undefined, tags = {}, timeout = 10000, // 10s
+    logger = new logger_1.Logger(), pid = utils.randomId(), pollFrequency = 5000, // 5s
+    retryPolicy = retryPolicies.exponential(), store = undefined, tags = {}, timeout = 10000, // 10s
     url = undefined, } = {}) {
-        this.encoder = encoder;
-        this.logger = logger;
-        this.pid = pid;
-        this.poll = poll;
-        this.retry = retry;
-        this.tags = tags;
-        this.timeout = timeout;
         if (store) {
             this.store = store;
         }
@@ -79,43 +68,71 @@ class ResonateBase {
                 pid,
             });
         }
+        this.logger = logger;
+        this.#invocationHandles = new Map();
+        this.defaultInvocationOptions = {
+            __resonate: true,
+            durable: true,
+            eidFn: utils.randomId,
+            encoder: encoder,
+            idempotencyKeyFn: utils.hash,
+            shouldLock: undefined,
+            pollFrequency,
+            retryPolicy,
+            tags,
+            timeout,
+            version: 0,
+        };
         // promises
         this.promises = {
-            create: (id, timeout, opts = {}) => promises.DurablePromise.create(this.store.promises, this.encoder, id, timeout, opts),
-            resolve: (id, value, opts = {}) => promises.DurablePromise.resolve(this.store.promises, this.encoder, id, value, opts),
-            reject: (id, error, opts = {}) => promises.DurablePromise.reject(this.store.promises, this.encoder, id, error, opts),
-            cancel: (id, error, opts = {}) => promises.DurablePromise.cancel(this.store.promises, this.encoder, id, error, opts),
-            get: (id) => promises.DurablePromise.get(this.store.promises, this.encoder, id),
-            search: (id, state, tags, limit) => promises.DurablePromise.search(this.store.promises, this.encoder, id, state, tags, limit),
+            create: (id, timeout, opts = {}) => durablePromises.DurablePromise.create(this.promisesStore, encoder, id, timeout, opts),
+            resolve: (id, value, opts = {}) => durablePromises.DurablePromise.resolve(this.promisesStore, encoder, id, value, opts),
+            reject: (id, error, opts = {}) => durablePromises.DurablePromise.reject(this.promisesStore, encoder, id, error, opts),
+            cancel: (id, error, opts = {}) => durablePromises.DurablePromise.cancel(this.promisesStore, encoder, id, error, opts),
+            get: (id) => durablePromises.DurablePromise.get(this.promisesStore, encoder, id),
+            search: (id, state, tags, limit) => durablePromises.DurablePromise.search(this.promisesStore, encoder, id, state, tags, limit),
         };
         // schedules
         this.schedules = {
-            create: (id, cron, promiseId, promiseTimeout, opts = {}) => schedules.Schedule.create(this.store.schedules, this.encoder, id, cron, promiseId, promiseTimeout, opts),
-            get: (id) => schedules.Schedule.get(this.store.schedules, this.encoder, id),
-            search: (id, tags, limit) => schedules.Schedule.search(this.store.schedules, this.encoder, id, tags, limit),
+            create: (id, cron, promiseId, promiseTimeout, opts = {}) => schedules.Schedule.create(this.store.schedules, encoder, id, cron, promiseId, promiseTimeout, opts),
+            get: (id) => schedules.Schedule.get(this.store.schedules, encoder, id),
+            search: (id, tags, limit) => schedules.Schedule.search(this.store.schedules, encoder, id, tags, limit),
         };
     }
+    get promisesStore() {
+        return this.store.promises;
+    }
+    get locksStore() {
+        return this.store.locks;
+    }
+    registeredFunction(funcName, version) {
+        if (!this.#registeredFunctions[funcName]?.[version]) {
+            throw new Error(`Function ${funcName} version ${version} not registered`);
+        }
+        return this.#registeredFunctions[funcName][version];
+    }
     register(name, func, opts = {}) {
         // set default version
         opts.version = opts.version ?? 1;
-        // set default options
-        const options = this.defaults(opts);
+        // set default values for the options options
+        const options = this.withDefaultOpts(opts);
         if (options.version <= 0) {
             throw new Error("Version must be greater than 0");
         }
-        if (!this.functions[name]) {
-            this.functions[name] = {};
+        if (!this.#registeredFunctions[name]) {
+            this.#registeredFunctions[name] = {};
         }
-        if (this.functions[name][options.version]) {
+        if (this.#registeredFunctions[name][options.version]) {
             throw new Error(`Function ${name} version ${options.version} already registered`);
         }
-        // register as latest (0) if version is greatest so far
-        if (options.version > Math.max(...Object.values(this.functions[name]).map((f) => f.opts.version))) {
-            this.functions[name][0] = { func, opts: options };
+        // Get the highest version number of existing functions with this name
+        const latestVersion = Math.max(...Object.values(this.#registeredFunctions[name]).map((f) => f.opts.version));
+        // If the new function's version is higher, register it as the latest (index 0)
+        if (options.version > latestVersion) {
+            this.#registeredFunctions[name][0] = { func, opts: options };
         }
         // register specific version
-        this.functions[name][options.version] = { func, opts: options };
-        return (id, ...args) => this.run(name, id, ...args, options);
+        this.#registeredFunctions[name][options.version] = { func, opts: options };
     }
     registerModule(module, opts = {}) {
         for (const key in module) {
@@ -123,50 +140,209 @@ class ResonateBase {
         }
     }
     /**
-     * Run a Resonate function. Functions must first be registered with {@link register}.
+     * Start the resonate service which continually checks for pending promises
+     * every `delay` ms.
      *
-     * @template T The return type of the function.
-     * @param id A unique id for the function invocation.
-     * @param name The function name.
-     * @param argsWithOpts The function arguments.
-     * @returns A promise that resolve to the function return value.
+     * @param delay Frequency in ms to check for pending promises.
      */
-    run(name, id, ...argsWithOpts) {
-        const { args, opts: { version }, part: { durable, idempotencyKey, tags, timeout }, } = this.split(argsWithOpts);
-        if (!this.functions[name] || !this.functions[name][version]) {
-            throw new Error(`Function ${name} version ${version} not registered`);
-        }
-        // the options registered with the function are the defaults
-        const { func, opts: defaults } = this.functions[name][version];
-        // only the following options can be overridden, this information is persisted
-        // in the durable promise and therefore not required on the recovery path
-        const override = {};
-        if (durable !== undefined) {
-            override.durable = durable;
-        }
-        if (idempotencyKey !== undefined) {
-            override.idempotencyKey = idempotencyKey;
-        }
-        if (tags !== undefined) {
-            override.tags = { ...defaults.tags, ...tags, "resonate:invocation": "true" };
+    async start(delay = 5000) {
+        clearInterval(this.#interval);
+        this.#_start();
+        this.#interval = setInterval(this.#_start.bind(this), delay);
+    }
+    /**
+     * Stop the resonate service.
+     */
+    async stop() {
+        clearInterval(this.#interval);
+    }
+    async #_start() {
+        try {
+            for await (const promises of this.promisesStore.search("*", "pending", { "resonate:invocation": "true" })) {
+                for (const promiseRecord of promises) {
+                    const param = this.defaultInvocationOptions.encoder.decode(promiseRecord.param.data);
+                    if (param &&
+                        typeof param === "object" &&
+                        "func" in param &&
+                        typeof param.func === "string" &&
+                        "version" in param &&
+                        typeof param.version === "number" &&
+                        "args" in param &&
+                        Array.isArray(param.args) &&
+                        "retryPolicy" in param &&
+                        retryPolicies.isRetryPolicy(param.retryPolicy)) {
+                        // Since the promise is already created on the server, we should use that idempotencyKey.
+                        // If for whatever reason it is not, we should recalculate it using our defaults.
+                        const idempotencyKeyFn = (_) => {
+                            return (promiseRecord.idempotencyKeyForCreate ??
+                                this.defaultInvocationOptions.idempotencyKeyFn(promiseRecord.id));
+                        };
+                        await this.invokeLocal(param.func, promiseRecord.id, ...param.args, (0, options_1.options)({
+                            retryPolicy: param.retryPolicy,
+                            version: param.version,
+                            idempotencyKeyFn,
+                        }));
+                    }
+                }
+            }
         }
-        else {
-            override.tags = { ...defaults.tags, "resonate:invocation": "true" };
+        catch (e) {
+            // squash all errors and log,
+            // transient errors will be ironed out in the next interval
+            this.logger.error(e);
         }
-        if (timeout !== undefined) {
-            override.timeout = timeout;
+    }
+    async run(name, id, ...argsWithOverrides) {
+        const handle = await this.invokeLocal(name, id, ...argsWithOverrides);
+        return await handle.result();
+    }
+    async invokeLocal(name, id, ...argsWithOverrides) {
+        if (this.#invocationHandles.has(id)) {
+            return this.#invocationHandles.get(id);
         }
-        // merge defaults with override to get opts
-        const opts = {
-            ...defaults,
-            ...override,
-        };
+        const { args, opts: optionOverrides } = utils.split(argsWithOverrides);
+        // version 0 means the latest registered version
+        const givenVersion = optionOverrides?.version ?? 0;
+        // guarantees we only use the overrides in case the user pass an object with more properties
+        const { eidFn, idempotencyKeyFn, retryPolicy, tags, timeout, version } = optionOverrides;
+        const { func, opts: registeredOpts } = this.registeredFunction(name, givenVersion);
+        const opts = utils.mergeObjects({
+            eidFn,
+            idempotencyKeyFn,
+            retryPolicy,
+            tags,
+            timeout,
+            version,
+        }, registeredOpts);
+        // We want to preserve the registered version.
+        opts.version = registeredOpts.version;
+        // For tags we need to merge the objects themselves
+        // giving priority to the passed tags and add the
+        // resonate:invocation tag to identify a top level invocation
+        opts.tags = { ...registeredOpts.tags, ...tags, "resonate:invocation": "true" };
         // lock on top level is true by default
-        opts.lock = opts.lock ?? true;
-        return this.execute(name, id, func, args, opts, defaults);
+        opts.shouldLock = opts.shouldLock ?? true;
+        const param = {
+            func: name,
+            version: opts.version,
+            retryPolicy: opts.retryPolicy,
+            args,
+        };
+        const idempotencyKey = opts.idempotencyKeyFn(id);
+        const storedPromise = await this.promisesStore.create(id, idempotencyKey, false, undefined, opts.encoder.encode(param), Date.now() + opts.timeout, opts.tags);
+        const runFunc = async () => {
+            const eid = opts.eidFn(id);
+            let value;
+            // If the promise that comes back from the server is already completed, resolve or reject right away.
+            switch (storedPromise.state) {
+                case "RESOLVED":
+                    return opts.encoder.decode(storedPromise.value.data);
+                case "REJECTED":
+                    throw opts.encoder.decode(storedPromise.value.data);
+                case "REJECTED_CANCELED":
+                    throw new errors_1.ResonateError("Resonate function canceled", errors_1.ErrorCodes.CANCELED, opts.encoder.decode(storedPromise.value.data));
+                case "REJECTED_TIMEDOUT":
+                    throw new errors_1.ResonateError(`Resonate function timedout at ${new Date(storedPromise.timeout).toISOString()}`, errors_1.ErrorCodes.TIMEDOUT);
+            }
+            // storedPromise.state === "PENDING"
+            try {
+                // Acquire the lock if necessary
+                if (opts.shouldLock) {
+                    const acquireLock = async () => {
+                        try {
+                            return await this.store.locks.tryAcquire(id, eid);
+                        }
+                        catch (e) {
+                            // if lock is already acquired, return false so we can poll
+                            if (e instanceof errors_1.ResonateError && e.code === errors_1.ErrorCodes.STORE_FORBIDDEN) {
+                                return false;
+                            }
+                            throw e;
+                        }
+                    };
+                    while (!(await acquireLock())) {
+                        await (0, utils_1.sleep)(opts.pollFrequency);
+                    }
+                }
+                let error;
+                const ctx = Context.createRootContext(this, { id, eid, name, opts });
+                // we need to hold on to a boolean to determine if the function was successful,
+                // we cannot rely on the value or error as these values could be undefined
+                let success = true;
+                try {
+                    value = await (0, retry_1.runWithRetry)(async () => {
+                        ctx.reset();
+                        return await func(ctx, ...args);
+                    }, opts.retryPolicy, storedPromise.timeout);
+                }
+                catch (e) {
+                    if (ctx.aborted) {
+                        throw e;
+                    }
+                    // We need to capture the error to be able to reject the durable promise
+                    // after that we will then propagate this error by rejecting the result promise
+                    error = e;
+                    success = false;
+                }
+                finally {
+                    await ctx.finalize();
+                }
+                let completedPromiseRecord;
+                if (success) {
+                    completedPromiseRecord = await this.promisesStore.resolve(id, idempotencyKey, false, storedPromise.value.headers, opts.encoder.encode(value));
+                }
+                else {
+                    completedPromiseRecord = await this.promisesStore.reject(id, idempotencyKey, false, storedPromise.value.headers, opts.encoder.encode(error));
+                }
+                // Because of eventual consistency and recovery paths it is possible that we get a
+                // rejected promise even if we did call `resolve` on it or the other way around.
+                // What should never happen is that we get a "PENDING" promise
+                switch (completedPromiseRecord.state) {
+                    case "RESOLVED":
+                        return value;
+                    case "REJECTED":
+                        throw error;
+                    case "REJECTED_CANCELED":
+                        throw new errors_1.ResonateError("Resonate function canceled", errors_1.ErrorCodes.CANCELED, error);
+                    case "REJECTED_TIMEDOUT":
+                        throw new errors_1.ResonateError(`Resonate function timedout at ${new Date(completedPromiseRecord.timeout).toISOString()}`, errors_1.ErrorCodes.TIMEDOUT);
+                    case "PENDING":
+                        throw new Error("Unreachable");
+                }
+            }
+            catch (err) {
+                if (err instanceof errors_1.ResonateError && (err.code === errors_1.ErrorCodes.CANCELED || err.code === errors_1.ErrorCodes.TIMEDOUT)) {
+                    // Cancel and timeout errors just forward them
+                    throw err;
+                }
+                else if (err instanceof errors_1.ResonateError && err.code !== errors_1.ErrorCodes.ABORT) {
+                    // All other resonate errors we wrap them in an abort.
+                    throw new errors_1.ResonateError("Unrecoverable Error: Aborting", errors_1.ErrorCodes.ABORT, err);
+                }
+                else {
+                    // - The error was already an abort error, for example, the unrecoverable error happened in one
+                    // of the children invocations
+                    // - Error in the user function.
+                    // Either way, just forward it.
+                    throw err;
+                }
+            }
+            finally {
+                // release lock if necessary
+                if (opts.shouldLock) {
+                    await this.locksStore.release(id, eid);
+                }
+            }
+            return value;
+        };
+        const resultPromise = runFunc();
+        const handle = new InvocationHandle(resultPromise, id);
+        this.#invocationHandles.set(id, handle);
+        return handle;
     }
-    schedule(name, cron, func, ...argsWithOpts) {
-        const { args, opts } = this.split(argsWithOpts);
+    async schedule(name, cron, func, ...argsWithOpts) {
+        const { args, opts: givenOpts } = utils.split(argsWithOpts);
+        const opts = this.withDefaultOpts(givenOpts);
         if (typeof func === "function") {
             // if function is provided, the default version is 1
             // as opposed to 0 (alias for latest version)
@@ -174,94 +350,398 @@ class ResonateBase {
             this.register(name, func, opts);
         }
         const funcName = typeof func === "string" ? func : name;
-        if (!this.functions[funcName] || !this.functions[funcName][opts.version]) {
-            throw new Error(`Function ${funcName} version ${opts.version} not registered`);
-        }
-        const { opts: { version, timeout, tags: promiseTags }, } = this.functions[funcName][opts.version];
-        const idempotencyKey = typeof opts.idempotencyKey === "function" ? opts.idempotencyKey(funcName) : opts.idempotencyKey;
+        const { opts: { retryPolicy: retry, version, timeout, tags: promiseTags }, } = this.registeredFunction(funcName, opts.version);
+        const idempotencyKey = opts.idempotencyKeyFn(funcName);
         const promiseParam = {
             func: funcName,
             version,
+            retryPolicy: retry,
             args,
         };
-        return this.schedules.create(name, cron, "{{.id}}.{{.timestamp}}", timeout, {
+        return await this.schedules.create(name, cron, "{{.id}}.{{.timestamp}}", timeout, {
             idempotencyKey,
             promiseParam,
             promiseTags,
         });
     }
+    withDefaultOpts(givenOpts = {}) {
+        // merge tags
+        const tags = { ...this.defaultInvocationOptions.tags, ...givenOpts.tags };
+        return {
+            ...this.defaultInvocationOptions,
+            ...givenOpts,
+            tags,
+        };
+    }
+}
+exports.Resonate = Resonate;
+class Context {
+    #resonate;
+    #stopAllPolling = false;
+    #invocationHandles;
+    #aborted;
+    #abortCause;
+    childrenCount;
+    invocationData;
+    parent;
+    root;
+    constructor(resonate, invocationData, parent) {
+        this.#resonate = resonate;
+        this.#invocationHandles = new Map();
+        this.#aborted = false;
+        this.parent = parent;
+        this.root = !parent ? this : parent.root;
+        this.invocationData = invocationData;
+        this.childrenCount = 0;
+    }
+    static createRootContext(resonate, invocationData) {
+        return new Context(resonate, invocationData, undefined);
+    }
+    static createChildrenContext(parentCtx, invocationData) {
+        return new Context(parentCtx.#resonate, invocationData, parentCtx);
+    }
+    reset() {
+        this.childrenCount = 0;
+    }
+    async finalize() {
+        await Promise.allSettled(Array.from(this.#invocationHandles, ([_, handle]) => handle.result()));
+    }
+    abort(cause) {
+        this.root.#aborted = true;
+        this.root.#abortCause = cause;
+    }
+    get aborted() {
+        return this.#aborted;
+    }
+    get abortCause() {
+        return this.#abortCause;
+    }
+    async run(funcOrId, ...argsWithOpts) {
+        let handle;
+        if (typeof funcOrId === "string") {
+            handle = await this.invokeRemote(funcOrId, ...argsWithOpts);
+        }
+        else {
+            handle = await this.invokeLocal(funcOrId, ...argsWithOpts);
+        }
+        return await handle.result();
+    }
+    async invokeRemote(funcId, ...argsWithOpts) {
+        if (this.#invocationHandles.has(funcId)) {
+            return this.#invocationHandles.get(funcId);
+        }
+        const { opts: givenOpts } = utils.split(argsWithOpts);
+        const { opts: registeredOpts } = this.#resonate.registeredFunction(this.root.invocationData.name, this.root.invocationData.opts.version);
+        const opts = { ...registeredOpts, ...givenOpts };
+        // Merge the tags
+        opts.tags = { ...registeredOpts.tags, ...givenOpts?.tags };
+        // Default lock is false for children execution
+        opts.shouldLock = opts.shouldLock ?? false;
+        // Children execution do not need params since we don't go trough the recovery path with children
+        const param = {};
+        const idempotencyKey = opts.idempotencyKeyFn(funcId);
+        const storedPromise = await this.#resonate.promisesStore.create(funcId, idempotencyKey, false, undefined, opts.encoder.encode(param), Date.now() + opts.timeout, opts.tags);
+        const runFunc = async () => {
+            while (!this.#stopAllPolling) {
+                const durablePromiseRecord = await this.#resonate.promisesStore.get(storedPromise.id);
+                switch (durablePromiseRecord.state) {
+                    case "RESOLVED":
+                        return opts.encoder.decode(durablePromiseRecord.value.data);
+                    case "REJECTED":
+                        throw opts.encoder.decode(durablePromiseRecord.value.data);
+                    case "REJECTED_CANCELED":
+                        throw new errors_1.ResonateError("Resonate function canceled", errors_1.ErrorCodes.CANCELED, opts.encoder.decode(durablePromiseRecord.value.data));
+                    case "REJECTED_TIMEDOUT":
+                        throw new errors_1.ResonateError(`Resonate function timedout at ${new Date(durablePromiseRecord.timeout).toISOString()}`, errors_1.ErrorCodes.TIMEDOUT);
+                    case "PENDING":
+                        break;
+                }
+                // TODO: Consider using exponential backoff instead.
+                (0, utils_1.sleep)(opts.pollFrequency);
+            }
+            throw new Error(`Polling of remote invocation with ${funcId} was stopped`);
+        };
+        const resultPromise = runFunc();
+        const invocationHandle = new InvocationHandle(resultPromise, funcId);
+        this.#invocationHandles.set(funcId, invocationHandle);
+        return invocationHandle;
+    }
+    async invokeLocal(func, ...argsWithOpts) {
+        const { args, opts: givenOpts } = utils.split(argsWithOpts);
+        const { opts: registeredOpts } = this.#resonate.registeredFunction(this.root.invocationData.name, this.root.invocationData.opts.version);
+        const opts = { ...registeredOpts, ...givenOpts };
+        // Merge the tags
+        opts.tags = { ...registeredOpts.tags, ...givenOpts.tags };
+        // Default lock is false for children execution
+        opts.shouldLock = opts.shouldLock ?? false;
+        this.childrenCount++;
+        // If it is an anonymous function give at anon name nested within the current invocation name
+        const name = func.name ? func.name : `${this.invocationData.name}__anon${this.childrenCount}`;
+        const id = `${this.invocationData.id}.${this.childrenCount}.${name}`;
+        if (this.#invocationHandles.has(id)) {
+            return this.#invocationHandles.get(id);
+        }
+        if (!opts.durable) {
+            const eid = opts.eidFn(id);
+            const runFunc = async () => {
+                const ctx = Context.createChildrenContext(this, { name, id, eid, opts });
+                const timeout = Date.now() + opts.timeout;
+                return (await (0, retry_1.runWithRetry)(async () => {
+                    ctx.reset();
+                    return await func(ctx, ...args);
+                }, opts.retryPolicy, timeout));
+            };
+            const resultPromise = runFunc();
+            const handle = new InvocationHandle(resultPromise, id);
+            this.#invocationHandles.set(id, handle);
+            return handle;
+        }
+        // Children execution do not need params since we don't go trough the recovery path with children
+        const param = {};
+        const idempotencyKey = opts.idempotencyKeyFn(id);
+        const storedPromise = await this.#resonate.promisesStore.create(id, idempotencyKey, false, undefined, opts.encoder.encode(param), Date.now() + opts.timeout, opts.tags);
+        const runFunc = async () => {
+            const eid = opts.eidFn(id);
+            let value;
+            // If the promise that comes back from the server is already completed, resolve or reject right away.
+            switch (storedPromise.state) {
+                case "RESOLVED":
+                    return opts.encoder.decode(storedPromise.value.data);
+                case "REJECTED":
+                    throw opts.encoder.decode(storedPromise.value.data);
+                case "REJECTED_CANCELED":
+                    throw new errors_1.ResonateError("Resonate function canceled", errors_1.ErrorCodes.CANCELED, opts.encoder.decode(storedPromise.value.data));
+                case "REJECTED_TIMEDOUT":
+                    throw new errors_1.ResonateError(`Resonate function timedout at ${new Date(storedPromise.timeout).toISOString()}`, errors_1.ErrorCodes.TIMEDOUT);
+            }
+            // storedPromise.state === "PENDING"
+            try {
+                // Acquire the lock if necessary
+                if (opts.shouldLock) {
+                    const acquireLock = async () => {
+                        try {
+                            return await this.#resonate.locksStore.tryAcquire(id, eid);
+                        }
+                        catch (e) {
+                            // if lock is already acquired, return false so we can poll
+                            if (e instanceof errors_1.ResonateError && e.code === errors_1.ErrorCodes.STORE_FORBIDDEN) {
+                                return false;
+                            }
+                            throw e;
+                        }
+                    };
+                    while (!(await acquireLock())) {
+                        await (0, utils_1.sleep)(opts.pollFrequency);
+                    }
+                }
+                let error;
+                const ctx = Context.createChildrenContext(this, { id, eid, name, opts });
+                // we need to hold on to a boolean to determine if the function was successful,
+                // we cannot rely on the value or error as these values could be undefined
+                let success = true;
+                try {
+                    value = await (0, retry_1.runWithRetry)(async () => {
+                        ctx.reset();
+                        return await func(ctx, ...args);
+                    }, opts.retryPolicy, storedPromise.timeout);
+                }
+                catch (e) {
+                    // We need to capture the error to be able to reject the durable promise,
+                    // after that we will then propagate this error by rejecting the result promise
+                    error = e;
+                    success = false;
+                }
+                finally {
+                    // Resonate will implicitly await all the invocationHandles as the last
+                    // thing it does with the context before it goes out of scope
+                    await ctx.finalize();
+                }
+                if (this.root.aborted) {
+                    throw new errors_1.ResonateError("Unrecoverable Error: Aborting", errors_1.ErrorCodes.ABORT, this.root.abortCause);
+                }
+                let completedPromiseRecord;
+                if (success) {
+                    completedPromiseRecord = await this.#resonate.promisesStore.resolve(id, idempotencyKey, false, storedPromise.value.headers, opts.encoder.encode(value));
+                }
+                else {
+                    completedPromiseRecord = await this.#resonate.promisesStore.reject(id, idempotencyKey, false, storedPromise.value.headers, opts.encoder.encode(error));
+                }
+                // Because of eventual consistency and recovery paths it is possible that we get a
+                // rejected promise even if we did call `resolve` on it or the other way around.
+                // What should never happen is that we get a "PENDING" promise
+                switch (completedPromiseRecord.state) {
+                    case "RESOLVED":
+                        return value;
+                    case "REJECTED":
+                        throw error;
+                    case "REJECTED_CANCELED":
+                        throw new errors_1.ResonateError("Resonate function canceled", errors_1.ErrorCodes.CANCELED, error);
+                    case "REJECTED_TIMEDOUT":
+                        throw new errors_1.ResonateError(`Resonate function timedout at ${new Date(completedPromiseRecord.timeout).toISOString()}`, errors_1.ErrorCodes.TIMEDOUT);
+                    case "PENDING":
+                        throw new Error("Unreachable");
+                }
+            }
+            catch (err) {
+                if (err instanceof errors_1.ResonateError && (err.code === errors_1.ErrorCodes.CANCELED || err.code === errors_1.ErrorCodes.TIMEDOUT)) {
+                    // Cancel and timeout errors, just forward them
+                    throw err;
+                }
+                else if (err instanceof errors_1.ResonateError && err.code !== errors_1.ErrorCodes.ABORT) {
+                    // Any other instance of ResonateError we must abort the current execution.
+                    this.abort(err);
+                    throw new errors_1.ResonateError("Unrecoverable Error: Aborting", errors_1.ErrorCodes.ABORT, err);
+                }
+                else {
+                    throw err;
+                }
+            }
+            finally {
+                // release lock if necessary
+                if (opts.shouldLock) {
+                    await this.#resonate.locksStore.release(id, eid);
+                }
+            }
+            return value;
+        };
+        const resultPromise = runFunc();
+        const invocationHandle = new InvocationHandle(resultPromise, id);
+        this.#invocationHandles.set(id, invocationHandle);
+        return invocationHandle;
+    }
     /**
-     * Construct options.
+     * Durable version of sleep.
+     * Sleep for the specified time (ms).
      *
-     * @param opts A partial {@link Options} object.
-     * @returns PartialOptions.
+     * @param ms Amount of time to sleep in milliseconds.
+     * @returns A Promise that resolves after the specified time has elapsed.
      */
-    options(opts = {}) {
-        return { ...opts, __resonate: true };
+    async sleep(ms) {
+        const id = `${this.invocationData.id}.${this.childrenCount++}`;
+        const handle = await this.invokeRemote(id, (0, options_1.options)({ timeout: ms, pollFrequency: ms, tags: { "resonate:timeout": "true" }, durable: true }));
+        await handle.result();
     }
     /**
-     * Start the resonate service.
+     * Creates a Promise that is resolved with an array of results when all of the provided Promises
+     * resolve, or rejected when any Promise is rejected.
      *
-     * @param delay Frequency in ms to check for pending promises.
+     * @param values An array of Promises.
+     * @param opts Optional {@link options}.
+     * @returns A new ResonatePromise.
      */
-    start(delay = 5000) {
-        clearInterval(this.interval);
-        this.interval = setInterval(() => this._start(), delay);
+    all(values, opts = {}) {
+        // catch all promises to prevent unhandled promise rejections,
+        // since Promise.all will not be called in the case where the
+        // durable promise already completed
+        for (const v of values) {
+            if (v instanceof Promise)
+                v.catch(() => { });
+        }
+        // prettier-ignore
+        return this.run(() => Promise.all(values), (0, options_1.options)({
+            retryPolicy: retryPolicies.never(),
+            ...opts,
+        }));
     }
     /**
-     * Stop the resonate service.
+     * Creates a Promise that is fulfilled by the first given promise to be fulfilled, or rejected
+     * with an AggregateError.
+     *
+     * @param values An array of Promises.
+     * @param opts Optional {@link options}.
+     * @returns A new ResonatePromise.
      */
-    stop() {
-        clearInterval(this.interval);
-    }
-    defaults({ durable = true, eid = utils.randomId, encoder = this.encoder, idempotencyKey = utils.hash, lock = undefined, poll = this.poll, retry = this.retry, tags = {}, timeout = this.timeout, version = 0, } = {}) {
-        // merge tags
-        tags = { ...this.tags, ...tags };
-        return {
-            __resonate: true,
-            eid,
-            durable,
-            encoder,
-            idempotencyKey,
-            lock,
-            poll,
-            retry,
-            tags,
-            timeout,
-            version,
-        };
+    any(values, opts = {}) {
+        // catch all promises to prevent unhandled promise rejections,
+        // since Promise.any will not be called in the case where the
+        // durable promise already completed
+        for (const v of values) {
+            if (v instanceof Promise)
+                v.catch(() => { });
+        }
+        // prettier-ignore
+        return this.run(() => Promise.any(values), (0, options_1.options)({
+            retryPolicy: retryPolicies.never(),
+            ...opts,
+        }));
     }
-    async _start() {
-        try {
-            for await (const promises of this.promises.search("*", "pending", { "resonate:invocation": "true" })) {
-                for (const promise of promises) {
-                    const param = promise.param();
-                    if (param &&
-                        typeof param === "object" &&
-                        "func" in param &&
-                        typeof param.func === "string" &&
-                        "version" in param &&
-                        typeof param.version === "number" &&
-                        "args" in param &&
-                        Array.isArray(param.args)) {
-                        const { func, opts } = this.functions[param.func][param.version];
-                        this.execute(param.func, promise.id, func, param.args, opts, opts, promise);
-                    }
-                }
-            }
+    /**
+     * Creates a Promise that is resolved or rejected when any of the provided Promises are resolved
+     * or rejected.
+     *
+     * @param values An array of Promises.
+     * @param opts Optional {@link options}.
+     * @returns A new ResonatePromise.
+     */
+    race(values, opts = {}) {
+        // catch all promises to prevent unhandled promise rejections,
+        // since Promise.race will not be called in the case where the
+        // durable promise already completed
+        for (const v of values) {
+            if (v instanceof Promise)
+                v.catch(() => { });
         }
-        catch (e) {
-            // squash all errors and log,
-            // transient errors will be ironed out in the next interval
-            this.logger.error(e);
+        // prettier-ignore
+        return this.run(() => Promise.race(values), (0, options_1.options)({
+            retryPolicy: retryPolicies.never(),
+            ...opts,
+        }));
+    }
+    /**
+     * Creates a Promise that is resolved with an array of results when all of the provided Promises
+     * resolve or reject.
+     *
+     * @param values An array of Promises.
+     * @param opts Optional {@link options}.
+     * @returns A new Promise.
+     */
+    allSettled(values, opts = {}) {
+        // catch all promises to prevent unhandled promise rejections,
+        // since Promise.allSettled will not be called in the case where the
+        // durable promise already completed
+        for (const v of values) {
+            if (v instanceof Promise)
+                v.catch(() => { });
         }
+        // prettier-ignore
+        return this.run(() => Promise.allSettled(values), (0, options_1.options)({
+            retryPolicy: retryPolicies.never(),
+            ...opts,
+        }));
+    }
+    /**
+     * Invoke a Resonate function in detached mode. Functions must first be registered with Resonate.
+     * a detached invocation will not be implecitly awaited at the end of the current context, instead
+     * it will be "supervised" as a top level invocation.
+     *
+     * @template R The return type of the function.
+     * @param id A unique id for the function invocation.
+     * @param name The function name.
+     * @param argsWithOverrides The function arguments and options overrides.
+     * @returns A Res.
+     */
+    async detached(name, id, ...argsWithOverrides) {
+        return await this.#resonate.invokeLocal(name, id, ...argsWithOverrides);
+    }
+}
+exports.Context = Context;
+class InvocationHandle {
+    resultPromise;
+    invocationId;
+    constructor(resultPromise, invocationId) {
+        this.resultPromise = resultPromise;
+        this.invocationId = invocationId;
+    }
+    /**
+     * get the current state of the resultPromise.
+     *
+     */
+    async state() {
+        return await utils.promiseState(this.resultPromise);
     }
-    split(args) {
-        const part = args[args.length - 1];
-        return (0, options_1.isOptions)(part)
-            ? { args: args.slice(0, -1), opts: this.defaults(part), part }
-            : { args, opts: this.defaults(), part: {} };
+    async result() {
+        return this.resultPromise;
     }
 }
-exports.ResonateBase = ResonateBase;
+exports.InvocationHandle = InvocationHandle;
 //# sourceMappingURL=resonate.js.map