feat: Add fast-fail support in github action if it can't retrieve the package-info.json file (#314)

shannah · web-flow · commit 62f3c4c326d1 · 2025-11-01T05:58:47.000-07:00
diff --git a/action.yml b/action.yml
@@ -27,6 +27,13 @@ inputs:
     description: Optional target repository where to publish releases.
     required: false
     default: ${{ github.repository }}
+  require_existing_jdeploy_tag:
+    description: |
+      Fail if jdeploy tag doesn't exist (strict mode for established projects).
+      Set to 'true' for projects that should always have a jdeploy tag.
+      This prevents accidental data loss by ensuring package-info.json exists before updating.
+    required: false
+    default: 'false'
 
 runs:
   using: composite
@@ -202,6 +209,7 @@ runs:
         GITHUB_REPOSITORY=${{ inputs.target_repository }} $jdeploy_exec github-prepare-release
       env:
         GH_TOKEN: ${{ github.actor }}:${{ inputs.github_token }}
+        JDEPLOY_REQUIRE_EXISTING_TAG: ${{ inputs.require_existing_jdeploy_tag }}
 
     - name: Prepare Installer Bundles for Tag
       if: ${{ env.JDEPLOY_SKIP_EXECUTION != 'true' && inputs.deploy_target == 'github' && github.ref_type == 'tag' }}
@@ -218,6 +226,7 @@ runs:
         GITHUB_REPOSITORY=${{ inputs.target_repository }} $jdeploy_exec github-prepare-release
       env:
         GH_TOKEN: ${{ github.actor }}:${{ inputs.github_token }}
+        JDEPLOY_REQUIRE_EXISTING_TAG: ${{ inputs.require_existing_jdeploy_tag }}
 
     - name: Publish package-info.json to GitHub
       uses: softprops/action-gh-release@v2
diff --git a/cli/src/main/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriver.java b/cli/src/main/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriver.java
@@ -3,6 +3,7 @@
 import ca.weblite.jdeploy.appbundler.BundlerSettings;
 import ca.weblite.jdeploy.downloadPage.DownloadPageSettings;
 import ca.weblite.jdeploy.downloadPage.DownloadPageSettingsService;
+import ca.weblite.jdeploy.environment.Environment;
 import ca.weblite.jdeploy.factories.CheerpjServiceFactory;
 import ca.weblite.jdeploy.helpers.GithubReleaseNotesMutator;
 import ca.weblite.jdeploy.helpers.PackageInfoBuilder;
@@ -27,6 +28,8 @@
 import org.apache.commons.io.FileUtils;
 import org.json.JSONObject;
 
+import java.nio.charset.StandardCharsets;
+
 import javax.inject.Inject;
 import javax.inject.Singleton;
 import java.io.*;
@@ -58,11 +61,13 @@ public class GitHubPublishDriver implements PublishDriverInterface {
     private final DownloadPageSettingsService downloadPageSettingsService;
 
     private final PlatformBundleGenerator platformBundleGenerator;
-    
+
     private final DefaultBundleService defaultBundleService;
-    
+
     private final JDeployProjectFactory projectFactory;
 
+    private final Environment environment;
+
     @Inject
     public GitHubPublishDriver(
             BasePublishDriver baseDriver,
@@ -73,7 +78,8 @@ public GitHubPublishDriver(
             DownloadPageSettingsService downloadPageSettingsService,
             PlatformBundleGenerator platformBundleGenerator,
             DefaultBundleService defaultBundleService,
-            JDeployProjectFactory projectFactory
+            JDeployProjectFactory projectFactory,
+            Environment environment
     ) {
         this.baseDriver = baseDriver;
         this.bundleCodeService = bundleCodeService;
@@ -84,6 +90,7 @@ public GitHubPublishDriver(
         this.platformBundleGenerator = platformBundleGenerator;
         this.defaultBundleService = defaultBundleService;
         this.projectFactory = projectFactory;
+        this.environment = environment;
     }
 
     @Override
@@ -165,10 +172,22 @@ public void prepare(
 
         saveGithubReleaseFiles(context, target);
         PackageInfoBuilder builder = new PackageInfoBuilder();
-        InputStream oldPackageInfo = loadPackageInfo(context, target);
+        InputStream oldPackageInfo = loadPackageInfo(context, target); // May throw IOException now
         if (oldPackageInfo != null) {
-            builder.load(oldPackageInfo);
+            try {
+                builder.load(oldPackageInfo);
+                context.out().println("Loaded existing package-info.json with version history");
+            } catch (Exception ex) {
+                throw new IOException(
+                    "CRITICAL: Failed to parse existing package-info.json. " +
+                    "The file exists but is corrupted or invalid. " +
+                    "Cannot proceed as this would cause data loss.",
+                    ex
+                );
+            }
         } else {
+            // Only reached if jdeploy tag doesn't exist and strict mode is off
+            context.out().println("Creating new package-info.json for first release");
             builder.setCreatedTime();
         }
         builder.setModifiedTime();
@@ -178,10 +197,12 @@ public void prepare(
         if (!PrereleaseHelper.isPrereleaseVersion(version)) {
             builder.setLatestVersion(version);
         }
-        builder.save(
-                Files.newOutputStream(new File(context.getGithubReleaseFilesDir(),
-                        "package-info.json").toPath())
-        );
+
+        File packageInfoFile = new File(context.getGithubReleaseFilesDir(), "package-info.json");
+        builder.save(Files.newOutputStream(packageInfoFile.toPath()));
+
+        // Verify the saved file
+        verifyPackageInfoIntegrity(context, packageInfoFile, version, oldPackageInfo != null);
         // Trigger register of package name
 
         bundleCodeService.fetchJdeployBundleCode(
@@ -298,16 +319,144 @@ private void saveGithubReleaseFiles(PublishingContext context, PublishTargetInte
         context.out().println("Assets copied to " + releaseFilesDir);
     }
 
-    private InputStream loadPackageInfo(PublishingContext context, PublishTargetInterface target) {
+    private InputStream loadPackageInfo(PublishingContext context, PublishTargetInterface target) throws IOException {
         String packageInfoUrl = target.getUrl() + "/releases/download/jdeploy/package-info.json";
+
+        // First check if jdeploy tag exists
+        boolean jdeployTagExists = checkJdeployTagExists(context, target);
+
+        int maxRetries = 3;
+        int retryDelayMs = 2000;
+        IOException lastException = null;
+
+        for (int attempt = 1; attempt <= maxRetries; attempt++) {
+            try {
+                InputStream stream = URLUtil.openStream(new URL(packageInfoUrl));
+                // Validate that we can parse it as JSON
+                validatePackageInfoJson(stream);
+                // Re-open stream since validation consumed it
+                return URLUtil.openStream(new URL(packageInfoUrl));
+            } catch (IOException ex) {
+                lastException = ex;
+                if (attempt < maxRetries) {
+                    context.out().println(
+                        "Attempt " + attempt + "/" + maxRetries +
+                        " failed to load package-info.json from " + packageInfoUrl +
+                        ", retrying in " + retryDelayMs + "ms... Error: " + ex.getMessage()
+                    );
+                    try {
+                        Thread.sleep(retryDelayMs);
+                        retryDelayMs *= 2; // Exponential backoff
+                    } catch (InterruptedException ie) {
+                        Thread.currentThread().interrupt();
+                        throw new IOException("Interrupted while retrying package-info.json load", ie);
+                    }
+                }
+            }
+        }
+
+        // All retries exhausted
+        if (jdeployTagExists) {
+            // jdeploy tag exists but we can't load package-info.json - CRITICAL ERROR
+            throw new IOException(
+                "CRITICAL: The 'jdeploy' tag exists in the repository but package-info.json " +
+                "could not be retrieved or parsed after " + maxRetries + " attempts at " +
+                packageInfoUrl + ". This indicates a serious issue. " +
+                "Cannot proceed as this would cause data loss. " +
+                "Please investigate the jdeploy release and its assets. " +
+                "Last error: " + (lastException != null ? lastException.getMessage() : "unknown"),
+                lastException
+            );
+        }
+
+        // Check if strict mode is enabled (require jdeploy tag to exist)
+        boolean requireExistingTag = "true".equals(environment.get("JDEPLOY_REQUIRE_EXISTING_TAG"));
+        if (requireExistingTag) {
+            throw new IOException(
+                "CRITICAL: jdeploy tag does not exist but JDEPLOY_REQUIRE_EXISTING_TAG is set to true. " +
+                "This project requires an existing jdeploy tag. " +
+                "If this is the first release, set require_existing_jdeploy_tag: 'false' in your workflow.",
+                lastException
+            );
+        }
+
+        // jdeploy tag doesn't exist - this is likely the first release
+        context.out().println(
+            "jdeploy tag not found at " + packageInfoUrl +
+            ". This appears to be the first release, creating new package-info.json"
+        );
+        return null;
+    }
+
+    private boolean checkJdeployTagExists(PublishingContext context, PublishTargetInterface target) {
         try {
-            return URLUtil.openStream(new URL(packageInfoUrl));
-        } catch (IOException ex) {
+            String tagsUrl = target.getUrl() + "/releases/tags/jdeploy";
+            HttpURLConnection conn = (HttpURLConnection) new URL(tagsUrl).openConnection();
+            conn.setRequestMethod("GET");
+            conn.setInstanceFollowRedirects(true);
+            conn.setConnectTimeout(5000);
+            conn.setReadTimeout(5000);
+
+            int responseCode = conn.getResponseCode();
+            conn.disconnect();
+
+            return responseCode == 200;
+        } catch (Exception ex) {
             context.out().println(
-                    "Failed to open stream for existing package-info.json at " + packageInfoUrl +
-                            ". Perhaps it doesn't exist yet"
+                "Could not check if jdeploy tag exists (assuming it doesn't): " + ex.getMessage()
+            );
+            return false;
+        }
+    }
+
+    private void validatePackageInfoJson(InputStream stream) throws IOException {
+        try {
+            String content = IOUtil.readToString(stream);
+            JSONObject json = new JSONObject(content);
+
+            // Validate required fields
+            if (!json.has("name")) {
+                throw new IOException("package-info.json is missing required 'name' field");
+            }
+            if (!json.has("versions")) {
+                throw new IOException("package-info.json is missing required 'versions' field");
+            }
+
+            // Basic structure validation
+            json.getJSONObject("versions"); // Will throw if not an object
+
+        } catch (org.json.JSONException ex) {
+            throw new IOException("package-info.json is not valid JSON: " + ex.getMessage(), ex);
+        }
+    }
+
+    private void verifyPackageInfoIntegrity(
+        PublishingContext context,
+        File packageInfoFile,
+        String currentVersion,
+        boolean hadPreviousVersions
+    ) throws IOException {
+        try {
+            String content = FileUtils.readFileToString(packageInfoFile, StandardCharsets.UTF_8);
+            JSONObject json = new JSONObject(content);
+
+            // Verify current version was added
+            if (!json.getJSONObject("versions").has(currentVersion)) {
+                throw new IOException(
+                    "Verification failed: package-info.json is missing the current version " + currentVersion
+                );
+            }
+
+            context.out().println(
+                "Verification passed: package-info.json contains " +
+                json.getJSONObject("versions").length() + " version(s)"
+            );
+
+        } catch (org.json.JSONException ex) {
+            throw new IOException(
+                "Verification failed: Generated package-info.json is invalid JSON",
+                ex
             );
-            return null;
         }
     }
 
diff --git a/cli/src/main/resources/ca/weblite/jdeploy/github/ant-workflow.yml b/cli/src/main/resources/ca/weblite/jdeploy/github/ant-workflow.yml
@@ -7,6 +7,11 @@ on:
     branches: [ '*' ]
     tags: [ '*' ]
 
+# Prevent concurrent jDeploy workflows to avoid race conditions
+concurrency:
+  group: jdeploy-${{ github.repository }}
+  cancel-in-progress: false
+
 jobs:
   build:
     permissions:
diff --git a/cli/src/main/resources/ca/weblite/jdeploy/github/gradle-workflow.yml b/cli/src/main/resources/ca/weblite/jdeploy/github/gradle-workflow.yml
@@ -8,6 +8,11 @@ on:
     branches: [ '*' ]
     tags: [ '*' ]
 
+# Prevent concurrent jDeploy workflows to avoid race conditions
+concurrency:
+  group: jdeploy-${{ github.repository }}
+  cancel-in-progress: false
+
 permissions:
   contents: read
 
diff --git a/cli/src/main/resources/ca/weblite/jdeploy/github/maven-workflow.yml b/cli/src/main/resources/ca/weblite/jdeploy/github/maven-workflow.yml
@@ -8,6 +8,11 @@ on:
     branches: ['*']
     tags: ['*']
 
+# Prevent concurrent jDeploy workflows to avoid race conditions
+concurrency:
+  group: jdeploy-${{ github.repository }}
+  cancel-in-progress: false
+
 jobs:
   build:
     permissions:
diff --git a/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverIntegrationTest.java b/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverIntegrationTest.java
@@ -140,11 +140,12 @@ public void setup() throws Exception {
         ca.weblite.jdeploy.services.PlatformBundleGenerator platformBundleGenerator = mock(ca.weblite.jdeploy.services.PlatformBundleGenerator.class);
         ca.weblite.jdeploy.services.DefaultBundleService defaultBundleService = mock(ca.weblite.jdeploy.services.DefaultBundleService.class);
         ca.weblite.jdeploy.factories.JDeployProjectFactory projectFactory = mock(ca.weblite.jdeploy.factories.JDeployProjectFactory.class);
-        
+        ca.weblite.jdeploy.environment.Environment githubDriverEnvironment = mock(ca.weblite.jdeploy.environment.Environment.class);
+
         when(cheerpjServiceFactory.create(any())).thenReturn(cheerpjService);
         when(cheerpjService.isEnabled()).thenReturn(false);
         when(packageNameService.getFullPackageName(any(), any())).thenReturn("test-app");
-        
+
         githubDriver = new GitHubPublishDriver(
             baseDriver,
             bundleCodeService,
@@ -154,7 +155,8 @@ public void setup() throws Exception {
             downloadPageSettingsService,
             platformBundleGenerator,
             defaultBundleService,
-            projectFactory
+            projectFactory,
+            githubDriverEnvironment
         );
         
         // Setup test target
diff --git a/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverPackageInfoTest.java b/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverPackageInfoTest.java
diff --git a/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverPlatformBundlesTest.java b/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverPlatformBundlesTest.java
diff --git a/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverTest.java b/cli/src/test/java/ca/weblite/jdeploy/publishing/github/GitHubPublishDriverTest.java
