Submissions schema filters out declined&cancelled review assignments

[jardakotesovec]

Describe the issue
On new submission listing we would like to indicate for editors also review assignments that has been declined or cancelled. Currently Submissions Schema filters them out - https://github.com/pkp/pkp-lib/blob/main/classes/submission/maps/Schema.php#L422

The new submission listing is using the api/_submissions endpoint .

What application are you using?
OJS, OMP or OPS version 3.5

[Vitaliy-1]

Editors, Authors and Reviewers have access to the new dashboard. It might have sense to separate mapping of the submissions for editors from other roles, as it includes more data, for which authors and reviewers shouldn't have access to. Declined and cancelled reviews are such an example.

My proposal is to create a separate mapping for editor's list, e.g. Schema::mapToEditorsList()

[ewhanson]

I'm wondering if rather than a separate mapping, it would be possible to do this via some sort of permissions, e.g. an editor would have the extra review assignments included because they have permission to access them. That way we won't be maintaining multiple mappings that re similar but not exactly the same. I'll do some thinking on what that could look like and if that makes sense with the existing model we have in place.

[Vitaliy-1]

it would be possible to do this via some sort of permissions

I'm currently working on adopting laravel permissions library but that's a long road

[Vitaliy-1]

@Hafsa-Naeem, I believe that the best approach here would be to create a separate submission mapping for authors (or editors). It could be together with a new endpoint or using the same endpoint (_submissions/assigned) with different output depending on a role and/or additional query. I'd say that a new endpoint sounds better, @jardakotesovec, what do you think? Is it inline with your idea regarding distinguishing between author's and editor's dashboard?

[jardakotesovec]

@Vitaliy-1 I don't know whats better fit how to achieve it with current architecture. But just from API point of view if there is field or information that certain role should not have access to - my suggestion would be - just don't include it. For example in graphql where you could ask for lots of different data - common practice there would be to return null if you don't have permissions to access something.

[Vitaliy-1]

In the submission schema we have the method that defines mapping mapManyToSubmissionsList() and mapToSubmissionsList(). The latter has the line

return $this->mapByProperties($this->getSubmissionsListProps(), $item, $anonymizeReviews);

On the top of my head, we can do the separate mapping for authors: mapManyToSubmissionsAuthorList() and mapToSubmissionsAuthorList(). The latter will include simplified version of submission list properties. Or bypass this step and pass additional argument, the same approach as for anonymisation of reviews. The data should exclude:

• reviewAssignments - we need to replace the data there with just number of active reviews, as per Evaluate what information to expose to the author and reviewers regarding submission #9956 (comment)
• exclude recommendationsIn. Let's keep it just for editors
• revaluate if data from stages should be also removed
• It's relevant for _submissions/assigned and submission/{id} endpoint

In contrast, the schema and endpoint for editors should include info regarding declined and cancelled review assignments

[Hafsa-Naeem]

@Vitaliy-1 Ready for review
pkp/pkp-lib: Show declined/cancelled reviews to editors #10847

[Hafsa-Naeem]

@Vitaliy-1 Ready for review
pkp-lib: pkp/pkp-lib#10076 show declined/cancelled reviews to editors #10847
ojs: [TESTS ONLY] Submodule update ##hafsanaeem/pkp/pkp-lib#10076 #4679

[Vitaliy-1]

Thanks, added a review

[Hafsa-Naeem]

@Vitaliy-1 Ready for review again
pkp-lib: pkp/pkp-lib#10076 show declined/cancelled reviews to editors #10847
ojs: [TEST ONLY] Submodule update ##hafsanaeem/pkp/pkp-lib#10076 #4679

[Vitaliy-1]

Thanks! I left a comment for a change to ensure that we are a given full information to a user about reviews in a stage, to which the person is assigned to. This might be relevant for OMP.

[Hafsa-Naeem]

@Vitaliy-1 Ready for review again
pkp-lib: pkp/pkp-lib#10076 show declined/cancelled reviews to editors #10847
ojs: pkp/pkp-lib#10076 Show declined/cancelled reviews to editors & update submodule reference
omp: pkp/pkp-lib#10076 Added getReviewStages method to Application class #1852