Merge pull request IQSS#11920 from vera/feat/list-assignments-more-info

sekmiller · web-flow · commit a07a2f871785 · 2026-04-23T16:20:21.000-04:00
feat: let APIs return more info about role assignments
diff --git a/doc/release-notes/11920-more-ra-info.md b/doc/release-notes/11920-more-ra-info.md
@@ -0,0 +1 @@
+All API endpoints that return information about role assignments (such as `/api/dataverses/$ID/assignments`) now include additional fields in their JSON responses: `assigneeName`, `roleDescription`, `definitionPointName`, `definitionPointType`, and `definitionPointGlobalId` (if available).
diff --git a/src/main/java/edu/harvard/iq/dataverse/DvObject.java b/src/main/java/edu/harvard/iq/dataverse/DvObject.java
@@ -140,6 +140,10 @@ public String visit(DataFile df) {
     
     @Column(insertable = false, updatable = false) private String dtype;
 
+    public String getDtype() {
+        return dtype;
+    }
+
     @OneToMany(mappedBy="dvobject",fetch = FetchType.LAZY,cascade={CascadeType.REMOVE, CascadeType.MERGE, CascadeType.PERSIST, CascadeType.REFRESH})
     private List<DataverseFeaturedItem> dataverseFeaturedItems;
 
diff --git a/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java b/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinter.java
@@ -75,17 +75,22 @@ public class JsonPrinter {
     @EJB
     static InAppNotificationsJsonPrinter inAppNotificationsJsonPrinter;
 
+    @EJB
+    static RoleAssigneeServiceBean roleAssigneeService;
+
     public static void injectSettingsService(SettingsServiceBean ssb,
                                              DatasetFieldServiceBean dfsb,
                                              DataverseFieldTypeInputLevelServiceBean dfils,
                                              DatasetServiceBean ds,
                                              MailServiceBean ms,
-                                             InAppNotificationsJsonPrinter njp) {
+                                             InAppNotificationsJsonPrinter njp,
+                                             RoleAssigneeServiceBean ras) {
             settingsService = ssb;
             datasetFieldService = dfsb;
             datasetService = ds;
             mailService = ms;
             inAppNotificationsJsonPrinter = njp;
+            roleAssigneeService = ras;
     }
 
     public JsonPrinter() {
@@ -145,14 +150,24 @@ public static JsonArrayBuilder jsonRoleAssignments(List<RoleAssignment> roleAssi
     }
 
     public static JsonObjectBuilder json(RoleAssignment ra) {
-        return jsonObjectBuilder()
-                .add("id", ra.getId())
-                .add("assignee", ra.getAssigneeIdentifier())
-                .add("roleId", ra.getRole().getId())
-                .add("roleName", ra.getRole().getName())
-                .add("_roleAlias", ra.getRole().getAlias())
-                .add("privateUrlToken", ra.getPrivateUrlToken())
-                .add("definitionPointId", ra.getDefinitionPoint().getId());
+        JsonObjectBuilder job = jsonObjectBuilder()
+                                    .add("id", ra.getId())
+                                    .add("assignee", ra.getAssigneeIdentifier())
+                                    .add("assigneeName", roleAssigneeService.getRoleAssignee(ra.getAssigneeIdentifier()).getDisplayInfo().getTitle())
+                                    .add("roleId", ra.getRole().getId())
+                                    .add("roleName", ra.getRole().getName())
+                                    .add("roleDescription", ra.getRole().getDescription())
+                                    .add("_roleAlias", ra.getRole().getAlias())
+                                    .add("privateUrlToken", ra.getPrivateUrlToken())
+                                    .add("definitionPointId", ra.getDefinitionPoint().getId())
+                                    .add("definitionPointName", ra.getDefinitionPoint().getDisplayName())
+                                    .add("definitionPointType", ra.getDefinitionPoint().getDtype());
+
+        if (ra.getDefinitionPoint().getGlobalId() != null) {
+            job.add("definitionPointGlobalId", ra.getDefinitionPoint().getGlobalId().toString());
+        }
+
+        return job;
     }
 
     public static JsonArrayBuilder json(Set<Permission> permissions) {
diff --git a/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinterHelper.java b/src/main/java/edu/harvard/iq/dataverse/util/json/JsonPrinterHelper.java
@@ -1,9 +1,6 @@
 package edu.harvard.iq.dataverse.util.json;
 
-import edu.harvard.iq.dataverse.DatasetFieldServiceBean;
-import edu.harvard.iq.dataverse.DatasetServiceBean;
-import edu.harvard.iq.dataverse.DataverseFieldTypeInputLevelServiceBean;
-import edu.harvard.iq.dataverse.MailServiceBean;
+import edu.harvard.iq.dataverse.*;
 import edu.harvard.iq.dataverse.settings.SettingsServiceBean;
 
 import jakarta.annotation.PostConstruct;
@@ -37,6 +34,9 @@ public class JsonPrinterHelper {
     @EJB
     InAppNotificationsJsonPrinter inAppNotificationsJsonPrinter;
 
+    @EJB
+    RoleAssigneeServiceBean roleAssigneeService;
+
     @PostConstruct
     public void injectService() {
         JsonPrinter.injectSettingsService(
@@ -45,7 +45,8 @@ public void injectService() {
                 datasetFieldInpuLevelSvc,
                 datasetSvc,
                 mailSvc,
-                inAppNotificationsJsonPrinter
+                inAppNotificationsJsonPrinter,
+                roleAssigneeService
         );
     }
 }
diff --git a/src/test/java/edu/harvard/iq/dataverse/util/json/JsonPrinterTest.java b/src/test/java/edu/harvard/iq/dataverse/util/json/JsonPrinterTest.java
@@ -99,6 +99,7 @@ public void setUp() {
 
     @Test
     public void testJson_RoleAssignment() {
+        JsonPrinter.injectSettingsService(null, null, null, null, null, null, new MockRoleAssigneeService());
         DataverseRole aRole = new DataverseRole();
         PrivateUrlUser privateUrlUserIn = new PrivateUrlUser(42);
         RoleAssignee anAssignee = privateUrlUserIn;
@@ -116,6 +117,7 @@ public void testJson_RoleAssignment() {
 
     @Test
     public void testJson_PrivateUrl() {
+        JsonPrinter.injectSettingsService(null, null, null, null, null, null, new MockRoleAssigneeService());
         DataverseRole aRole = new DataverseRole();
         PrivateUrlUser privateUrlUserIn = new PrivateUrlUser(42);
         RoleAssignee anAssignee = privateUrlUserIn;
@@ -199,7 +201,7 @@ public void testDatasetContactOutOfBoxNoPrivacy() {
         datasetContactField.setDatasetFieldCompoundValues(vals);
         fields.add(datasetContactField);
 
-        JsonPrinter.injectSettingsService(null, null, null, null, null, null);
+        JsonPrinter.injectSettingsService(null, null, null, null, null, null, null);
 
         JsonObject jsonObject = JsonPrinter.json(block, fields).build();
         assertNotNull(jsonObject);
@@ -240,7 +242,7 @@ public void testDatasetContactWithPrivacy() {
         datasetContactField.setDatasetFieldCompoundValues(vals);
         fields.add(datasetContactField);
 
-        JsonPrinter.injectSettingsService(new MockSettingsSvc(), null, null, null, null, null);
+        JsonPrinter.injectSettingsService(new MockSettingsSvc(), null, null, null, null, null, null);
 
         JsonObject jsonObject = JsonPrinter.json(block, fields).build();
         assertNotNull(jsonObject);
@@ -290,7 +292,7 @@ public void testDatasetFieldTypesWithChildren() {
 
         block.setDatasetFieldTypes(datasetFieldTypes);
 
-        JsonPrinter.injectSettingsService(new MockSettingsSvc(), null, null ,null, null, null);
+        JsonPrinter.injectSettingsService(new MockSettingsSvc(), null, null ,null, null, null, null);
 
         JsonObject jsonObject = JsonPrinter.json(block).build();
         assertNotNull(jsonObject);
@@ -355,6 +357,15 @@ public boolean isTrueForKey(SettingsServiceBean.Key key, boolean defaultValue) {
 
     }
 
+    private static class MockRoleAssigneeService extends RoleAssigneeServiceBean {
+
+        @Override
+        public RoleAssignee getRoleAssignee(String identifier) {
+            return new PrivateUrlUser(42);
+        }
+
+    }
+
     @Test
     public void testEnum() throws JsonParseException {
         JsonArrayBuilder arr = JsonPrinter.enumsToJson(Arrays.asList(Type.REVOKEROLE, Type.ASSIGNROLE));

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+All API endpoints that return information about role assignments (such as `/api/dataverses/$ID/assignments`) now include additional fields in their JSON responses: `assigneeName`, `roleDescription`, `definitionPointName`, `definitionPointType`, and `definitionPointGlobalId` (if available).