Email variable for the review reminder is not being shared with the UI

[jonasraoni]

Describe the bug
The email variable reviewAssignmentUrl for the template REVIEW_REMIND (review reminder) is not being passed to the UI.

I also think the constants/classes should be renamed to "review reminder".

To Reproduce

1. Enter on the review stage.
2. Click on the button to send a reminder to the reviewer.
3. See the variable is not stylized and also doesn't appear in the list of variables.

Added section and variable not being rendered.
Steps to reproduce.

1. Login as Editor
2. Find submission in copyediting stage.
3. Start a discussion with copyeditor
4. Login as copyeditor
5. Check notification bell

What application are you using?
OJS 3.4 and OJS stable-3.5.0

Additional information

[jonasraoni]

Also, it was unexpected for me that the email editor is working differently from the one at the Workflow > Emails, where the variables are displayed in plain text and the icon to insert variables is different:

Assuming it's a work in progress.

[Vitaliy-1]

@jonasraoni, is at an old template that should be replaced during upgrade?

[Vitaliy-1]

Apart from it, reviewAssignmentUrl isn't exposed deliberately:

pkp-lib/controllers/grid/users/reviewer/form/ReviewReminderForm.php

Line 89 in 3536404

// Don't expose the reviewer's one-click access URL to editors

[Vitaliy-1]

Also, it was unexpected for me that the email editor is working differently from the one at the Workflow > Emails, where the variables are displayed in plain text and the icon to insert variables is different

I recall variables are replaced before being sent

[Vitaliy-1]

The new wording for the template is different: https://github.com/pkp/ojs/blob/main/locale/en/emails.po#L251
I assume, the old template had custom modifications and that's why it was preserved, right?

[jonasraoni]

@Vitaliy-1 this is a mix of UI and backend issue.

The UI of the email editor is different, the email editor that appears when I click on the button Submission > Workflow > Review > Send Reminder has:

• + button, which allows me to select variables, but only the URL is available (it refers to the {$passwordResetUrl}.
• Only 1 variable
• The variable is not displayed as text, but as a kind of icon, which looks nice for me, see:
  

On another hand, if I access the email editor of the template, at Workflow > Emails > Add and edit templates, then it has:

• + Insert content button
• 32 variables
• The variables as displayed in plain-text, which I think is worse (the user might change something by accident)

[jonasraoni]

But I also had another issue in this part, I tagged you here:
https://github.com/pkp/pkp-lib/pull/9151/files#r1636973735

I think it might need some extra review, so I just fixed locally by replacing the variable passwordResetUrl by lostPasswordUrl on the template.

[asmecher]

One note about this template that might help clear up some confusion: For any templates that use access keys (3.4.0 and older) or invitations (3.5.0 and newer), we intentionally didn't present the full URL to the editor for viewing. That's because doing so would expose the secret key that goes out with the email. We need to prevent the editor (or anyone else) from intercepting these. Therefore they're coded so that the variable replacement happens right before the message gets delivered.

That said, it would be nicer to show something nicer than {$someVariableName} in the interface while editing the email.

[Hafsa-Naeem]

@jonasraoni @Vitaliy-1 @asmecher After a detailed review and attempts to recreate the concerns discussed about the email template behavior in OJS 3.4.0, I've observed the following: the Review Reminder functionality directly accesses predefined templates that include variables like {$recipientName}, {$submissionTitle}, and {$reviewDueDate}. These variables are dynamically replaced with actual data in the editor and the template does not display raw variables but shows the actual data:

however when accessing template through Workflow > Emails > Add and edit templates variables are shown in their placeholder form ({$variableName}) this approach seems to be by design which I think is intended for administrative purposes and allowing template customization and a clear understanding of what data will be dynamically inserted.