Adding new exception type for workflow step failures

[amitgalitz]

Description

Adds a new exception type to differentiate between errors that are due to flow-framework's fault during provisioning vs errors that are due to the downstream plugin's faults.

Also fixed error handling on deprovision:
previously if we gave a payload to the deprovision request we got a 500 error of Channel is already closed

The two error types:

"error": "org.opensearch.flowframework.exception.WorkflowStepException during step create_ingest_pipeline, restStatus: BAD_REQUEST"
"error": "org.opensearch.flowframework.exception.WorkflowStepException during step create_ingest_pipeline, restStatus: BAD_REQUEST"

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[codecov]

Codecov Report

Attention: Patch coverage is 45.16129% with 17 lines in your changes are missing coverage. Please review.

Project coverage is 72.75%. Comparing base (eab5ab6) to head (e5ab7c3).

Files	Patch %	Lines
...flowframework/exception/WorkflowStepException.java	25.00%	6 Missing ⚠️
...rk/transport/ProvisionWorkflowTransportAction.java	0.00%	4 Missing ⚠️
...h/flowframework/rest/RestCreateWorkflowAction.java	0.00%	1 Missing ⚠️
...h/flowframework/rest/RestDeleteWorkflowAction.java	0.00%	1 Missing ⚠️
...wframework/rest/RestDeprovisionWorkflowAction.java	50.00%	1 Missing ⚠️
...flowframework/rest/RestGetWorkflowStateAction.java	0.00%	1 Missing ⚠️
.../flowframework/rest/RestGetWorkflowStepAction.java	0.00%	1 Missing ⚠️
...lowframework/rest/RestProvisionWorkflowAction.java	0.00%	1 Missing ⚠️
...mework/workflow/AbstractRetryableWorkflowStep.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #577      +/-   ##
============================================
- Coverage     72.95%   72.75%   -0.20%     
- Complexity      680      681       +1     
============================================
  Files            81       82       +1     
  Lines          3479     3491      +12     
  Branches        278      279       +1     
============================================
+ Hits           2538     2540       +2     
- Misses          822      832      +10     
  Partials        119      119              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[owaiskazi19]

Tests are not failing currently because WorkflowStepException extendsFlowFrameworkException but we should change the rest test cases to check for WorkflowStepException.

[amitgalitz]

Tests are not failing currently because WorkflowStepException extendsFlowFrameworkException but we should change the rest test cases to check for WorkflowStepException.

Actually there is another reason for this also, that makes me debate if we even need this here. We actually don't return the WorkflowStepException in the rest here ever because we just write it to the error field in the index if it happens during the step. User gets the workflow ID back

[amitgalitz]

Tests are not failing currently because WorkflowStepException extendsFlowFrameworkException but we should change the rest test cases to check for WorkflowStepException.

Actually there is another reason for this also, that makes me debate if we even need this here. We actually don't return the WorkflowStepException in the rest here ever because we just write it to the error field in the index if it happens during the step. User gets the workflow ID back

@joshpalis lmk if you have any opposition to just adding the WorkflowStepException and not changing the rest classes due to above reason

[joshpalis]

@joshpalis lmk if you have any opposition to just adding the WorkflowStepException and not changing the rest classes due to above reason

No concerns, looks good to me

[opensearch-trigger-bot]

The backport to 2.x failed:

The process '/usr/bin/git' failed with exit code 128

To backport manually, run these commands in your terminal:

# Navigate to the root of your repository
cd $(git rev-parse --show-toplevel)
# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add ../.worktrees/flow-framework/backport-2.x 2.x
# Navigate to the new working tree
pushd ../.worktrees/flow-framework/backport-2.x
# Create a new branch
git switch --create backport/backport-577-to-2.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 0f3962974188ac6ff9202c32d0827bdea33636b9
# Push it to GitHub
git push --set-upstream origin backport/backport-577-to-2.x
# Go back to the original working tree
popd
# Delete the working tree
git worktree remove ../.worktrees/flow-framework/backport-2.x

Then, create a pull request where the base branch is 2.x and the compare/head branch is backport/backport-577-to-2.x.