[Improvement-18034][alert] Add configurable timeout for script alert plugin by asadjan4611 · Pull Request #18050 · apache/dolphinscheduler

asadjan4611 · 2026-03-11T09:45:36Z

Purpose of the pull request

The Script Alert Plugin executes external scripts to send alerts. Currently, ProcessUtils.executeScript() calls process.waitFor() with no timeout. If a script hangs (network stall, deadlock, etc.), it permanently blocks a thread in the alert sender thread pool, degrading or blocking all alert delivery.

This PR adds a configurable timeout parameter (default: 60 seconds) to the Script Alert Plugin following the same pattern used by the HTTP Alert Plugin.

Brief change log

Add SCRIPT_TIMEOUT, NAME_SCRIPT_TIMEOUT, DEFAULT_SCRIPT_TIMEOUT constants to ScriptParamsConstants
Add InputNumberParam timeout parameter to ScriptAlertChannelFactory.params()
Replace blocking process.waitFor() with process.waitFor(timeout, TimeUnit.SECONDS) in ProcessUtils
Destroy process forcibly and interrupt stream gobblers on timeout
Parse timeout config in ScriptSender with fallback to default
Handle timeout exit code with clear error message in alert result

Verify this pull request

This change added tests and can be verified as follows:

Added ProcessUtilsTest.testExecuteScriptTimeout to verify process timeout and forced destruction (returns exit code -2)
Added ScriptSenderTest.testDefaultTimeout to verify default timeout works correctly
Added ScriptSenderTest.testCustomTimeout to verify custom timeout value is parsed and applied
Updated ScriptAlertChannelFactoryTest.testGetParams to verify new param count (3 → 4)
Compilation verified locally with mvn clean compile

Copilot

Pull request overview

Adds a configurable execution timeout to the Script Alert Plugin to prevent hung scripts from permanently blocking alert-sender threads, aligning behavior with the HTTP alert plugin’s timeout pattern.

Changes:

Introduce script timeout plugin parameter (default 60s) and expose it via the Script plugin channel factory params.
Update script execution to use waitFor(timeout, TimeUnit.SECONDS) and return a dedicated timeout exit code.
Add/adjust unit tests for the new timeout parameter and timeout behavior.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java	Adds timed waiting for script processes and timeout handling.
dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java	Parses timeout config and maps timeout exit code to a clearer alert result message.
dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptParamsConstants.java	Adds timeout-related constants and default value.
dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactory.java	Exposes timeout as an `InputNumberParam` in the Script plugin UI params.
dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java	Updates tests to use the new timeout API and adds a timeout test case.
dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java	Adds basic tests for default/custom timeout configuration.
dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactoryTest.java	Updates expected param count after adding timeout.

Comments suppressed due to low confidence (1)

dolphinscheduler-alert/dolphinscheduler-alert-plugins/dolphinscheduler-alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java:64

The catch block interrupts the current thread for both InterruptedException and IOException. Interrupting the thread on an IOException can cause unrelated higher-level code to behave as if it was interrupted. Split the catch and only call Thread.currentThread().interrupt() when the exception is actually an InterruptedException.

        } catch (IOException | InterruptedException e) {
            log.error("execute alert script error {}", e.getMessage());
            Thread.currentThread().interrupt();
        }

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java

...src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactory.java

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java

asadjan4611 · 2026-03-11T14:20:59Z

@SbloodyS I have resolved all the copilot issue's please review it again.

…apache#18034)

SbloodyS · 2026-03-16T09:29:43Z

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java

+                    closeProcessStreams(process);
+                    joinGobbler(inputStreamGobbler);
+                    joinGobbler(errorStreamGobbler);
+                    return -2;


It's better to use positive integer here.

SbloodyS · 2026-03-16T09:30:19Z

...src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactory.java

                .build();

-        return Arrays.asList(scriptUserParam, scriptPathParam, scriptTypeParams);
+        InputNumberParam scriptTimeoutParam =


It is best to tell the user the meaning of the exit code in the document.

SbloodyS · 2026-03-16T09:31:37Z

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java

                ? config.get(ScriptParamsConstants.NAME_SCRIPT_USER_PARAMS)
                : "";
+        String timeoutConfig = config.get(ScriptParamsConstants.NAME_SCRIPT_TIMEOUT);
+        if (StringUtils.isNotBlank(timeoutConfig)) {


Suggested change

if (StringUtils.isNotBlank(timeoutConfig)) {

if (StringUtils.isNotEmpty(timeoutConfig)) {

SbloodyS · 2026-03-16T09:33:42Z

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java

+            try {
+                parsedTimeout = Long.parseLong(timeoutConfig);
+            } catch (NumberFormatException ex) {
+                log.warn("Invalid script timeout config value: '{}', using default: {}",


We should return alertResult here.

SbloodyS · 2026-03-16T09:35:15Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java

    private String[] cmd = {"/bin/sh", "-c", shellFilPath + " -t 1"};

    @Test
+    @DisabledOnOs(OS.WINDOWS)


We don't need to do this since we've decleared in the document that windows is not supported.

SbloodyS · 2026-03-16T09:35:23Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java

+    }
+
+    @Test
+    @DisabledOnOs(OS.WINDOWS)


SbloodyS · 2026-03-26T07:38:12Z

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java

 @Slf4j
 public final class ProcessUtils {

+    static final int EXECUTE_ERROR_EXIT_CODE = -1;


Do not use negative number here.

okay fixed out

SbloodyS · 2026-03-26T07:39:06Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java

+    }

-    private String[] cmd = {"/bin/sh", "-c", shellFilPath + " -t 1"};
+    private static String getJavaBin() {


Same as #18050 (comment)

SbloodyS · 2026-03-26T07:39:29Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

    }

    @Test
+    @DisabledOnOs(OS.WINDOWS)


Same as #18050 (comment)

SbloodyS · 2026-03-31T02:31:56Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java


-    private String[] cmd = {"/bin/sh", "-c", shellFilPath + " -t 1"};
+    private static String getJavaBin() {
+        String executableName = System.getProperty("os.name").toLowerCase().contains("win")


Same as #18050 (comment)

SbloodyS · 2026-03-31T02:32:15Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

        AlertResult alertResult;
        alertResult = scriptSender.sendScriptAlert("test user params NPE", "test content");
-        Assertions.assertTrue(alertResult.isSuccess());
+        if (isWindows()) {


Same as #18050 (comment)

SbloodyS · 2026-03-31T02:32:19Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

        AlertResult alertResult;
        alertResult = scriptSender.sendScriptAlert("test title Kris", "test content");
-        Assertions.assertTrue(alertResult.isSuccess());
+        if (isWindows()) {


Same as #18050 (comment)

SbloodyS · 2026-03-31T02:32:35Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

        alertResult = scriptSender.sendScriptAlert("test path NPE", "test content");
        assertFalse(alertResult.isSuccess());
-        Assertions.assertTrue(alertResult.getMessage().contains("shell script is invalid, only support .sh file"));
+        if (isWindows()) {


Same as #18050 (comment)

SbloodyS · 2026-03-31T02:32:40Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

+    public void testDefaultTimeout() {
+        ScriptSender scriptSender = new ScriptSender(scriptConfig);
+        AlertResult alertResult = scriptSender.sendScriptAlert("test title Kris", "test content");
+        if (isWindows()) {


Same as #18050 (comment)

SbloodyS · 2026-03-31T02:32:43Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

+        scriptConfig.put(ScriptParamsConstants.NAME_SCRIPT_TIMEOUT, "30");
+        ScriptSender scriptSender = new ScriptSender(scriptConfig);
+        AlertResult alertResult = scriptSender.sendScriptAlert("test title Kris", "test content");
+        if (isWindows()) {


Same as #18050 (comment)

SbloodyS · 2026-03-31T02:32:50Z

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

+        ScriptSender scriptSender = new ScriptSender(scriptConfig);
+        AlertResult alertResult = scriptSender.sendScriptAlert("test title Kris", "test content");
+        Assertions.assertFalse(alertResult.isSuccess());
+        if (isWindows()) {


Same as #18050 (comment)

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtils.java

...src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptAlertChannelFactory.java

...alert-script/src/main/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSender.java

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ScriptSenderTest.java

...t-script/src/test/java/org/apache/dolphinscheduler/plugin/alert/script/ProcessUtilsTest.java

asadjan4611 · 2026-04-08T06:57:15Z

@SbloodyS i have fix all the issue's please again review it .

SbloodyS · 2026-04-08T08:06:24Z

CI still failed. @asadjan4611

…esolution

asadjan4611 · 2026-04-08T11:57:30Z

@SbloodyS
i have fix all the checks that have been failing and i test it locally now all the checks related to it have been passsed

SbloodyS · 2026-04-08T13:51:12Z

You should run mvn spotless:apply to format the code. @asadjan4611

…e checks

asadjan4611 · 2026-04-08T15:18:59Z

okay @SbloodyS
Thanks your guidance and i have done it.

SbloodyS

There are still many unaddressed comments, you should check them yourself first.

...scheduler-alert-plugins/dolphinscheduler-alert-script/src/test/script/shell/scriptExample.sh

sonarqubecloud · 2026-04-09T02:12:16Z

Quality Gate failed

Failed conditions
0.0% Coverage on New Code (required ≥ 60%)

See analysis details on SonarQube Cloud

asadjan4611 requested a review from SbloodyS as a code owner March 11, 2026 09:45

github-actions bot added backend test labels Mar 11, 2026

github-actions bot assigned asadjan4611 Mar 11, 2026

SbloodyS requested a review from Copilot March 11, 2026 10:05

Copilot started reviewing on behalf of SbloodyS March 11, 2026 10:06 View session

SbloodyS added this to the 3.4.2 milestone Mar 11, 2026

SbloodyS added the improvement make more easy to user or prompt friendly label Mar 11, 2026

Copilot AI reviewed Mar 11, 2026

View reviewed changes

[Improvement][alert] Add configurable timeout for script alert plugin (…

124bf56

…apache#18034)

asadjan4611 force-pushed the feature-18034-script-alert-timeout branch from e902f7e to 124bf56 Compare March 12, 2026 14:07

Merge branch 'dev' into feature-18034-script-alert-timeout

357592b

SbloodyS reviewed Mar 16, 2026

View reviewed changes

[Improvement][alert] Refine script timeout handling and docs

9b55f6c

asadjan4611 requested a review from EricGao888 as a code owner March 25, 2026 04:17

Merge branch 'dev' into feature-18034-script-alert-timeout

0ace319

github-actions bot added the document label Mar 26, 2026

SbloodyS requested changes Mar 26, 2026

View reviewed changes

[Improvement][alert] Address reviewer feedback for script timeout tests

c824269

asadjan4611 requested a review from SbloodyS March 26, 2026 12:50

Merge branch 'dev' into feature-18034-script-alert-timeout

06d3685

SbloodyS requested changes Mar 31, 2026

View reviewed changes

SbloodyS requested a review from Copilot March 31, 2026 02:33

Copilot started reviewing on behalf of SbloodyS March 31, 2026 02:33 View session

Copilot AI reviewed Mar 31, 2026

View reviewed changes

asadjan4611 added 3 commits April 1, 2026 13:05

Refactor script alert timeout handling

b90a5bf

Remove legacy script timeout constants

bffaefd

Fix script timeout documentation

571b35a

asadjan4611 requested a review from SbloodyS April 1, 2026 08:14

Merge branch 'dev' into feature-18034-script-alert-timeout

7fae4d9

[Improvement-18034][alert] Fix script timeout checks and dependency r…

7dedc08

…esolution

Merge branch 'dev' into feature-18034-script-alert-timeout

7093e8f

[Improvement-18034][alert] Refine timeout handling and fix build/styl…

cd820d7

…e checks

Merge branch 'dev' into feature-18034-script-alert-timeout

a11d3d5

SbloodyS reviewed Apr 9, 2026

View reviewed changes

...scheduler-alert-plugins/dolphinscheduler-alert-script/src/test/script/shell/scriptExample.sh Outdated Show resolved Hide resolved

[Improvement-18034][alert] Fix script test file EOF formatting

d473c62

asadjan4611 requested a review from SbloodyS April 9, 2026 07:44

	if (StringUtils.isNotBlank(timeoutConfig)) {
	if (StringUtils.isNotEmpty(timeoutConfig)) {

Conversation

asadjan4611 commented Mar 11, 2026

Purpose of the pull request

Brief change log

Verify this pull request

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asadjan4611 commented Mar 11, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

asadjan4611 commented Apr 8, 2026

Uh oh!

SbloodyS commented Apr 8, 2026

Uh oh!

asadjan4611 commented Apr 8, 2026

Uh oh!

SbloodyS commented Apr 8, 2026

Uh oh!

asadjan4611 commented Apr 8, 2026

Uh oh!