feat: add export to excel functionality in reviewers and assignments tab in fap page by Bhaswati1148 · Pull Request #1839 · UserOfficeProject/user-office-core

Bhaswati1148 · 2026-09-28T14:21:22Z

Description

This PR adds the export to excel functionality in reviewers and assignments tab in fap page. The export creates multiple sheets if multiple users(reviewers) are selected.
The exported excel will have the columns : Proposal ID, Proposal title, Instrument, Date assigned, Rank, Grade, Comment, Status

Motivation and Context

This functionality has been added to allow the FAP Secretary in STFC to export reviewer reviews to Excel.

How Has This Been Tested

An E2E test has been added to verify the export functionality when the download button is clicked and to validate the contents of the exported Excel file.

Fixes

Closes UserOfficeProject/issue-tracker#1574

Changes

Depends on

Tests included/Docs Updated?

I have added tests to cover my changes.
All relevant doc has been updated

…ffice-core into 1574-export-fap-reviewers-review

…ailable.

Scott-James-Hurley · 2026-10-01T13:07:32Z

-      .andWhere('call_id', callId);
+      .where('fap_id', fapId);
+
+    if (callId != 0) {


Is there a legitimate case where callId is 0?

The callId is set to 0 when no calls are selected in the frontend.

Could add a commment?

Scott-James-Hurley · 2026-10-01T13:33:17Z


      cy.get('[data-cy="submit"]').click();

-      cy.notification({


What's the motivation behind removing this?

I removed the notification assertion because the success notification appears and disappears very quickly, and I couldn't find a reliable way for Cypress to get hold of it before it disappeared. This was making the test unreliable. The assignment itself is still verified by checking that the proposal appears in the FAP assignments table, so the test continues to validate the operation successfully.

Scott-James-Hurley · 2026-10-01T13:51:03Z

+      return;
+    }
+    const reviewerProposalMap = new Map<number, number[]>();
+    // const reviewerIds = rowData.map((reviewer) => reviewer.user.userId);


Can these commented out lines please be removed?

Removed them

Scott-James-Hurley · 2026-10-02T08:14:08Z

+    });
+    const reviewerProposals = Object.fromEntries(reviewerProposalMap);
+    reviewerProposalMap.forEach((key, value) => {
+      console.log('reviewerid  ' + key + `proposals ` + value);


This logging can be removed now, I reckon.

removed them

mutambaraf

LGTM apart form just a few comments

mutambaraf · 2026-10-02T14:50:44Z

+      const userWithRole = {
+        ...res.locals.agent,
+      };


We may need to validate we are getting all the information we need from this object.

Id is the information we need from userWithRole object which will be used further in the process. The middleware effectively validates the user’s id, it reads req.user.user.id, looks up that user with getAgent(id), and returns an unauthorized response if no user is found. It then puts the resulting user data into res.locals.agent. So I believe a second id check in the XLSX handler would usually be redundant.

mutambaraf · 2026-10-02T14:52:03Z

+      const reviewerProposalsParam = req.query.reviewerProposals;
+
+      if (typeof reviewerProposalsParam !== 'string') {
+        throw new Error('reviewerProposals is required');


We can say Proposals reviewer is required

mutambaraf

LGTM apart from the failing tests

zacharyjhankin · 2026-10-12T15:24:30Z

+          dateAssigned: formatDate(assignment.dateAssigned),
+          rank: assignment.rank ?? null,
+          grade: assignment.grade,
+          comment: stripHtml(assignment.comment ?? '-'),


We could be more clear about what comment this is. There are loads of different types of comments on proposals, which one?

We could be more clear about what comment this is. There are loads of different types of comments on proposals, which one?

The Excel export feature is being added to the Review and Assignments tab on the FAP page. This tab displays reviewers and their reviews of proposals assigned to them, as well as reviews submitted by other reviewers. Therefore, the comments included in the Excel export refer specifically to the FAP reviewers’ comments on those proposals.

Thus "FAP review comment" column heading?

zacharyjhankin · 2026-10-12T15:32:08Z

Are we planning to support importing this in the future?

…ffice-core into 1574-export-fap-reviewers-review

… this branch, so manually adding them

Bhaswati1148 · 2026-10-19T12:35:25Z

Are we planning to support importing this in the future?

There are no plans to support importing this at the moment.

zacharyjhankin · 2026-10-20T08:35:01Z

    "luxon": "^3.4.4",
    "pdf-parse": "^1.1.1",
-    "typescript": "~5.3.3",
+    "typescript": "^5.3.3",


From memory typescript doesn't actually follow semantic versioning. So when you put this ^ it allows the minor version to get automatically bumped. Which could potentially break UOS when someone releases to production. It seems like we shouldn't update any dependencies, maybe an accident while developing?

also isn't typescript in dev dependencies now? Maybe this is a git branch conflict?

zacharyjhankin · 2026-10-20T08:50:22Z

+  comment,
+  status,
+}: ReviewRowInput): Array<string | number> => [
+  proposalId ?? '-',


The convention in the rest of the export xlsx is to use instead of - for this purpose. It would be good to be consistent.

zacharyjhankin · 2026-10-20T08:51:50Z

+
+    const rows = rankedRows
+      .sort((a, b) => {
+        if (a.rank === null || b.rank === null) {


If instead of using === you used == to check vs null then your code would also work for undefined

Because currently your code puts null at the bottom, but undefined at the top which probably isn't desired

zacharyjhankin · 2026-10-20T09:00:06Z

+            return a.grade === null ? 1 : -1;
+          }
+        } else if (a.grade !== b.grade) {
+          return b.grade - a.grade;


Might be worth adding a comment that we are sorting from rank smallest to biggest, and grade biggest to smallest. Just to avoid confustion

zacharyjhankin · 2026-10-20T09:37:33Z


          break;
        }
-        case Event.PROPOSAL_DATA_ACCESS_INVITE_ACCEPTED: {


Why are you deleting this event?

It seems that something went wrong while updating my branch with develop. I will revert back the changes that are not related to my changes.

zacharyjhankin · 2026-10-20T09:38:23Z

          break;
        default: {
          let changedObjectId: number;
-          if (typeof (event as any)[event.key]?.primaryKey === 'number') {


Why are you changing this?

zacharyjhankin · 2026-10-20T10:10:17Z

+      const userRole = req.user.currentRole;
+
+      callFactoryService(
+        DownloadType.XLSX,


I just want to add that:

DownloadType.XLSX, XLSXType.MANAGEMENT_DECISION,

seems to work perfectly fine.
The factory doesn't seem to need us to add a bespoke one for each download type.

zacharyjhankin · 2026-10-20T10:17:48Z

There is certainly a bug here. The fap_reviews table in the database does not contain the instrument that it is relevant to. So why do we have the instrument in the excel document/UI of "reviewers and assignments"?

My DB

fap_reviews:

review_id	user_id	proposal_pk	"comment"	grade	status	created_at	updated_at	fap_id	notification_email_sent	fap_proposal_id	questionary_id	date_assigned	reassigned	date_reassigned	email_sent	"rank"
3	2	1	<p>f</p>	7	1	2026-10-20 10:58:16.035 +0100	2026-10-20 10:58:16.035 +0100	1	false	3	9	2026-10-20 10:58:16.035 +0100	false		false

fap_proposals

proposal_pk	fap_id	date_assigned	call_id	fap_time_allocation	instrument_id	fap_meeting_instrument_submitted	fap_proposal_id	instrument_has_proposals_id
1	1	2026-10-20 10:54:41.934 +0100	1		1	false	3	1
1	1	2026-10-20 10:54:41.934 +0100	1		2	false	4	2

This is one proposal that as two instruments reviewed by the same FAP panel

Bhaswati1148 added 4 commits September 24, 2026 12:53

initial changes for hpl excel sheet download feature

fbff885

Merge branch 'develop' of https://github.com/UserOfficeProject/user-o…

4387ff6

…ffice-core into 1574-export-fap-reviewers-review

add e2e test for export to excel functionality

0bfb265

Merge branch 'develop' of https://github.com/UserOfficeProject/user-o…

1fdac5d

…ffice-core into 1574-export-fap-reviewers-review

Bhaswati1148 requested a review from a team as a code owner September 28, 2026 14:21

Bhaswati1148 requested review from mutambaraf and removed request for a team September 28, 2026 14:21

Bhaswati1148 changed the title ~~feat: add export to excel functionality in reviewers and assignments page~~ feat: add export to excel functionality in reviewers and assignments tab in fap page Sep 28, 2026

skip the new test for the time being until the Factory changes are av…

6b3ba40

…ailable.

Bhaswati1148 mentioned this pull request Sep 28, 2026

add new xlsx type for fap reviews data export UserOfficeProject/user-office-factory#954

Merged

2 tasks

Bhaswati1148 and others added 6 commits September 30, 2026 16:24

fix failing e2e tests

402cb57

Merge branch 'develop' into 1574-export-fap-reviewers-review

a48a5e7

fix few more failing e2e tests

e155f24

Merge branch 'develop' into 1574-export-fap-reviewers-review

53535d2

Merge branch 'develop' into 1574-export-fap-reviewers-review

90e1003

Merge branch 'develop' into 1574-export-fap-reviewers-review

861fa05

Scott-James-Hurley approved these changes Oct 2, 2026

View reviewed changes

mutambaraf and others added 2 commits October 2, 2026 11:43

Merge branch 'develop' into 1574-export-fap-reviewers-review

eec575c

clean up

256d89b

mutambaraf reviewed Oct 2, 2026

View reviewed changes

Bhaswati1148 and others added 4 commits October 6, 2026 11:08

correction of the exception message

20724b8

Merge branch 'develop' into 1574-export-fap-reviewers-review

3126f6b

sort the rows in ascending rank order and descending grades

03d1db8

fix failing e2e test

839d7b9

Bhaswati1148 requested a review from mutambaraf October 7, 2026 10:47

mutambaraf reviewed Oct 7, 2026

View reviewed changes

mutambaraf and others added 4 commits October 7, 2026 15:53

Merge branch 'develop' into 1574-export-fap-reviewers-review

d002f49

Merge branch 'develop' into 1574-export-fap-reviewers-review

9dfd29e

Merge branch 'develop' into 1574-export-fap-reviewers-review

0d0cd6d

Merge branch 'develop' into 1574-export-fap-reviewers-review

f9b083e

Bhaswati1148 and others added 3 commits October 12, 2026 11:27

Merge branch 'develop' into 1574-export-fap-reviewers-review

4ea4e1c

fix few more tests

8efdd55

fix e2e test

60366fa

zacharyjhankin reviewed Oct 12, 2026

View reviewed changes

Bhaswati1148 added 2 commits October 19, 2026 11:51

Merge branch 'develop' of https://github.com/UserOfficeProject/user-o…

916ca20

…ffice-core into 1574-export-fap-reviewers-review

something went wrong while merging the fap test fixes from develop to…

c3f1040

… this branch, so manually adding them

Bhaswati1148 and others added 2 commits October 19, 2026 16:09

Change column name to FAP Review Comment

0997cc8

Merge branch 'develop' into 1574-export-fap-reviewers-review

a017cbf

Bhaswati1148 requested review from mutambaraf and zacharyjhankin October 20, 2026 08:31

zacharyjhankin reviewed Oct 20, 2026

View reviewed changes

zacharyjhankin self-requested a review October 20, 2026 10:21

zacharyjhankin requested changes Oct 20, 2026

View reviewed changes

Bhaswati1148 and others added 2 commits October 20, 2026 13:37

revert back changes in files which are not related to this PR

ce5e6ba

Merge branch 'develop' into 1574-export-fap-reviewers-review

4bd645c

Conversation

Bhaswati1148 commented Sep 28, 2026

Description

Motivation and Context

How Has This Been Tested

Fixes

Changes

Depends on

Tests included/Docs Updated?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mutambaraf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mutambaraf left a comment

Choose a reason for hiding this comment

Uh oh!

zacharyjhankin Oct 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zacharyjhankin commented Oct 12, 2026

Uh oh!

Bhaswati1148 commented Oct 19, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zacharyjhankin commented Oct 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This branch has not been deployed

Reviewers

Assignees

Labels

Projects

zacharyjhankin Oct 12, 2026 •

edited

Loading

zacharyjhankin commented Oct 20, 2026 •

edited

Loading