feat(workflows-sdk): run, registerStepSuccess and registerStepFailure shortcut

[adrien2p]

What

Currently, when exporting a workflow using the workflowExport util, it is mandatory to first call the resulted function passing the container before being able to call run, registerStepSuccess or failure on it. Now, it is possible to either continue that way, or to directly call the run, registerStepSuccess or failure on the exported workflow and at that moment it is possible to pass a container if needed

e.g

const workflow = exportWorkflow("id" as any, "result_step", prepare)
const wfRunner = workflow(container)
wfRunner.run(...) // Here the container is not expected

or

const workflow = exportWorkflow("id" as any, "result_step", prepare)
workflow.run(...) // Here we can now pass an optional container 

[changeset-bot]

🦋 Changeset detected

Latest commit: 8ab1a56

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@medusajs/workflows-sdk	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
api-reference	🔄 Building (Inspect)	Visit Preview		Jan 22, 2024 6:49pm
medusa-dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 22, 2024 6:49pm

2 Ignored Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-ui	⬜️ Ignored (Inspect)	Visit Preview		Jan 22, 2024 6:49pm
medusa-docs	⬜️ Ignored (Inspect)	Visit Preview		Jan 22, 2024 6:49pm

[adrien2p]

cc @olivermrbl @carlos-r-l-rodrigues

[carlos-r-l-rodrigues]

LGTM

[adrien2p]

@carlos-r-l-rodrigues do you think I should merge so that I can include it in our pr?

[olivermrbl]

I would love to give it a spin 👍

[adrien2p]

@olivermrbl sure, you can look at the tests to see the usage. But at somepoint everything will go through the engine, so it will always go through the enigine run method which among other things accept the container as part of the options 👍

[olivermrbl]

This is great!

And if there's no container, it will try to use the loaded modules under the hood right?

So for example:

const createSomething = createSomethingWorkflow()

const { result, errors } = await createSomething.run({
  input: { ... }
})

[adrien2p]

yes, or you can do

// Here it will use the loaded modules
const { result, errors } = await createSomethingWorkflow.run({
  input: { ... }
})

no need for the first step

[olivermrbl]

Love it 😍

[carlos-r-l-rodrigues]

We have to support both ways:

const wf = myWorkflow();
wf.run({})

and

myWorkflow.run({})

The first one is an instance of LocalWorkflows that is the only way you can extend it.

const wf = myWorkflow();
wf.addStep(...)
wf.run({})

[olivermrbl]

@carlos-r-l-rodrigues, makes sense!