PR comments

Author: nevingeorgesunny

.DS_Store

@@ -107,12 +107,11 @@ public class SupportAction implements RootAction, StaplerProxy {
      */
     private final Logger logger = Logger.getLogger(SupportAction.class.getName());
 
-    private static final String SUPPORT_BUNDLE_FILE_NAME = "support-bundle.zip";
     private static final String SUPPORT_BUNDLE_CREATION_FOLDER = Paths.get(System.getProperty("java.io.tmpdir"))
             .resolve("support-bundle")
             .toString();
 
-    private static final Map<UUID, SupportBundleAsyncGenerator> generatorMap = new ConcurrentHashMap<>();
+    private static final Map<UUID, SupportBundleAsyncGenerator> generatorByTaskId = new ConcurrentHashMap<>();
 
     @Override
     @Restricted(NoExternalUse.class)
@@ -378,7 +377,7 @@ public HttpRedirect doGenerateAllBundlesAsync(StaplerRequest2 req, StaplerRespon
         UUID taskId = UUID.randomUUID();
         SupportBundleAsyncGenerator supportBundleAsyncGenerator = new SupportBundleAsyncGenerator();
         supportBundleAsyncGenerator.init(taskId, components);
-        generatorMap.put(taskId, supportBundleAsyncGenerator);
+        generatorByTaskId.put(taskId, supportBundleAsyncGenerator);
 
         return new HttpRedirect("progressPage?taskId=" + taskId);
     }
@@ -506,8 +505,8 @@ public boolean isSelected() {
         }
     }
 
-    public ProgressiveRendering getGenerateSupportBundle(@QueryParameter String taskId) throws Exception {
-        return generatorMap.get(UUID.fromString(taskId));
+    public ProgressiveRendering getGeneratorByTaskId(@QueryParameter String taskId) throws Exception {
+        return generatorByTaskId.get(UUID.fromString(taskId));
     }
 
     public static class SupportBundleAsyncGenerator extends ProgressiveRendering {
@@ -517,6 +516,7 @@ public static class SupportBundleAsyncGenerator extends ProgressiveRendering {
         private String pathToBundle;
         private List<Component> components;
         private boolean supportBundleGenerationInProgress = false;
+        private String supportBundleName;
 
         public SupportBundleAsyncGenerator init(UUID taskId, List<Component> components) {
             this.taskId = taskId;
@@ -526,36 +526,40 @@ public SupportBundleAsyncGenerator init(UUID taskId, List<Component> components)
 
         @Override
         protected void compute() throws Exception {
-            if (!supportBundleGenerationInProgress) {
-                this.supportBundleGenerationInProgress = true;
-                logger.info("Generating support bundle... task id " + taskId);
-                File outputDir = new File(SUPPORT_BUNDLE_CREATION_FOLDER + "/" + taskId);
-                if (!outputDir.exists()) {
-                    if (!outputDir.mkdirs()) {
-                        throw new IOException("Failed to create directory: " + outputDir.getAbsolutePath());
-                    }
+            if (supportBundleGenerationInProgress) {
+                return;
+            }
+            this.supportBundleName = BundleFileName.generate();
+            this.supportBundleGenerationInProgress = true;
+//            Thread.sleep(6000);
+            logger.fine("Generating support bundle... task id " + taskId);
+            File outputDir = new File(SUPPORT_BUNDLE_CREATION_FOLDER + "/" + taskId);
+            if (!outputDir.exists()) {
+                if (!outputDir.mkdirs()) {
+                    throw new IOException("Failed to create directory: " + outputDir.getAbsolutePath());
                 }
+            }
 
-                try (FileOutputStream fileOutputStream =
-                        new FileOutputStream(new File(outputDir, SUPPORT_BUNDLE_FILE_NAME))) {
-                    SupportPlugin.setRequesterAuthentication(Jenkins.getAuthentication2());
-                    try {
-                        try (ACLContext ignored = ACL.as2(ACL.SYSTEM2)) {
-                            SupportPlugin.writeBundle(fileOutputStream, components);
-                        } catch (IOException e) {
-                            logger.log(Level.FINE, e.getMessage(), e);
-                        }
-                    } finally {
-                        SupportPlugin.clearRequesterAuthentication();
+            try (FileOutputStream fileOutputStream =
+                    new FileOutputStream(new File(outputDir, supportBundleName))) {
+                SupportPlugin.setRequesterAuthentication(Jenkins.getAuthentication2());
+                try {
+                    try (ACLContext ignored = ACL.as2(ACL.SYSTEM2)) {
+                        SupportPlugin.writeBundle(fileOutputStream, components);
+                    } catch (IOException e) {
+                        logger.log(Level.WARNING, e.getMessage(), e);
                     }
                 } finally {
-                    logger.fine("Response completed");
+                    SupportPlugin.clearRequesterAuthentication();
                 }
-
-                pathToBundle = outputDir.getAbsolutePath() + "/" + SUPPORT_BUNDLE_FILE_NAME;
-                isCompleted = true;
-                progress(1);
+            } finally {
+                logger.fine("Response completed");
             }
+
+            pathToBundle = outputDir.getAbsolutePath() + "/" + supportBundleName;
+            isCompleted = true;
+            progress(1);
+
         }
 
         @NonNull
@@ -564,21 +568,25 @@ protected JSON data() {
             JSONObject json = new JSONObject();
             json.put("isCompleted", isCompleted);
             json.put("pathToBundle", pathToBundle);
-            json.put("status", 1);
             json.put("taskId", String.valueOf(taskId));
             return json;
         }
+
+        public String getSupportBundleName() {
+            return supportBundleName;
+        }
     }
 
     public void doDownloadBundle(@QueryParameter("taskId") String taskId, StaplerResponse2 rsp) throws IOException {
-        File bundleFile = new File(SUPPORT_BUNDLE_CREATION_FOLDER + "/" + taskId + "/" + SUPPORT_BUNDLE_FILE_NAME);
+        String supportBundleName = generatorByTaskId.get(UUID.fromString(taskId)).getSupportBundleName();
+        File bundleFile = new File(SUPPORT_BUNDLE_CREATION_FOLDER + "/" + taskId + "/" + supportBundleName);
         if (!bundleFile.exists()) {
             rsp.sendError(HttpServletResponse.SC_NOT_FOUND, "Support bundle file not found");
             return;
         }
 
         rsp.setContentType("application/zip");
-        rsp.addHeader("Content-Disposition", "attachment; filename=" + SUPPORT_BUNDLE_FILE_NAME);
+        rsp.addHeader("Content-Disposition", "attachment; filename=" + supportBundleName);
         try (ServletOutputStream outputStream = rsp.getOutputStream();
                 FileInputStream inputStream = new FileInputStream(bundleFile)) {
             IOUtils.copy(inputStream, outputStream);
@@ -592,7 +600,7 @@ public void doDownloadBundle(@QueryParameter("taskId") String taskId, StaplerRes
 
                             try {
                                 FileUtils.deleteDirectory(outputDir);
-                                generatorMap.remove(taskId);
+                                generatorByTaskId.remove(taskId);
                                 logger.fine(() -> "Cleaned up temporary directory " + outputDir);
 
                             } catch (IOException e) {

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

@@ -9,7 +9,7 @@
         <l:main-panel>
             <h2>Generating Support Bundle</h2>
             <p id="progressMessage">Generating a support bundle for this Jenkins instance. This may take a few minutes.</p>
-            <l:progressiveRendering handler="${it.getGenerateSupportBundle(request.getParameter('taskId'))}" callback="updateProgressUI"/>
+            <l:progressiveRendering handler="${it.getGeneratorByTaskId(request.getParameter('taskId'))}" callback="updateProgressUI"/>
             <l:progressAnimation/>
             <a id="downloadButton" style="display:none;" class="btn btn-primary" href="#">Download Support Bundle</a>
         </l:main-panel>

src/main/resources/com/cloudbees/jenkins/support/SupportAction/progressPage.jelly

@@ -1,5 +1,6 @@
 package com.cloudbees.jenkins.support;
 
+import static org.awaitility.Awaitility.await;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.containsString;
 import static org.hamcrest.Matchers.equalTo;
@@ -38,6 +39,8 @@
 import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.logging.Level;
 import java.util.logging.LogRecord;
 import java.util.logging.Logger;
@@ -71,8 +74,6 @@
  */
 public class SupportActionTest {
 
-    private static final Logger LOGGER = Logger.getLogger(SupportActionTest.class.getName());
-
     private static final Path SUPPORT_BUNDLE_CREATION_FOLDER =
             Paths.get(System.getProperty("java.io.tmpdir")).resolve("support-bundle");
 
@@ -106,7 +107,7 @@ public void generateAllBundles() throws IOException, SAXException {
     public void generateBundlesByUIButtonClick() throws IOException, SAXException, InterruptedException {
         ZipFile supportBundle = downloadSupportBundleByButtonClick();
         assertNotNull(supportBundle.getEntry("manifest.md"));
-        cleanUp();
+        cleanUpSupportBundleInTempFolder();
     }
 
     @Test
@@ -340,25 +341,20 @@ private ZipFile downloadSupportBundleByButtonClick() throws IOException, SAXExce
 
         HtmlAnchor downloadLink = null;
         int maxRetries = 10;
-        int retryCount = 0;
-        int waitTime = 1000;
         File zipFile;
+        AtomicReference<HtmlPage> pageRef = new AtomicReference<>(page);
 
-        while (retryCount < maxRetries) {
+        HtmlPage finalPage = page;
+        await().timeout(10, TimeUnit.SECONDS).until(() -> {
             try {
-                // Check if the download link is present
-                downloadLink = page.getAnchorByText("Download Support Bundle");
-                if (downloadLink != null) {
-                    break;
-                }
+                return pageRef.get().getAnchorByText("Download Support Bundle") != null;
             } catch (ElementNotFoundException e) {
-                // If the link is not found, wait and retry
-                page = (HtmlPage) page.refresh();
-                Thread.sleep(waitTime);
-                retryCount++;
+                pageRef.set((HtmlPage) pageRef.get().refresh());
+                return false;
             }
-        }
+        });
 
+        downloadLink = pageRef.get().getAnchorByText("Download Support Bundle");
         if (downloadLink != null) {
             // Download the zip file
             WebResponse response = downloadLink.click().getWebResponse();
@@ -461,7 +457,7 @@ public void takeSnapshotAndMakeSureSomethingHappens() throws Exception {
                     fail(r.getMessage());
                 }
             }
-            cleanUp();
+            cleanUpSupportBundleInTempFolder();
         }
     }
 
@@ -644,18 +640,19 @@ private void assertBundleNotContains(ZipFile zip, Collection<String> fileNames)
         }
     }
 
-    public void cleanUp() {
+    public void cleanUpSupportBundleInTempFolder() {
         try {
-            if (Files.exists(SUPPORT_BUNDLE_CREATION_FOLDER)) {
-                try (Stream<Path> paths = Files.walk(SUPPORT_BUNDLE_CREATION_FOLDER)) {
-                    paths.filter(Files::isRegularFile).forEach(path -> {
-                        try {
-                            Files.delete(path);
-                        } catch (IOException e) {
-                            throw new RuntimeException(e);
-                        }
-                    });
-                }
+            if (!Files.exists(SUPPORT_BUNDLE_CREATION_FOLDER)) {
+                return;
+            }
+            try (Stream<Path> paths = Files.walk(SUPPORT_BUNDLE_CREATION_FOLDER)) {
+                paths.filter(Files::isRegularFile).forEach(path -> {
+                    try {
+                        Files.delete(path);
+                    } catch (IOException e) {
+                        throw new RuntimeException(e);
+                    }
+                });
             }
         } catch (IOException e) {
             throw new RuntimeException(e);