XWIKI-20187: The TOC in notifications emails displays "$title" instead of the actual page title

  * Use proper context user to evaluate email template

(cherry picked from commit fc688b1b)

xwiki-platform-core/xwiki-platform-notifications/xwiki-platform-notifications-notifiers/xwiki-platform-notifications-notifiers-default/src/main/java/org/xwiki/notifications/notifiers/internal/email/AbstractMimeMessageIterator.java

@@ -411,11 +411,14 @@ public MimeMessage next()
         XWikiContext xcontext = this.xcontextProvider.get();
 
         WikiReference currentWiki = xcontext.getWikiReference();
+        DocumentReference currentContextUser = xcontext.getUserReference();
 
         ExtendedMimeMessage message = null;
         try {
             // Switch to user's wiki to make sure the mail is generated from target user point of view
             xcontext.setWikiReference(this.currentUser.getWikiReference());
+            // Ensure to use the user we target in email to properly create notifications.
+            xcontext.setUserReference(this.currentUser);
 
             DocumentReference templateDocumentReference =
                 this.documentReferenceResolver.resolve(this.templateReference, this.currentUser);
@@ -434,6 +437,8 @@ public MimeMessage next()
         } finally {
             // Restore wiki
             xcontext.setWikiReference(currentWiki);
+            // Restore context user
+            xcontext.setUserReference(currentContextUser);
         }
 
         // Look for the next email to send

xwiki-platform-core/xwiki-platform-notifications/xwiki-platform-notifications-notifiers/xwiki-platform-notifications-notifiers-default/src/test/java/org/xwiki/notifications/notifiers/internal/email/DefaultPeriodicMimeMessageIteratorTest.java

@@ -28,6 +28,7 @@
 import java.util.stream.Collectors;
 
 import javax.inject.Named;
+import javax.inject.Provider;
 import javax.mail.internet.InternetAddress;
 import javax.mail.internet.MimeMessage;
 
@@ -61,6 +62,7 @@
 import org.xwiki.user.UserReferenceResolver;
 import org.xwiki.wiki.descriptor.WikiDescriptorManager;
 
+import com.xpn.xwiki.XWikiContext;
 import com.xpn.xwiki.api.Attachment;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -73,6 +75,7 @@
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
+import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
@@ -130,6 +133,11 @@ class DefaultPeriodicMimeMessageIteratorTest
     @MockComponent
     private NotificationConfiguration notificationConfiguration;
 
+    @MockComponent
+    private Provider<XWikiContext> contextProvider;
+
+    private XWikiContext context;
+
     @BeforeComponent
     void beforeComponent(MockitoComponentManager componentManager) throws Exception
     {
@@ -146,6 +154,8 @@ void beforeEach()
         when(this.wikiDescriptorManager.getCurrentWikiId()).thenReturn("xwiki");
         when(this.mailSenderConfiguration.getFromAddress()).thenReturn("xwiki@xwiki.org");
         when(this.documentReferenceResolver.resolve(eq(TEMPLATE_REFERENCE), any())).thenReturn(TEMPLATE_REFERENCE);
+        this.context = mock(XWikiContext.class);
+        when(this.contextProvider.get()).thenReturn(this.context);
     }
 
     @Test
@@ -165,7 +175,7 @@ void test() throws Exception
         when(this.documentAccessBridge.getProperty(userB, userClass, 0, "email")).thenReturn("bad email");
         when(this.documentAccessBridge.getProperty(userC, userClass, 0, "email")).thenReturn("userC@xwiki.org");
         when(this.serializer.serialize(userA)).thenReturn("xwiki:XWiki.UserA");
-        when(this.serializer.serialize(userB)).thenReturn("xwiki:XWiki.UserA");
+        when(this.serializer.serialize(userB)).thenReturn("xwiki:XWiki.UserB");
         when(this.serializer.serialize(userC)).thenReturn("xwiki:XWiki.UserC");
 
         CompositeEvent compositeEvent1UserA = mock(CompositeEvent.class);
@@ -289,6 +299,10 @@ void test() throws Exception
 
         // Verify
         verify(this.serializer, never()).serialize(userB);
+        verify(this.context, times(2)).setUserReference(userA);
+        verify(this.context, never()).setUserReference(userB);
+        verify(this.context).setUserReference(userC);
+        verify(this.context, times(3)).setUserReference(null);
 
         assertEquals(this.iterator, this.iterator.iterator());
     }