Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat(workflows-sdk): additional properties to context #6760

Merged
merged 7 commits into from
Mar 20, 2024
Merged

Feat(workflows-sdk): additional properties to context #6760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
f0c9ab7
add idempotency key to context
carlos-r-l-rodrigues Mar 20, 2024
5b8833e
step name
carlos-r-l-rodrigues Mar 20, 2024
05a4bdb
changeset
carlos-r-l-rodrigues Mar 20, 2024
517d2cd
Merge branch 'develop' into feat/workflow-step-context
carlos-r-l-rodrigues Mar 20, 2024
573f5a2
Merge branch 'feat/workflow-step-context' of https://github.com/medus…
carlos-r-l-rodrigues Mar 20, 2024
a4d05d6
update hook
carlos-r-l-rodrigues Mar 20, 2024
f1549be
Merge branch 'develop' into feat/workflow-step-context
carlos-r-l-rodrigues Mar 20, 2024
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 .changeset/violet-bikes-develop.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@medusajs/workflows-sdk": patch
---

Added idempotencyKey to workflow step context
10 changes: 10 additions & 0 deletions packages/workflows-sdk/src/utils/composer/create-step.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ function applyStep<
const handler = {
invoke: async (transactionContext) => {
const executionContext: StepExecutionContext = {
workflowId: transactionContext.model_id,
stepName: transactionContext.action,
action: "invoke",
idempotencyKey: transactionContext.idempotency_key,
attempt: transactionContext.attempt,
container: transactionContext.container,
metadata: transactionContext.metadata,
context: transactionContext.context,
Expand All @@ -148,6 +153,11 @@ function applyStep<
compensate: compensateFn
? async (transactionContext) => {
const executionContext: StepExecutionContext = {
workflowId: transactionContext.model_id,
stepName: transactionContext.action,
action: "compensate",
idempotencyKey: transactionContext.idempotency_key,
attempt: transactionContext.attempt,
container: transactionContext.container,
metadata: transactionContext.metadata,
context: transactionContext.context,
Expand Down
5 changes: 5 additions & 0 deletions packages/workflows-sdk/src/utils/composer/hook.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,11 @@ export function hook<TOutput>(
return {
__value: async function (transactionContext) {
const executionContext: StepExecutionContext = {
workflowId: transactionContext.model_id,
stepName: transactionContext.action,
action: transactionContext.action_type,
idempotencyKey: transactionContext.idempotency_key,
attempt: transactionContext.attempt,
container: transactionContext.container,
metadata: transactionContext.metadata,
context: transactionContext.context,
Expand Down
25 changes: 25 additions & 0 deletions packages/workflows-sdk/src/utils/composer/type.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,31 @@ export type CreateWorkflowComposerContext = {
* The step's context.
*/
export interface StepExecutionContext {
/**
* The ID of the workflow.
*/
workflowId: string

/**
* The attempt number of the step.
*/
attempt: number

/**
* The idempoency key of the step.
*/
idempotencyKey: string

/**
* The name of the step.
*/
stepName: string

/**
* The action of the step.
*/
action: "invoke" | "compensate"

/**
* The container used to access resources, such as services, in the step.
*/
Expand Down
Loading