add overwrite to name, email, institution, and position in guestbook response JSON

Author: stevenwinship

src/main/java/edu/harvard/iq/dataverse/util/json/JsonParser.java

@@ -603,6 +603,11 @@ public GuestbookResponse parseGuestbookResponse(JsonObject obj, GuestbookRespons
         if (obj == null || guestbookResponse == null || guestbookResponse.getGuestbook() == null || guestbookResponse.getGuestbook().getCustomQuestions() == null) {
             return null;
         }
+        // overwrite name, email, institution and position.
+        guestbookResponse.setName(obj.getString("name", guestbookResponse.getName()));
+        guestbookResponse.setEmail(obj.getString("email", guestbookResponse.getEmail()));
+        guestbookResponse.setInstitution(obj.getString("institution", guestbookResponse.getInstitution()));
+        guestbookResponse.setPosition(obj.getString("position", guestbookResponse.getPosition()));
         Map<Long, CustomQuestion> cqMap = new HashMap<>();
         guestbookResponse.getGuestbook().getCustomQuestions().stream().forEach(cq -> cqMap.put(cq.getId(),cq));
         JsonArray answers = obj.getJsonArray("answers");
@@ -637,14 +642,14 @@ public GuestbookResponse parseGuestbookResponse(JsonObject obj, GuestbookRespons
         }
         guestbookResponse.setCustomQuestionResponses(customQuestionResponses);
         // verify each required question is in the response
-        List<String> missingReponses = new ArrayList<>();
+        List<String> missingResponses = new ArrayList<>();
         for (Map.Entry<Long, CustomQuestion> e : cqMap.entrySet()) {
             if (e.getValue().isRequired()) {
-                missingReponses.add(e.getValue().getQuestionString());
+                missingResponses.add(e.getValue().getQuestionString());
             }
         }
-        if (!missingReponses.isEmpty()) {
-            String missing = String.join(",", missingReponses);
+        if (!missingResponses.isEmpty()) {
+            String missing = String.join(",", missingResponses);
             throw new JsonParseException(BundleUtil.getStringFromBundle("access.api.requestAccess.failure.guestbookresponseMissingRequired", List.of(missing)));
         }
 

src/test/java/edu/harvard/iq/dataverse/api/FilesIT.java

@@ -3888,6 +3888,14 @@ public void testDownloadFileWithGuestbookResponse() throws IOException, JsonPars
         String apiToken = UtilIT.getApiTokenFromResponse(createUserResponse);
         String username = UtilIT.getUsernameFromResponse(createUserResponse);
 
+        // Create second user with no permission
+        createUserResponse = UtilIT.createRandomUser();
+        createUserResponse.prettyPrint();
+        assertEquals(200, createUserResponse.getStatusCode());
+        String apiToken2 = UtilIT.getApiTokenFromResponse(createUserResponse);
+        String username2 = UtilIT.getUsernameFromResponse(createUserResponse);
+        String user2Email = JsonPath.from(createUserResponse.body().asString()).getString("data.authenticatedUser.email");
+
         // Create Dataset
         Response createDatasetResponse = UtilIT.createRandomDatasetViaNativeApi(dataverseAlias, ownerApiToken);
         createDatasetResponse.then().assertThat().statusCode(CREATED.getStatusCode());
@@ -3997,6 +4005,21 @@ public void testDownloadFileWithGuestbookResponse() throws IOException, JsonPars
         signedUrlResponse = get(signedUrl);
         signedUrlResponse.prettyPrint();
         assertEquals(OK.getStatusCode(), signedUrlResponse.getStatusCode());
+
+        // TEST Overwrite name, email, institution and position in guestbook Response. Using user2
+        requestFileAccessResponse = UtilIT.requestFileAccess(fileId1.toString(), apiToken2, null);
+        assertEquals(200, requestFileAccessResponse.getStatusCode());
+        grantFileAccessResponse = UtilIT.grantFileAccess(fileId1.toString(), "@" + username2, ownerApiToken);
+        assertEquals(200, grantFileAccessResponse.getStatusCode());
+        // Modify guestbookResponse excluding email to show that the email remains unchanged
+        guestbookResponse = guestbookResponse.replace("\"guestbookResponse\": {",
+                "\"guestbookResponse\": { \"name\":\"My Name\", \"position\":\"My Position\", \"institution\":\"My Institution\",");
+        downloadResponse = UtilIT.getDownloadFileUrlWithGuestbookResponse(fileId1, apiToken2, guestbookResponse, true);
+        downloadResponse.prettyPrint();
+        downloadResponse.then().assertThat()
+                .statusCode(OK.getStatusCode());
+        Response guestbookResponses = UtilIT.getGuestbookResponses(dataverseAlias, guestbook.getId(), ownerApiToken);
+        assertTrue(guestbookResponses.prettyPrint().contains("My Name," + user2Email + ",My Institution,My Position"));
     }
 
     @Test
@@ -4045,7 +4068,5 @@ public void testDownloadFileWithSignedUrl() throws IOException, JsonParseExcepti
         downloadResponse.prettyPrint();
         downloadResponse.then().assertThat()
                 .statusCode(OK.getStatusCode());
-        String signedUrl = UtilIT.getSignedUrlFromResponse(downloadResponse);
-
     }
 }

src/test/java/edu/harvard/iq/dataverse/util/json/JsonParserTest.java

@@ -811,6 +811,10 @@ public void testGuestbookResponse() throws JsonParseException {
 
         final String guestbookResponseJson = """
                         {
+                            "name": "My Name",
+                            "email": "myemail@example.com",
+                            "institution": "Harvard",
+                            "position": "Upright",
                             "answers": [
                                 {
                                     "id": 1,
@@ -872,5 +876,20 @@ public void testGuestbookResponse() throws JsonParseException {
             System.out.println(e.getMessage());
             assertTrue(e.getMessage().contains("ID 4 not found"));
         }
+
+        // Test overwrite name, email, institution and position.
+        try {
+            jsonObj = JsonUtil.getJsonObject(guestbookResponseJson);
+            gbr = sut.parseGuestbookResponse(jsonObj, guestbookResponse);
+            assertEquals("My Name", gbr.getName());
+            // Removing name from the JSON defaults it to the original value in guestbook response
+            gbr.setName("My Original Name");
+            jsonObj = JsonUtil.getJsonObject(guestbookResponseJson.replace("\"name\": \"My Name\",", ""));
+            gbr = sut.parseGuestbookResponse(jsonObj, guestbookResponse);
+            assertEquals("My Original Name", gbr.getName());
+        } catch (JsonParseException e) {
+            System.out.println(e.getMessage());
+            assertTrue(e.getMessage().contains("ID 4 not found"));
+        }
     }
 }