Remove support for mclogs v1 instances

Author: JulianVennen

CHANGELOG.md

@@ -12,6 +12,7 @@
 - `LimitedReader` and `Util` are now internal
 - `LogReader` has been split into multiple classes in the `reader` package.
 - Removed deprecated constants and constructor from the `Log` class.
+- Mclogs instances running v1 are no longer supported.
 
 ## New Features
 - You can now specify a source and other metadata when uploading logs. By default, this is filled with the project name

README.md

@@ -136,10 +136,7 @@ System.out.println("Detected problems: " + analysisResult.getAnalysis().getProbl
 
 ### Using a self-hosted instance of mclogs
 ```java
-Instance instance = new Instance()
-        .setApiBaseUrl("https://api.logs.example.com")
-        .setViewLogUrl("https://api.logs.example.com");
-client.setInstance(instance);
+client.setInstance(new Instance("https://api.logs.example.com"));
 ```
 
 ### Checking the storage limits of the current instance

src/main/java/gs/mclo/api/Instance.java

@@ -2,32 +2,22 @@
 
 import org.jetbrains.annotations.Nullable;
 
-@SuppressWarnings("NotNullFieldNotInitialized")
 public final class Instance {
     private String apiBaseUrl;
-    private String viewLogUrl;
 
     /**
      * Create a new Instance with the default API base URL and view log URL
      */
     public Instance() {
-        this(null, null);
+        this(null);
     }
 
     /**
      * Create a new Instance with a custom API base URL and view log URL
      * @param apiBaseUrl the base URL for the API (e.g. <a href="https://api.mclo.gs/">https://api.mclo.gs/</a>)
-     * @param viewLogUrl the base URL for viewing logs (e.g. <a href="https://mclo.gs/">https://mclo.gs/</a>)
      */
-    public Instance(@Nullable String apiBaseUrl, @Nullable String viewLogUrl) {
-        this.setApiBaseUrl(apiBaseUrl)
-                .setViewLogUrl(viewLogUrl);
-    }
-
-    private String ensureEndsWithSlash(String url) {
-        if (!url.endsWith("/"))
-            url += "/";
-        return url;
+    public Instance(@Nullable String apiBaseUrl) {
+        this.setApiBaseUrl(apiBaseUrl);
     }
 
     /**
@@ -51,35 +41,6 @@ public Instance setApiBaseUrl(@Nullable String apiBaseUrl) {
         return this;
     }
 
-    /**
-     * Get the base URL for viewing logs
-     * @return the base URL for viewing logs
-     */
-    public String getViewLogUrl() {
-        return viewLogUrl;
-    }
-
-    /**
-     * Get the URL for viewing a log
-     * @param id the ID of the log (e.g. HpAwPry)
-     * @return the base URL for viewing logs (e.g. <a href="https://mclo.gs/HpAwPry">https://mclo.gs/HpAwPry</a>)
-     */
-    public String getViewLogUrl(String id) {
-        return viewLogUrl + id;
-    }
-
-    /**
-     * Set the base URL for viewing logs
-     * @param viewLogUrl the base URL for viewing logs (e.g. <a href="https://mclo.gs/">https://mclo.gs/</a>)
-     * @return this
-     */
-    public Instance setViewLogUrl(@Nullable String viewLogUrl) {
-        if (viewLogUrl == null || viewLogUrl.isEmpty())
-            viewLogUrl = "https://mclo.gs/";
-        this.viewLogUrl = ensureEndsWithSlash(viewLogUrl);
-        return this;
-    }
-
     /**
      * Get the URL for uploading a log
      * @return the URL for uploading a log (e.g. <a href="https://api.mclo.gs/1/log">https://api.mclo.gs/1/log</a>)
@@ -130,4 +91,10 @@ public String getStorageLimitUrl() {
     public String getLogUrl(String id) {
         return apiBaseUrl + "1/log/" + id;
     }
+
+    private String ensureEndsWithSlash(String url) {
+        if (!url.endsWith("/"))
+            url += "/";
+        return url;
+    }
 }

src/main/java/gs/mclo/api/MclogsClient.java

@@ -319,7 +319,7 @@ public CompletableFuture<GetLogResponse> getLog(String id, LogField... fields) {
      * @param token deletion token of the log to delete
      * @return a future that completes when the log is deleted
      */
-    public CompletableFuture<Void> deleteLog(String id, @Nullable String token) {
+    public CompletableFuture<Void> deleteLog(String id, String token) {
         HttpRequest request = requestBuilder.request(instance.getLogUrl(id))
                 .header("Authorization", "Bearer " + token)
                 .DELETE()

src/main/java/gs/mclo/api/response/CommonLogResponse.java

@@ -7,6 +7,7 @@
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.Nullable;
 
+import java.time.Instant;
 import java.util.HashSet;
 import java.util.Objects;
 import java.util.Set;
@@ -19,6 +20,13 @@ public class CommonLogResponse implements Initializable {
 
     private String id;
     private @Nullable String source;
+    private Instant created;
+    private Instant expires;
+    private long size;
+    private int lines;
+    private int errors;
+    private String url;
+    private String raw;
     private Set<Metadata<?>> metadata = new HashSet<>();
 
     /**
@@ -40,12 +48,48 @@ public String getId() {
     }
 
     /**
-     * Get the metadata associated with this log
+     * Get the creation time of the log
      *
-     * @return the metadata associated with this log
+     * @return the creation time of the log
      */
-    public Set<Metadata<?>> getMetadata() {
-        return metadata;
+    public Instant getCreated() {
+        return created;
+    }
+
+    /**
+     * Get the expiration time of the log
+     *
+     * @return the expiration time of the log
+     */
+    public Instant getExpires() {
+        return expires;
+    }
+
+    /**
+     * Get the size of the log in bytes
+     *
+     * @return the size of the log in bytes
+     */
+    public long getSize() {
+        return size;
+    }
+
+    /**
+     * Get the number of lines in the log
+     *
+     * @return the number of lines in the log
+     */
+    public int getLines() {
+        return lines;
+    }
+
+    /**
+     * Get the number of error lines detected in the log
+     *
+     * @return the number of error lines detected in the log
+     */
+    public int getErrors() {
+        return errors;
     }
 
     /**
@@ -54,7 +98,7 @@ public Set<Metadata<?>> getMetadata() {
      * @return the url to view this log (e.g. <a href="https://mclo.gs/HpAwPry">https://mclo.gs/HpAwPry</a>)
      */
     public String getUrl() {
-        return client().getInstance().getViewLogUrl(id);
+        return url;
     }
 
     /**
@@ -63,7 +107,16 @@ public String getUrl() {
      * @return the url to view this log raw (e.g. <a href="https://mclo.gs/raw/HpAwPry">https://mclo.gs/raw/HpAwPry</a>)
      */
     public String getRawUrl() {
-        return client().getInstance().getRawLogUrl(id);
+        return raw;
+    }
+
+    /**
+     * Get the metadata associated with this log
+     *
+     * @return the metadata associated with this log
+     */
+    public Set<Metadata<?>> getMetadata() {
+        return metadata;
     }
 
     /**

src/main/java/gs/mclo/api/response/GetLogResponse.java

@@ -3,67 +3,15 @@
 import gs.mclo.api.response.log.LogContent;
 import org.jetbrains.annotations.Nullable;
 
-import java.time.Instant;
-
-@SuppressWarnings({"unused", "NotNullFieldNotInitialized"})
+@SuppressWarnings({"unused"})
 public final class GetLogResponse extends CommonLogResponse {
-    private Instant created;
-    private Instant expires;
-    private long size;
-    private int lines;
-    private int errors;
 
     private @Nullable LogContent content;
 
     private GetLogResponse() {
 
     }
 
-    /**
-     * Get the creation time of the log
-     *
-     * @return the creation time of the log
-     */
-    public Instant getCreated() {
-        return created;
-    }
-
-    /**
-     * Get the expiration time of the log
-     *
-     * @return the expiration time of the log
-     */
-    public Instant getExpires() {
-        return expires;
-    }
-
-    /**
-     * Get the size of the log in bytes
-     *
-     * @return the size of the log in bytes
-     */
-    public long getSize() {
-        return size;
-    }
-
-    /**
-     * Get the number of lines in the log
-     *
-     * @return the number of lines in the log
-     */
-    public int getLines() {
-        return lines;
-    }
-
-    /**
-     * Get the number of error lines detected in the log
-     *
-     * @return the number of error lines detected in the log
-     */
-    public int getErrors() {
-        return errors;
-    }
-
     /**
      * Get the content of the log
      *

src/main/java/gs/mclo/api/response/UploadLogResponse.java

@@ -1,74 +1,21 @@
 package gs.mclo.api.response;
 
-import org.jetbrains.annotations.Nullable;
-
-import java.time.Instant;
 import java.util.concurrent.CompletableFuture;
 
-@SuppressWarnings({"unused"})
+@SuppressWarnings({"unused", "NotNullFieldNotInitialized"})
 public final class UploadLogResponse extends CommonLogResponse {
-    private @Nullable Instant created;
-    private @Nullable Instant expires;
-    private @Nullable Long size;
-    private @Nullable Integer lines;
-    private @Nullable Integer errors;
-    private @Nullable String token;
+    private String token;
 
     private UploadLogResponse() {
 
     }
 
-    /**
-     * Get the creation time of the log
-     *
-     * @return the creation time of the log or null if this instance is outdated
-     */
-    public @Nullable Instant getCreated() {
-        return created;
-    }
-
-    /**
-     * Get the expiration time of the log
-     *
-     * @return the expiration time of the log or null if this instance is outdated
-     */
-    public @Nullable Instant getExpires() {
-        return expires;
-    }
-
-    /**
-     * Get the size of the log in bytes
-     *
-     * @return the size of the log in bytes or null if this instance is outdated
-     */
-    public @Nullable Long getSize() {
-        return size;
-    }
-
-    /**
-     * Get the number of lines in the log
-     *
-     * @return the number of lines in the log or null if this instance is outdated
-     */
-    public @Nullable Integer getLines() {
-        return lines;
-    }
-
-    /**
-     * Get the number of error lines detected in the log
-     *
-     * @return the number of error lines detected in the log or null if this instance is outdated
-     */
-    public @Nullable Integer getErrors() {
-        return errors;
-    }
-
     /**
      * Get the token for deleting the log
      *
      * @return the token for deleting the log or null if this instance is outdated
      */
-    public @Nullable String getToken() {
+    public String getToken() {
         return token;
     }
 

src/test/java/gs/mclo/api/ApiTest.java

@@ -13,7 +13,7 @@ protected void setUp() throws InterruptedException {
         var logViewUrl = System.getenv("MCLOGS_LOG_VIEW_URL");
 
         if ((apiUrl != null && !apiUrl.isBlank()) || (logViewUrl != null && !logViewUrl.isBlank())) {
-            client.setInstance(new Instance(apiUrl, logViewUrl));
+            client.setInstance(new Instance(apiUrl));
         }
 
         Thread.sleep(50); // Avoid rate limiting

src/test/java/gs/mclo/api/MclogsClientTest.java

@@ -168,9 +168,7 @@ void userAgents() {
     void customInstance() {
         String content = TestUtil.getFileContents("src/test/resources/logs/one.log");
 
-        Instance instance = new Instance("https://api.mclo.gs", "https://mclo.gs")
-                .setApiBaseUrl("https://api.mclo.gs")
-                .setViewLogUrl("https://mclo.gs");
+        Instance instance = new Instance("https://api.mclo.gs");
 
         MclogsClient client = new MclogsClient("aternos/mclogs-java-tests")
                 .setInstance(instance);