Add pause/resume button to the pipeline overview page by stuartrowe · Pull Request #1345 · jenkinsci/pipeline-graph-view-plugin

stuartrowe · 2026-06-19T04:28:59Z

Resolves #1344

Implemented a pause/resume button to toggle the pause state of the underlying CpsFlowExecution.

Added new API methods for pausing, resuming and querying the pause state.
Created new buttons in tempory-wrapper.jelly and connected them to the API methods with javascript following the same pattern as the existing cancel button.

Pause	Resume

Testing done

Added new Playwright tests to verify the pause and resume button behaviors. Additional manual testing.

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests that demonstrate the feature works or the issue is fixed

timja · 2026-06-19T06:45:12Z

Could we use an overflow menu?
I don't think this needs to be a primary action in the app bar.

I've never used this button and I don't think it should be in front of cancel which is intentionally to the left of all other actions to make it easy to click.

Thanks for the PR

stuartrowe · 2026-06-19T19:10:19Z

I've prototyped adding an overflow menu to the existing Cancel button:

Pause	Resume

It would be nice if the pipeline visualization would reflect the paused state as well.

Copilot

Pull request overview

Adds pause/resume controls to the Pipeline Overview page, exposing CpsFlowExecution pause state via new backend endpoints and wiring them into the existing “Cancel” split-button dropdown, with Playwright coverage for the new behavior.

Changes:

Added doPause, doResume, and pauseState endpoints to the Pipeline Console View action.
Added Pause/Resume dropdown items in temporary-wrapper.jelly plus JS handlers and polling to keep UI state in sync.
Added Playwright tests and page-object helpers for pause/resume interactions.

Reviewed changes

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

Show a summary per file

File	Description
src/main/java/io/jenkins/plugins/pipelinegraphview/consoleview/PipelineConsoleViewAction.java	Adds pause/resume endpoints and pause-state query API.
src/main/resources/components/temporary-wrapper.jelly	Adds Pause/Resume dropdown items and binds them to Stapler JS proxies.
src/main/webapp/js/build.js	Adds click handling + polling to toggle Pause/Resume visibility; improves cancel split-button hiding.
src/main/resources/io/jenkins/plugins/pipelinegraphview/Messages.properties	Adds localized messages for pause/resume failures and unsupported pipelines.
src/main/resources/components/temporary-wrapper.properties	Adds UI strings for Pause/Resume menu items and success notifications.
src/test/java/io/jenkins/plugins/pipelinegraphview/playwright/PipelineOverviewPage.java	Adds page-object helpers for pause/resume.
src/test/java/io/jenkins/plugins/pipelinegraphview/PipelineGraphViewPauseTest.java	Adds Playwright tests validating pause/resume behavior and visibility changes.

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

+        FlowExecution execution = run.getExecution();
+        if (execution == null) {
+            return HttpResponses.errorJSON("No execution found");
+        }
+
+        if (!run.isBuilding()) {
+            return HttpResponses.errorJSON(Messages.run_isFinished());
+        }


+        FlowExecution execution = run.getExecution();
+        if (execution == null) {
+            return HttpResponses.errorJSON("No execution found");
+        }
+
+        if (!run.isBuilding()) {
+            return HttpResponses.errorJSON(Messages.run_isFinished());
+        }


+  fetch("pauseState")
+    .then((rsp) => rsp.json())
+    .then((result) => {


+// Start polling
+setInterval(updatePauseResumeMenuItems, 5000);
+// Initial update
+setTimeout(updatePauseResumeMenuItems, 500);


+                                <j:set var="cancelProxyId" value="${h.generateId()}" />
+                                <st:bind value="${it}" var="rerunAction${cancelProxyId}"/>
                                <div class="jenkins-split-button">
                                    <button id="pgv-rerun"
-                                            data-proxy-name="rerunAction${proxyId}"
+                                            data-proxy-name="rerunAction${cancelProxyId}"
                                            class="jenkins-button jenkins-!-build-color">


+        // Verify entire cancel split-button is hidden
+        assertThat(cancelButton).isHidden();


timja

Generally looks good, copilots comments look worth reviewing.

Feedback:

Can we add an indication the pipeline in paused? - Maybe an info banner: https://weekly.ci.jenkins.io/design-library/banner/
This doesn't work in the new experimental view - somewhat similar to jenkinsci/workflow-cps-plugin#1790 but I guess the same is needed for cancel - cc @janfaracik

…overflow menu is visible

Remove observer pattern as pause state polling needs to always run when the build is in progress in order to show/hide the banner. Poll every 5s when the pause/resume menu items are hidden and every 1s when they are visible.

stuartrowe · 2026-06-21T22:38:50Z

@timja I've addressed copilot's suggestions and added a banner when the execution is paused.

Do you have any feedback on the placement and choice of warning color?

timja

Tested, it was missing on the new layout still with the experimental feature flag.

I've added it there too, good enough for now, could add a button to resume to the CTA but I doubt this is used much.

stuartrowe added 4 commits June 18, 2026 20:40

Implement doPause and getPauseState API methods

e1de99e

Separate pause and resume API methods to simplify frontend/js work

74f0b5d

Add buttons to temporary-wrapper and javascript to toggle pause/resume

786c2ee

Add tests for pause and resume

574029a

stuartrowe requested a review from a team as a code owner June 19, 2026 04:29

Fix eslint promise/always-return

9c7fc1c

Move pause/resume buttons to overflow menu attached to the cancel button

5cb7b2e

Fix tests after moving pause/resume buttons

0d7b047

timja requested a review from Copilot June 21, 2026 07:46

timja added the enhancement New feature or request label Jun 21, 2026

Copilot started reviewing on behalf of timja June 21, 2026 07:47 View session

Copilot AI reviewed Jun 21, 2026

View reviewed changes

timja reviewed Jun 21, 2026

View reviewed changes

stuartrowe added 6 commits June 21, 2026 12:15

Check that run is building before accessing execution

7bc4387

Check response before parsing json

90cf68f

Rename cancelProxyId as reunProxyId used for rerunAction

8a7cf96

Use MutationObserver to only update pause and resume menu items when …

f5b0bcb

…overflow menu is visible

Update test to verify the the pause menu item is hidden

588c490

Add banner when build execution is paused

fd8f20c

Remove observer pattern as pause state polling needs to always run when the build is in progress in order to show/hide the banner. Poll every 5s when the pause/resume menu items are hidden and every 1s when they are visible.

stuartrowe and others added 3 commits June 21, 2026 15:48

Ensure the paused banner is hidden by default

20ff1fd

Run prettier

7b9b70e

Move paused message and add to new layout

953740e

timja approved these changes Jun 22, 2026

View reviewed changes

timja enabled auto-merge (squash) June 22, 2026 21:23

timja merged commit 1cf0f01 into jenkinsci:main Jun 22, 2026
17 checks passed

timja mentioned this pull request Jun 25, 2026

Pipeline Overview sends excessive /stages/pauseState requests (~100 rps) from a single browser tab #1356

Closed

Navigation Menu

Uh oh!

Uh oh!

Add pause/resume button to the pipeline overview page - #1345

Add pause/resume button to the pipeline overview page#1345
timja merged 16 commits into
jenkinsci:mainfrom
stuartrowe:issue-1344-pause-button

stuartrowe commented Jun 19, 2026

Uh oh!

timja commented Jun 19, 2026

Uh oh!

stuartrowe commented Jun 19, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

timja left a comment

Uh oh!

stuartrowe commented Jun 21, 2026

Uh oh!

timja left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		// Verify entire cancel split-button is hidden
		assertThat(cancelButton).isHidden();

Uh oh!

Uh oh!

Conversation

stuartrowe commented Jun 19, 2026

Testing done

Submitter checklist

Uh oh!

timja commented Jun 19, 2026

Uh oh!

stuartrowe commented Jun 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

timja left a comment

Choose a reason for hiding this comment

Uh oh!

stuartrowe commented Jun 21, 2026

Uh oh!

timja left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants