forked from opensearch-project/flow-framework
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Feature/agent_framework] Deprovision API (opensearch-project#271)
* Deprovision REST and Transport Actions Signed-off-by: Daniel Widdis <widdis@gmail.com> * Fix errors you find actually running the code Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add test for Rest deprovision action Signed-off-by: Daniel Widdis <widdis@gmail.com> * Initial copypaste of Deprovision Transport Action Test Signed-off-by: Daniel Widdis <widdis@gmail.com> * Add some delays to let deletions propagate, reset workflow state Signed-off-by: Daniel Widdis <widdis@gmail.com> * Improved deprovisioning results and status updates Signed-off-by: Daniel Widdis <widdis@gmail.com> * Fix bug in resource created parsing Signed-off-by: Daniel Widdis <widdis@gmail.com> * Completed test implementations Signed-off-by: Daniel Widdis <widdis@gmail.com> * Fixes after rebase Signed-off-by: Daniel Widdis <widdis@gmail.com> --------- Signed-off-by: Daniel Widdis <widdis@gmail.com>
- Loading branch information
Showing
10 changed files
with
857 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
src/main/java/org/opensearch/flowframework/rest/RestDeprovisionWorkflowAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
| package org.opensearch.flowframework.rest; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.opensearch.ExceptionsHelper; | ||
| import org.opensearch.client.node.NodeClient; | ||
| import org.opensearch.core.action.ActionListener; | ||
| import org.opensearch.core.rest.RestStatus; | ||
| import org.opensearch.core.xcontent.ToXContent; | ||
| import org.opensearch.core.xcontent.XContentBuilder; | ||
| import org.opensearch.flowframework.common.FlowFrameworkFeatureEnabledSetting; | ||
| import org.opensearch.flowframework.exception.FlowFrameworkException; | ||
| import org.opensearch.flowframework.transport.DeprovisionWorkflowAction; | ||
| import org.opensearch.flowframework.transport.WorkflowRequest; | ||
| import org.opensearch.rest.BaseRestHandler; | ||
| import org.opensearch.rest.BytesRestResponse; | ||
| import org.opensearch.rest.RestRequest; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
|
|
||
| import static org.opensearch.flowframework.common.CommonValue.WORKFLOW_ID; | ||
| import static org.opensearch.flowframework.common.CommonValue.WORKFLOW_URI; | ||
| import static org.opensearch.flowframework.common.FlowFrameworkSettings.FLOW_FRAMEWORK_ENABLED; | ||
|
|
||
| /** | ||
| * Rest Action to facilitate requests to de-provision a workflow | ||
| */ | ||
| public class RestDeprovisionWorkflowAction extends BaseRestHandler { | ||
|
|
||
| private static final String DEPROVISION_WORKFLOW_ACTION = "deprovision_workflow"; | ||
| private static final Logger logger = LogManager.getLogger(RestDeprovisionWorkflowAction.class); | ||
| private final FlowFrameworkFeatureEnabledSetting flowFrameworkFeatureEnabledSetting; | ||
|
|
||
| /** | ||
| * Instantiates a new RestDeprovisionWorkflowAction | ||
| * @param flowFrameworkFeatureEnabledSetting Whether this API is enabled | ||
| */ | ||
| public RestDeprovisionWorkflowAction(FlowFrameworkFeatureEnabledSetting flowFrameworkFeatureEnabledSetting) { | ||
| this.flowFrameworkFeatureEnabledSetting = flowFrameworkFeatureEnabledSetting; | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return DEPROVISION_WORKFLOW_ACTION; | ||
| } | ||
|
|
||
| @Override | ||
| protected BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException { | ||
|
|
||
| try { | ||
| if (!flowFrameworkFeatureEnabledSetting.isFlowFrameworkEnabled()) { | ||
| throw new FlowFrameworkException( | ||
| "This API is disabled. To enable it, update the setting [" + FLOW_FRAMEWORK_ENABLED.getKey() + "] to true.", | ||
| RestStatus.FORBIDDEN | ||
| ); | ||
| } | ||
| // Validate content | ||
| if (request.hasContent()) { | ||
| throw new FlowFrameworkException("No request body is required", RestStatus.BAD_REQUEST); | ||
| } | ||
| // Validate params | ||
| String workflowId = request.param(WORKFLOW_ID); | ||
| if (workflowId == null) { | ||
| throw new FlowFrameworkException("workflow_id cannot be null", RestStatus.BAD_REQUEST); | ||
| } | ||
| WorkflowRequest workflowRequest = new WorkflowRequest(workflowId, null); | ||
|
|
||
| return channel -> client.execute(DeprovisionWorkflowAction.INSTANCE, workflowRequest, ActionListener.wrap(response -> { | ||
| XContentBuilder builder = response.toXContent(channel.newBuilder(), ToXContent.EMPTY_PARAMS); | ||
| channel.sendResponse(new BytesRestResponse(RestStatus.OK, builder)); | ||
| }, exception -> { | ||
| try { | ||
| FlowFrameworkException ex = exception instanceof FlowFrameworkException | ||
| ? (FlowFrameworkException) exception | ||
| : new FlowFrameworkException(exception.getMessage(), ExceptionsHelper.status(exception)); | ||
| XContentBuilder exceptionBuilder = ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS); | ||
| channel.sendResponse(new BytesRestResponse(ex.getRestStatus(), exceptionBuilder)); | ||
| } catch (IOException e) { | ||
| logger.error("Failed to send back provision workflow exception", e); | ||
| channel.sendResponse(new BytesRestResponse(ExceptionsHelper.status(e), e.getMessage())); | ||
| } | ||
| })); | ||
|
|
||
| } catch (FlowFrameworkException ex) { | ||
| return channel -> channel.sendResponse( | ||
| new BytesRestResponse(ex.getRestStatus(), ex.toXContent(channel.newErrorBuilder(), ToXContent.EMPTY_PARAMS)) | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public List<Route> routes() { | ||
| return ImmutableList.of( | ||
| new Route(RestRequest.Method.POST, String.format(Locale.ROOT, "%s/{%s}/%s", WORKFLOW_URI, WORKFLOW_ID, "_deprovision")) | ||
| ); | ||
| } | ||
| } |
27 changes: 27 additions & 0 deletions
27
src/main/java/org/opensearch/flowframework/transport/DeprovisionWorkflowAction.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
| package org.opensearch.flowframework.transport; | ||
|
|
||
| import org.opensearch.action.ActionType; | ||
|
|
||
| import static org.opensearch.flowframework.common.CommonValue.TRANSPORT_ACTION_NAME_PREFIX; | ||
|
|
||
| /** | ||
| * External Action for public facing RestDeprovisionWorkflowAction | ||
| */ | ||
| public class DeprovisionWorkflowAction extends ActionType<WorkflowResponse> { | ||
| /** The name of this action */ | ||
| public static final String NAME = TRANSPORT_ACTION_NAME_PREFIX + "workflow/deprovision"; | ||
| /** An instance of this action */ | ||
| public static final DeprovisionWorkflowAction INSTANCE = new DeprovisionWorkflowAction(); | ||
|
|
||
| private DeprovisionWorkflowAction() { | ||
| super(NAME, WorkflowResponse::new); | ||
| } | ||
| } |
Oops, something went wrong.