starred/windmill
1
0
Fork 0
mirror of https://github.com/windmill-labs/windmill.git synced 2026-09-07 00:01:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add resume and cancel button text options to Slack approval API + formatted args + typo (#8095)

Browse Source
This commit is contained in:
hugocasa
2026-02-25 17:28:06 +00:00
committed by GitHub
parent 935b0058e2
commit c7c828b56e
4 changed files with 80 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
backend/windmill-api/openapi.yaml
+20
View File
@@ -10680,6 +10680,16 @@ paths:
required: false
schema:
type: string
- name: resume_button_text
in: query
required: false
schema:
type: string
- name: cancel_button_text
in: query
required: false
schema:
type: string
responses:
"200":
description: Interactive slack approval message sent successfully
@@ -10726,6 +10736,16 @@ paths:
required: false
schema:
type: string
- name: resume_button_text
in: query
required: false
schema:
type: string
- name: cancel_button_text
in: query
required: false
schema:
type: string
responses:
"200":
description: Interactive slack approval message sent successfully
backend/windmill-api/src/approvals.rs
+13 -2
View File
@@ -83,6 +83,12 @@ pub struct QueryDynamicEnumJson {
pub dynamic_enums_json: Option<serde_json::Value>,
}
#[derive(Deserialize, Debug)]
pub struct QueryButtonText {
pub resume_button_text: Option<String>,
pub cancel_button_text: Option<String>,
}
#[derive(Debug)]
pub struct ApprovalFormDetails {
pub message_str: String,
@@ -266,7 +272,12 @@ pub async fn get_approval_form_details(
})
});
let args_str = args.map_or("None".to_string(), |a| a.get().to_string());
let args_str = args.map_or("None".to_string(), |a| {
serde_json::from_str::<serde_json::Value>(a.get())
.ok()
.and_then(|v| serde_json::to_string_pretty(&v).ok())
.unwrap_or_else(|| a.get().to_string())
});
let parent_job_id_str = parent_job_id.map_or("None".to_string(), |id| id.to_string());
let script_path_str = script_path.as_deref().unwrap_or("None");
@@ -282,7 +293,7 @@ pub async fn get_approval_form_details(
{}: {created_by}\n\n\
{}: {created_at_formatted}\n\n\
{}: {script_path_str}\n\n\
{}: {args_str}\n\n\
{}:\n```\n{args_str}\n```\n\n\
{}: {parent_job_id_str}\n\n",
bold_format.replace("{}", "Created by"),
bold_format.replace("{}", "Created at"),
backend/windmill-api/src/slack_approvals.rs
+32 -5
View File
@@ -16,8 +16,8 @@ use crate::jobs::{QueryApprover, ResumeUrls};
use crate::{
approvals::{
extract_w_id_from_resume_url, handle_resume_action, ApprovalFormDetails, FieldType,
MessageFormat, QueryDefaultArgsJson, QueryDynamicEnumJson, QueryFlowStepId, QueryMessage,
ResumeFormField, ResumeSchema,
MessageFormat, QueryButtonText, QueryDefaultArgsJson, QueryDynamicEnumJson,
QueryFlowStepId, QueryMessage, ResumeFormField, ResumeSchema,
},
auth::OptTokened,
};
@@ -107,6 +107,8 @@ struct ModalActionValue {
flow_step_id: Option<String>,
default_args_json: Option<String>,
dynamic_enums_json: Option<String>,
resume_button_text: Option<String>,
cancel_button_text: Option<String>,
}
#[derive(Deserialize, Debug)]
@@ -200,6 +202,8 @@ pub async fn slack_app_callback_handler(
container,
default_args_json.as_ref(),
dynamic_enums_json.as_ref(),
parsed_value.resume_button_text.as_deref(),
parsed_value.cancel_button_text.as_deref(),
)
.await
.map_err(|e| Error::BadRequest(e.to_string()))?;
@@ -229,6 +233,7 @@ pub async fn request_slack_approval(
Query(flow_step_id): Query<QueryFlowStepId>,
Query(default_args_json): Query<QueryDefaultArgsJson>,
Query(dynamic_enums_json): Query<QueryDynamicEnumJson>,
Query(button_text): Query<QueryButtonText>,
) -> Result<StatusCode, Error> {
let slack_resource_path = slack_resource_path.slack_resource_path;
let channel_id = channel_id.channel_id;
@@ -255,6 +260,8 @@ pub async fn request_slack_approval(
flow_step_id.as_str(),
default_args_json.default_args_json.as_ref(),
dynamic_enums_json.dynamic_enums_json.as_ref(),
button_text.resume_button_text.as_deref(),
button_text.cancel_button_text.as_deref(),
)
.await
.map_err(|e| Error::BadRequest(e.to_string()))?;
@@ -752,6 +759,8 @@ async fn send_slack_message(
flow_step_id: &str,
default_args_json: Option<&serde_json::Value>,
dynamic_enums_json: Option<&serde_json::Value>,
resume_button_text: Option<&str>,
cancel_button_text: Option<&str>,
) -> Result<StatusCode, Box<dyn std::error::Error>> {
let url = "https://slack.com/api/chat.postMessage";
@@ -779,6 +788,14 @@ async fn send_slack_message(
value["dynamic_enums_json"] = dynamic_enums_json.clone();
}
if let Some(resume_button_text) = resume_button_text {
value["resume_button_text"] = serde_json::json!(resume_button_text);
}
if let Some(cancel_button_text) = cancel_button_text {
value["cancel_button_text"] = serde_json::json!(cancel_button_text);
}
let payload = serde_json::json!({
"channel": channel_id,
"text": "A flow has been suspended. Please approve or reject the flow.",
@@ -842,6 +859,8 @@ async fn get_modal_blocks(
container: Container,
default_args_json: Option<&serde_json::Value>,
dynamic_enums_json: Option<&serde_json::Value>,
resume_button_text: Option<&str>,
cancel_button_text: Option<&str>,
) -> Result<axum::Json<serde_json::Value>, Error> {
let approval_details = crate::approvals::get_approval_form_details(
db,
@@ -895,6 +914,8 @@ async fn get_modal_blocks(
&urls.resume,
resource_path,
container,
resume_button_text,
cancel_button_text,
)))
}
@@ -905,6 +926,8 @@ fn construct_payload(
resume_url: &str,
resource_path: &str,
container: Container,
resume_button_text: Option<&str>,
cancel_button_text: Option<&str>,
) -> serde_json::Value {
let mut view = serde_json::json!({
"type": "modal",
@@ -912,12 +935,12 @@ fn construct_payload(
"notify_on_close": true,
"title": {
"type": "plain_text",
"text": "Worfklow Suspended"
"text": "Workflow Suspended"
},
"blocks": blocks,
"submit": {
"type": "plain_text",
"text": "Resume Workflow"
"text": resume_button_text.unwrap_or("Resume Workflow")
},
"private_metadata": serde_json::json!({ "resume_url": resume_url, "resource_path": resource_path, "container": container, "hide_cancel": hide_cancel }).to_string(),
});
@@ -925,7 +948,7 @@ fn construct_payload(
if !hide_cancel {
view["close"] = serde_json::json!({
"type": "plain_text",
"text": "Cancel Workflow"
"text": cancel_button_text.unwrap_or("Cancel Workflow")
});
}
@@ -949,6 +972,8 @@ async fn open_modal_with_blocks(
container: Container,
default_args_json: Option<&serde_json::Value>,
dynamic_enums_json: Option<&serde_json::Value>,
resume_button_text: Option<&str>,
cancel_button_text: Option<&str>,
) -> Result<(), Box<dyn std::error::Error>> {
let resume_id = rand::random::<u32>();
let blocks_json = match get_modal_blocks(
@@ -964,6 +989,8 @@ async fn open_modal_with_blocks(
container,
default_args_json,
dynamic_enums_json,
resume_button_text,
cancel_button_text,
)
.await
{
typescript-client/client.ts
+15
View File
@@ -1169,6 +1169,8 @@ interface SlackApprovalOptions {
approver?: string;
defaultArgsJson?: Record<string, any>;
dynamicEnumsJson?: Record<string, any>;
resumeButtonText?: string;
cancelButtonText?: string;
}
interface TeamsApprovalOptions {
@@ -1208,6 +1210,8 @@ interface TeamsApprovalOptions {
* approver: "approver123",
* defaultArgsJson: { key1: "value1", key2: 42 },
* dynamicEnumsJson: { foo: ["choice1", "choice2"], bar: ["optionA", "optionB"] },
* resumeButtonText: "Resume",
* cancelButtonText: "Cancel",
* });
* ```
*
@@ -1220,6 +1224,8 @@ export async function requestInteractiveSlackApproval({
approver,
defaultArgsJson,
dynamicEnumsJson,
resumeButtonText,
cancelButtonText,
}: SlackApprovalOptions): Promise<void> {
const workspace = getWorkspace();
const flowJobId = getEnv("WM_FLOW_JOB_ID");
@@ -1244,6 +1250,8 @@ export async function requestInteractiveSlackApproval({
flowStepId: string;
defaultArgsJson?: string;
dynamicEnumsJson?: string;
resumeButtonText?: string;
cancelButtonText?: string;
} = {
slackResourcePath,
channelId,
@@ -1265,6 +1273,13 @@ export async function requestInteractiveSlackApproval({
params.dynamicEnumsJson = JSON.stringify(dynamicEnumsJson);
}
if (resumeButtonText) {
params.resumeButtonText = resumeButtonText;
}
if (cancelButtonText) {
params.cancelButtonText = cancelButtonText;
}
await JobService.getSlackApprovalPayload({
workspace,
...params,