feat: piece branching

[islamaf]

What does this PR do?

Fixes #2065

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 138bd25. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 3 targets

• nx affected --target=lint --parallel=3
• nx affected --target=build -c production --parallel=3
• nx run-many --target=test --projects=engine,shared,server-api --parallel=3

---

Sent with 💌 from NxCloud.

[abuaboud]

Instead of using a name since you are using it as an id

We can change this to an object where the key is the name of the branch

[islamaf]

I think the issue would be mainly with adding other properties to the branch in case we would need to add this later, if we would go with an object, I suggest this way:

{
    branchName: {
       expectedOutput: true,
       ...otherProperties,
    },
} 

by this way, we would be able to extend the functionality further in the future. What do you think?

[abuaboud]

map of objects work

[abuaboud]

map of objects work

[abuaboud]

Editing flow definition is bad idea and this information is already duplicated.

You can use action definition in the piece to obtain the branch names.

[abuaboud]

action as value should be enough

[abuaboud]

The frontend should tell us the branch name (which is the same as what is defined in the outputs in the piece), and we should update the action in children map. We should never hardcode 'onFailureAction' and 'onSuccessAction'.

[abuaboud]

Same comment as above this is hardcoded.

[abuaboud]

You are depending on the value to decide where to branch this is wrong, what if both were true.

What if i want to include information like it were approved by who? I think you should use key as to execute branch or not this can be rewritten like that

async function runBranchablePieceWithVersion({
    pieceOutput,
    executionState,
    action,
    constants,
    stepOutput,
    version = 'v1',
}: RunBranchablePieceWithVersion): Promise<FlowExecutorContext> {
    const versions = {
        v1: async (): Promise<FlowExecutorContext> => {
            let newExecutionContext = executionState
            for (const [branchKey, _branchValue] of pieceOutput.output.entries()) {
                const childAction = action.children[branchKey]
                if (isNil(childAction)) {
                    continue
                }
                newExecutionContext = await flowExecutor.execute({
                    action: childAction,
                    executionState: newExecutionContext,
                    constants,
                })
                break;
            }
            return newExecutionContext.upsertStep(action.name, stepOutput
                .setOutput(pieceOutput.output))
                .increaseTask()
                .setVerdict(ExecutionVerdict.RUNNING, undefined)
        },
    }

    return versions[version]()
}

Also you can change generate approval link to

 async run(ctx) {
    return {
      approveLink: ctx.generateResumeUrl({
        queryParams: { action: 'approve' },
      }),
      denyLink: ctx.generateResumeUrl({
        queryParams: { action: 'deny' },
      }),
    };
    ```

[abuaboud]

You will also have to bump package.json

[abuaboud]

This has to be removed, It's duplicated information, you already have it in definition selectedTriggerOrAction

[abuaboud]

This has to be removed, It's duplicated information, you already have it in definition suggestion.outputs

[abuaboud]

You already allow array in the framework, this will not work for the documentation you have wrote.

The children array / outputs array in the piece can be longer than 2 elements