Merge pull request #1836 from NASA-AMMOS/feat/simultaneous-workspace-file-edit-protections

Add simultaneous-edit protection to workspace file saves

Author: Mythicaeda

e2e-tests/src/test/java/gov/nasa/jpl/aerie/e2e/WorkspaceETagTests.java

@@ -0,0 +1,103 @@
+package gov.nasa.jpl.aerie.e2e;
+
+import com.microsoft.playwright.Playwright;
+import gov.nasa.jpl.aerie.e2e.utils.GatewayRequests;
+import gov.nasa.jpl.aerie.e2e.utils.HasuraRequests;
+import gov.nasa.jpl.aerie.e2e.utils.WorkspaceRequests;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.nio.file.Path;
+
+import static gov.nasa.jpl.aerie.e2e.types.User.admin;
+import static org.junit.jupiter.api.Assertions.assertNotEquals;
+
+public class WorkspaceETagTests {
+  // Requests
+  private static Playwright playwright;
+  private static HasuraRequests hasura;
+  private static WorkspaceRequests wsServer;
+
+  // Class-Wide Data
+  private static int cdictId;
+  private static int parcelId;
+
+  private static String adminToken;
+
+  private int workspaceId;
+
+  @BeforeAll
+  static void beforeAll() throws IOException {
+    // Setup Requests
+    playwright = Playwright.create();
+    hasura = new HasuraRequests(playwright);
+    wsServer = new WorkspaceRequests(playwright);
+
+    // Get valid JWT tokens for the users
+    try (final var gateway = new GatewayRequests(playwright)) {
+      adminToken = gateway.login(admin);
+    }
+
+    // Set up parcel and dictionary to use across the tests
+    cdictId = hasura.createMockCommandDictionary("WorkspaceETagTest", "Workspace E2E Test");
+    parcelId = hasura.createMockParcel("Workspace ETag Parcel", cdictId);
+  }
+
+  @AfterAll
+  static void afterAll() throws IOException {
+    // Cleanup parcel and dictionary
+    hasura.deleteMockCommandDictionary(cdictId);
+    hasura.deleteMockParcel(parcelId);
+
+    // Cleanup Requests
+    wsServer.close();
+    hasura.close();
+    playwright.close();
+  }
+
+  @BeforeEach
+  void beforeEach() throws IOException {
+    workspaceId = wsServer.createWorkspace("ETagWSTests", parcelId);
+  }
+
+  @AfterEach
+  void afterEach() throws IOException {
+    wsServer.deleteWorkspace(workspaceId);
+  }
+
+  /**
+   * When generating Entity Tags for a file, the WS server reads the file in 1MB chunks.
+   * This test uploads two 1.2MB files that are the exact same size and differ solely after the 1MB mark,
+   * then compares the generated ETags.
+   */
+  @Test
+  void chunkingDoesNotAffectETags() throws IOException {
+    final var versionAPath = Path.of("versionA.txt");
+    final var versionBPath = Path.of("versionB.txt");
+
+    // Upload the two files
+    wsServer.putFile(
+        adminToken,
+        workspaceId,
+        versionAPath,
+        Path.of("workspaces", "workspace_etag_test_original.txt"));
+    wsServer.putFile(
+        adminToken,
+        workspaceId,
+        versionBPath,
+        Path.of("workspaces", "workspace_etag_test_modified.txt"));
+
+    // GET the files
+    final var versionA = wsServer.get(adminToken, workspaceId, versionAPath);
+    final var versionB = wsServer.get(adminToken, workspaceId, versionBPath);
+
+    // Compare the eTag headers
+    final var versionAETag = versionA.headers().get("etag");
+    final var versionBETag = versionB.headers().get("etag");
+    assertNotEquals(versionAETag, versionBETag);
+  }
+}

e2e-tests/src/test/java/gov/nasa/jpl/aerie/e2e/utils/WorkspaceRequests.java

@@ -14,6 +14,7 @@
 import javax.json.JsonObject;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.List;
 import java.util.Map;
@@ -143,6 +144,30 @@ public APIResponse putFile(String token, int workspaceId, Path fileLocation, Str
     return request.put(SINGLE_ITEM_URL.formatted(workspaceId, fileLocation), options);
   }
 
+  /**
+   * Upload a file located in the test resources to the Workspace Server using the 'PUT file' endpoint.
+   * Does not pass the "overwrite" flag.
+   * @param token The JWT token for the user making the request
+   * @param workspaceId The workspace to insert the file into
+   * @param fileLocation Where to place the file in the workspace
+   * @param resourcePath The Path to the file within the test resources folder (src/test/resources)
+   * @return The APIResponse from the server
+   */
+  public APIResponse putFile(String token, int workspaceId, Path fileLocation, Path resourcePath) throws IOException
+  {
+    byte[] buffer = Files.readAllBytes(Path.of("src/test/resources/", resourcePath.toString()));
+    FilePayload filePayload = new FilePayload(
+        fileLocation.getFileName().toString(),
+        "text/plain",
+        buffer);
+    final var options = RequestOptions
+        .create()
+        .setQueryParam("type", "file")
+        .setHeader("Authorization", "Bearer "+token)
+        .setMultipart(FormData.create().set("file", filePayload));
+    return request.put(SINGLE_ITEM_URL.formatted(workspaceId, fileLocation), options);
+  }
+
   /**
    * Call the 'File PUT' endpoint in the Workspace server. Passes the overwrite flag
    * @param token The JWT token for the user making the request