Generate support bundle Async #617

nevingeorgesunny · 2025-01-27T09:58:57Z

The problem that I am trying to solve

Currently, when users click on the "Generate Bundle" button on the /jenkins/support/ page, There is no user feedback.In case the generation process takes too long, the request may result in a 503 Timeout

Here is the fix

We will generate support bundle anync in backend which we poll for its status from UI.
The support bundle will be saved in the tmp folder, this will be deleted once the user has downloaded the files

here is a gif for the UX

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

nevingeorgesunny · 2025-02-06T12:37:53Z

src/test/java/com/cloudbees/jenkins/support/SupportActionTest.java

@@ -309,11 +314,17 @@ private WebResponse doBundle(String action, String bundle, String user, String e
    }

    private ZipFile downloadBundle(String s) throws IOException, SAXException {


All the test remain the same , as the only thing that changed was how the zip file was obtained, previoulsy it was a sync call , now its async , we just fetch the zip file after the support bundle is created

…ugin into generate-support-bundle-async

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

src/main/java/com/cloudbees/jenkins/support/SupportPlugin.java

src/test/java/com/cloudbees/jenkins/support/SupportActionTest.java

jglick

Minor comments, but seems to work as advertised.

jglick · 2025-02-20T15:28:19Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

-                if (!outputDir.mkdirs()) {
-                    throw new IOException("Failed to create directory: " + outputDir.getAbsolutePath());
+            Path outputDir = SUPPORT_BUNDLE_CREATION_FOLDER.resolve(taskId.toString());
+            if (!Files.exists(outputDir)) {


My point was that you do not need to do this check: createDirectories quietly returns if the directory already exists.

jglick · 2025-02-20T15:28:44Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

+                try {
+                    Files.createDirectories(outputDir);
+                } catch (IOException e) {
+                    throw new IOException("Failed to create directory: " + outputDir.toAbsolutePath(), e);


Probably unnecessary to wrap and rethrow; the original IOException would include sufficient details.

jglick · 2025-02-20T15:29:07Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

+            try (FileOutputStream fileOutputStream =
+                    new FileOutputStream(new File(outputDir.toString(), SYNC_SUPPORT_BUNDLE))) {


Preferable to use Files.newOutputStream.

jglick · 2025-02-20T15:29:53Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

@@ -517,7 +520,7 @@ public ProgressiveRendering getGeneratorByTaskId(String taskId) throws Exception
    }

    public static class SupportBundleAsyncGenerator extends ProgressiveRendering {
-        private final Logger logger = Logger.getLogger(SupportBundleAsyncGenerator.class.getName());
+        private final Logger logger = Logger.getLogger(SupportAction.class.getName());


No I meant you could just use

support-core-plugin/src/main/java/com/cloudbees/jenkins/support/SupportAction.java

Line 105 in effed5e

private final Logger logger = Logger.getLogger(SupportAction.class.getName());

jglick · 2025-02-20T15:30:06Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

-                if (!outputDir.mkdirs()) {
-                    throw new IOException("Failed to create directory: " + outputDir.getAbsolutePath());
+            Path outputDir = SUPPORT_BUNDLE_CREATION_FOLDER.resolve(taskId.toString());
+            if (!Files.exists(outputDir)) {


jglick · 2025-02-20T15:30:19Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

+                } catch (IOException e) {
+                    throw new IOException("Failed to create directory: " + outputDir.toAbsolutePath(), e);


jglick · 2025-02-20T15:30:28Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

                }
            }

-            try (FileOutputStream fileOutputStream = new FileOutputStream(new File(outputDir, supportBundleName))) {
+            try (FileOutputStream fileOutputStream =
+                    new FileOutputStream(new File(outputDir.toString(), supportBundleName))) {


jglick · 2025-02-20T15:31:09Z

src/main/java/com/cloudbees/jenkins/support/SupportAction.java

-        try (ServletOutputStream outputStream = rsp.getOutputStream();
-                FileInputStream inputStream = new FileInputStream(bundleFile)) {
-            IOUtils.copy(inputStream, outputStream);
+        try (ServletOutputStream outputStream = rsp.getOutputStream()) {


stylistically, just

Suggested change

try (ServletOutputStream outputStream = rsp.getOutputStream()) {

try (OutputStream outputStream = rsp.getOutputStream()) {

or

Suggested change

try (ServletOutputStream outputStream = rsp.getOutputStream()) {

try (var outputStream = rsp.getOutputStream()) {

suffices

jglick · 2025-02-20T15:31:55Z

src/test/java/com/cloudbees/jenkins/support/SupportActionTest.java

@@ -347,7 +345,7 @@ private ZipFile downloadSupportBundleByButtonClick() throws IOException, SAXExce
        AtomicReference<HtmlPage> pageRef = new AtomicReference<>(page);

        HtmlPage finalPage = page;
-        await().timeout(10, TimeUnit.HOURS).until(() -> {
+        await().timeout(10, TimeUnit.SECONDS).until(() -> {


or simply

Suggested change

await().timeout(10, TimeUnit.SECONDS).until(() -> {

await().until(() -> {

since this is the default timeout

nevingeorgesunny added 2 commits January 27, 2025 14:54

skleton code for generating support bundle async

ee22fda

typo fix

af6cc21

nevingeorgesunny requested a review from a team as a code owner January 27, 2025 09:58

nevingeorgesunny marked this pull request as draft January 27, 2025 09:59

nevingeorgesunny changed the title ~~Generate support bundle Async~~ [WIP]Generate support bundle Async Jan 27, 2025

github-advanced-security bot found potential problems Jan 27, 2025

View reviewed changes

nevingeorgesunny added 11 commits January 27, 2025 15:34

adding @RequirePOST

7695ea5

adding js to the buttoin

5675aa7

using ProgressiveRendering

b8bcdf6

Merge branch 'master' into generate-support-bundle-async

37bc835

optimising code

d65c900

reverting SupportRunAction

4e4134c

reverting supportAction index

ff965ef

removing sleep

57c3ce2

adding test

ebc046c

mvn spotless apply

a0fd7ee

optimisng UX

9029a26

nevingeorgesunny commented Feb 6, 2025

View reviewed changes

nevingeorgesunny changed the title ~~[WIP]Generate support bundle Async~~ Generate support bundle Async Feb 6, 2025

nevingeorgesunny added 11 commits February 6, 2025 19:23

empty commit to re trigger build

8346e34

logs for debugging test

623fcc8

logs for debugging test

cae36ab

reoving logs

ff88a2d

fixing broken test

2a6962e

empty commit to re trigger build

3f9ecbe

tested fixed

b6ca3f6

increating the test wait time

3303906

fixing test

4159947

fixing unwanted commit

261fcc2

mvn spotless apply

931b8d6

jglick added 2 commits February 19, 2025 19:08

Spotless

8bdbb2b

Merge branch 'master' of https://github.com/jenkinsci/support-core-pl…

b1093eb

…ugin into generate-support-bundle-async

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportAction.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportAction.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportAction.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportAction.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportAction.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportAction.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportPlugin.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportPlugin.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportPlugin.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/main/java/com/cloudbees/jenkins/support/SupportPlugin.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/test/java/com/cloudbees/jenkins/support/SupportActionTest.java Outdated Show resolved Hide resolved

jglick reviewed Feb 20, 2025

View reviewed changes

src/test/java/com/cloudbees/jenkins/support/SupportActionTest.java Outdated Show resolved Hide resolved

jglick approved these changes Feb 20, 2025

View reviewed changes

nevingeorgesunny added 2 commits February 20, 2025 09:31

pr comments

aec97b4

mvn spotless apply

effed5e

nevingeorgesunny mentioned this pull request Feb 20, 2025

Adding rolled custom logs in support bundle #627

Merged

jglick reviewed Feb 20, 2025

View reviewed changes

jglick added this pull request to the merge queue Feb 20, 2025

Merged via the queue into jenkinsci:master with commit 6a6bf31 Feb 20, 2025
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Generate support bundle Async #617

Generate support bundle Async #617

nevingeorgesunny commented Jan 27, 2025 •

edited

Loading

nevingeorgesunny Feb 6, 2025

jglick left a comment

jglick Feb 20, 2025

jglick Feb 20, 2025

jglick Feb 20, 2025

jglick Feb 20, 2025

jglick Feb 20, 2025

jglick Feb 20, 2025

jglick Feb 20, 2025

jglick Feb 20, 2025

jglick Feb 20, 2025

		@@ -309,11 +314,17 @@ private WebResponse doBundle(String action, String bundle, String user, String e
		}

		private ZipFile downloadBundle(String s) throws IOException, SAXException {

		try (FileOutputStream fileOutputStream =
		new FileOutputStream(new File(outputDir.toString(), SYNC_SUPPORT_BUNDLE))) {

		} catch (IOException e) {
		throw new IOException("Failed to create directory: " + outputDir.toAbsolutePath(), e);

	try (ServletOutputStream outputStream = rsp.getOutputStream()) {
	try (OutputStream outputStream = rsp.getOutputStream()) {

	try (ServletOutputStream outputStream = rsp.getOutputStream()) {
	try (var outputStream = rsp.getOutputStream()) {

	await().timeout(10, TimeUnit.SECONDS).until(() -> {
	await().until(() -> {

Generate support bundle Async #617

Generate support bundle Async #617

Conversation

nevingeorgesunny commented Jan 27, 2025 • edited Loading

The problem that I am trying to solve

Here is the fix

Choose a reason for hiding this comment

jglick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nevingeorgesunny commented Jan 27, 2025 •

edited

Loading