Add deprecation warnings to Steps from Apps components (#1319)

seratch · web-flow · commit 54d924c7e5f0 · 2024-06-06T10:47:28.000+09:00
diff --git a/bolt/src/main/java/com/slack/api/bolt/App.java b/bolt/src/main/java/com/slack/api/bolt/App.java
@@ -772,14 +772,26 @@ public App viewClosed(Pattern callbackId, ViewClosedHandler handler) {
     // Workflows: Steps from Apps
     // https://api.slack.com/workflows/steps
 
+    /**
+     * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+     */
+    @Deprecated
     public App step(WorkflowStep step) {
         return this.use(step);
     }
 
+    /**
+     * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+     */
+    @Deprecated
     public App workflowStepEdit(String callbackId, WorkflowStepEditHandler handler) {
         return workflowStepEdit(Pattern.compile("^" + Pattern.quote(callbackId) + "$"), handler);
     }
 
+    /**
+     * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+     */
+    @Deprecated
     public App workflowStepEdit(Pattern callbackId, WorkflowStepEditHandler handler) {
         if (workflowStepEditHandlers.get(callbackId) != null) {
             log.warn("Replaced the handler for {}", callbackId);
@@ -788,10 +800,18 @@ public App workflowStepEdit(Pattern callbackId, WorkflowStepEditHandler handler)
         return this;
     }
 
+    /**
+     * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+     */
+    @Deprecated
     public App workflowStepSave(String callbackId, WorkflowStepSaveHandler handler) {
         return workflowStepSave(Pattern.compile("^" + Pattern.quote(callbackId) + "$"), handler);
     }
 
+    /**
+     * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+     */
+    @Deprecated
     public App workflowStepSave(Pattern callbackId, WorkflowStepSaveHandler handler) {
         if (workflowStepSaveHandlers.get(callbackId) != null) {
             log.warn("Replaced the handler for {}", callbackId);
@@ -800,10 +820,18 @@ public App workflowStepSave(Pattern callbackId, WorkflowStepSaveHandler handler)
         return this;
     }
 
+    /**
+     * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+     */
+    @Deprecated
     public App workflowStepExecute(String pattern, WorkflowStepExecuteHandler handler) {
         return workflowStepExecute(Pattern.compile("^.*" + Pattern.quote(pattern) + ".*$"), handler);
     }
 
+    /**
+     * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+     */
+    @Deprecated
     public App workflowStepExecute(Pattern pattern, WorkflowStepExecuteHandler handler) {
         if (workflowStepExecuteHandlers.get(pattern) != null) {
             log.warn("Replaced the handler for {}", pattern);
diff --git a/bolt/src/main/java/com/slack/api/bolt/context/WorkflowCompleteUtility.java b/bolt/src/main/java/com/slack/api/bolt/context/WorkflowCompleteUtility.java
@@ -3,12 +3,14 @@
 import com.slack.api.methods.MethodsClient;
 import com.slack.api.methods.SlackApiException;
 import com.slack.api.methods.response.workflows.WorkflowsStepCompletedResponse;
-import com.slack.api.model.workflow.WorkflowStepOutput;
 
 import java.io.IOException;
-import java.util.List;
 import java.util.Map;
 
+/**
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+ */
+@Deprecated
 public interface WorkflowCompleteUtility {
 
     String getWorkflowStepExecuteId();
diff --git a/bolt/src/main/java/com/slack/api/bolt/context/WorkflowConfigureUtility.java b/bolt/src/main/java/com/slack/api/bolt/context/WorkflowConfigureUtility.java
@@ -10,6 +10,10 @@
 
 import static com.slack.api.model.view.Views.view;
 
+/**
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+ */
+@Deprecated
 public interface WorkflowConfigureUtility {
 
     String getTriggerId();
diff --git a/bolt/src/main/java/com/slack/api/bolt/context/WorkflowFailUtility.java b/bolt/src/main/java/com/slack/api/bolt/context/WorkflowFailUtility.java
@@ -2,12 +2,15 @@
 
 import com.slack.api.methods.MethodsClient;
 import com.slack.api.methods.SlackApiException;
-import com.slack.api.methods.response.workflows.WorkflowsStepCompletedResponse;
 import com.slack.api.methods.response.workflows.WorkflowsStepFailedResponse;
 
 import java.io.IOException;
 import java.util.Map;
 
+/**
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+ */
+@Deprecated
 public interface WorkflowFailUtility {
 
     String getWorkflowStepExecuteId();
diff --git a/bolt/src/main/java/com/slack/api/bolt/context/WorkflowUpdateUtility.java b/bolt/src/main/java/com/slack/api/bolt/context/WorkflowUpdateUtility.java
@@ -10,6 +10,10 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+ */
+@Deprecated
 public interface WorkflowUpdateUtility {
 
     String getWorkflowStepEditId();
diff --git a/bolt/src/main/java/com/slack/api/bolt/context/builtin/WorkflowStepEditContext.java b/bolt/src/main/java/com/slack/api/bolt/context/builtin/WorkflowStepEditContext.java
@@ -6,6 +6,7 @@
 
 /**
  * workflow_step_edit type request's context.
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
  */
 @Getter
 @Setter
@@ -14,6 +15,7 @@
 @AllArgsConstructor
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = false)
+@Deprecated
 public class WorkflowStepEditContext extends Context implements WorkflowConfigureUtility {
 
     private String triggerId;
diff --git a/bolt/src/main/java/com/slack/api/bolt/context/builtin/WorkflowStepExecuteContext.java b/bolt/src/main/java/com/slack/api/bolt/context/builtin/WorkflowStepExecuteContext.java
@@ -6,7 +6,8 @@
 import lombok.*;
 
 /**
- * workflow_step_edit type request's context.
+ * workflow_step_execute type request's context.
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
  */
 @Getter
 @Setter
@@ -15,6 +16,7 @@
 @AllArgsConstructor
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = false)
+@Deprecated
 public class WorkflowStepExecuteContext extends Context
         implements WorkflowCompleteUtility, WorkflowFailUtility {
     private String callbackId;
diff --git a/bolt/src/main/java/com/slack/api/bolt/context/builtin/WorkflowStepSaveContext.java b/bolt/src/main/java/com/slack/api/bolt/context/builtin/WorkflowStepSaveContext.java
@@ -10,13 +10,18 @@
 
 import java.util.Map;
 
+/**
+ * workflow_step_save type request's context.
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+ */
 @Getter
 @Setter
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
 @ToString(callSuper = true)
 @EqualsAndHashCode(callSuper = false)
+@Deprecated
 public class WorkflowStepSaveContext extends Context implements WorkflowUpdateUtility {
 
     private String workflowStepEditId;
diff --git a/bolt/src/main/java/com/slack/api/bolt/handler/builtin/WorkflowStepEditHandler.java b/bolt/src/main/java/com/slack/api/bolt/handler/builtin/WorkflowStepEditHandler.java
@@ -6,5 +6,6 @@
 import com.slack.api.bolt.response.Response;
 
 @FunctionalInterface
+@Deprecated
 public interface WorkflowStepEditHandler extends Handler<WorkflowStepEditContext, WorkflowStepEditRequest, Response> {
 }
diff --git a/bolt/src/main/java/com/slack/api/bolt/handler/builtin/WorkflowStepExecuteHandler.java b/bolt/src/main/java/com/slack/api/bolt/handler/builtin/WorkflowStepExecuteHandler.java
@@ -6,5 +6,6 @@
 import com.slack.api.bolt.response.Response;
 
 @FunctionalInterface
+@Deprecated
 public interface WorkflowStepExecuteHandler extends Handler<WorkflowStepExecuteContext, WorkflowStepExecuteRequest, Response> {
 }
diff --git a/bolt/src/main/java/com/slack/api/bolt/handler/builtin/WorkflowStepSaveHandler.java b/bolt/src/main/java/com/slack/api/bolt/handler/builtin/WorkflowStepSaveHandler.java
@@ -6,5 +6,6 @@
 import com.slack.api.bolt.response.Response;
 
 @FunctionalInterface
+@Deprecated
 public interface WorkflowStepSaveHandler extends Handler<WorkflowStepSaveContext, WorkflowStepSaveRequest, Response> {
 }
diff --git a/bolt/src/main/java/com/slack/api/bolt/middleware/builtin/WorkflowStep.java b/bolt/src/main/java/com/slack/api/bolt/middleware/builtin/WorkflowStep.java
@@ -17,12 +17,16 @@
 import java.util.concurrent.ExecutorService;
 import java.util.regex.Pattern;
 
+/**
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+ */
 @Slf4j
 @Getter
 @Setter
 @Builder
 @NoArgsConstructor
 @AllArgsConstructor
+@Deprecated
 public class WorkflowStep implements Middleware, AutoCloseable {
 
     private String callbackId;
diff --git a/bolt/src/main/java/com/slack/api/bolt/request/builtin/WorkflowStepEditRequest.java b/bolt/src/main/java/com/slack/api/bolt/request/builtin/WorkflowStepEditRequest.java
@@ -9,6 +9,8 @@
 import lombok.ToString;
 
 @ToString(callSuper = true)
+// Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+@Deprecated
 public class WorkflowStepEditRequest extends Request<WorkflowStepEditContext> {
 
     private final String requestBody;
diff --git a/bolt/src/main/java/com/slack/api/bolt/request/builtin/WorkflowStepExecuteRequest.java b/bolt/src/main/java/com/slack/api/bolt/request/builtin/WorkflowStepExecuteRequest.java
@@ -10,6 +10,8 @@
 import lombok.ToString;
 
 @ToString(callSuper = true)
+// Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+@Deprecated
 public class WorkflowStepExecuteRequest extends Request<WorkflowStepExecuteContext> {
 
     private final String requestBody;
diff --git a/bolt/src/main/java/com/slack/api/bolt/request/builtin/WorkflowStepSaveRequest.java b/bolt/src/main/java/com/slack/api/bolt/request/builtin/WorkflowStepSaveRequest.java
@@ -9,6 +9,8 @@
 import lombok.ToString;
 
 @ToString(callSuper = true)
+// Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
+@Deprecated
 public class WorkflowStepSaveRequest extends Request<WorkflowStepSaveContext> {
 
     private final String requestBody;
diff --git a/slack-api-model/src/main/java/com/slack/api/model/event/WorkflowStepDeletedEvent.java b/slack-api-model/src/main/java/com/slack/api/model/event/WorkflowStepDeletedEvent.java
@@ -8,8 +8,10 @@
  * A workflow step supported by your app was removed from a workflow
  * <p>
  * https://api.slack.com/events/workflow_step_deleted
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
  */
 @Data
+@Deprecated
 public class WorkflowStepDeletedEvent implements Event {
 
     public static final String TYPE_NAME = "workflow_step_deleted";
diff --git a/slack-api-model/src/main/java/com/slack/api/model/event/WorkflowStepExecuteEvent.java b/slack-api-model/src/main/java/com/slack/api/model/event/WorkflowStepExecuteEvent.java
@@ -7,8 +7,10 @@
  * A workflow step supported by your app should execute
  * <p>
  * https://api.slack.com/events/workflow_step_execute
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
  */
 @Data
+@Deprecated
 public class WorkflowStepExecuteEvent implements Event {
 
     public static final String TYPE_NAME = "workflow_step_execute";
diff --git a/slack-api-model/src/main/java/com/slack/api/model/event/WorkflowUnpublishedEvent.java b/slack-api-model/src/main/java/com/slack/api/model/event/WorkflowUnpublishedEvent.java
@@ -7,8 +7,10 @@
  * A workflow that contains a step supported by your app was unpublished
  * <p>
  * https://api.slack.com/events/workflow_unpublished
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
  */
 @Data
+@Deprecated
 public class WorkflowUnpublishedEvent implements Event {
 
     public static final String TYPE_NAME = "workflow_unpublished";
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowDeletedHandler.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowDeletedHandler.java
@@ -4,6 +4,7 @@
 import com.slack.api.app_backend.events.payload.WorkflowDeletedPayload;
 import com.slack.api.model.event.WorkflowDeletedEvent;
 
+@Deprecated
 public abstract class WorkflowDeletedHandler extends EventHandler<WorkflowDeletedPayload> {
 
     @Override
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowPublishedHandler.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowPublishedHandler.java
@@ -4,6 +4,7 @@
 import com.slack.api.app_backend.events.payload.WorkflowPublishedPayload;
 import com.slack.api.model.event.WorkflowPublishedEvent;
 
+@Deprecated
 public abstract class WorkflowPublishedHandler extends EventHandler<WorkflowPublishedPayload> {
 
     @Override
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowStepDeletedHandler.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowStepDeletedHandler.java
@@ -4,6 +4,7 @@
 import com.slack.api.app_backend.events.payload.WorkflowStepDeletedPayload;
 import com.slack.api.model.event.WorkflowStepDeletedEvent;
 
+@Deprecated
 public abstract class WorkflowStepDeletedHandler extends EventHandler<WorkflowStepDeletedPayload> {
 
     @Override
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowStepExecuteHandler.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowStepExecuteHandler.java
@@ -4,6 +4,7 @@
 import com.slack.api.app_backend.events.payload.WorkflowStepExecutePayload;
 import com.slack.api.model.event.WorkflowStepExecuteEvent;
 
+@Deprecated
 public abstract class WorkflowStepExecuteHandler extends EventHandler<WorkflowStepExecutePayload> {
 
     @Override
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowUnpublishedHandler.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/handler/WorkflowUnpublishedHandler.java
@@ -4,6 +4,7 @@
 import com.slack.api.app_backend.events.payload.WorkflowPublishedPayload;
 import com.slack.api.model.event.WorkflowUnpublishedEvent;
 
+@Deprecated
 public abstract class WorkflowUnpublishedHandler extends EventHandler<WorkflowPublishedPayload> {
 
     @Override
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowDeletedPayload.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowDeletedPayload.java
@@ -6,6 +6,7 @@
 import java.util.List;
 
 @Data
+@Deprecated
 public class WorkflowDeletedPayload implements EventsApiPayload<WorkflowDeletedEvent> {
 
     private String token;
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowPublishedPayload.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowPublishedPayload.java
@@ -6,6 +6,7 @@
 import java.util.List;
 
 @Data
+@Deprecated
 public class WorkflowPublishedPayload implements EventsApiPayload<WorkflowPublishedEvent> {
 
     private String token;
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowStepDeletedPayload.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowStepDeletedPayload.java
@@ -6,6 +6,7 @@
 import java.util.List;
 
 @Data
+@Deprecated
 public class WorkflowStepDeletedPayload implements EventsApiPayload<WorkflowStepDeletedEvent> {
 
     private String token;
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowStepExecutePayload.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowStepExecutePayload.java
@@ -6,6 +6,7 @@
 import java.util.List;
 
 @Data
+@Deprecated
 public class WorkflowStepExecutePayload implements EventsApiPayload<WorkflowStepExecuteEvent> {
 
     private String token;
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowUnpublishedPayload.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/events/payload/WorkflowUnpublishedPayload.java
@@ -6,6 +6,7 @@
 import java.util.List;
 
 @Data
+@Deprecated
 public class WorkflowUnpublishedPayload implements EventsApiPayload<WorkflowUnpublishedEvent> {
 
     private String token;
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/interactive_components/payload/WorkflowStepEditPayload.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/interactive_components/payload/WorkflowStepEditPayload.java
@@ -12,11 +12,13 @@
 
 /**
  * https://api.slack.com/reference/workflows/workflow_step_edit
+ * @deprecated Use new custom steps: https://api.slack.com/automation/functions/custom-bolt
  */
 @Data
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
+@Deprecated
 public class WorkflowStepEditPayload {
 
     public static final String TYPE = "workflow_step_edit";
diff --git a/slack-app-backend/src/main/java/com/slack/api/app_backend/views/payload/WorkflowStepSavePayload.java b/slack-app-backend/src/main/java/com/slack/api/app_backend/views/payload/WorkflowStepSavePayload.java
@@ -15,6 +15,7 @@
 @Builder
 @AllArgsConstructor
 @NoArgsConstructor
+@Deprecated
 public class WorkflowStepSavePayload {
     public static final String TYPE = "view_submission";
     private final String type = TYPE;

Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,6 @@`
`6`	`6`	`import com.slack.api.bolt.response.Response;`
`7`	`7`
`8`	`8`	`@FunctionalInterface`
	`9`	`+@Deprecated`
`9`	`10`	`public interface WorkflowStepEditHandler extends Handler<WorkflowStepEditContext, WorkflowStepEditRequest, Response> {`
`10`	`11`	`}`