@hatchet-dev/typescript-sdk 1.25.0 → 1.26.1

package/protoc/v1/workflows.js

@@ -5,7 +5,7 @@
 //   protoc               v3.19.1
 // source: v1/workflows.proto
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.Concurrency = exports.DefaultFilter = exports.CreateWorkflowVersionRequest = exports.BranchDurableTaskResponse = exports.BranchDurableTaskRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.ConcurrencyLimitStrategy = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
+exports.AdminServiceDefinition = exports.GetRunDetailsResponse_TaskRunsEntry = exports.GetRunDetailsResponse = exports.TaskRunDetail = exports.GetRunDetailsRequest = exports.CreateWorkflowVersionResponse = exports.CreateTaskRateLimit = exports.CreateTaskOpts_SlotRequestsEntry = exports.CreateTaskOpts_WorkerLabelsEntry = exports.CreateTaskOpts = exports.Concurrency = exports.DefaultFilter = exports.BulkTriggerIdempotencyCollisionError = exports.IdempotencyCollisionError = exports.IdempotencyConfig = exports.CreateWorkflowVersionRequest = exports.BranchDurableTaskResponse = exports.BranchDurableTaskRequest = exports.TriggerWorkflowRunResponse = exports.TriggerWorkflowRunRequest_DesiredWorkerLabelsEntry = exports.TriggerWorkflowRunRequest = exports.ReplayTasksResponse = exports.CancelTasksResponse = exports.TasksFilter = exports.ReplayTasksRequest = exports.CancelTasksRequest = exports.ConcurrencyLimitStrategy = exports.RunStatus = exports.RateLimitDuration = exports.StickyStrategy = exports.protobufPackage = void 0;
 exports.stickyStrategyFromJSON = stickyStrategyFromJSON;
 exports.stickyStrategyToJSON = stickyStrategyToJSON;
 exports.rateLimitDurationFromJSON = rateLimitDurationFromJSON;
@@ -1111,6 +1111,7 @@ function createBaseCreateWorkflowVersionRequest() {
         concurrencyArr: [],
         defaultFilters: [],
         inputJsonSchema: undefined,
+        idempotency: undefined,
     };
 }
 exports.CreateWorkflowVersionRequest = {
@@ -1157,6 +1158,9 @@ exports.CreateWorkflowVersionRequest = {
         if (message.inputJsonSchema !== undefined) {
             writer.uint32(114).bytes(message.inputJsonSchema);
         }
+        if (message.idempotency !== undefined) {
+            exports.IdempotencyConfig.encode(message.idempotency, writer.uint32(122).fork()).join();
+        }
         return writer;
     },
     decode(input, length) {
@@ -1264,6 +1268,13 @@ exports.CreateWorkflowVersionRequest = {
                     message.inputJsonSchema = reader.bytes();
                     continue;
                 }
+                case 15: {
+                    if (tag !== 122) {
+                        break;
+                    }
+                    message.idempotency = exports.IdempotencyConfig.decode(reader, reader.uint32());
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1322,6 +1333,9 @@ exports.CreateWorkflowVersionRequest = {
                 : isSet(object.input_json_schema)
                     ? bytesFromBase64(object.input_json_schema)
                     : undefined,
+            idempotency: isSet(object.idempotency)
+                ? exports.IdempotencyConfig.fromJSON(object.idempotency)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -1369,6 +1383,9 @@ exports.CreateWorkflowVersionRequest = {
         if (message.inputJsonSchema !== undefined) {
             obj.inputJsonSchema = base64FromBytes(message.inputJsonSchema);
         }
+        if (message.idempotency !== undefined) {
+            obj.idempotency = exports.IdempotencyConfig.toJSON(message.idempotency);
+        }
         return obj;
     },
     create(base) {
@@ -1397,6 +1414,219 @@ exports.CreateWorkflowVersionRequest = {
         message.concurrencyArr = ((_k = object.concurrencyArr) === null || _k === void 0 ? void 0 : _k.map((e) => exports.Concurrency.fromPartial(e))) || [];
         message.defaultFilters = ((_l = object.defaultFilters) === null || _l === void 0 ? void 0 : _l.map((e) => exports.DefaultFilter.fromPartial(e))) || [];
         message.inputJsonSchema = (_m = object.inputJsonSchema) !== null && _m !== void 0 ? _m : undefined;
+        message.idempotency =
+            object.idempotency !== undefined && object.idempotency !== null
+                ? exports.IdempotencyConfig.fromPartial(object.idempotency)
+                : undefined;
+        return message;
+    },
+};
+function createBaseIdempotencyConfig() {
+    return { expression: '', ttlMs: 0 };
+}
+exports.IdempotencyConfig = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.expression !== '') {
+            writer.uint32(10).string(message.expression);
+        }
+        if (message.ttlMs !== 0) {
+            writer.uint32(16).int64(message.ttlMs);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseIdempotencyConfig();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.expression = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.ttlMs = longToNumber(reader.int64());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            expression: isSet(object.expression) ? globalThis.String(object.expression) : '',
+            ttlMs: isSet(object.ttlMs)
+                ? globalThis.Number(object.ttlMs)
+                : isSet(object.ttl_ms)
+                    ? globalThis.Number(object.ttl_ms)
+                    : 0,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.expression !== '') {
+            obj.expression = message.expression;
+        }
+        if (message.ttlMs !== 0) {
+            obj.ttlMs = Math.round(message.ttlMs);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.IdempotencyConfig.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b;
+        const message = createBaseIdempotencyConfig();
+        message.expression = (_a = object.expression) !== null && _a !== void 0 ? _a : '';
+        message.ttlMs = (_b = object.ttlMs) !== null && _b !== void 0 ? _b : 0;
+        return message;
+    },
+};
+function createBaseIdempotencyCollisionError() {
+    return { existingRunExternalId: '' };
+}
+exports.IdempotencyCollisionError = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        if (message.existingRunExternalId !== '') {
+            writer.uint32(10).string(message.existingRunExternalId);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseIdempotencyCollisionError();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.existingRunExternalId = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            existingRunExternalId: isSet(object.existingRunExternalId)
+                ? globalThis.String(object.existingRunExternalId)
+                : isSet(object.existing_run_external_id)
+                    ? globalThis.String(object.existing_run_external_id)
+                    : '',
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.existingRunExternalId !== '') {
+            obj.existingRunExternalId = message.existingRunExternalId;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.IdempotencyCollisionError.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a;
+        const message = createBaseIdempotencyCollisionError();
+        message.existingRunExternalId = (_a = object.existingRunExternalId) !== null && _a !== void 0 ? _a : '';
+        return message;
+    },
+};
+function createBaseBulkTriggerIdempotencyCollisionError() {
+    return { successfulWorkflowRunExternalIds: [], collisions: [] };
+}
+exports.BulkTriggerIdempotencyCollisionError = {
+    encode(message, writer = new wire_1.BinaryWriter()) {
+        for (const v of message.successfulWorkflowRunExternalIds) {
+            writer.uint32(10).string(v);
+        }
+        for (const v of message.collisions) {
+            exports.IdempotencyCollisionError.encode(v, writer.uint32(18).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof wire_1.BinaryReader ? input : new wire_1.BinaryReader(input);
+        const end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseBulkTriggerIdempotencyCollisionError();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.successfulWorkflowRunExternalIds.push(reader.string());
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.collisions.push(exports.IdempotencyCollisionError.decode(reader, reader.uint32()));
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            successfulWorkflowRunExternalIds: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.successfulWorkflowRunExternalIds)
+                ? object.successfulWorkflowRunExternalIds.map((e) => globalThis.String(e))
+                : globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.successful_workflow_run_external_ids)
+                    ? object.successful_workflow_run_external_ids.map((e) => globalThis.String(e))
+                    : [],
+            collisions: globalThis.Array.isArray(object === null || object === void 0 ? void 0 : object.collisions)
+                ? object.collisions.map((e) => exports.IdempotencyCollisionError.fromJSON(e))
+                : [],
+        };
+    },
+    toJSON(message) {
+        var _a, _b;
+        const obj = {};
+        if ((_a = message.successfulWorkflowRunExternalIds) === null || _a === void 0 ? void 0 : _a.length) {
+            obj.successfulWorkflowRunExternalIds = message.successfulWorkflowRunExternalIds;
+        }
+        if ((_b = message.collisions) === null || _b === void 0 ? void 0 : _b.length) {
+            obj.collisions = message.collisions.map((e) => exports.IdempotencyCollisionError.toJSON(e));
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.BulkTriggerIdempotencyCollisionError.fromPartial(base !== null && base !== void 0 ? base : {});
+    },
+    fromPartial(object) {
+        var _a, _b, _c, _d;
+        const message = createBaseBulkTriggerIdempotencyCollisionError();
+        message.successfulWorkflowRunExternalIds =
+            (_b = (_a = object.successfulWorkflowRunExternalIds) === null || _a === void 0 ? void 0 : _a.map((e) => e)) !== null && _b !== void 0 ? _b : [];
+        message.collisions =
+            (_d = (_c = object.collisions) === null || _c === void 0 ? void 0 : _c.map((e) => exports.IdempotencyCollisionError.fromPartial(e))) !== null && _d !== void 0 ? _d : [];
         return message;
     },
 };

package/util/errors/bulk-trigger-idempotency-collision-error.d.ts

@@ -0,0 +1,6 @@
+import { IdempotencyCollisionError } from './idempotency-collision-error';
+export declare class BulkTriggerIdempotencyCollisionError extends Error {
+    successfulWorkflowRunExternalIds: string[];
+    collisions: IdempotencyCollisionError[];
+    constructor(successfulWorkflowRunExternalIds: string[], collisions: IdempotencyCollisionError[]);
+}

package/util/errors/bulk-trigger-idempotency-collision-error.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkTriggerIdempotencyCollisionError = void 0;
+class BulkTriggerIdempotencyCollisionError extends Error {
+    constructor(successfulWorkflowRunExternalIds, collisions) {
+        super('idempotency key collision in bulk trigger');
+        this.name = 'BulkTriggerIdempotencyCollisionError';
+        this.successfulWorkflowRunExternalIds = successfulWorkflowRunExternalIds;
+        this.collisions = collisions;
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.BulkTriggerIdempotencyCollisionError = BulkTriggerIdempotencyCollisionError;

package/util/errors/idempotency-collision-error.d.ts

@@ -0,0 +1,5 @@
+import HatchetError from './hatchet-error';
+export declare class IdempotencyCollisionError extends HatchetError {
+    existingRunExternalId: string;
+    constructor(existingRunExternalId: string);
+}

package/util/errors/idempotency-collision-error.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IdempotencyCollisionError = void 0;
+const hatchet_error_1 = __importDefault(require("./hatchet-error"));
+class IdempotencyCollisionError extends hatchet_error_1.default {
+    constructor(existingRunExternalId) {
+        super(`idempotency key collision: existing run ${existingRunExternalId} already exists`);
+        this.name = 'IdempotencyCollisionError';
+        this.existingRunExternalId = existingRunExternalId;
+        Object.setPrototypeOf(this, new.target.prototype);
+    }
+}
+exports.IdempotencyCollisionError = IdempotencyCollisionError;

package/util/retrier.d.ts

@@ -1,2 +1,2 @@
 import { Logger } from './logger';
-export declare function retrier<T>(fn: () => Promise<T>, logger: Logger, retries?: number, interval?: number): Promise<T>;
+export declare function retrier<T>(fn: () => Promise<T>, logger: Logger, retries?: number, interval?: number, shouldRetry?: (e: unknown) => boolean): Promise<T>;

package/util/retrier.js

@@ -18,13 +18,16 @@ const DEFAULT_RETRY_INTERVAL = 0.1; // seconds
 const DEFAULT_RETRY_COUNT = 8;
 const MAX_JITTER = 100; // milliseconds
 function retrier(fn_1, logger_1) {
-    return __awaiter(this, arguments, void 0, function* (fn, logger, retries = DEFAULT_RETRY_COUNT, interval = DEFAULT_RETRY_INTERVAL) {
+    return __awaiter(this, arguments, void 0, function* (fn, logger, retries = DEFAULT_RETRY_COUNT, interval = DEFAULT_RETRY_INTERVAL, shouldRetry = () => true) {
         let lastError;
         for (let i = 0; i < retries; i++) {
             try {
                 return yield fn();
             }
             catch (e) {
+                if (!shouldRetry(e)) {
+                    throw e;
+                }
                 lastError = e instanceof Error ? e : new Error(String(e));
                 logger.error(`Error: ${lastError.message}`);
                 // Calculate exponential backoff with random jitter

package/v1/client/admin.js

@@ -25,14 +25,99 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdminClient = void 0;
 const hatchet_error_1 = __importDefault(require("../../util/errors/hatchet-error"));
+const idempotency_collision_error_1 = require("../../util/errors/idempotency-collision-error");
+const bulk_trigger_idempotency_collision_error_1 = require("../../util/errors/bulk-trigger-idempotency-collision-error");
 const workflow_run_ref_1 = __importDefault(require("../../util/workflow-run-ref"));
+const grpc_js_1 = require("@grpc/grpc-js");
+const status_1 = require("../../protoc/google/rpc/status");
+const workflows_1 = require("../../protoc/v1/workflows");
+const nice_grpc_common_1 = require("nice-grpc-common");
 const grpc_helpers_1 = require("../../util/grpc-helpers");
 const child_listener_client_1 = require("../../clients/listeners/run-listener/child-listener-client");
-const workflows_1 = require("../../protoc/workflows");
-const workflows_2 = require("../../protoc/v1/workflows");
+const workflows_2 = require("../../protoc/workflows");
+const workflows_3 = require("../../protoc/v1/workflows");
 const retrier_1 = require("../../util/retrier");
 const batch_1 = require("../../util/batch");
 const apply_namespace_1 = require("../../util/apply-namespace");
+function isGrpcServiceError(e) {
+    return e instanceof Error && 'code' in e && 'metadata' in e;
+}
+function extractExistingRunIdFromGrpcError(e) {
+    var _a;
+    try {
+        const [binData] = e.metadata.get('grpc-status-details-bin');
+        if (!binData)
+            return '';
+        const status = status_1.Status.decode(binData instanceof Buffer ? binData : Buffer.from(binData));
+        for (const detail of status.details) {
+            if (detail.typeUrl.includes('IdempotencyCollisionError')) {
+                return (_a = workflows_1.IdempotencyCollisionError.decode(detail.value).existingRunExternalId) !== null && _a !== void 0 ? _a : '';
+            }
+        }
+    }
+    catch (_b) {
+        // ignore decoding errors
+    }
+    return '';
+}
+function isNiceGrpcAlreadyExists(e) {
+    return e instanceof nice_grpc_common_1.ClientError && e.code === nice_grpc_common_1.Status.ALREADY_EXISTS;
+}
+function decodeBulkTriggerCollision(status) {
+    for (const detail of status.details) {
+        if (detail.typeUrl.includes('BulkTriggerIdempotencyCollisionError')) {
+            const proto = workflows_1.BulkTriggerIdempotencyCollisionError.decode(detail.value);
+            return new bulk_trigger_idempotency_collision_error_1.BulkTriggerIdempotencyCollisionError(proto.successfulWorkflowRunExternalIds, proto.collisions.map((c) => new idempotency_collision_error_1.IdempotencyCollisionError(c.existingRunExternalId)));
+        }
+    }
+    return null;
+}
+function extractBulkTriggerCollisionFromGrpcError(e) {
+    try {
+        const [binData] = e.metadata.get('grpc-status-details-bin');
+        if (!binData)
+            return null;
+        const status = status_1.Status.decode(binData instanceof Buffer ? binData : Buffer.from(binData));
+        return decodeBulkTriggerCollision(status);
+    }
+    catch (_a) {
+        return null;
+    }
+}
+function extractBulkTriggerCollisionFromNiceGrpcMetadata(metadata) {
+    if (!metadata)
+        return null;
+    try {
+        const binData = metadata.get('grpc-status-details-bin');
+        if (!binData)
+            return null;
+        const status = status_1.Status.decode(binData);
+        return decodeBulkTriggerCollision(status);
+    }
+    catch (_a) {
+        return null;
+    }
+}
+function extractRunIdFromNiceGrpcMetadata(metadata) {
+    var _a;
+    if (!metadata)
+        return '';
+    try {
+        const binData = metadata.get('grpc-status-details-bin');
+        if (!binData)
+            return '';
+        const status = status_1.Status.decode(binData);
+        for (const detail of status.details) {
+            if (detail.typeUrl.includes('IdempotencyCollisionError')) {
+                return (_a = workflows_1.IdempotencyCollisionError.decode(detail.value).existingRunExternalId) !== null && _a !== void 0 ? _a : '';
+            }
+        }
+    }
+    catch (_b) {
+        // ignore decoding errors
+    }
+    return '';
+}
 function convertDesiredWorkerLabels(labels) {
     return Object.fromEntries(Object.entries(labels).map(([key, label]) => [
         key,
@@ -49,9 +134,9 @@ class AdminClient {
     constructor(config, api, runs) {
         this.config = config;
         this.logger = config.logger(`Admin`, config.log_level);
-        const { client, channel, factory } = (0, grpc_helpers_1.createGrpcClient)(config, workflows_1.WorkflowServiceDefinition);
+        const { client, channel, factory } = (0, grpc_helpers_1.createGrpcClient)(config, workflows_2.WorkflowServiceDefinition);
         this.workflowsGrpc = client;
-        this.adminGrpc = factory.create(workflows_2.AdminServiceDefinition, channel);
+        this.adminGrpc = factory.create(workflows_3.AdminServiceDefinition, channel);
         this.listenerClient = new child_listener_client_1.RunListenerClient(config, channel, factory, api);
         this.runs = runs;
     }
@@ -82,6 +167,7 @@ class AdminClient {
      */
     runWorkflow(workflowName, input, options) {
         return __awaiter(this, void 0, void 0, function* () {
+            let trailerMetadata;
             try {
                 const computedName = (0, apply_namespace_1.applyNamespace)(workflowName, this.config.namespace).toLowerCase();
                 const inputStr = JSON.stringify(input);
@@ -92,14 +178,26 @@ class AdminClient {
                     parentTaskRunExternalId: parentTaskRunExternalId !== null && parentTaskRunExternalId !== void 0 ? parentTaskRunExternalId : parentStepRunId, additionalMetadata: additionalMetadata ? JSON.stringify(additionalMetadata) : undefined, priority: opts.priority, desiredWorkerLabels: desiredWorkerLabels
                         ? convertDesiredWorkerLabels(desiredWorkerLabels)
                         : {} });
-                const resp = yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.workflowsGrpc.triggerWorkflow(request); }), this.logger);
+                const resp = yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
+                    return this.workflowsGrpc.triggerWorkflow(request, {
+                        onTrailer: (trailer) => {
+                            trailerMetadata = trailer;
+                        },
+                    });
+                }), this.logger, undefined, undefined, (e) => !isNiceGrpcAlreadyExists(e));
                 const id = resp.workflowRunId;
                 const ref = new workflow_run_ref_1.default(id, this.listenerClient, this.runs, options === null || options === void 0 ? void 0 : options.parentId, options === null || options === void 0 ? void 0 : options._standaloneTaskName);
                 yield ref.getWorkflowRunId();
                 return ref;
             }
             catch (e) {
-                throw new hatchet_error_1.default(e.message);
+                if (isGrpcServiceError(e) && e.code === grpc_js_1.status.ALREADY_EXISTS) {
+                    throw new idempotency_collision_error_1.IdempotencyCollisionError(extractExistingRunIdFromGrpcError(e));
+                }
+                if (isNiceGrpcAlreadyExists(e)) {
+                    throw new idempotency_collision_error_1.IdempotencyCollisionError(extractRunIdFromNiceGrpcMetadata(trailerMetadata));
+                }
+                throw new hatchet_error_1.default(e instanceof Error ? e.message : String(e));
             }
         });
     }
@@ -129,15 +227,23 @@ class AdminClient {
             });
             const batches = (0, batch_1.batch)(workflowRequests, batchSize, (_a = this.config.grpc_max_send_message_length) !== null && _a !== void 0 ? _a : 4 * 1024 * 1024);
             this.logger.debug(`batching ${batches.length} batches`);
+            let bulkTrailerMetadata;
             try {
                 const results = [];
                 // for loop to ensure serial execution of batches
                 for (const { payloads, originalIndices, batchIndex } of batches) {
-                    const request = workflows_1.BulkTriggerWorkflowRequest.create({
+                    const request = workflows_2.BulkTriggerWorkflowRequest.create({
                         workflows: payloads,
                     });
                     // Call the bulk trigger workflow method for this batch
-                    const bulkTriggerWorkflowResponse = yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () { return this.workflowsGrpc.bulkTriggerWorkflow(request); }), this.logger);
+                    const bulkTriggerWorkflowResponse = yield (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
+                        return this.workflowsGrpc.bulkTriggerWorkflow(request, {
+                            onTrailer: (trailer) => {
+                                bulkTrailerMetadata = trailer;
+                            },
+                        });
+                    }), this.logger, undefined, undefined, (e) => !isNiceGrpcAlreadyExists(e) &&
+                        !(isGrpcServiceError(e) && e.code === grpc_js_1.status.ALREADY_EXISTS));
                     this.logger.debug(`batch ${batchIndex + 1} of ${batches.length}`);
                     // Map the results back to their original indices
                     const batchResults = bulkTriggerWorkflowResponse.workflowRunIds.map((resp, index) => {
@@ -150,7 +256,17 @@ class AdminClient {
                 return results;
             }
             catch (e) {
-                throw new hatchet_error_1.default(e.message);
+                if (isGrpcServiceError(e) && e.code === grpc_js_1.status.ALREADY_EXISTS) {
+                    const collision = extractBulkTriggerCollisionFromGrpcError(e);
+                    if (collision)
+                        throw collision;
+                }
+                if (isNiceGrpcAlreadyExists(e)) {
+                    const collision = extractBulkTriggerCollisionFromNiceGrpcMetadata(bulkTrailerMetadata);
+                    if (collision)
+                        throw collision;
+                }
+                throw new hatchet_error_1.default(e instanceof Error ? e.message : String(e));
             }
         });
     }

package/v1/client/worker/context.d.ts

@@ -8,7 +8,7 @@
  * @module Context
  */
 import { Priority, RunOpts, TaskWorkflowDeclaration, BaseWorkflowDeclaration as WorkflowV1 } from '../../declaration';
-import { Action } from '../../../clients/dispatcher/action-listener';
+import type { Action } from '../../../clients/dispatcher/action-listener';
 import { Logger, LogLevel } from '../../../util/logger';
 import WorkflowRunRef from '../../../util/workflow-run-ref';
 import { Conditions } from '../../conditions';
@@ -144,8 +144,15 @@ export declare class Context<T, K = {}> {
     /**
      * Gets the name of the current workflow.
      * @returns The name of the workflow.
+     * @deprecated This method returns the task name. Use {@link workflowNameV1} for the workflow
+     * name or {@link taskName} for the task name.
      */
     workflowName(): string;
+    /**
+     * Gets the name of the current workflow.
+     * @returns The name of the workflow.
+     */
+    workflowNameV1(): string;
     /**
      * Gets the user data associated with the workflow.
      * @returns The user data.

package/v1/client/worker/context.js

@@ -24,6 +24,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.DurableContext = exports.Context = exports.ContextWorker = void 0;
 const declaration_1 = require("../../declaration");
 const hatchet_error_1 = __importDefault(require("../../../util/errors/hatchet-error"));
+const action_listener_1 = require("../../../clients/dispatcher/action-listener");
 const parse_1 = require("../../../util/parse");
 const conditions_1 = require("../../conditions");
 const transformer_1 = require("../../conditions/transformer");
@@ -210,10 +211,19 @@ class Context {
     /**
      * Gets the name of the current workflow.
      * @returns The name of the workflow.
+     * @deprecated This method returns the task name. Use {@link workflowNameV1} for the workflow
+     * name or {@link taskName} for the task name.
      */
     workflowName() {
         return this.action.jobName;
     }
+    /**
+     * Gets the name of the current workflow.
+     * @returns The name of the workflow.
+     */
+    workflowNameV1() {
+        return (0, action_listener_1.workflowNameFromAction)(this.action);
+    }
     /**
      * Gets the user data associated with the workflow.
      * @returns The user data.
@@ -288,7 +298,7 @@ class Context {
             return Promise.resolve();
         }
         const logger = this.v1.config.logger('ctx', this.v1.config.log_level);
-        const contextExtra = Object.assign({ workflowRunId: this.action.workflowRunId, taskRunExternalId: this.action.taskRunExternalId, retryCount: this.action.retryCount, workflowName: this.action.jobName }, extra === null || extra === void 0 ? void 0 : extra.extra);
+        const contextExtra = Object.assign({ workflowRunId: this.action.workflowRunId, taskRunExternalId: this.action.taskRunExternalId, retryCount: this.action.retryCount, workflowName: this.workflowNameV1() }, extra === null || extra === void 0 ? void 0 : extra.extra);
         const promises = [];
         if (!level || level === 'INFO') {
             promises.push(logger.info(message, contextExtra));

package/v1/client/worker/worker-internal.js

@@ -335,6 +335,12 @@ class InternalWorker {
                         expression: f.expression,
                         payload: f.payload ? new TextEncoder().encode(JSON.stringify(f.payload)) : undefined,
                     }))) !== null && _w !== void 0 ? _w : [],
+                    idempotency: workflow.idempotency
+                        ? {
+                            expression: workflow.idempotency.expression,
+                            ttlMs: workflow.idempotency.ttlMs,
+                        }
+                        : undefined,
                 });
                 this.registeredWorkflowPromises.push(registeredWorkflow);
                 yield registeredWorkflow;

package/v1/declaration.d.ts

@@ -9,7 +9,7 @@ import WorkflowRunRef from '../util/workflow-run-ref';
 import { CronWorkflows, ScheduledWorkflows, V1CreateFilterRequest } from '../clients/rest/generated/data-contracts';
 import * as z from 'zod/v4';
 import { IHatchetClient } from './client/client.interface';
-import { CreateWorkflowTaskOpts, CreateOnFailureTaskOpts, TaskFn, CreateWorkflowDurableTaskOpts, CreateBaseTaskOpts, CreateOnSuccessTaskOpts, Concurrency, DurableTaskFn, WorkerLabelComparator } from './task';
+import { CreateWorkflowTaskOpts, CreateOnFailureTaskOpts, TaskFn, CreateWorkflowDurableTaskOpts, CreateBaseTaskOpts, CreateOnSuccessTaskOpts, Concurrency, DurableTaskFn, WorkerLabelComparator, IdempotencyConfig } from './task';
 import { Duration } from './client/duration';
 import { MetricsClient } from './client/features/metrics';
 import { InputType, OutputType, UnknownInputType, JsonObject, Resolved } from './types';
@@ -152,6 +152,11 @@ export type CreateBaseWorkflowOpts = {
      * can be used on the dashboard for autocomplete.
      */
     inputValidator?: z.ZodType<any>;
+    /**
+     * (optional) idempotency configuration for the workflow.
+     * Prevents more than one run from occurring for a given key within the TTL window.
+     */
+    idempotency?: IdempotencyConfig;
 };
 export type CreateTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, TaskFn<I, O>>;
 export type CreateDurableTaskWorkflowOpts<I extends InputType = UnknownInputType, O extends OutputType = void> = CreateBaseWorkflowOpts & CreateBaseTaskOpts<I, O, DurableTaskFn<I, O>> & {