@hatchet-dev/typescript-sdk 1.5.2 → 1.5.4

package/clients/event/event-client.d.ts

@@ -24,6 +24,6 @@ export declare class EventClient {
     constructor(config: ClientConfig, channel: Channel, factory: ClientFactory);
     push<T>(type: string, input: T, options?: PushEventOptions): Promise<import("../../protoc/events/events").Event>;
     bulkPush<T>(type: string, inputs: EventWithMetadata<T>[], options?: PushEventOptions): Promise<import("../../protoc/events/events").Events>;
-    putLog(stepRunId: string, log: string, level?: LogLevel): void;
-    putStream(stepRunId: string, data: string | Uint8Array): void;
+    putLog(stepRunId: string, log: string, level?: LogLevel, taskRetryCount?: number, metadata?: Record<string, any>): Promise<void>;
+    putStream(stepRunId: string, data: string | Uint8Array): Promise<void>;
 }

package/clients/event/event-client.js

@@ -82,46 +82,52 @@ class EventClient {
             throw new hatchet_error_1.default(e.message);
         }
     }
-    putLog(stepRunId, log, level) {
-        const createdAt = new Date();
-        if (log.length > 1000) {
-            this.logger.warn(`log is too long, skipping: ${log.length} characters`);
-            return;
-        }
-        //  fire and forget the log
-        this.client
-            .putLog({
-            stepRunId,
-            createdAt,
-            message: log,
-            level: level || LogLevel.INFO,
-        })
-            .catch((e) => {
-            // log a warning, but this is not a fatal error
-            this.logger.warn(`Could not put log: ${e.message}`);
+    putLog(stepRunId, log, level, taskRetryCount, metadata) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const createdAt = new Date();
+            if (log.length > 1000) {
+                this.logger.warn(`log is too long, skipping: ${log.length} characters`);
+                return;
+            }
+            //  fire and forget the log
+            yield this.client
+                .putLog({
+                stepRunId,
+                createdAt,
+                message: log,
+                level: level || LogLevel.INFO,
+                taskRetryCount,
+                metadata: metadata ? JSON.stringify(metadata) : undefined,
+            })
+                .catch((e) => {
+                // log a warning, but this is not a fatal error
+                this.logger.warn(`Could not put log: ${e.message}`);
+            });
         });
     }
     putStream(stepRunId, data) {
-        const createdAt = new Date();
-        let dataBytes;
-        if (typeof data === 'string') {
-            dataBytes = new TextEncoder().encode(data);
-        }
-        else if (data instanceof Uint8Array) {
-            dataBytes = data;
-        }
-        else {
-            throw new Error('Invalid data type. Expected string or Uint8Array.');
-        }
-        (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
-            return this.client.putStreamEvent({
-                stepRunId,
-                createdAt,
-                message: dataBytes,
+        return __awaiter(this, void 0, void 0, function* () {
+            const createdAt = new Date();
+            let dataBytes;
+            if (typeof data === 'string') {
+                dataBytes = new TextEncoder().encode(data);
+            }
+            else if (data instanceof Uint8Array) {
+                dataBytes = data;
+            }
+            else {
+                throw new Error('Invalid data type. Expected string or Uint8Array.');
+            }
+            (0, retrier_1.retrier)(() => __awaiter(this, void 0, void 0, function* () {
+                return this.client.putStreamEvent({
+                    stepRunId,
+                    createdAt,
+                    message: dataBytes,
+                });
+            }), this.logger).catch((e) => {
+                // log a warning, but this is not a fatal error
+                this.logger.warn(`Could not put log: ${e.message}`);
             });
-        }), this.logger).catch((e) => {
-            // log a warning, but this is not a fatal error
-            this.logger.warn(`Could not put log: ${e.message}`);
         });
     }
 }

package/clients/hatchet-client/hatchet-logger.d.ts

@@ -1,13 +1,16 @@
-import { Logger, LogLevel } from '../../util/logger';
+import { LogExtra, Logger, LogLevel } from '../../util/logger';
 export declare const DEFAULT_LOGGER: (context: string, logLevel?: LogLevel) => HatchetLogger;
+type UtilKeys = 'trace';
 export declare class HatchetLogger implements Logger {
     private logLevel;
     private context;
     constructor(context: string, logLevel?: LogLevel);
     private log;
-    debug(message: string): void;
-    info(message: string): void;
-    green(message: string): void;
-    warn(message: string, error?: Error): void;
-    error(message: string, error?: Error): void;
+    debug(message: string): Promise<void>;
+    info(message: string): Promise<void>;
+    green(message: string): Promise<void>;
+    warn(message: string, error?: Error): Promise<void>;
+    error(message: string, error?: Error): Promise<void>;
+    util(key: UtilKeys, message: string, extra?: LogExtra): void | Promise<void>;
 }
+export {};

package/clients/hatchet-client/hatchet-logger.js

@@ -1,4 +1,13 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HatchetLogger = exports.DEFAULT_LOGGER = void 0;
 /* eslint-disable no-console */
@@ -39,19 +48,34 @@ class HatchetLogger {
         }
     }
     debug(message) {
-        this.log('DEBUG', message, '35');
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.log('DEBUG', message, '35');
+        });
     }
     info(message) {
-        this.log('INFO', message);
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.log('INFO', message);
+        });
     }
     green(message) {
-        this.log('INFO', message, '32');
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.log('INFO', message, '32');
+        });
     }
     warn(message, error) {
-        this.log('WARN', `${message} ${error}`, '93');
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.log('WARN', `${message} ${error}`, '93');
+        });
     }
     error(message, error) {
-        this.log('ERROR', `${message} ${error}`, '91');
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.log('ERROR', `${message} ${error}`, '91');
+        });
+    }
+    util(key, message, extra) {
+        if (key === 'trace') {
+            this.log('INFO', `trace: ${message}`, '35');
+        }
     }
 }
 exports.HatchetLogger = HatchetLogger;

package/examples/bulk-fanout-worker.js

@@ -33,7 +33,7 @@ const parentWorkflow = {
                 }));
                 const spawnedWorkflows = yield ctx.spawnWorkflows(workflowRequests);
                 const results = yield Promise.all(spawnedWorkflows.map((workflowRef) => workflowRef.output.then((result) => {
-                    ctx.log('spawned workflow result:');
+                    ctx.logger.info('spawned workflow result:');
                     return result;
                 })));
                 console.log('spawned workflow results:', results);

package/examples/byo-logger.js

@@ -22,20 +22,27 @@ class PinoLogger {
         this.logLevel = logLevel;
         this.context = context;
     }
-    debug(message) {
-        logger.debug(message);
+    debug(message, extra) {
+        logger.debug(message, extra);
     }
-    info(message) {
-        logger.info(message);
+    info(message, extra) {
+        logger.info(message, extra);
     }
-    green(message) {
-        logger.info(`%c${message}`);
+    green(message, extra) {
+        logger.info(`%c${message}`, extra);
     }
-    warn(message, error) {
-        logger.warn(`${message} ${error}`);
+    warn(message, error, extra) {
+        logger.warn(`${message} ${error}`, extra);
     }
-    error(message, error) {
-        logger.error(`${message} ${error}`);
+    error(message, error, extra) {
+        logger.error(`${message} ${error}`, extra);
+    }
+    // optional util method
+    util(key, message, extra) {
+        // for example you may want to expose a trace method
+        if (key === 'trace') {
+            logger.info('trace', extra);
+        }
     }
 }
 const hatchet = sdk_1.default.init({
@@ -44,34 +51,22 @@ const hatchet = sdk_1.default.init({
 });
 // !!
 // > Use the logger
-const sleep = (ms) => new Promise((resolve) => {
-    setTimeout(resolve, ms);
+const workflow = hatchet.task({
+    name: 'byo-logger-example',
+    fn: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
+        // eslint-disable-next-line no-plusplus
+        for (let i = 0; i < 5; i++) {
+            logger.info(`log message ${i}`);
+        }
+        return { step1: 'completed step run' };
+    }),
 });
-const workflow = {
-    id: 'byo-logger-example',
-    description: 'An example showing how to pass a custom logger to Hatchet',
-    on: {
-        event: 'byo-logger:spawn',
-    },
-    steps: [
-        {
-            name: 'logger-step1',
-            run: (ctx) => __awaiter(void 0, void 0, void 0, function* () {
-                // eslint-disable-next-line no-plusplus
-                for (let i = 0; i < 5; i++) {
-                    logger.info(`log message ${i}`);
-                    yield sleep(500);
-                }
-                return { step1: 'completed step run' };
-            }),
-        },
-    ],
-};
 // !!
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
-        const worker = yield hatchet.worker('byo-logger-worker', 1);
-        yield worker.registerWorkflow(workflow);
+        const worker = yield hatchet.worker('byo-logger-worker', {
+            workflows: [workflow],
+        });
         worker.start();
     });
 }

package/examples/fanout-worker.js

@@ -28,7 +28,7 @@ const parentWorkflow = {
                 const promises = Array.from({ length: 3 }, (_, i) => ctx
                     .spawnWorkflow('child-workflow', { input: `child-input-${i}` }, { additionalMetadata: { childKey: 'childValue' } })
                     .then((result) => {
-                    ctx.log('spawned workflow result:');
+                    ctx.logger.info('spawned workflow result:');
                     return result.output;
                 }));
                 const results = yield Promise.all(promises);

package/examples/logger.js

@@ -33,7 +33,7 @@ const workflow = {
                 // log in a for loop
                 // eslint-disable-next-line no-plusplus
                 for (let i = 0; i < 10; i++) {
-                    ctx.log(`log message ${i}`);
+                    ctx.logger.info(`log message ${i}`);
                     yield sleep(200);
                 }
                 return { step1: 'completed step run' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hatchet-dev/typescript-sdk",
-  "version": "1.5.2",
+  "version": "1.5.4",
   "description": "Background task orchestration & visibility for developers",
   "types": "dist/index.d.ts",
   "files": [

package/protoc/dispatcher/dispatcher.d.ts

@@ -158,7 +158,12 @@ export interface AssignedAction {
     childWorkflowKey?: string | undefined;
     /** (optional) the parent workflow run id (if this is a child workflow) */
     parentWorkflowRunId?: string | undefined;
+    /** (optional) the priority of the run */
     priority: number;
+    /** (optional) the workflow id */
+    workflowId?: string | undefined;
+    /** (optional) the workflow version id */
+    workflowVersionId?: string | undefined;
 }
 export interface WorkerListenRequest {
     /** the id of the worker */

package/protoc/dispatcher/dispatcher.js

@@ -1094,6 +1094,8 @@ function createBaseAssignedAction() {
         childWorkflowKey: undefined,
         parentWorkflowRunId: undefined,
         priority: 0,
+        workflowId: undefined,
+        workflowVersionId: undefined,
     };
 }
 exports.AssignedAction = {
@@ -1152,6 +1154,12 @@ exports.AssignedAction = {
         if (message.priority !== 0) {
             writer.uint32(144).int32(message.priority);
         }
+        if (message.workflowId !== undefined) {
+            writer.uint32(154).string(message.workflowId);
+        }
+        if (message.workflowVersionId !== undefined) {
+            writer.uint32(162).string(message.workflowVersionId);
+        }
         return writer;
     },
     decode(input, length) {
@@ -1287,6 +1295,20 @@ exports.AssignedAction = {
                     message.priority = reader.int32();
                     continue;
                 }
+                case 19: {
+                    if (tag !== 154) {
+                        break;
+                    }
+                    message.workflowId = reader.string();
+                    continue;
+                }
+                case 20: {
+                    if (tag !== 162) {
+                        break;
+                    }
+                    message.workflowVersionId = reader.string();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -1325,6 +1347,10 @@ exports.AssignedAction = {
                 ? globalThis.String(object.parentWorkflowRunId)
                 : undefined,
             priority: isSet(object.priority) ? globalThis.Number(object.priority) : 0,
+            workflowId: isSet(object.workflowId) ? globalThis.String(object.workflowId) : undefined,
+            workflowVersionId: isSet(object.workflowVersionId)
+                ? globalThis.String(object.workflowVersionId)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -1383,13 +1409,19 @@ exports.AssignedAction = {
         if (message.priority !== 0) {
             obj.priority = Math.round(message.priority);
         }
+        if (message.workflowId !== undefined) {
+            obj.workflowId = message.workflowId;
+        }
+        if (message.workflowVersionId !== undefined) {
+            obj.workflowVersionId = message.workflowVersionId;
+        }
         return obj;
     },
     create(base) {
         return exports.AssignedAction.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v;
         const message = createBaseAssignedAction();
         message.tenantId = (_a = object.tenantId) !== null && _a !== void 0 ? _a : '';
         message.workflowRunId = (_b = object.workflowRunId) !== null && _b !== void 0 ? _b : '';
@@ -1409,6 +1441,8 @@ exports.AssignedAction = {
         message.childWorkflowKey = (_r = object.childWorkflowKey) !== null && _r !== void 0 ? _r : undefined;
         message.parentWorkflowRunId = (_s = object.parentWorkflowRunId) !== null && _s !== void 0 ? _s : undefined;
         message.priority = (_t = object.priority) !== null && _t !== void 0 ? _t : 0;
+        message.workflowId = (_u = object.workflowId) !== null && _u !== void 0 ? _u : undefined;
+        message.workflowVersionId = (_v = object.workflowVersionId) !== null && _v !== void 0 ? _v : undefined;
         return message;
     },
 };

package/protoc/events/events.d.ts

@@ -29,6 +29,8 @@ export interface PutLogRequest {
     level?: string | undefined;
     /** associated log line metadata */
     metadata: string;
+    /** the retry count of the task run */
+    taskRetryCount?: number | undefined;
 }
 export interface PutLogResponse {
 }

package/protoc/events/events.js

@@ -208,7 +208,14 @@ exports.Events = {
     },
 };
 function createBasePutLogRequest() {
-    return { stepRunId: '', createdAt: undefined, message: '', level: undefined, metadata: '' };
+    return {
+        stepRunId: '',
+        createdAt: undefined,
+        message: '',
+        level: undefined,
+        metadata: '',
+        taskRetryCount: undefined,
+    };
 }
 exports.PutLogRequest = {
     encode(message, writer = new wire_1.BinaryWriter()) {
@@ -227,6 +234,9 @@ exports.PutLogRequest = {
         if (message.metadata !== '') {
             writer.uint32(42).string(message.metadata);
         }
+        if (message.taskRetryCount !== undefined) {
+            writer.uint32(48).int32(message.taskRetryCount);
+        }
         return writer;
     },
     decode(input, length) {
@@ -271,6 +281,13 @@ exports.PutLogRequest = {
                     message.metadata = reader.string();
                     continue;
                 }
+                case 6: {
+                    if (tag !== 48) {
+                        break;
+                    }
+                    message.taskRetryCount = reader.int32();
+                    continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
@@ -286,6 +303,9 @@ exports.PutLogRequest = {
             message: isSet(object.message) ? globalThis.String(object.message) : '',
             level: isSet(object.level) ? globalThis.String(object.level) : undefined,
             metadata: isSet(object.metadata) ? globalThis.String(object.metadata) : '',
+            taskRetryCount: isSet(object.taskRetryCount)
+                ? globalThis.Number(object.taskRetryCount)
+                : undefined,
         };
     },
     toJSON(message) {
@@ -305,19 +325,23 @@ exports.PutLogRequest = {
         if (message.metadata !== '') {
             obj.metadata = message.metadata;
         }
+        if (message.taskRetryCount !== undefined) {
+            obj.taskRetryCount = Math.round(message.taskRetryCount);
+        }
         return obj;
     },
     create(base) {
         return exports.PutLogRequest.fromPartial(base !== null && base !== void 0 ? base : {});
     },
     fromPartial(object) {
-        var _a, _b, _c, _d, _e;
+        var _a, _b, _c, _d, _e, _f;
         const message = createBasePutLogRequest();
         message.stepRunId = (_a = object.stepRunId) !== null && _a !== void 0 ? _a : '';
         message.createdAt = (_b = object.createdAt) !== null && _b !== void 0 ? _b : undefined;
         message.message = (_c = object.message) !== null && _c !== void 0 ? _c : '';
         message.level = (_d = object.level) !== null && _d !== void 0 ? _d : undefined;
         message.metadata = (_e = object.metadata) !== null && _e !== void 0 ? _e : '';
+        message.taskRetryCount = (_f = object.taskRetryCount) !== null && _f !== void 0 ? _f : undefined;
         return message;
     },
 };

package/step.js

@@ -301,7 +301,7 @@ class V0Context {
             this.logger.warn('cannot log from context without stepRunId');
             return;
         }
-        this.v0.event.putLog(stepRunId, message, level);
+        this.v0.event.putLog(stepRunId, message, level, this.retryCount());
     }
     /**
      * Refreshes the timeout for the current task.

package/util/logger/logger.d.ts

@@ -1,9 +1,12 @@
+import { JsonObject } from '../../v1';
+export type LogExtra = JsonObject;
 export declare abstract class Logger {
-    abstract debug(message: string): void;
-    abstract info(message: string): void;
-    abstract green(message: string): void;
-    abstract warn(message: string, error?: Error): void;
-    abstract error(message: string, error?: Error): void;
+    abstract debug(message: string, extra?: LogExtra): void | Promise<void>;
+    abstract info(message: string, extra?: LogExtra): void | Promise<void>;
+    abstract green(message: string, extra?: LogExtra): void | Promise<void>;
+    abstract warn(message: string, error?: Error, extra?: LogExtra): void | Promise<void>;
+    abstract error(message: string, error?: Error, extra?: LogExtra): void | Promise<void>;
+    abstract util?(key: string, message: string, extra?: LogExtra): void | Promise<void>;
 }
 export type LogLevel = 'OFF' | 'DEBUG' | 'INFO' | 'WARN' | 'ERROR';
 export declare enum LogLevelEnum {

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

@@ -16,6 +16,10 @@ type ChildRunOpts = RunOpts & {
     key?: string;
     sticky?: boolean;
 };
+type LogExtra = {
+    extra?: any;
+    error?: Error;
+};
 interface ContextData<T, K> {
     input: T;
     triggers: TriggerData;
@@ -32,11 +36,12 @@ export declare class Context<T, K = {}> {
     v1: HatchetClient;
     worker: ContextWorker;
     overridesData: Record<string, any>;
-    logger: Logger;
+    _logger: Logger;
     spawnIndex: number;
     constructor(action: Action, v1: HatchetClient, worker: V1Worker);
     get abortController(): AbortController;
     get cancelled(): boolean;
+    cancel(): Promise<void>;
     /**
      * Retrieves the output of a parent task.
      * @param parentTask - The a CreateTaskOpts or string of the parent task name.
@@ -87,6 +92,16 @@ export declare class Context<T, K = {}> {
      * @returns The workflow run ID.
      */
     workflowRunId(): string;
+    /**
+     * Gets the workflow ID of the currently running workflow.
+     * @returns The workflow id.
+     */
+    workflowId(): string | undefined;
+    /**
+     * Gets the workflow version ID of the currently running workflow.
+     * @returns The workflow version ID.
+     */
+    workflowVersionId(): string | undefined;
     /**
      * Gets the ID of the current task run.
      * @returns The task run ID.
@@ -101,8 +116,16 @@ export declare class Context<T, K = {}> {
      * Logs a message from the current task.
      * @param message - The message to log.
      * @param level - The log level (optional).
+     * @deprecated use ctx.logger.infoger.info, ctx.logger.infoger.debug, ctx.logger.infoger.warn, ctx.logger.infoger.error, ctx.logger.infoger.trace instead
      */
-    log(message: string, level?: LogLevel): void;
+    log(message: string, level?: LogLevel, extra?: LogExtra): Promise<void> | Promise<void[]>;
+    get logger(): {
+        info: (message: string, extra?: any) => Promise<void> | Promise<void[]>;
+        debug: (message: string, extra?: any) => Promise<void> | Promise<void[]>;
+        warn: (message: string, extra?: LogExtra) => Promise<void> | Promise<void[]>;
+        error: (message: string, extra?: LogExtra) => Promise<void> | Promise<void[]>;
+        util: (key: string, message: string, extra?: LogExtra) => void | Promise<void>;
+    };
     /**
      * Refreshes the timeout for the current task.
      * @param incrementBy - The interval by which to increment the timeout.

package/v1/client/worker/context.js

@@ -34,7 +34,7 @@ class Context {
             this.action = action;
             this.v1 = v1;
             this.worker = new step_1.ContextWorker(worker);
-            this.logger = v1.config.logger(`Context Logger`, v1.config.log_level);
+            this._logger = v1.config.logger(`Context Logger`, v1.config.log_level);
             // if this is a getGroupKeyRunId, the data is the workflow input
             if (action.getGroupKeyRunId !== '') {
                 this.input = data;
@@ -54,6 +54,15 @@ class Context {
     get cancelled() {
         return this.controller.signal.aborted;
     }
+    cancel() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.v1.runs.cancel({
+                ids: [this.action.stepRunId],
+            });
+            // optimistically abort the run
+            this.controller.abort();
+        });
+    }
     /**
      * Retrieves the output of a parent task.
      * @param parentTask - The a CreateTaskOpts or string of the parent task name.
@@ -92,7 +101,7 @@ class Context {
     errors() {
         const errors = this.data.step_run_errors || {};
         if (Object.keys(errors).length === 0) {
-            this.logger.error('No run errors found. `ctx.errors` is intended to be run in an on-failure task, and will only work on engine versions more recent than v0.53.10');
+            this._logger.error('No run errors found. `ctx.errors` is intended to be run in an on-failure task, and will only work on engine versions more recent than v0.53.10');
         }
         return errors;
     }
@@ -140,6 +149,20 @@ class Context {
     workflowRunId() {
         return this.action.workflowRunId;
     }
+    /**
+     * Gets the workflow ID of the currently running workflow.
+     * @returns The workflow id.
+     */
+    workflowId() {
+        return this.action.workflowId;
+    }
+    /**
+     * Gets the workflow version ID of the currently running workflow.
+     * @returns The workflow version ID.
+     */
+    workflowVersionId() {
+        return this.action.workflowVersionId;
+    }
     /**
      * Gets the ID of the current task run.
      * @returns The task run ID.
@@ -158,29 +181,56 @@ class Context {
      * Logs a message from the current task.
      * @param message - The message to log.
      * @param level - The log level (optional).
+     * @deprecated use ctx.logger.infoger.info, ctx.logger.infoger.debug, ctx.logger.infoger.warn, ctx.logger.infoger.error, ctx.logger.infoger.trace instead
      */
-    log(message, level) {
+    log(message, level, extra) {
         const { stepRunId } = this.action;
         if (!stepRunId) {
             // log a warning
-            this.logger.warn('cannot log from context without stepRunId');
-            return;
+            this._logger.warn('cannot log from context without stepRunId');
+            return Promise.resolve();
         }
         const logger = this.v1.config.logger('ctx', this.v1.config.log_level);
+        const contextExtra = Object.assign({ workflowRunId: this.action.workflowRunId, taskRunId: this.action.stepRunId, retryCount: this.action.retryCount, workflowName: this.action.jobName }, extra === null || extra === void 0 ? void 0 : extra.extra);
+        const promises = [];
         if (!level || level === 'INFO') {
-            logger.info(message);
+            promises.push(logger.info(message, contextExtra));
         }
         else if (level === 'DEBUG') {
-            logger.debug(message);
+            promises.push(logger.debug(message, contextExtra));
         }
         else if (level === 'WARN') {
-            logger.warn(message);
+            promises.push(logger.warn(message, extra === null || extra === void 0 ? void 0 : extra.error, contextExtra));
         }
         else if (level === 'ERROR') {
-            logger.error(message);
+            promises.push(logger.error(message, extra === null || extra === void 0 ? void 0 : extra.error, contextExtra));
         }
         // FIXME: this is a hack to get around the fact that the log level is not typed
-        this.v1.event.putLog(stepRunId, message, level);
+        promises.push(this.v1.event.putLog(stepRunId, message, level, this.retryCount(), extra === null || extra === void 0 ? void 0 : extra.extra));
+        return Promise.all(promises);
+    }
+    get logger() {
+        return {
+            info: (message, extra) => {
+                return this.log(message, 'INFO', { extra });
+            },
+            debug: (message, extra) => {
+                return this.log(message, 'DEBUG', { extra });
+            },
+            warn: (message, extra) => {
+                return this.log(message, 'WARN', extra);
+            },
+            error: (message, extra) => {
+                return this.log(message, 'ERROR', extra);
+            },
+            util: (key, message, extra) => {
+                const logger = this.v1.config.logger('ctx', this.v1.config.log_level);
+                if (!logger.util) {
+                    return Promise.resolve();
+                }
+                return logger.util(key, message, extra === null || extra === void 0 ? void 0 : extra.extra);
+            },
+        };
     }
     /**
      * Refreshes the timeout for the current task.
@@ -192,7 +242,7 @@ class Context {
             const { stepRunId } = this.action;
             if (!stepRunId) {
                 // log a warning
-                this.logger.warn('cannot refresh timeout from context without stepRunId');
+                this._logger.warn('cannot refresh timeout from context without stepRunId');
                 return;
             }
             yield this.v1._v0.dispatcher.refreshTimeout(incrementBy, stepRunId);
@@ -220,7 +270,7 @@ class Context {
             const { stepRunId } = this.action;
             if (!stepRunId) {
                 // log a warning
-                this.logger.warn('cannot log from context without stepRunId');
+                this._logger.warn('cannot log from context without stepRunId');
                 return;
             }
             yield this.v1._v0.event.putStream(stepRunId, data);
@@ -240,7 +290,7 @@ class Context {
             throw new hatchet_error_1.default(`Cannot run with sticky: workflow ${workflowName} is not registered on the worker`);
         }
         const { workflowRunId, stepRunId } = this.action;
-        const finalOpts = Object.assign(Object.assign({}, options), { parentId: workflowRunId, parentStepRunId: stepRunId, childIndex: this.spawnIndex, desiredWorkerId: sticky ? this.worker.id() : undefined, _standaloneTaskName: workflow instanceof declaration_1.TaskWorkflowDeclaration ? workflow._standalone_task_name : undefined });
+        const finalOpts = Object.assign(Object.assign({}, options), { parentId: workflowRunId, parentStepRunId: stepRunId, childIndex: this.spawnIndex, childKey: options === null || options === void 0 ? void 0 : options.key, desiredWorkerId: sticky ? this.worker.id() : undefined, _standaloneTaskName: workflow instanceof declaration_1.TaskWorkflowDeclaration ? workflow._standalone_task_name : undefined });
         this.spawnIndex += 1;
         return { workflowName, opts: finalOpts };
     }

package/v1/examples/simple/workflow-with-child.d.ts

@@ -11,6 +11,9 @@ export declare const child1: import("../..").CreateWorkflowTaskOpts<ChildInput,
 export declare const child2: import("../..").CreateWorkflowTaskOpts<ChildInput, {
     TransformedMessage: string;
 }>;
+export declare const child3: import("../..").CreateWorkflowTaskOpts<ChildInput, {
+    TransformedMessage: string;
+}>;
 export declare const parent: import("../..").TaskWorkflowDeclaration<ParentInput, {
     TransformedMessage: string;
 }>;

package/v1/examples/simple/workflow-with-child.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parent = exports.child2 = exports.child1 = exports.child = void 0;
+exports.parent = exports.child3 = exports.child2 = exports.child1 = exports.child = void 0;
 // > Declaring a Task
 const hatchet_client_1 = require("../hatchet-client");
 exports.child = hatchet_client_1.hatchet.workflow({
@@ -18,7 +18,7 @@ exports.child = hatchet_client_1.hatchet.workflow({
 exports.child1 = exports.child.task({
     name: 'child1',
     fn: (input, ctx) => {
-        ctx.log('hello from the child1');
+        ctx.logger.info('hello from the child1', { hello: 'moon' });
         return {
             TransformedMessage: input.Message.toLowerCase(),
         };
@@ -27,7 +27,17 @@ exports.child1 = exports.child.task({
 exports.child2 = exports.child.task({
     name: 'child2',
     fn: (input, ctx) => {
-        ctx.log('hello from the child2');
+        ctx.logger.info('hello from the child2');
+        return {
+            TransformedMessage: input.Message.toLowerCase(),
+        };
+    },
+});
+exports.child3 = exports.child.task({
+    name: 'child3',
+    parents: [exports.child1, exports.child2],
+    fn: (input, ctx) => {
+        ctx.logger.info('hello from the child3');
         return {
             TransformedMessage: input.Message.toLowerCase(),
         };

package/version.d.ts

@@ -1 +1 @@
-export declare const HATCHET_VERSION = "1.5.2";
+export declare const HATCHET_VERSION = "1.5.4";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HATCHET_VERSION = void 0;
-exports.HATCHET_VERSION = '1.5.2';
+exports.HATCHET_VERSION = '1.5.4';

package/workflow.d.ts

@@ -387,10 +387,10 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         event: string;
         cron?: undefined;
     } | undefined;
+    timeout?: string | undefined;
     version?: string | undefined;
     scheduleTimeout?: string | undefined;
     sticky?: PbStickyStrategy | undefined;
-    timeout?: string | undefined;
     onFailure?: {
         name: string;
         timeout?: string | undefined;
@@ -449,10 +449,10 @@ export declare const CreateWorkflowSchema: z.ZodObject<{
         event: string;
         cron?: undefined;
     } | undefined;
+    timeout?: string | undefined;
     version?: string | undefined;
     scheduleTimeout?: string | undefined;
     sticky?: PbStickyStrategy | undefined;
-    timeout?: string | undefined;
     onFailure?: {
         name: string;
         timeout?: string | undefined;