Add feature to remove fingerpints after successful upload

See #27 Squashed commit of the following: commit b664f5b11b406d1ecf9b8fb5e2286de15641cc15 Author: Marius <[email protected]> Date: Thu Jun 13 12:16:27 2019 +0200 Move line endings back to Unix's LF commit b5807b8 Author: Juan Jose Rodriguez <[email protected]> Date: Tue Jun 4 17:16:59 2019 +0200 Change uploadFinished visibility to protected commit ebb5eab Author: Juan Jose Rodriguez <[email protected]> Date: Tue May 21 14:41:37 2019 +0200 #26 Add support for removeFingerprintOnSuccess config property
tus · Jun 13, 2019 · 003ff8a · 003ff8a
1 parent fc74dfc
commit 003ff8a
Show file tree

Hide file tree

Showing 5 changed files with 167 additions and 19 deletions.
diff --git a/build.gradle b/build.gradle
@@ -18,6 +18,7 @@ dependencies {
     compile 'org.jetbrains:annotations:13.0'
     testCompile 'junit:junit:4.12'
     testCompile 'org.mock-server:mockserver-netty:5.2.2'
+    testCompile 'org.mockito:mockito-core:2.+'
 }
 
 task sourcesJar(type: Jar, dependsOn: classes) {

diff --git a/src/main/java/io/tus/java/client/TusClient.java b/src/main/java/io/tus/java/client/TusClient.java
@@ -20,6 +20,7 @@ public class TusClient {
 
     private URL uploadCreationURL;
     private boolean resumingEnabled;
+    private boolean removeFingerprintOnSuccessEnabled;
     private TusURLStore urlStore;
     private Map<String, String> headers;
     private int connectTimeout = 5000;
@@ -84,6 +85,37 @@ public boolean resumingEnabled() {
         return resumingEnabled;
     }
 
+    /**
+     * Enable removing fingerprints after a successful upload.
+     *
+     * @see #disableRemoveFingerprintOnSuccess()
+     */
+    public void enableRemoveFingerprintOnSuccess() {
+        removeFingerprintOnSuccessEnabled = true;
+    }
+
+    /**
+     * Disable removing fingerprints after a successful upload.
+     *
+     * @see #enableRemoveFingerprintOnSuccess()
+     */
+    public void disableRemoveFingerprintOnSuccess() {
+        removeFingerprintOnSuccessEnabled = false;
+    }
+
+    /**
+     * Get the current status if removing fingerprints after a successful upload.
+     *
+     * @see #enableRemoveFingerprintOnSuccess()
+     * @see #disableRemoveFingerprintOnSuccess()
+     *
+     * @return True if resuming has been enabled using {@link #enableResuming(TusURLStore)}
+     */
+    public boolean removeFingerprintOnSuccessEnabled() {
+        return removeFingerprintOnSuccessEnabled;
+    }
+
+
     /**
      * Set headers which will be added to every HTTP requestes made by this TusClient instance.
      * These may to overwrite tus-specific headers, which can be identified by their Tus-*
@@ -165,7 +197,7 @@ public TusUploader createUpload(@NotNull TusUpload upload) throws ProtocolExcept
             urlStore.set(upload.getFingerprint(), uploadURL);
         }
 
-        return new TusUploader(this, uploadURL, upload.getTusInputStream(), 0);
+        return new TusUploader(this, upload, uploadURL, upload.getTusInputStream(), 0);
     }
 
     /**
@@ -233,7 +265,7 @@ public TusUploader beginOrResumeUploadFromURL(@NotNull TusUpload upload, @NotNul
         }
         long offset = Long.parseLong(offsetStr);
 
-        return new TusUploader(this, uploadURL, upload.getTusInputStream(), offset);
+        return new TusUploader(this, upload, uploadURL, upload.getTusInputStream(), offset);
     }
 
     /**
@@ -286,4 +318,16 @@ public void prepareConnection(@NotNull HttpURLConnection connection) {
             }
         }
     }
+
+    /**
+     * Actions to be performed after a successful upload completion.
+     * Manages URL removal from the URL store if remove fingerprint on success is enabled
+     *
+     * @param upload that has been finished
+     */
+    protected void uploadFinished(@NotNull TusUpload upload) {
+        if (resumingEnabled && removeFingerprintOnSuccessEnabled) {
+            urlStore.remove(upload.getFingerprint());
+        }
+    }
 }
diff --git a/src/main/java/io/tus/java/client/TusUploader.java b/src/main/java/io/tus/java/client/TusUploader.java
@@ -24,6 +24,7 @@ public class TusUploader {
     private TusInputStream input;
     private long offset;
     private TusClient client;
+    private TusUpload upload;
     private byte[] buffer;
     private int requestPayloadSize = 10 * 1024 * 1024;
     private int bytesRemainingForRequest;
@@ -41,11 +42,12 @@ public class TusUploader {
      * @param offset Offset to read from
      * @throws IOException Thrown if an exception occurs while issuing the HTTP request.
      */
-    public TusUploader(TusClient client, URL uploadURL, TusInputStream input, long offset) throws IOException {
+    public TusUploader(TusClient client, TusUpload upload, URL uploadURL, TusInputStream input, long offset) throws IOException {
         this.uploadURL = uploadURL;
         this.input = input;
         this.offset = offset;
         this.client = client;
+        this.upload = upload;
 
         input.seekTo(offset);
 
@@ -270,6 +272,10 @@ public URL getUploadURL() {
      */
     public void finish() throws ProtocolException, IOException {
         finishConnection();
+        if (upload.getSize() == offset) {
+            client.uploadFinished(upload);
+        }
+
         // Close the TusInputStream after checking the response and closing the connection to ensure
         // that we will not need to read from it again in the future.
         input.close();

diff --git a/src/test/java/io/tus/java/client/TestTusClient.java b/src/test/java/io/tus/java/client/TestTusClient.java
@@ -1,5 +1,10 @@
 package io.tus.java.client;
 
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.net.HttpURLConnection;
@@ -13,8 +18,6 @@
 import org.mockserver.model.HttpRequest;
 import org.mockserver.model.HttpResponse;
 
-import static org.junit.Assert.*;
-
 
 public class TestTusClient extends MockServerProvider {
     @Test
@@ -351,4 +354,47 @@ public void testFollowRedirects() throws Exception {
 
         assertEquals(uploader.getUploadURL(), new URL(mockServerURL + "/foo"));
     }
+
+    @Test
+    public void testRemoveFingerprintOnSuccessDisabled() throws IOException, ProtocolException {
+
+        TusClient client = new TusClient();
+
+        TusURLStore store = new TusURLMemoryStore();
+        URL dummyURL = new URL("http://dummy-url/files/dummy");
+        store.set("fingerprint", dummyURL);
+        client.enableResuming(store);
+
+        assertTrue(!client.removeFingerprintOnSuccessEnabled());
+
+        TusUpload upload = new TusUpload();
+        upload.setFingerprint("fingerprint");
+
+        client.uploadFinished(upload);
+
+        assertTrue(dummyURL.equals(store.get("fingerprint")));
+
+    }
+
+    @Test
+    public void testRemoveFingerprintOnSuccessEnabled() throws IOException, ProtocolException {
+
+        TusClient client = new TusClient();
+
+        TusURLStore store = new TusURLMemoryStore();
+        URL dummyURL = new URL("http://dummy-url/files/dummy");
+        store.set("fingerprint", dummyURL);
+        client.enableResuming(store);
+        client.enableRemoveFingerprintOnSuccess();
+
+        assertTrue(client.removeFingerprintOnSuccessEnabled());
+
+        TusUpload upload = new TusUpload();
+        upload.setFingerprint("fingerprint");
+
+        client.uploadFinished(upload);
+
+        assertTrue(store.get("fingerprint") == null);
+
+    }
 }
diff --git a/src/test/java/io/tus/java/client/TestTusUploader.java b/src/test/java/io/tus/java/client/TestTusUploader.java
@@ -1,15 +1,14 @@
 package io.tus.java.client;
 
-import org.junit.Assume;
-import org.junit.Test;
-import org.mockserver.model.HttpRequest;
-import org.mockserver.model.HttpResponse;
-import org.mockserver.socket.PortFactory;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.mockito.Mockito.mock;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.times;
 
 import java.io.BufferedReader;
 import java.io.ByteArrayInputStream;
 import java.io.IOException;
-import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStream;
 import java.net.MalformedURLException;
@@ -18,7 +17,11 @@
 import java.net.URL;
 import java.util.Arrays;
 
-import static org.junit.Assert.*;
+import org.junit.Assume;
+import org.junit.Test;
+import org.mockserver.model.HttpRequest;
+import org.mockserver.model.HttpResponse;
+import org.mockserver.socket.PortFactory;
 
 public class TestTusUploader extends MockServerProvider {
     private boolean isOpenJDK6 = System.getProperty("java.version").startsWith("1.6") &&
@@ -45,7 +48,9 @@ public void testTusUploader() throws IOException, ProtocolException {
         TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
         long offset = 3;
 
-        TusUploader uploader = new TusUploader(client, uploadUrl, input, offset);
+        TusUpload upload = new TusUpload();
+
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, offset);
 
         uploader.setChunkSize(5);
         assertEquals(uploader.getChunkSize(), 5);
@@ -58,6 +63,48 @@ public void testTusUploader() throws IOException, ProtocolException {
         uploader.finish();
     }
 
+    @Test
+    public void testTusUploaderClientUploadFinishedCalled() throws IOException, ProtocolException {
+
+        TusClient client = mock(TusClient.class);
+
+        byte[] content = "hello world".getBytes();
+
+        URL uploadUrl = new URL("http://dummy-url/foo");
+        TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
+        long offset = 10;
+
+        TusUpload upload = new TusUpload();
+        upload.setSize(10);
+
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, offset);
+        uploader.finish();
+
+        // size and offset are the same, so uploadfinished() should be called
+        verify(client).uploadFinished(upload);
+    }
+
+    @Test
+    public void testTusUploaderClientUploadFinishedNotCalled() throws IOException, ProtocolException {
+
+        TusClient client = mock(TusClient.class);
+
+        byte[] content = "hello world".getBytes();
+
+        URL uploadUrl = new URL("http://dummy-url/foo");
+        TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
+        long offset = 0;
+
+        TusUpload upload = new TusUpload();
+        upload.setSize(10);
+
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, offset);
+        uploader.finish();
+
+        // size is greater than offset, so uploadfinished() should not be called
+        verify(client,times(0)).uploadFinished(upload);
+    }
+
     @Test
     public void testTusUploaderFailedExpectation() throws IOException, ProtocolException {
         Assume.assumeFalse(isOpenJDK6);
@@ -71,9 +118,9 @@ public void testTusUploaderFailedExpectation() throws IOException, ProtocolExcep
         URL uploadUrl = new URL(server.getURL() + "/expect");
         TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
         long offset = 3;
-
+        TusUpload upload = new TusUpload();
         boolean exceptionThrown = false;
-        TusUploader uploader = new TusUploader(client, uploadUrl, input, offset);
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, offset);
         try {
             uploader.uploadChunk();
         } catch(ProtocolException e) {
@@ -168,8 +215,9 @@ public void testSetRequestPayloadSize() throws Exception {
         TusClient client = new TusClient();
         URL uploadUrl = new URL(mockServerURL + "/payload");
         TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
+        TusUpload upload = new TusUpload();
 
-        TusUploader uploader = new TusUploader(client, uploadUrl, input, 0);
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, 0);
 
         assertEquals(uploader.getRequestPayloadSize(), 10 * 1024 * 1024);
         uploader.setRequestPayloadSize(5);
@@ -197,8 +245,9 @@ public void testSetRequestPayloadSizeThrows() throws Exception {
         TusClient client = new TusClient();
         URL uploadUrl = new URL(mockServerURL + "/payloadException");
         TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
+        TusUpload upload = new TusUpload();
 
-        TusUploader uploader = new TusUploader(client, uploadUrl, input, 0);
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, 0);
 
         uploader.setChunkSize(4);
         uploader.uploadChunk();
@@ -220,8 +269,9 @@ public void testMissingUploadOffsetHeader() throws Exception {
         TusClient client = new TusClient();
         URL uploadUrl = new URL(mockServerURL + "/missingHeader");
         TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
+        TusUpload upload = new TusUpload();
 
-        TusUploader uploader = new TusUploader(client, uploadUrl, input, 0);
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, 0);
 
         boolean exceptionThrown = false;
         try {
@@ -249,8 +299,9 @@ public void testUnmatchingUploadOffsetHeader() throws Exception {
         TusClient client = new TusClient();
         URL uploadUrl = new URL(mockServerURL + "/unmatchingHeader");
         TusInputStream input = new TusInputStream(new ByteArrayInputStream(content));
+        TusUpload upload = new TusUpload();
 
-        TusUploader uploader = new TusUploader(client, uploadUrl, input, 0);
+        TusUploader uploader = new TusUploader(client, upload, uploadUrl, input, 0);
 
         boolean exceptionThrown = false;
         try {