Templates and Notifications API fixes

doc/release-notes/11703-notifications-and-templates-api-fixes.md

@@ -0,0 +1,13 @@
+# Release Notes
+
+## Templates API fixes
+- Added the missing `isDefault` field to the **Get Dataset Templates** API response.
+- Added the missing `fileAccessRequest` field of terms of use and access to the **Get Dataset Templates** API response.
+- Added the missing `contactForAccess` field of terms of use and access to the **Get Dataset Templates** API response.
+- Resolved an API **500 error** that occurred when working with templates containing custom license terms.
+- Updated API behavior so templates are **no longer returned from parent dataverses** when the "Include Templates from Root" option is unchecked in the UI.
+
+## Notifications API fixes
+- Fixed API errors caused by NullPointerException when retrieving notifications without a requestor.
+
+See #11704

src/main/java/edu/harvard/iq/dataverse/api/dto/NewTemplateDTO.java

@@ -38,6 +38,7 @@ public Template toTemplate() {
         template.updateInstructions();
         template.setCreateTime(new Timestamp(new Date().getTime()));
         template.setUsageCount(0L);
+        template.setIsDefaultForDataverse(isDefault);
 
         return template;
     }

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/CreateTemplateCommand.java

@@ -48,7 +48,14 @@ public Template execute(CommandContext ctxt) throws CommandException {
             DatasetFieldUtil.tidyUpFields(template.getDatasetFields(), false);
         }
 
-        return ctxt.templates().save(template);
+        Template createdTemplate = ctxt.templates().save(template);
+
+        if (initialize && template.isIsDefaultForDataverse()) {
+            dataverse.setDefaultTemplate(createdTemplate);
+            ctxt.em().merge(dataverse);
+        }
+
+        return template;
     }
 
     private static void updateTermsOfUseAndAccess(CommandContext ctxt, Template template) {

src/main/java/edu/harvard/iq/dataverse/engine/command/impl/ListDataverseTemplatesCommand.java

@@ -26,14 +26,22 @@ public ListDataverseTemplatesCommand(DataverseRequest request, Dataverse dataver
 
     @Override
     public List<Template> execute(CommandContext ctxt) throws CommandException {
-        List<Template> templates = new ArrayList<>();
+        List<Template> availableTemplates = new ArrayList<>(dataverse.getTemplates());
 
-        if (dataverse.getOwner() != null) {
-            templates.addAll(dataverse.getParentTemplates());
+        if (!dataverse.isTemplateRoot() && dataverse.getOwner() != null) {
+            availableTemplates.addAll(dataverse.getParentTemplates());
         }
 
-        templates.addAll(dataverse.getTemplates());
+        setDefaultTemplate(availableTemplates);
 
-        return templates;
+        return availableTemplates;
+    }
+
+    private void setDefaultTemplate(List<Template> availableTemplates) {
+        Optional.ofNullable(dataverse.getDefaultTemplate())
+                .map(Template::getId).flatMap(defaultTemplateId -> availableTemplates.stream()
+                        .filter(template -> template.getId().equals(defaultTemplateId))
+                        .findFirst())
+                .ifPresent(template -> template.setIsDefaultForDataverse(true));
     }
 }

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

@@ -195,9 +195,11 @@ private void addDatasetCreatedFields(final NullSafeJsonBuilder notificationJson,
     }
 
     private void addRequestorFields(final NullSafeJsonBuilder notificationJson, final AuthenticatedUser requestor) {
-        notificationJson.add(KEY_REQUESTOR_FIRST_NAME, requestor.getFirstName());
-        notificationJson.add(KEY_REQUESTOR_LAST_NAME, requestor.getLastName());
-        notificationJson.add(KEY_REQUESTOR_EMAIL, requestor.getEmail());
+        if (requestor != null) {
+            notificationJson.add(KEY_REQUESTOR_FIRST_NAME, requestor.getFirstName());
+            notificationJson.add(KEY_REQUESTOR_LAST_NAME, requestor.getLastName());
+            notificationJson.add(KEY_REQUESTOR_EMAIL, requestor.getEmail());
+        }
     }
 
     private void addDatasetFields(final NullSafeJsonBuilder notificationJson, final UserNotification userNotification) {

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

@@ -1592,6 +1592,7 @@ public static JsonObjectBuilder jsonTemplate(Template template) {
         return jsonObjectBuilder()
                 .add("id", template.getId())
                 .add("name", template.getName())
+                .add("isDefault", template.isIsDefaultForDataverse())
                 .add("usageCount", template.getUsageCount())
                 .add("createTime", template.getCreateTime().toString())
                 .add("createDate", template.getCreateDate())
@@ -1602,9 +1603,10 @@ public static JsonObjectBuilder jsonTemplate(Template template) {
     }
 
     public static JsonObjectBuilder jsonTermsOfUseAndAccess(TermsOfUseAndAccess termsOfUseAndAccess) {
+        License license = termsOfUseAndAccess.getLicense();
         return jsonObjectBuilder()
                 .add("id", termsOfUseAndAccess.getId())
-                .add("license", json(termsOfUseAndAccess.getLicense()))
+                .add("license", license != null ? json(license) : null)
                 .add("termsOfUse", termsOfUseAndAccess.getTermsOfUse())
                 .add("termsOfAccess", termsOfUseAndAccess.getTermsOfAccess())
                 .add("confidentialityDeclaration", termsOfUseAndAccess.getConfidentialityDeclaration())
@@ -1618,7 +1620,9 @@ public static JsonObjectBuilder jsonTermsOfUseAndAccess(TermsOfUseAndAccess term
                 .add("originalArchive", termsOfUseAndAccess.getOriginalArchive())
                 .add("availabilityStatus", termsOfUseAndAccess.getAvailabilityStatus())
                 .add("sizeOfCollection", termsOfUseAndAccess.getSizeOfCollection())
-                .add("studyCompletion", termsOfUseAndAccess.getStudyCompletion());
+                .add("studyCompletion", termsOfUseAndAccess.getStudyCompletion())
+                .add("contactForAccess", termsOfUseAndAccess.getContactForAccess())
+                .add("fileAccessRequest", termsOfUseAndAccess.isFileAccessRequest());
     }
 
     public static JsonArrayBuilder jsonTemplateInstructions(Map<String, String> templateInstructions) {

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

@@ -2335,6 +2335,7 @@ public void testCreateAndGetTemplates() {
         );
         createTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
                 .body("data.name", equalTo("Dataverse template"))
+                .body("data.isDefault", equalTo(true))
                 .body("data.usageCount", equalTo(0))
                 .body("data.termsOfUseAndAccess.license.name", equalTo("CC0 1.0"))
                 .body("data.datasetFields.citation.fields.size()", equalTo(1))
@@ -2358,6 +2359,7 @@ public void testCreateAndGetTemplates() {
         getTemplateResponse.then().assertThat().statusCode(OK.getStatusCode())
                 .body("data.size()", equalTo(1))
                 .body("data[0].name", equalTo("Dataverse template"))
+                .body("data[0].isDefault", equalTo(true))
                 .body("data[0].usageCount", equalTo(0))
                 .body("data[0].termsOfUseAndAccess.license.name", equalTo("CC0 1.0"))
                 .body("data[0].datasetFields.citation.fields.size()", equalTo(1))

src/test/java/edu/harvard/iq/dataverse/engine/command/impl/ListDataverseTemplatesCommandTest.java

@@ -5,14 +5,18 @@
 import edu.harvard.iq.dataverse.engine.command.CommandContext;
 import edu.harvard.iq.dataverse.engine.command.DataverseRequest;
 import edu.harvard.iq.dataverse.engine.command.exception.CommandException;
+import edu.harvard.iq.dataverse.util.template.TemplateBuilder;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.mockito.Mockito;
 
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 public class ListDataverseTemplatesCommandTest {
@@ -28,52 +32,138 @@ public void setUp() {
 
     @Test
     public void execute_shouldReturnTemplates_noParent() throws CommandException {
+        // Arrange
         Dataverse dataverseMock = Mockito.mock(Dataverse.class);
-
         Mockito.when(dataverseMock.getTemplates()).thenReturn(Collections.singletonList(testTemplate));
 
         ListDataverseTemplatesCommand sut = new ListDataverseTemplatesCommand(dataverseRequestStub, dataverseMock);
 
+        // Act
         List<Template> result = sut.execute(Mockito.mock(CommandContext.class));
 
+        // Assert
         assertEquals(1, result.size());
         assertEquals(testTemplate, result.get(0));
     }
 
     @Test
     public void execute_shouldReturnTemplates_parentHasTemplates() throws CommandException {
+        // Arrange
         Template parentTemplate = new Template();
-
         Dataverse dataverseMock = Mockito.mock(Dataverse.class);
         Dataverse parentDataverseMock = Mockito.mock(Dataverse.class);
-
         Mockito.when(dataverseMock.getTemplates()).thenReturn(Collections.singletonList(testTemplate));
         Mockito.when(dataverseMock.getParentTemplates()).thenReturn(Collections.singletonList(parentTemplate));
         Mockito.when(dataverseMock.getOwner()).thenReturn(parentDataverseMock);
 
         ListDataverseTemplatesCommand sut = new ListDataverseTemplatesCommand(dataverseRequestStub, dataverseMock);
 
+        // Act
         List<Template> result = sut.execute(Mockito.mock(CommandContext.class));
 
+        // Assert
         assertEquals(2, result.size());
         assertTrue(result.contains(testTemplate));
         assertTrue(result.contains(parentTemplate));
     }
 
+    @Test
+    public void execute_shouldNotIncludeParentTemplates_whenDataverseIsRoot() throws CommandException {
+        // Arrange
+        String parentTemplateName = "parentTemplate";
+        Template parentTemplate = TemplateBuilder.aTemplate().withName(parentTemplateName).build();
+        String childTemplateName = "childTemplateName";
+        Template childTemplate = TemplateBuilder.aTemplate().withName(childTemplateName).build();
+        Dataverse dataverseMock = Mockito.mock(Dataverse.class);
+        Dataverse parentDataverseMock = Mockito.mock(Dataverse.class);
+        Mockito.when(dataverseMock.getTemplates()).thenReturn(Collections.singletonList(childTemplate));
+        Mockito.when(dataverseMock.getParentTemplates()).thenReturn(Collections.singletonList(parentTemplate));
+        Mockito.when(dataverseMock.getOwner()).thenReturn(parentDataverseMock);
+        Mockito.when(dataverseMock.isTemplateRoot()).thenReturn(true);
+
+        ListDataverseTemplatesCommand sut = new ListDataverseTemplatesCommand(dataverseRequestStub, dataverseMock);
+
+        // Act
+        List<Template> result = sut.execute(Mockito.mock(CommandContext.class));
+
+        // Assert
+        assertEquals(1, result.size());
+        assertTrue(result.get(0).getName().equals(childTemplateName));
+    }
+
+
     @Test
     public void execute_shouldReturnTemplates_parentHasNoTemplates() throws CommandException {
+        // Arrange
         Dataverse dataverseMock = Mockito.mock(Dataverse.class);
         Dataverse parentDataverseStub = Mockito.mock(Dataverse.class);
-
         Mockito.when(dataverseMock.getTemplates()).thenReturn(Collections.singletonList(testTemplate));
         Mockito.when(dataverseMock.getOwner()).thenReturn(parentDataverseStub);
         Mockito.when(dataverseMock.getParentTemplates()).thenReturn(Collections.emptyList());
 
         ListDataverseTemplatesCommand sut = new ListDataverseTemplatesCommand(dataverseRequestStub, dataverseMock);
 
+        // Act
         List<Template> result = sut.execute(Mockito.mock(CommandContext.class));
 
+        // Assert
         assertEquals(1, result.size());
         assertTrue(result.contains(testTemplate));
     }
+
+
+    @Test
+    public void execute_shouldSetDefaultTemplate_whenDefaultIsPresent() throws CommandException {
+        // Arrange
+        String defaultTplName = "defaultTplName";
+        String otherTplName = "otherTplName";
+
+        Template defaultTpl = TemplateBuilder.aTemplate().withName(defaultTplName).isDefault(true).build();
+        Template otherTpl = TemplateBuilder.aTemplate().withName(otherTplName).isDefault(false).build();
+
+        Dataverse dataverseMock = Mockito.mock(Dataverse.class);
+        Mockito.when(dataverseMock.getTemplates()).thenReturn(Arrays.asList(defaultTpl, otherTpl));
+        Mockito.when(dataverseMock.getDefaultTemplate()).thenReturn(defaultTpl);
+
+        ListDataverseTemplatesCommand sut = new ListDataverseTemplatesCommand(dataverseRequestStub, dataverseMock);
+
+        // Act
+        List<Template> result = sut.execute(Mockito.mock(CommandContext.class));
+
+        // Assert
+        assertEquals(2, result.size());
+
+        Template resultDefault = findTemplateByName(result, defaultTplName);
+        assertNotNull(resultDefault, "Default template should be in the list");
+        assertTrue(resultDefault.isIsDefaultForDataverse(), "The template with name " + defaultTplName + " should be marked as default");
+
+        Template resultOther = findTemplateByName(result, otherTplName);
+        assertNotNull(resultOther, "Other template should be in the list");
+        assertFalse(resultOther.isIsDefaultForDataverse(), "The template with name " + otherTplName + " should NOT be marked as default");
+    }
+
+    @Test
+    public void execute_shouldNotSetDefault_whenNoDefaultTemplateExists() throws CommandException {
+        // Arrange
+        testTemplate = TemplateBuilder.aTemplate().isDefault(false).build();
+        Dataverse dataverseMock = Mockito.mock(Dataverse.class);
+        Mockito.when(dataverseMock.getTemplates()).thenReturn(Collections.singletonList(testTemplate));
+        Mockito.when(dataverseMock.getDefaultTemplate()).thenReturn(null);
+
+        ListDataverseTemplatesCommand sut = new ListDataverseTemplatesCommand(dataverseRequestStub, dataverseMock);
+
+        // Act
+        List<Template> result = sut.execute(Mockito.mock(CommandContext.class));
+
+        // Assert
+        assertEquals(1, result.size());
+        assertFalse(result.get(0).isIsDefaultForDataverse(), "No template should be marked as default");
+    }
+
+    private Template findTemplateByName(List<Template> templates, String name) {
+        return templates.stream()
+                .filter(t -> name.equals(t.getName()))
+                .findFirst()
+                .orElse(null);
+    }
 }

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

@@ -229,6 +229,26 @@ public void testAddFieldsByType_requestFileAccess() {
         verify(notificationJson).add(KEY_DATAFILE_DISPLAY_NAME, "Test File");
     }
 
+    @Test
+    public void testAddFieldsByType_requestFileAccess_nullRequestor() {
+        userNotification.setType(UserNotification.Type.REQUESTFILEACCESS);
+        userNotification.setObjectId(1L);
+        userNotification.setRequestor(null);
+
+        DataFile dataFile = mock(DataFile.class);
+        when(dataFile.getId()).thenReturn(1L);
+        when(dataFile.getDisplayName()).thenReturn("Test File");
+        when(dataFileService.find(1L)).thenReturn(dataFile);
+
+        sut.addFieldsByType(notificationJson, authenticatedUser, userNotification);
+
+        verify(notificationJson, never()).add(eq(KEY_REQUESTOR_FIRST_NAME), anyString());
+        verify(notificationJson, never()).add(eq(KEY_REQUESTOR_LAST_NAME), anyString());
+        verify(notificationJson, never()).add(eq(KEY_REQUESTOR_EMAIL), anyString());
+        verify(notificationJson).add(KEY_DATAFILE_ID, Long.valueOf("1"));
+        verify(notificationJson).add(KEY_DATAFILE_DISPLAY_NAME, "Test File");
+    }
+
     @Test
     public void testAddFieldsByType_grantFileAccess() {
         userNotification.setType(UserNotification.Type.GRANTFILEACCESS);