Merge pull request #11915 from IQSS/11773-incorrect-roles-listed-in-assignrole-notifications

Limit notifications role assignment list

Author: sekmiller

doc/release-notes/11773-incorrect-roles-listed-in-assignrole-notifications.md

@@ -0,0 +1,4 @@
+This release changes the text in assign role notifications to list only the role being assigned that generated the specific notification.
+The previous implementation listed all the roles associated with the dataset in each notification.
+
+See also [the guides](https://dataverse-guide--11664.org.readthedocs.build/en/11664/user/account.html#notifications) and #11773.

src/main/java/edu/harvard/iq/dataverse/ManagePermissionsPage.java

@@ -202,7 +202,7 @@ private void revokeRole(RoleAssignment ra) {
             commandEngine.submit(new RevokeRoleCommand(ra, dvRequestService.getDataverseRequest()));
             JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("permission.roleWasRemoved", Arrays.asList(ra.getRole().getName(), roleAssigneeService.getRoleAssignee(ra.getAssigneeIdentifier()).getDisplayInfo().getTitle())));
             RoleAssignee assignee = roleAssigneeService.getRoleAssignee(ra.getAssigneeIdentifier());
-            notifyRoleChange(assignee, UserNotification.Type.REVOKEROLE);
+            notifyRoleChange(assignee, UserNotification.Type.REVOKEROLE, ra.getRole());
         } catch (PermissionException ex) {
             JH.addMessage(FacesMessage.SEVERITY_ERROR, BundleUtil.getStringFromBundle("permission.roleNotAbleToBeRemoved"), BundleUtil.getStringFromBundle("permission.permissionsMissing", Arrays.asList(ex.getRequiredPermissions().toString())));
         } catch (CommandException ex) {
@@ -525,17 +525,21 @@ public void assignRole(ActionEvent evt) {
      * Will notify all members of a group.
      * @param ra The {@code RoleAssignee} to be notified.
      * @param type The type of notification.
+     * @param r The {@code DataverseRole} associated with the change
      */
-    private void notifyRoleChange(RoleAssignee ra, UserNotification.Type type) {
+    private void notifyRoleChange(RoleAssignee ra, UserNotification.Type type, DataverseRole r) {
+        String additionalInfo = r != null ? String.format("{ roleId: %d, roleName: %s }", r.getId(), r.getName()) : null;
         if (ra instanceof AuthenticatedUser) {
-            userNotificationService.sendNotification((AuthenticatedUser) ra, new Timestamp(new Date().getTime()), type, dvObject.getId());
+            userNotificationService.sendNotification((AuthenticatedUser) ra, new Timestamp(new Date().getTime()), type,
+                    dvObject.getId(), null, null, false, additionalInfo);
         } else if (ra instanceof ExplicitGroup) {
             ExplicitGroup eg = (ExplicitGroup) ra;
             Set<String> explicitGroupMembers = eg.getContainedRoleAssgineeIdentifiers();
             for (String id : explicitGroupMembers) {
                 RoleAssignee explicitGroupMember = roleAssigneeService.getRoleAssignee(id);
                 if (explicitGroupMember instanceof AuthenticatedUser) {
-                    userNotificationService.sendNotification((AuthenticatedUser) explicitGroupMember, new Timestamp(new Date().getTime()), type, dvObject.getId());
+                    userNotificationService.sendNotification((AuthenticatedUser) explicitGroupMember, new Timestamp(new Date().getTime()), type,
+                            dvObject.getId(), null, null, false, additionalInfo);
                 }
             }
         }
@@ -553,7 +557,7 @@ private void assignRole(RoleAssignee ra, DataverseRole r) {
             JsfHelper.addSuccessMessage(BundleUtil.getStringFromBundle("permission.roleAssignedToFor", args));
             // don't notify if role = file downloader and object is not released
             if (!(r.getAlias().equals(DataverseRole.FILE_DOWNLOADER) && !dvObject.isReleased()) ){
-                notifyRoleChange(ra, UserNotification.Type.ASSIGNROLE);
+                notifyRoleChange(ra, UserNotification.Type.ASSIGNROLE, r);
             }
 
         } catch (PermissionException ex) {

src/main/java/edu/harvard/iq/dataverse/authorization/providers/builtin/DataverseUserPage.java

@@ -69,6 +69,7 @@
 import edu.harvard.iq.dataverse.authorization.providers.oauth2.impl.OrcidOAuth2AP;
 import java.io.IOException;
 import org.apache.commons.lang3.StringUtils;
+import org.json.JSONObject;
 import org.primefaces.event.TabChangeEvent;
 
 /**
@@ -453,8 +454,13 @@ public void onTabChange(TabChangeEvent event) {
     }
 
 
-    private String getRoleStringFromUser(AuthenticatedUser au, DvObject dvObj) {
+    private String getRoleStringFromUser(AuthenticatedUser au, DvObject dvObj, String additionalInfo) {
         // Find user's role(s) for given dataverse/dataset
+        if (additionalInfo != null && additionalInfo.contains("roleName:")) {
+            JSONObject jsonObject = new JSONObject(additionalInfo);
+            return jsonObject.getString("roleName");
+        }
+
         Set<RoleAssignment> roles = permissionService.assignmentsFor(au, dvObj);
         List<String> roleNames = new ArrayList<>();
 
@@ -481,16 +487,16 @@ public void displayNotification() {
                     // Can either be a dataverse or dataset, so search both
                     Dataverse dataverse = dataverseService.find(userNotification.getObjectId());
                     if (dataverse != null) {
-                        userNotification.setRoleString(this.getRoleStringFromUser(this.getCurrentUser(), dataverse ));
+                        userNotification.setRoleString(this.getRoleStringFromUser(this.getCurrentUser(), dataverse, userNotification.getAdditionalInfo()));
                         userNotification.setTheObject(dataverse);
                     } else {
                         Dataset dataset = datasetService.find(userNotification.getObjectId());
                         if (dataset != null){
-                            userNotification.setRoleString(this.getRoleStringFromUser(this.getCurrentUser(), dataset ));
+                            userNotification.setRoleString(this.getRoleStringFromUser(this.getCurrentUser(), dataset, userNotification.getAdditionalInfo()));
                             userNotification.setTheObject(dataset);
                         } else {
                             DataFile datafile = fileService.find(userNotification.getObjectId());
-                            userNotification.setRoleString(this.getRoleStringFromUser(this.getCurrentUser(), datafile ));
+                            userNotification.setRoleString(this.getRoleStringFromUser(this.getCurrentUser(), datafile, userNotification.getAdditionalInfo()));
                             userNotification.setTheObject(datafile);
                         }
                     }