-
Notifications
You must be signed in to change notification settings - Fork 410
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(flow): add ignoreDependencyOnFailure option (#2426)
- Loading branch information
1 parent
51ef4ae
commit c7559f4
Showing
12 changed files
with
215 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# Ignore Dependency | ||
|
||
In some situations, you may have a parent job and need to ignore when one of its children fail. | ||
|
||
The pattern to solve this requirement consists on using the **ignoreDependencyOnFailure** option. This option will make sure that when a job fails, the dependency is ignored from the parent, so the parent will complete without waiting for the failed children. | ||
|
||
```typescript | ||
const flow = new FlowProducer({ connection }); | ||
|
||
const originalTree = await flow.add({ | ||
name: 'root-job', | ||
queueName: 'topQueueName', | ||
data: {}, | ||
children: [ | ||
{ | ||
name, | ||
data: { idx: 0, foo: 'bar' }, | ||
queueName: 'childrenQueueName', | ||
opts: { ignoreDependencyOnFailure: true }, | ||
children: [ | ||
{ | ||
name, | ||
data: { idx: 1, foo: 'bah' }, | ||
queueName: 'grandChildrenQueueName', | ||
}, | ||
{ | ||
name, | ||
data: { idx: 2, foo: 'baz' }, | ||
queueName: 'grandChildrenQueueName', | ||
}, | ||
], | ||
}, | ||
{ | ||
name, | ||
data: { idx: 3, foo: 'foo' }, | ||
queueName: 'childrenQueueName', | ||
}, | ||
], | ||
}); | ||
``` | ||
|
||
{% hint style="info" %} | ||
As soon as a **child** with this option fails, the parent job will be moved to a waiting state only if there are no more pending children. | ||
{% endhint %} | ||
|
||
Failed children using this option can be retrieved by **getFailedChildrenValues** method: | ||
|
||
```typescript | ||
const failedChildrenValues = await originalTree.job.getFailedChildrenValues(); | ||
``` | ||
|
||
## Read more: | ||
|
||
- 💡 [Add Flow API Reference](https://api.docs.bullmq.io/classes/v5.FlowProducer.html#add) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--[[ | ||
Function to remove job keys. | ||
]] | ||
|
||
local function removeJobKeys(jobKey) | ||
return rcall("DEL", jobKey, jobKey .. ':logs', | ||
jobKey .. ':dependencies', jobKey .. ':processed', jobKey .. ':failed') | ||
end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters