Review summary backend by Vilmo18 · Pull Request #1317 · deep-learning-indaba/Baobab

Vilmo18 · 2025-04-02T21:33:13Z

New Patch – Baobab/Journal Updates

Multiple Article Submission: Support for submitting multiple articles per user.
Submission Views: Enhanced views for managing and reviewing submissions.
Chaining Mechanism: Implemented linkage between submitted articles and related articles for tracking.

Response Page Enhancements:

Validation Window: Added validation logic for journals and events.
Final Reviewer Comments: Introduced a dedicated section for final reviewers to provide feedback or recommendations.
Email Notifications: Automated email responses based on editorial decisions.

Additional Notes:

Several database migrations have been applied to support these updates.

…tion

Copilot

Copilot reviewed 32 out of 33 changed files in this pull request and generated 2 comments.

Files not reviewed (1)

webapp/public/locales/en/translation.json: Language not supported

api/app/responses/api.py

Copilot · 2025-04-15T16:19:44Z

api/app/outcome/api.py

+
+                    raise ValueError(errors.REVIEW_FORM_NOT_FOUND)
+


In the outcome POST method, raising a ValueError when review_form is not found interrupts the API flow; consider returning an appropriate error response to gracefully handle this case.

Suggested change

raise ValueError(errors.REVIEW_FORM_NOT_FOUND)

return errors.REVIEW_FORM_NOT_FOUND

upaq · 2025-06-03T20:40:15Z

api/app/outcome/api.py

            outcome_repository.add(outcome)
            db.session.commit()

-            if (status == Status.REJECTED or status == Status.WAITLIST):  # Email will be sent with offer for accepted candidates  


In the list of code changes, it looks like this code is deleted, but it is shifted down. It might be cleaner to swap the "if" statements?

upaq · 2025-06-03T20:41:33Z

api/app/outcome/api.py

-                    event=event,
-                    user=user,
-                )
+            if (event.event_type==EventType.JOURNAL):


space around == ?

upaq · 2025-06-03T20:41:56Z

api/app/outcome/api.py

+                    )
+
+            else:
+                if (status == Status.REJECTED or status == Status.WAITLIST):  # Email will be sent with offer for accepted candidates  


see earlier comment

upaq · 2025-06-03T20:43:27Z

api/app/outcome/models.py

-    REVIEW = "in review"
-    ACCEPT_W_REVISION = "accept with minor revision"
-    REJECT_W_ENCOURAGEMENT = "reject with encouragement to resubmit"
+    ACCEPTED = "Accepted"


Just checking as "accepted" -> "Accepted" will affect UI for all of Deep Learning Indaba. Is there no major text implications, i.e. the word used in the middle of a sentence somewhere?

Please undo these changes. These are primarily for the database and not for displaying in the UI. If a different text is needed on the UI then that mapping should happen there.

Thanks!
Done!

upaq · 2025-06-03T20:43:54Z

api/app/outcome/repository.py

+    def get_latest_by_user_for_event(user_id, event_id,response_id=None):
        outcome = (db.session.query(Outcome)
-                        .filter_by(user_id=user_id, event_id=event_id, latest=True)
+                        .filter_by(user_id=user_id, event_id=event_id, latest=True,response_id=response_id)


space after comma (style)?

upaq · 2025-06-03T20:44:57Z

api/app/responses/api.py

        responses = response_repository.get_all_for_user_application(user_id, application_form_id)

-        if not application_form.nominations and len(responses) > 0:
+        if  not allow_multiple_submissions and len(responses) > 0:


if (double space) not?

upaq · 2025-06-03T20:46:16Z

api/app/reviews/api.py

    def get_eligible_response_ids(self, event_id, reviewer_user_id, num_reviews, reviews_required, tags):
        candidate_responses = review_repository.get_candidate_responses(event_id, reviewer_user_id, reviews_required)
-        # Filter by tags
+        # Filter by tags 


tags space?

avishkar58

Hi Yvan,
Thanks for the PR. It's generally looking good! Have finished reviewing the backend changes, but still busy with the front-end ones.

avishkar58 · 2025-06-15T14:55:34Z

api/app/outcome/api.py


        try:
-            outcome = outcome_repository.get_latest_by_user_for_event(user_id, event_id)
+            outcome = outcome_repository.get_latest_by_user_for_event(user_id, event_id,response_id)


General style comment (please fix everywhere): please ensure there is a space after a comma in an argument list.

avishkar58 · 2025-06-15T14:57:52Z

api/app/outcome/api.py

        req_parser.add_argument('user_id', type=int, required=True)
        req_parser.add_argument('outcome', type=str, required=True)
+        req_parser.add_argument('response_id', type=int, required=True)
+        req_parser.add_argument('review_summary', type=str, required=True)


Having a review_summary being required for an outcome will break the Indaba process. For the Indaba, not all applications are reviewed, so there won't necessarily be a review summary. It would be better to keep review summaries associated with reviews and then have logic that picks that up for journal events when needed, instead of coupling reviews to outcomes as is done here.

although i see in the outcome model it's actually not required, so it shouldn't be required here then.

I've turned it to False and I used args.get('review_summary') to prevent case when we are getting nothing

avishkar58 · 2025-06-15T15:00:48Z

api/app/outcome/api.py

-                )
+            if (event.event_type==EventType.JOURNAL):
+                response = response_repository.get_by_id_and_user_id(outcome.response_id, outcome.user_id)
+                submission_title=strings.answer_by_question_key('submission_title', response.application_form, response.answers)


Please fix spacing around = here and everywhere else

avishkar58 · 2025-06-15T15:02:39Z

api/app/outcome/api.py

-                )
+            if (event.event_type==EventType.JOURNAL):
+                response = response_repository.get_by_id_and_user_id(outcome.response_id, outcome.user_id)
+                submission_title=strings.answer_by_question_key('submission_title', response.application_form, response.answers)


Is there some logic that enforces a submission_title field in every journal application form? Otherwise this can easily break without people realising it, and probably when it's too late to fix it.

I've added this script
if not submission_title: raise errors.SUBMISSION_TITLE_NOT_FOUND

avishkar58 · 2025-06-15T15:04:17Z

api/app/outcome/models.py

-    REVIEW = "in review"
-    ACCEPT_W_REVISION = "accept with minor revision"
-    REJECT_W_ENCOURAGEMENT = "reject with encouragement to resubmit"
+    ACCEPTED = "Accepted"


Please undo these changes. These are primarily for the database and not for displaying in the UI. If a different text is needed on the UI then that mapping should happen there.

avishkar58 · 2025-06-15T15:47:18Z

webapp/src/pages/ResponsePage/ResponsePage.js

+
+                    {this.props.t("Thank you for your submission of ")}
+                    <strong>{submission_title}</strong>
+                    {this.props.t(" to The Journal of Artificial Intelligence for Sustainable Development. Please find below a meta review summary, followed by the reviewer(s)’s feedback."


please replace with a placeholder for the event name rather than hardcoding this one

avishkar58 · 2025-06-15T15:47:48Z

webapp/src/pages/ResponsePage/ResponsePage.js

+
+                    <div className="application-status">
+                        <h5>{this.props.t("Meta-review")}</h5>
+                        <p className="greeting">


why is this className called "greeting" ?

avishkar58 · 2025-06-15T15:48:22Z

webapp/src/pages/ResponsePage/ResponsePage.js

+
+                <div className="letter-footer">
+                    <p>{this.props.t("Kind Regards")},</p>
+                    <p>{this.props.t("The JAISD editorial board")}</p>


Please replace with a placeholder

avishkar58 · 2025-06-15T15:48:55Z

webapp/src/pages/ResponsePage/ResponsePage.js

+                </button>
+            </div>
+
+            <div className="modal-body">


I'm not sure what exactly this "letter" is for, but can the contents instead be loaded from an email template, rather than being hard-coded into the UI?

avishkar58 · 2025-06-15T15:54:20Z

webapp/src/pages/applicationForm/components/ApplicationForm.js

+  renderSections() {
+    const applicationForm = this.state.applicationForm;
+    const applicationData = this.state.applicationData;
+    let html = [];


Please do this with a map which is more canonical react style (which favours immutable code), rather than a forEach pushing into an array. I know we have some code in the responsePage that works like this, but it shouldn't be there, and I don't want to add more code of a bad style

Vilmo18 · 2025-07-02T03:40:44Z

I will remove all useless css and translation

Vilmo18 added 27 commits January 29, 2025 01:08

add new migrations

922abc9

add new migrations

561ef22

Outcome model adjustment

c4851df

Outcome model adjustment

25ac768

Outcome model adjustment

5531c1a

Response model adjustment

503b569

Adjustment of service outcome and applicationForm

5dc41a2

creation of page ResponseDetails and modification of Eventstatus page

fb33cb1

add new routes

965f85c

insert css for application.js

e0a9e81

improving applicationForm

6b2587b

Submission displaying using chain mecanism

60242b1

Submission displaying using chain mecanism

a6b4e60

ResponseDetails clean code

9012c5f

Modal modification and improvement

2c360cf

adding response letter

33bd3d1

model adding

32002b3

adding textarea for comment-valiation for new submiss - adjust valida…

c5e3e89

…tion

clean code

e894f1c

backend enhancement

be6dc9d

confirmation button new submission

841d8d9

email template adding and sending email for journal event

dba4490

clean code

9517bc0

clean code and correcting typos

b0b05d6

fixing bugs email submission

043490e

fixing bugs sending email and enhance code fot it

613a150

remove typos from code

c707680

avishkar58 requested review from avishkar58 and Copilot April 15, 2025 16:18

Copilot AI reviewed Apr 15, 2025

View reviewed changes

Vilmo18 added 11 commits April 20, 2025 10:15

correction typos

d9a713b

improve migration

8c91e74

improve migration

1d21025

improve migration

d413d55

solve conficts translation

111704a

Merge branch 'develop' into review-summary-backend

abdeccc

Delete api/migrations/versions/0b9cc856acbb_.py

10cc03f

Delete api/migrations/versions/96d8500358ec_.py

c699cf3

Delete api/migrations/versions/afd6a07ccc79_.py

81b0461

Delete api/migrations/versions/61ecb542488f_.py

f2d8483

Update 4b881c1c6dc2_add_email_templates.py

50a8050

Vilmo18 force-pushed the review-summary-backend branch 3 times, most recently from b5c242d to 111704a Compare May 23, 2025 05:06

upaq reviewed Jun 3, 2025

View reviewed changes

avishkar58 requested changes Jun 15, 2025

View reviewed changes

Vilmo18 added 9 commits June 28, 2025 14:36

adding errors and clean code - fixing summary problems

a04301e

using map instead of forEach

6ae24b3

improve code quality

1ef444e

correction allow multiple submissions

18e3eae

correction code into strings.py -comments- and improvment

dc2f977

remove letter

1621c77

fix typos

6625ff2

correcting variables attributions

321d707

correcting variables attributions

f7c13a8

Vilmo18 and others added 2 commits July 2, 2025 00:48

improve migrations

51e3783

Merge branch 'develop' into review-summary-backend

b1dbd7d


	raise ValueError(errors.REVIEW_FORM_NOT_FOUND)

	return errors.REVIEW_FORM_NOT_FOUND

Conversation

Vilmo18 commented Apr 2, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Apr 15, 2025

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!

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!

avishkar58 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!

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!

Vilmo18 Jul 2, 2025 • 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!

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!

Vilmo18 commented Jul 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Vilmo18 Jul 2, 2025 •

edited

Loading