Repository navigation
fix(uipath-maestro-case): add test-recipient and go-live guidance [CA-232] #4870
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.
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
Changes from 2 commits
2ac28c9
f1ba7da
9b61b40
5be4487
fb064c4
006e774
10dbfb3
19edbe2
226b68f
a0e145e
60cac69
5451ad2
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -35,6 +35,38 @@ make from syntax alone. Exact signatures remain in the generated API. | |
| error. Write the complementary condition explicitly, even when the negative | ||
| arm only routes to a close-out. | ||
|
|
||
| ## Action recipients and the go-live trap | ||
|
|
||
| <!-- RULE:case.recipient.externalize --> | ||
| - An action task's `recipient` bakes the email address into the plan. Safe for | ||
| testing; a trap for go-live. Going live requires editing every action's | ||
| recipient in the source and republishing the case. | ||
|
|
||
| When a request names a person or test mailbox as the recipient, wire it | ||
| through a case **input** with a placeholder default instead of a literal. | ||
| Declare the input, reference it in the `recipient` field, and verify with | ||
| `case check --source` that the expression resolves: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should fix:
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in a0e145e. The verification claim now names what really catches this shape. With SDK 6.120.17,
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Partly: the doc now says |
||
|
|
||
| ```ts | ||
| .input({ approver: types.string }) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Blocking.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in a0e145e. The snippet now declares
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Verified at 5451ad2: the snippet now uses |
||
| // ... | ||
| .action({ ..., recipient: '=vars.start.output.approver' }) | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Blocking.
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in a0e145e. The recipient is now
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Verified at 5451ad2:
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🛑 Blocker · Types & contracts: use the case recipient contract This recipe fails before it can route an action: the case entry point does not export Show the supported input/default syntax and an expression recipient,
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fixed in a0e145e, as you suggested. The recipe is a case input plus |
||
| ``` | ||
|
|
||
| If `check` reports the expression as a literal, use a script task to read | ||
| the input into a variable and pass that variable's value instead. | ||
|
|
||
| Tell the user before publishing: | ||
| 1. The input default is a **test** value. It routes every action to that | ||
| address until someone edits the case input defaults and republishes. | ||
| 2. Going live means changing the defaults in the source (or removing them so | ||
| the caller must supply real addresses) and publishing a new version. | ||
|
|
||
| <!-- RULE:case.recipient.no-silent-default --> | ||
| - Do not set a recipient default to the user's own email without saying so. | ||
| State what the default is, that it is baked into the plan, and what | ||
| changing it requires. The user decides whether to publish with that default. | ||
|
|
||
| ## Script tasks | ||
|
|
||
| <!-- RULE:case.script.positional-rename --> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💬 Non-blocker · Architecture & design
CA-232 asks for test settings outside the case, such as an asset. This rule still embeds a default and requires a source edit and republish to change it.
Add a supported external configuration route, or explicitly track that ticket requirement as unresolved and describe this change as disclosure guidance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Partly addressed in a0e145e. The recipient is now the case input, so going live means changing the input default, or passing the address at start with
case process run --inputs. Nobody edits every action any more. An Orchestrator asset as the source is not covered. CA-232 stays open for that part, and the PR body says so.