Allow multiple assignees for tasks #184 (#222)

* Allow multiple assignees for tasks #184
* Updated the task manager class to allow multiple assignees
* Updated the java code allow the creation of a task macro with multiple assignees and made sure that the relation between them is kept
* Added a new test

* Allow multiple assignees for tasks #184
* Updated the task manager class to allow multiple assignees
* Updated the java code allow the creation of a task macro with multiple assignees and made sure that the relation between them is kept
* Added a new test

* Allow multiple assignees for tasks #184
 * Added the public code back and marked it as deprecated.

* Forgotten merge files

* Fix build

---------

Co-authored-by: Teodor Caras <[email protected]>

Author: Farcasut

application-task-api/src/main/java/com/xwiki/task/model/Task.java

@@ -20,6 +20,7 @@
 package com.xwiki.task.model;
 
 import java.util.Date;
+import java.util.List;
 
 import org.xwiki.model.reference.DocumentReference;
 import org.xwiki.stability.Unstable;
@@ -138,8 +139,11 @@ public class Task
 
     private DocumentReference reporter;
 
+    @Deprecated(since = "3.7.2")
     private DocumentReference assignee;
 
+    private List<DocumentReference> assignees;
+
     private Date createDate;
 
     private Date startDate;
@@ -239,6 +243,7 @@ public void setReporter(DocumentReference reporter)
     /**
      * @return a list of references to the users that are assigned to this task.
      */
+    @Deprecated(since = "3.7.2")
     public DocumentReference getAssignee()
     {
         return assignee;
@@ -247,11 +252,28 @@ public DocumentReference getAssignee()
     /**
      * @param assignee a list of references to the users that are assigned to this task.
      */
+    @Deprecated(since = "3.7.2")
     public void setAssignee(DocumentReference assignee)
     {
         this.assignee = assignee;
     }
 
+    /**
+     * @return a list of references to the users that are assigned to this task.
+     */
+    public List<DocumentReference> getAssignees()
+    {
+        return assignees;
+    }
+
+    /**
+     * @param assignees a list of references to the users that are assigned to this task.
+     */
+    public void setAssignees(List<DocumentReference> assignees)
+    {
+        this.assignees = assignees;
+    }
+
     /**
      * @return the timestamp for the creation of the task.
      */

application-task-default/src/main/java/com/xwiki/task/internal/DefaultTaskManager.java

@@ -19,8 +19,10 @@
  */
 package com.xwiki.task.internal;
 
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
+import java.util.stream.Collectors;
 
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -171,8 +173,10 @@ private Task getTaskFromXObject(BaseObject obj)
         task.setName(obj.getStringValue(Task.NAME));
         task.setNumber(obj.getIntValue(Task.NUMBER));
         task.setOwner(resolver.resolve(obj.getLargeStringValue(Task.OWNER), obj.getDocumentReference()));
-        String assignee = obj.getLargeStringValue(Task.ASSIGNEE);
-        task.setAssignee(assignee.isEmpty() ? null : resolver.resolve(assignee));
+        String assignees = obj.getLargeStringValue(Task.ASSIGNEE);
+        task.setAssignees(assignees.isEmpty() ? null
+            : Arrays.stream(assignees.split(",")).map(user -> resolver.resolve(user))
+            .collect(Collectors.toList()));
         task.setStatus(obj.getStringValue(Task.STATUS));
         task.setReporter(resolver.resolve(obj.getLargeStringValue(Task.REPORTER)));
         task.setDuedate(obj.getDateValue(Task.DUE_DATE));

application-task-default/src/main/java/com/xwiki/task/internal/TaskBlockProcessor.java

@@ -106,14 +106,14 @@ public Block createTaskLinkBlock(String reference, int taskNumber, ResourceType
      * Generate the content of a Task macro as a list of blocks. This list can be rendered in different syntaxes i.e.
      * xwiki/2.1.
      *
-     * @param assignee the string that will be used to generate a mention macro.
+     * @param assignees the list of strings that will be used to generate a mention macros.
      * @param duedate the date that will be formatted and used to generate a date macro.
      * @param text the message of the task that will precede the assignee and due date.
      * @param storageFormat the format desired for the date.
      * @return a list of blocks that represent the content of a macro.
      * @throws TaskException if the text parameter failed to be parsed.
      */
-    public List<Block> generateTaskContentBlocks(String assignee, Date duedate, String text,
+    public List<Block> generateTaskContentBlocks(List<String> assignees, Date duedate, String text,
         SimpleDateFormat storageFormat) throws TaskException
     {
         XDOM newTaskContentXDOM = null;
@@ -129,13 +129,13 @@ public List<Block> generateTaskContentBlocks(String assignee, Date duedate, Stri
         Block deadline = newTaskContentXDOM.getFirstBlock(new MacroBlockMatcher(DATE), Block.Axes.DESCENDANT_OR_SELF);
 
         boolean changed = false;
-        changed |= handleMentions(mentions, newTaskContentXDOM, assignee);
+        changed |= handleMentions(mentions, newTaskContentXDOM, assignees);
 
         changed |= handleDeadline(deadline, newTaskContentXDOM, duedate, storageFormat);
         return newTaskContentXDOM.getChildren();
     }
 
-    private boolean handleMentions(List<Block> mentions, XDOM newTaskContentXDOM, String assignees)
+    private boolean handleMentions(List<Block> mentions, XDOM newTaskContentXDOM, List<String> assignees)
     {
         if (mentions.isEmpty() && assignees == null) {
             // Nothing changed.
@@ -149,9 +149,8 @@ private boolean handleMentions(List<Block> mentions, XDOM newTaskContentXDOM, St
             return true;
         }
 
-        String[] splitAssignees = assignees.split(",");
         if (mentions.stream().map(block -> block.getParameter(REFERENCE)).collect(Collectors.toList())
-            .equals(Arrays.asList(splitAssignees)))
+            .equals(assignees))
         {
             // If the mentions and assignees are equal, nothing changed.
             return false;
@@ -160,20 +159,20 @@ private boolean handleMentions(List<Block> mentions, XDOM newTaskContentXDOM, St
         int i = 0;
         for (Block mention : mentions) {
             // Replace the existing mentions with the updated values coming from the task obj.
-            if (i >= splitAssignees.length) {
+            if (i >= assignees.size()) {
                 // If there are more mentions than assignees coming from the task obj, it means that they were removed.
                 mention.getParent().removeBlock(mention);
                 continue;
             }
-            mention.setParameter(REFERENCE, splitAssignees[i++]);
+            mention.setParameter(REFERENCE, assignees.get(i++));
         }
         // If there are more assignees than mentions, we need to create the said mentions.
-        for (int j = i; j < splitAssignees.length; j++) {
+        for (int j = i; j < assignees.size(); j++) {
             Map<String, String> mentionParams = new HashMap<>();
             mentionParams.put("style", "FULL_NAME");
-            mentionParams.put(REFERENCE, splitAssignees[j]);
+            mentionParams.put(REFERENCE, assignees.get(j));
             mentionParams.put("anchor",
-                splitAssignees[j].replace('.', '-') + '-' + RandomStringUtils.random(5, true, false));
+                assignees.get(j).replace('.', '-') + '-' + RandomStringUtils.random(5, true, false));
             MacroBlock mentionBlock = new MacroBlock(MENTION, mentionParams, true);
             newTaskContentXDOM.addChild(mentionBlock);
         }

application-task-default/src/main/java/com/xwiki/task/internal/TaskMacroUpdateEventListener.java

@@ -281,7 +281,10 @@ private void populateObjectWithMacroParams(XWikiContext context, Task task, Base
 
         object.set(Task.CREATE_DATE, task.getCreateDate(), context);
 
-        object.set(Task.ASSIGNEE, serializer.serialize(task.getAssignee()), context);
+        String assignees =
+            task.getAssignees().stream().map(user -> serializer.serialize(user))
+                .collect(Collectors.joining(","));
+        object.set(Task.ASSIGNEE, assignees, context);
 
         object.set(Task.DUE_DATE, task.getDueDate(), context);
 

application-task-default/src/main/java/com/xwiki/task/internal/TaskXDOMProcessor.java

@@ -22,9 +22,11 @@
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.Date;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import javax.inject.Inject;
 import javax.inject.Singleton;
@@ -203,7 +205,7 @@ private Task initTask(Syntax syntax, DocumentReference contentSource, MacroBlock
             XDOM macroContent = macroUtils.getMacroContentXDOM(macro, syntax);
             task.setName(macroUtils.renderMacroContent(macroContent.getChildren(), Syntax.PLAIN_1_0));
             task.setDescription(macro.getContent());
-            task.setAssignee(extractAssignedUser(macroContent));
+            task.setAssignees(extractAssignedUser(macroContent));
 
             Date deadline = extractDeadlineDate(macroContent);
 
@@ -231,7 +233,8 @@ private boolean maybeUpdateTaskMacroCall(DocumentReference documentReference, Ba
                     (Syntax) content.getMetaData().getMetaData().getOrDefault(MetaData.SYNTAX, Syntax.XWIKI_2_1);
 
                 List<Block> newTaskContentBlocks =
-                    taskBlockProcessor.generateTaskContentBlocks(taskObject.getLargeStringValue(Task.ASSIGNEE),
+                    taskBlockProcessor.generateTaskContentBlocks(
+                        List.of(taskObject.getLargeStringValue(Task.ASSIGNEE).split(",")),
                         taskObject.getDateValue(Task.DUE_DATE), taskObject.getLargeStringValue(Task.DESCRIPTION),
                         storageFormat);
 
@@ -306,14 +309,16 @@ private void extractBasicProperties(Map<String, String> macroParams, Task task)
         }
     }
 
-    private DocumentReference extractAssignedUser(XDOM taskContent)
+    private List<DocumentReference> extractAssignedUser(XDOM taskContent)
     {
-        MacroBlock macro = taskContent.getFirstBlock(new MacroBlockMatcher(MENTION_MACRO_ID), Block.Axes.DESCENDANT);
+        List<MacroBlock> macros = taskContent.getBlocks(new MacroBlockMatcher(MENTION_MACRO_ID), Block.Axes.DESCENDANT);
 
-        if (macro == null) {
-            return null;
+        if (macros == null) {
+            return Collections.emptyList();
         }
-        return resolver.resolve(macro.getParameters().get(Task.REFERENCE));
+
+        return macros.stream().map(macroBlock -> resolver.resolve(macroBlock.getParameters().get(Task.REFERENCE)))
+            .collect(Collectors.toList());
     }
 
     private Date extractDeadlineDate(XDOM taskContent)

application-task-default/src/main/java/com/xwiki/task/internal/macro/TasksMacro.java

@@ -25,6 +25,7 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.stream.Collectors;
 
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -153,7 +154,8 @@ private String getMacroContent(Task task, SimpleDateFormat storageFormat,
 
         {
             taskContent = macroUtils.renderMacroContent(blockProcessor.generateTaskContentBlocks(
-                task.getAssignee() != null ? serializer.serialize(task.getAssignee()) : null, task.getDueDate(),
+                task.getAssignees() != null ? task.getAssignees().stream().map(
+                    user -> serializer.serialize(user)).collect(Collectors.toList()) : null, task.getDueDate(),
                 task.getName(), storageFormat), context.getSyntax());
         }
         return taskContent;

application-task-default/src/test/java/com/xwiki/task/TaskMacroUpdateEventListenerTest.java

@@ -23,6 +23,7 @@
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.Date;
+import java.util.List;
 
 import javax.inject.Named;
 
@@ -51,7 +52,6 @@
 import com.xpn.xwiki.XWiki;
 import com.xpn.xwiki.XWikiContext;
 import com.xpn.xwiki.XWikiException;
-import com.xpn.xwiki.doc.DocumentRevisionProvider;
 import com.xpn.xwiki.doc.XWikiDocument;
 import com.xpn.xwiki.objects.BaseObject;
 import com.xpn.xwiki.objects.ObjectDiff;
@@ -188,7 +188,7 @@ void setup() throws XWikiException
         task_1.setReference(taskPage_1);
         task_1.setReporter(adminRef);
         task_1.setDuedate(date1);
-        task_1.setAssignee(adminRef);
+        task_1.setAssignees(List.of(adminRef));
         task_1.setName(TASK_NAME);
         task_1.setCompleteDate(date1);
         task_1.setStatus(Task.STATUS_DONE);
@@ -199,7 +199,7 @@ void setup() throws XWikiException
         task.setReference(taskPage);
         task.setReporter(adminRef);
         task.setDuedate(date1);
-        task.setAssignee(adminRef);
+        task.setAssignees(List.of(adminRef));
         task.setName(TASK_NAME);
         task.setCompleteDate(date1);
         task.setStatus(Task.STATUS_DONE);

application-task-default/src/test/java/com/xwiki/task/TaskXDOMProcessorTest.java

@@ -204,7 +204,8 @@ void updateTaskMacroCall() throws TaskException, ComponentLookupException
         when(this.taskObject.getDateValue(Task.CREATE_DATE)).thenReturn(DEFAULT_TASK_DATE);
         when(this.taskObject.getIntValue(Task.NUMBER)).thenReturn(1);
 
-        when(this.taskBlockProcessor.generateTaskContentBlocks(eq(adminReference.toString()), eq(DEFAULT_TASK_DATE),
+        when(this.taskBlockProcessor.generateTaskContentBlocks(eq(List.of(adminReference.toString())),
+            eq(DEFAULT_TASK_DATE),
             eq(TASK1_ID), any(SimpleDateFormat.class))).thenReturn(Collections.emptyList());
         when(this.macroUtils.renderMacroContent(Collections.emptyList(), Syntax.XWIKI_2_1)).thenReturn(
             "TaskContent");
@@ -219,7 +220,8 @@ void updateTaskMacroCall() throws TaskException, ComponentLookupException
         verify(this.taskMacro1).setParameter(Task.STATUS, Task.STATUS_DONE);
         verify(this.taskMacro1).setParameter(Task.CREATE_DATE, DEFAULT_TASK_DATE_STRING);
         verify(this.taskMacro1).setParameter(Task.REPORTER, this.adminReference.toString());
-        verify(this.taskBlockProcessor).generateTaskContentBlocks(eq(adminReference.toString()), eq(DEFAULT_TASK_DATE),
+        verify(this.taskBlockProcessor).generateTaskContentBlocks(eq(List.of(adminReference.toString())),
+            eq(DEFAULT_TASK_DATE),
             eq(TASK1_ID), any(SimpleDateFormat.class));
         verify(this.macroUtils).renderMacroContent(Collections.emptyList(), Syntax.XWIKI_2_1);
     }

application-task-default/src/test/resources/task3.test

@@ -1,50 +1,55 @@
 .runTransformations
 .#-----------------------------------------------------
 .input|xwiki/2.0
-.# Task macro test without displaying the id.
+.# Task macro test with multiple users inside
 .#-----------------------------------------------------
-{{task reference="Sandbox.Task" status="Done" idDisplayed="FALSE" }}
-Important task with the following deadline: {{date value="2021/09/07 00:00"/}}
+{{task reference="Sandbox.Task" createDate="2025-04-28" reporter="XWiki.superadmin" status="InProgress" completeDate=""}}
+   {{mention reference="XWiki.Admin" anchor="XWiki-Admin-SdPsS" style="FULL_NAME"/}}{{mention reference="XWiki.testest" anchor="XWiki-testest-ZiyFB" style="FULL_NAME"/}}
 {{/task}}
 .#-----------------------------------------------------
 .expect|event/1.0
 .#-----------------------------------------------------
 beginDocument
-beginMacroMarkerStandalone [task] [reference=Sandbox.Task|status=Done|idDisplayed=FALSE] [Important task with the following deadline: {{date value="2021/09/07 00:00"/}}]
+beginMacroMarkerStandalone [task] [reference=Sandbox.Task|createDate=2025-04-28|reporter=XWiki.superadmin|status=InProgress|completeDate=] [   {{mention reference="XWiki.Admin" anchor="XWiki-Admin-SdPsS" style="FULL_NAME"/}}{{mention reference="XWiki.testest" anchor="XWiki-testest-ZiyFB" style="FULL_NAME"/}}]
 beginGroup [[class]=[task-macro]]
 beginGroup [[class]=[task-info]]
 beginFormat [NONE]
-onRawText [<input type="checkbox" data-taskId="Sandbox.Task" data-rawid="Sandbox.Task" checked class="task-status">] [html/5.0]
+onRawText [<input type="checkbox" data-taskId="Sandbox.Task" data-rawid="Sandbox.Task"  class="task-status">] [html/5.0]
 endFormat [NONE]
+beginLink [Typed = [true] Type = [doc] Reference = [Sandbox.Task]] [false]
+onSpecialSymbol [#]
+onWord [1]
+endLink [Typed = [true] Type = [doc] Reference = [Sandbox.Task]] [false]
 endGroup [[class]=[task-info]]
 beginGroup [[class]=[task-content]]
 beginMetaData [[non-generated-content]=[java.util.List<org.xwiki.rendering.block.Block>]]
 beginParagraph
-onWord [Important]
 onSpace
-onWord [task]
 onSpace
-onWord [with]
 onSpace
-onWord [the]
-onSpace
-onWord [following]
-onSpace
-onWord [deadline]
-onSpecialSymbol [:]
-onSpace
-beginMacroMarkerInline [date] [value=2021/09/07 00:00]
-beginFormat [NONE] [[class]=[xwiki-date]]
-onWord [2021/09/07 00:00]
-endFormat [NONE] [[class]=[xwiki-date]]
-endMacroMarkerInline [date] [value=2021/09/07 00:00]
+beginMacroMarkerInline [mention] [reference=XWiki.Admin|anchor=XWiki-Admin-SdPsS|style=FULL_NAME]
+beginFormat [NONE] [[class]=[xwikirenderingerror]]
+onWord [Unknown macro: mention. Click on this message for details.]
+endFormat [NONE] [[class]=[xwikirenderingerror]]
+beginFormat [NONE] [[class]=[xwikirenderingerrordescription hidden]]
+onVerbatim [The [mention] macro is not in the list of registered macros. Verify the spelling or contact your administrator.] [true]
+endFormat [NONE] [[class]=[xwikirenderingerrordescription hidden]]
+endMacroMarkerInline [mention] [reference=XWiki.Admin|anchor=XWiki-Admin-SdPsS|style=FULL_NAME]
+beginMacroMarkerInline [mention] [reference=XWiki.testest|anchor=XWiki-testest-ZiyFB|style=FULL_NAME]
+beginFormat [NONE] [[class]=[xwikirenderingerror]]
+onWord [Unknown macro: mention. Click on this message for details.]
+endFormat [NONE] [[class]=[xwikirenderingerror]]
+beginFormat [NONE] [[class]=[xwikirenderingerrordescription hidden]]
+onVerbatim [The [mention] macro is not in the list of registered macros. Verify the spelling or contact your administrator.] [true]
+endFormat [NONE] [[class]=[xwikirenderingerrordescription hidden]]
+endMacroMarkerInline [mention] [reference=XWiki.testest|anchor=XWiki-testest-ZiyFB|style=FULL_NAME]
 endParagraph
 endMetaData [[non-generated-content]=[java.util.List<org.xwiki.rendering.block.Block>]]
 endGroup [[class]=[task-content]]
 endGroup [[class]=[task-macro]]
-endMacroMarkerStandalone [task] [reference=Sandbox.Task|status=Done|idDisplayed=FALSE] [Important task with the following deadline: {{date value="2021/09/07 00:00"/}}]
+endMacroMarkerStandalone [task] [reference=Sandbox.Task|createDate=2025-04-28|reporter=XWiki.superadmin|status=InProgress|completeDate=] [   {{mention reference="XWiki.Admin" anchor="XWiki-Admin-SdPsS" style="FULL_NAME"/}}{{mention reference="XWiki.testest" anchor="XWiki-testest-ZiyFB" style="FULL_NAME"/}}]
 endDocument
 .#-----------------------------------------------------
 .expect|xhtml/1.0
 .#-----------------------------------------------------
-<div class="task-macro"><div class="task-info"><input type="checkbox" data-taskId="Sandbox.Task" data-rawid="Sandbox.Task" checked class="task-status"></div><div class="task-content"><p>Important task with the following deadline: <span class="xwiki-date">2021/09/07 00:00</span></p></div></div>
+<div class="task-macro"><div class="task-info"><input type="checkbox" data-taskId="Sandbox.Task" data-rawid="Sandbox.Task"  class="task-status"><span class="wikiinternallink"><a href="Sandbox.Task">#1</a></span></div><div class="task-content"><p>&nbsp;&nbsp;&nbsp;<span class="xwikirenderingerror">Unknown macro: mention. Click on this message for details.</span><span class="xwikirenderingerrordescription hidden"><tt class="wikimodel-verbatim">The [mention] macro is not in the list of registered macros. Verify the spelling or contact your administrator.</tt></span><span class="xwikirenderingerror">Unknown macro: mention. Click on this message for details.</span><span class="xwikirenderingerrordescription hidden"><tt class="wikimodel-verbatim">The [mention] macro is not in the list of registered macros. Verify the spelling or contact your administrator.</tt></span></p></div></div>