Add caching and fallback for modal data

Author: DJtheRedstoner

src/main/java/gg/essential/ad/EssentialAPI.java

@@ -6,6 +6,7 @@
 import org.apache.commons.io.IOUtils;
 
 import java.io.BufferedReader;
+import java.io.BufferedWriter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.net.HttpURLConnection;
@@ -14,6 +15,7 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Base64;
+import java.util.Objects;
 import java.util.concurrent.CompletableFuture;
 
 public class EssentialAPI {
@@ -26,6 +28,8 @@ public class EssentialAPI {
 
     private static final String USER_AGENT = "EssentialAd/" + EssentialAdLoader.OUR_VERSION + " (" + EssentialAdLoader.OUR_PKG + ")";
 
+    private static final Path API_CACHE_FILE = AdConfig.CONFIG_FOLDER.resolve("data.cache.json");
+
     private static final Path API_OVERRIDE_FILE = AdConfig.CONFIG_FOLDER.resolve("data.override.json");
     private static final Path MODAL_OVERRIDE_FOLDER = AdConfig.CONFIG_FOLDER.resolve("override");
     private static final Path MODAL_OVERRIDE_FILE = MODAL_OVERRIDE_FOLDER.resolve("mod-partner-modal-metadata.json");
@@ -40,6 +44,8 @@ public static CompletableFuture<AdData> fetchAdData() {
                         AdData data = EssentialAd.GSON.fromJson(reader, AdData.class);
                         future.complete(data);
                         return;
+                    } catch (Exception e) {
+                        EssentialAd.LOGGER.error("Failed to load api override", e);
                     }
                 }
 
@@ -55,10 +61,16 @@ public static CompletableFuture<AdData> fetchAdData() {
                     response = IOUtils.toString(is, StandardCharsets.UTF_8);
                 }
 
+                try (BufferedWriter writer = Files.newBufferedWriter(API_CACHE_FILE)) {
+                    writer.write(response);
+                } catch (Exception e) {
+                    EssentialAd.LOGGER.error("Failed to write cached response", e);
+                }
+
                 AdData data = EssentialAd.GSON.fromJson(response, AdData.class);
 
                 if (Files.exists(MODAL_OVERRIDE_FILE)) {
-                    EssentialAd.LOGGER.info("Using modal override file");
+                    EssentialAd.LOGGER.info("Using modal override folder");
                     try (BufferedReader reader = Files.newBufferedReader(MODAL_OVERRIDE_FILE)) {
                         ModalData modalData = EssentialAd.GSON.fromJson(reader, ModalData.class);
                         // Replace image paths with base64 representation
@@ -74,15 +86,42 @@ public static CompletableFuture<AdData> fetchAdData() {
                         }
 
                         data = new AdData(modalData, data.getPartneredMods());
+                    } catch (Exception e) {
+                        EssentialAd.LOGGER.error("Failed to load modal override", e);
                     }
                 }
 
                 future.complete(data);
             } catch (Exception e) {
                 EssentialAd.LOGGER.error("Failed to fetch modal data", e);
-                future.completeExceptionally(e);
+
+                try {
+                    future.complete(getFallbackData());
+                } catch (Exception e2) {
+                    EssentialAd.LOGGER.error("Failed to load fallback modal data", e2);
+                    future.completeExceptionally(e2);
+                }
             }
         });
         return future;
     }
+
+    private static AdData getFallbackData() throws IOException {
+        if (Files.exists(API_CACHE_FILE)) {
+            try (BufferedReader reader = Files.newBufferedReader(API_CACHE_FILE)) {
+                AdData data = EssentialAd.GSON.fromJson(reader, AdData.class);
+                EssentialAd.LOGGER.info("Loaded cached response");
+                return data;
+            } catch (Exception e) {
+                EssentialAd.LOGGER.error("Failed to load cached response", e);
+            }
+        }
+
+        try (InputStream is = EssentialAd.class.getResourceAsStream("assets/data.fallback.json")) {
+            Objects.requireNonNull(is, "Fallback data missing!");
+            AdData data = EssentialAd.GSON.fromJson(IOUtils.toString(is, StandardCharsets.UTF_8), AdData.class);
+            EssentialAd.LOGGER.info("Loaded fallback data");
+            return data;
+        }
+    }
 }

src/main/java/gg/essential/ad/EssentialAd.java

@@ -198,7 +198,8 @@ private void createButton(
                 try {
                     data = adDataFuture.join();
                 } catch (CompletionException e) {
-                    ModalManager.INSTANCE.setModal(TwoButtonModal.errorModal()); // fixme, replace with better wording
+                    // This should only happen if the fallback data fails to load, which shouldn't happen.
+                    ModalManager.INSTANCE.setModal(TwoButtonModal.installFailed());
                     return;
                 }
                 ModalManager.INSTANCE.setModal(new AdModal(data.getModal(), getPartnerMods(data)));

src/main/java/gg/essential/ad/modal/AdModal.java

@@ -69,7 +69,7 @@ public void init() {
             if (success) {
                 ModalManager.INSTANCE.setModal(TwoButtonModal.postInstall());
             } else {
-                ModalManager.INSTANCE.setModal(TwoButtonModal.errorModal());
+                ModalManager.INSTANCE.setModal(TwoButtonModal.installFailed());
             }
         }));
 

src/main/java/gg/essential/ad/modal/TwoButtonModal.java

@@ -66,14 +66,14 @@ public static TwoButtonModal removeAds() {
         );
     }
 
-    public static TwoButtonModal errorModal() {
+    public static TwoButtonModal installFailed() {
         return new TwoButtonModal(
-            "Something went wrong\ninstalling Essential.",
-            (x, y, width) -> new ModalButton(x, y, width, ButtonColor.BLUE, "Install Manually", () -> {
-                UDesktop.browse("https://essential.gg");
+            "Essential Mod failed to install.\nSomething went wrong.",
+            (x, y, width) -> new ModalButton(x, y, width, ButtonColor.GRAY, "Okay", () -> {
                 ModalManager.INSTANCE.setModal(null);
             }),
-            (x, y, width) -> new ModalButton(x, y, width, ButtonColor.GRAY, "Okay", () -> {
+            (x, y, width) -> new ModalButton(x, y, width, ButtonColor.BLUE, "Download", () -> {
+                UDesktop.browse("https://essential.gg/download");
                 ModalManager.INSTANCE.setModal(null);
             })
         );

src/main/resources/gg/essential/ad/assets/data.fallback.json

@@ -0,0 +1 @@
+{"modal":{"subtitle":{"en_us":"Enhanced Minecraft features\nin one simple mod."},"features":[{"icon":"iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAQAAAAnOwc2AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAdnJLH8AAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAABxJREFUeNpjIA38BwMcUhgqITSGOoQgE1SAmgAAnF0T74BR+HYAAAAASUVORK5CYII\u003d","text":{"en_us":"Host worlds for free"}},{"icon":"iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAQAAAAnOwc2AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAdnJLH8AAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAAB1JREFUeNpjIAX8BwKsggSk4QwMFQhBBIuJgSIAAFXcJ9u/0PnYAAAAAElFTkSuQmCC","text":{"en_us":"Chat with friends"}},{"icon":"iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAQAAAAnOwc2AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAdnJLH8AAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAACJJREFUeNpjwAn+AwGMhgmhAYQQpjBCCsJDNQIhQFiQRAAAQKhPseGsT84AAAAASUVORK5CYII\u003d","text":{"en_us":"Create custom outfits"}},{"icon":"iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAQAAAAnOwc2AAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAdnJLH8AAAAgY0hSTQAAeiYAAICEAAD6AAAAgOgAAHUwAADqYAAAOpgAABdwnLpRPAAAAB9JREFUeNpjwAn+AwGERAihABIEYQBVCE0YiwsYyAAA8LFDvSmEnMMAAAAASUVORK5CYII\u003d","text":{"en_us":"React with emotes"}},{"icon":"iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAQAAAAnOwc2AAAAH0lEQVR42mPAC/7/Jyz4HwVgCKOpxiEEIVEE4TSJAAAK4S3TgTZ+bwAAAABJRU5ErkJggg\u003d\u003d","text":{"en_us":"Support __mod makers__"},"tooltip":{"en_us":"MOD_PARTNERS"}}],"links":{"learn_more":"https://essential.gg/mod-partners"}},"partnered_mods":[]}