[Backport 2.x] Reset workflow state to initial state after successful deprovision (#643)

Reset workflow state to initial state after successful deprovision (#635)


(cherry picked from commit 33ea800)

Signed-off-by: Daniel Widdis <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: opensearch-trigger-bot[bot]

CHANGELOG.md

@@ -16,7 +16,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 ### Features
 ### Enhancements
 ### Bug Fixes
-### Bug Fixes
+- Reset workflow state to initial state after successful deprovision ([#635](https://github.com/opensearch-project/flow-framework/pull/635))
 - Silently ignore content on APIs that don't require it ([#639](https://github.com/opensearch-project/flow-framework/pull/639))
 
 ### Infrastructure

src/main/java/org/opensearch/flowframework/transport/DeprovisionWorkflowTransportAction.java

@@ -44,11 +44,12 @@
 
 import static org.opensearch.flowframework.common.CommonValue.DEPROVISION_WORKFLOW_THREAD_POOL;
 import static org.opensearch.flowframework.common.CommonValue.PROVISIONING_PROGRESS_FIELD;
-import static org.opensearch.flowframework.common.CommonValue.PROVISION_START_TIME_FIELD;
+import static org.opensearch.flowframework.common.CommonValue.PROVISION_END_TIME_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.RESOURCES_CREATED_FIELD;
 import static org.opensearch.flowframework.common.CommonValue.STATE_FIELD;
 import static org.opensearch.flowframework.common.WorkflowResources.getDeprovisionStepByWorkflowStep;
 import static org.opensearch.flowframework.common.WorkflowResources.getResourceByWorkflowStep;
+import static org.opensearch.flowframework.util.ParseUtils.getUserContext;
 
 /**
  * Transport Action to deprovision a workflow from a stored use case template
@@ -224,18 +225,13 @@ private void updateWorkflowState(
         ActionListener<WorkflowResponse> listener
     ) {
         if (remainingResources.isEmpty()) {
-            // Successful deprovision
-            flowFrameworkIndicesHandler.updateFlowFrameworkSystemIndexDoc(
+            // Successful deprovision, reset state to initial
+            flowFrameworkIndicesHandler.putInitialStateToWorkflowState(
                 workflowId,
-                Map.ofEntries(
-                    Map.entry(STATE_FIELD, State.NOT_STARTED),
-                    Map.entry(PROVISIONING_PROGRESS_FIELD, ProvisioningProgress.NOT_STARTED),
-                    Map.entry(PROVISION_START_TIME_FIELD, Instant.now().toEpochMilli()),
-                    Map.entry(RESOURCES_CREATED_FIELD, Collections.emptyList())
-                ),
-                ActionListener.wrap(updateResponse -> {
-                    logger.info("updated workflow {} state to NOT_STARTED", workflowId);
-                }, exception -> { logger.error("Failed to update workflow state", exception); })
+                getUserContext(client),
+                ActionListener.wrap(indexResponse -> {
+                    logger.info("Reset workflow {} state to NOT_STARTED", workflowId);
+                }, exception -> { logger.error("Failed to reset to initial workflow state for {}", workflowId, exception); })
             );
             // return workflow ID
             listener.onResponse(new WorkflowResponse(workflowId));
@@ -246,7 +242,7 @@ private void updateWorkflowState(
                 Map.ofEntries(
                     Map.entry(STATE_FIELD, State.COMPLETED),
                     Map.entry(PROVISIONING_PROGRESS_FIELD, ProvisioningProgress.DONE),
-                    Map.entry(PROVISION_START_TIME_FIELD, Instant.now().toEpochMilli()),
+                    Map.entry(PROVISION_END_TIME_FIELD, Instant.now().toEpochMilli()),
                     Map.entry(RESOURCES_CREATED_FIELD, remainingResources)
                 ),
                 ActionListener.wrap(updateResponse -> {