Raise when returning an unstored Data from a WorkflowNode
#2747
Conversation
| super(WorkflowNode, self).validate_outgoing(target, link_type, link_label) | ||
| if link_type is LinkType.RETURN and not target.is_stored: | ||
| raise ValueError( | ||
| 'trying to return an unstored Data node from a workflow is not allowed because it will cause the ' |
There was a problem hiding this comment.
this is already good. What about something like:
"Workflow '{}' tried returning an unstored Data node. This likely means new Data is being created inside the workflow. In order to preserve data provenance, use a calcfunction to create this data, and return its output from the workflow.".format(...)
|
My thirst through was to override the |
sphuber
force-pushed
the
fix_2675_forbid_workchain_return_unstored
branch
3 times, most recently
from
3e58c4d to
599d55b
Compare
| super(WorkflowNode, self).validate_outgoing(target, link_type, link_label) | ||
| if link_type is LinkType.RETURN and not target.is_stored: | ||
| raise ValueError( | ||
| 'Workflow<{}> tried returning an unstored `Data` node. This likely means new `Data` is being created ' |
There was a problem hiding this comment.
I was thinking more of the name of the workflow (which should tell people where in the code they need to change things).
Happy to re-approve if you still want to change this.
There was a problem hiding this comment.
I adapted it to print the process label and also added two more tests on workchain and workfunction level, to make sure it also works through there
This will happen if one tries to return a `Data` node from within the body of a `WorkChain` or `workfunction`, which means that they probably created a new node based on its inputs or data returned by one of the processes it calls. However, this is strictly forbidden as the provenance of the new node will be lost. Given that beginning users are likely to make this mistake, instead of issuing a warning we explicitly forbid this behavior and raise in the link validation.
sphuber
force-pushed
the
fix_2675_forbid_workchain_return_unstored
branch
from
599d55b to
fcddd15
Compare
Fixes #2675
This will happen if one tries to return a
Datanode from within thebody of a
WorkChainorworkfunction, which means that they probablycreated a new node based on its inputs or data returned by one of the
processes it calls. However, this is strictly forbidden as the
provenance of the new node will be lost. Given that beginning users are
likely to make this mistake, instead of issuing a warning we explicitly
forbid this behavior and raise in the link validation.