InteractionContext::returnUrl() and branchReturnUrl() are named misleadingly. They do not send the visitor back to where they came from; they build the dispatcher continuation URL (a signed, capability-token link to the orchestra_interaction.step route) that advances the run to whatever it parks on next. In other words they are "continue to the next step" URLs, not "return" URLs.

The name overloads the word "return", which collides with the operator return-to-trace being added in #3610524 (the orchestra_return target). Renaming the continuation methods to say what they do removes the overload: afterwards "return" means only the operator return, and "next step" means workflow chaining.

Proposed change

  • Rename InteractionContext::returnUrl() to nextStepUrl().
  • Rename InteractionContext::branchReturnUrl() to branchNextStepUrl().
  • Update the callers: PaymentInteraction (three uses), ReviewInteractionBase, CommentInteraction, RedirectInteraction (the branch variant), and the SignalOutcomeInteraction test double, plus the OperationGateway comment.
  • Update the method docblocks to describe the next-step semantics.

This is a mechanical rename with no behavior change. The query argument names those methods feed (a downstream form's return field) are handled separately in #3610524; this issue is only the method naming on InteractionContext.

Issue fork orchestra-3611086

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

mably created an issue. See original summary.

mably’s picture

Status: Active » Needs review

  • mably committed b3c10d07 on 1.x
    task: #3611086 Rename InteractionContext::returnUrl() to nextStepUrl() (...
mably’s picture

Status: Needs review » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.