Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions packages/utils/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
export { pluralize } from './pluralize.js';
export {
parseClassName,
parseStepName,
parseWorkflowName,
} from './parse-name.js';
export { once, type PromiseWithResolvers, withResolvers } from './promise.js';
export { parseDurationToDate } from './time.js';
export {
Expand Down
24 changes: 24 additions & 0 deletions packages/utils/src/re-exports.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { describe, expect, test } from 'vitest';
import { parseClassName, parseStepName, parseWorkflowName } from './index';

describe('re-exports from main index', () => {
test('parseStepName is re-exported', () => {
expect(typeof parseStepName).toBe('function');
const result = parseStepName('step//./src/workflows/order//processOrder');
expect(result?.shortName).toBe('processOrder');
});

test('parseWorkflowName is re-exported', () => {
expect(typeof parseWorkflowName).toBe('function');
const result = parseWorkflowName(
'workflow//./src/workflows/pulse//pulseRemoteWorkflow'
);
expect(result?.shortName).toBe('pulseRemoteWorkflow');
});

test('parseClassName is re-exported', () => {
expect(typeof parseClassName).toBe('function');
const result = parseClassName('class//./src/models/point//Point');
expect(result?.shortName).toBe('Point');
});
});
7 changes: 6 additions & 1 deletion packages/workflow/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,11 @@
"./astro": "./dist/astro.js",
"./vite": "./dist/vite.js",
"./nest": "./dist/nest.js",
"./runtime": "./dist/runtime.js"
"./runtime": "./dist/runtime.js",
"./observability": {
"types": "./dist/observability.d.ts",
"default": "./dist/observability.js"
}
},
"scripts": {
"build": "tsc && chmod +x bin/run.js",
Expand All @@ -65,6 +69,7 @@
"@workflow/core": "workspace:*",
"@workflow/errors": "workspace:*",
"@workflow/typescript-plugin": "workspace:*",
"@workflow/utils": "workspace:*",
"ms": "2.1.3",
"@workflow/next": "workspace:*",
"@workflow/nest": "workspace:*",
Expand Down
48 changes: 48 additions & 0 deletions packages/workflow/src/observability.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { describe, expect, test } from 'vitest';
import {
hydrateData,
hydrateResourceIO,
observabilityRevivers,
parseClassName,
parseStepName,
parseWorkflowName,
} from './observability';

describe('workflow/observability re-exports', () => {
test('parseStepName is exported and works', () => {
const result = parseStepName('step//./src/workflows/pulse//queryKBStep');
expect(result?.shortName).toBe('queryKBStep');
});

test('parseWorkflowName is exported and works', () => {
const result = parseWorkflowName(
'workflow//./src/workflows/pulse//pulseRemoteWorkflow'
);
expect(result?.shortName).toBe('pulseRemoteWorkflow');
});

test('parseClassName is exported and works', () => {
const result = parseClassName('class//./src/models//MyModel');
expect(result?.shortName).toBe('MyModel');
});

test('observabilityRevivers is exported', () => {
expect(typeof observabilityRevivers).toBe('object');
expect(observabilityRevivers).toHaveProperty('ReadableStream');
expect(observabilityRevivers).toHaveProperty('WritableStream');
expect(observabilityRevivers).toHaveProperty('StepFunction');
});

test('hydrateResourceIO is exported and handles plain values', () => {
const step = { stepId: 'test', input: 'hello', output: 42 };
const result = hydrateResourceIO(step, observabilityRevivers);
expect(result.input).toBe('hello');
expect(result.output).toBe(42);
});

test('hydrateData is exported and passes through plain values', () => {
expect(hydrateData('hello', observabilityRevivers)).toBe('hello');
expect(hydrateData(42, observabilityRevivers)).toBe(42);
expect(hydrateData(null, observabilityRevivers)).toBe(null);
});
});
29 changes: 29 additions & 0 deletions packages/workflow/src/observability.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/**
* Observability utilities for hydrating serialized workflow data.
*
* Use these when inspecting workflow step I/O, run inputs/outputs,
* or event data from the Workflow SDK's world APIs.
*
* @example
* ```ts
* import { getWorld } from 'workflow/api';
* import { hydrateResourceIO, observabilityRevivers } from 'workflow/observability';
*
* const world = getWorld();
* const step = await world.steps.get(runId, stepId, { resolveData: 'all' });
* const hydrated = hydrateResourceIO(step, observabilityRevivers);
* // hydrated.input and hydrated.output are now plain JS objects
* ```
*/
export {
hydrateData,
hydrateResourceIO,
observabilityRevivers,
type Revivers,
} from '@workflow/core/serialization-format';

export {
parseClassName,
parseStepName,
parseWorkflowName,
} from '@workflow/utils';
13 changes: 4 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading