Add Review Stages Setting #1204

tomatoprinx · 2024-07-13T16:07:17Z

Types of changes

Description

Initialize setting review / proposal stage page
Created new branch from current master branch and cherrypicked from Initialize setting review / proposal stage page #782

Steps to Test This Pull Request

Steps to reproduce the behavior:

Login with admin account
Go to 'Review Stages' page
Click hotkeys in the 'Set Review Stage' section
Submit

Expected behavior

Only admin can see this page.
Review stages hotkeys corresponding to Proposal Review System Documentation.
Submit and update the setting to dj-registry.
Rendering current stage settings to the frontend.

Related Issue

#782

More Information

… disabled)

…after values without ss (seconds)

…UT_FORMATS) for pycontw-2020.proposals.disable.after & catch ValidationError

…o the form that will be submitted

… form

…rom data loss on invalid `proposals.disable.after` value

codecov · 2024-07-21T15:28:46Z

Codecov Report

Attention: Patch coverage is 98.11321% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.44%. Comparing base (0e6ad43) to head (ee689cc).
Report is 1 commits behind head on master.

Files with missing lines	Patch %	Lines
src/reviews/views.py	97.91%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1204      +/-   ##
==========================================
+ Coverage   74.03%   74.44%   +0.40%     
==========================================
  Files          81       81              
  Lines        3062     3115      +53     
==========================================
+ Hits         2267     2319      +52     
- Misses        795      796       +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

mattwang44 · 2025-01-11T06:40:53Z

src/locale/en_US/LC_MESSAGES/django.po

please fix the translation entries with fuzzy marks

mattwang44 · 2025-01-11T06:50:32Z

src/reviews/views.py

+    datetime_input_format += ['%Y-%m-%dT%H:%M:%S', '%Y-%m-%dT%H:%M']
+    value = value.strip()
+    # Try to strptime against each input format.
+    for format in datetime_input_format:


it's better not to mutate the input arguments

Suggested change

datetime_input_format += ['%Y-%m-%dT%H:%M:%S', '%Y-%m-%dT%H:%M']

value = value.strip()

# Try to strptime against each input format.

for format in datetime_input_format:

value = value.strip()

# Try to strptime against each valid format

valid_formats = datetime_input_format + ['%Y-%m-%dT%H:%M:%S', '%Y-%m-%dT%H:%M']

for format in valid_formats:

mattwang44 · 2025-01-11T06:52:36Z

src/reviews/views.py

+    current_review_stages_setting[tag] = value
+
+
+def date_preprocess(datetime_input_format, value):


give the arg a plural name if it's a list

Suggested change

def date_preprocess(datetime_input_format, value):

def date_preprocess(datetime_input_formats: list[str], value: str) -> datetime.datetime | None:

mattwang44 · 2025-01-11T06:56:30Z

src/static/js/reviews/review_stages.js

+	function Call_for_Proposals() {
+		proposals_creatable.checked = true;


nit: we typically use camel case for class/variable names in javascript

Suggested change

function Call_for_Proposals() {

proposals_creatable.checked = true;

function CallForProposals() {

proposalsCreatable.checked = true;

mattwang44 · 2025-01-11T06:57:46Z

src/static/css/vendors/bootstrap/_panels.scss

  padding: $panel-body-padding;
+	color: black;


ensure same indent style

Suggested change

padding: $panel-body-padding;

color: black;

padding: $panel-body-padding;

color: black;

mattwang44 · 2025-01-11T06:59:30Z

src/reviews/views.py

@@ -327,3 +332,77 @@ def get_success_url(self):
        if query_string:
            return url + '?' + query_string
        return url
+
+
+def review_stages(request):


nit: consider rewriting it into a class-based view, as it seems to be one of our conventions

mattwang44 · 2025-01-11T07:06:25Z

src/reviews/views.py

+        value = reg.get(key, '')
+        update_current_review_stages_setting(tag, value, current_review_stages_setting)
+
+    if request.method == 'POST':


what are the allowed methods of this api? can i call with PUT, PATCH, GET?

mattwang44 · 2025-01-11T07:12:25Z

src/templates/default/reviews/review_stages.html

+						</div>
+					</li>
+					<li class="panel-title list-group-item">
+						timezone


What's the purpose of allowing updating the timezone?
Aren't we switching the stages based AoE (Anywhere on Earth) time? The README of the review stages does not mention timezone too.

mattwang44 · 2025-01-11T07:22:42Z

src/reviews/views.py

+    if "." in tag:
+        tag = tag.replace(".", "_")
+    current_review_stages_setting[tag] = value


to relieve the maintainers/developers from the burden to remember the conversion logic, can we align the naming of the reg keys and context pass to the template?

mattwang44 · 2025-01-11T07:25:36Z

src/reviews/views.py

+                    date_time_obj = date_preprocess(DATETIME_INPUT_FORMATS, request.POST[tag])
+                    if date_time_obj is None:
+                        messages.error(request, 'Please input valid date format : " + "%Y-%m-%dT%H:%M')
+                        value = None


why save None on error? maybe we can raise exception and respond with 400 instead?

mattwang44 · 2025-01-11T07:32:00Z

Consider organizing the whole commit history again, leaving only important commits for reviewers.
Please ensure the feature runs well with the upcoming bootstrap for 2025 (feat: update PyConTW 2024 to 2025(BackEnd) #1213)

alice6373 added 20 commits July 13, 2024 16:40

Initialize setting review / proposal stage page

04553f9

Alice fixup with love

f195f71

Clear gui

69a7f07

Default timezone sring handling

7300021

rename to Review Stages

a036250

Generating timezone dynamically with pytz

81d875e

Delete comment in review_stages.html

1397208

Delete print() in view.py

1f485a3

Update GUI

db36ab6

return value add reviews_state()

d867fc2

Rename First Round Review_2 to First Round Review

65016fa

Change the typography to vertical

95d6dc9

Rename First Round Review_1 to Locked (proposal editing and reviewing…

b56946c

… disabled)

Enhance user friendliness : accepting pycontw-2020.proposals.disable.…

663e433

…after values without ss (seconds)

Enhance user friendliness : Try more django date format (DATETIME_INP…

c2a6d53

…UT_FORMATS) for pycontw-2020.proposals.disable.after & catch ValidationError

Enhance user friendliness : display current review stage setting

cc7fc66

Enhance user friendliness : automatically load the current settings t…

8547598

…o the form that will be submitted

Move url.py & view.py to more precise folder

aaa5034

Fix problem that current settings will not be loaded after submitting…

0ad9045

… form

proposals.disabled.after not be required

f2dd18e

tomatoprinx marked this pull request as draft July 13, 2024 16:07

tomatoprinx mentioned this pull request Jul 13, 2024

[program] - 審稿系統 - 新增審稿各階段預設參數設定 #1168

Open

tomatoprinx added 7 commits July 20, 2024 14:24

Remove unnecessary parentheses and harcoded key

eef9a46

Fix duplicated return() and safeguard current_review_stages_setting f…

4fac698

…rom data loss on invalid `proposals.disable.after` value

Fix proposals.disable.after value rendering in input element

4e0bcdd

Update panel font color for user experience

d73d206

Update message files for translations

007022a

Fix ruff check errors

ef2e045

Fix element id

8b9d274

Add test method for configuration_switch

1edd88c

josix marked this pull request as ready for review September 17, 2024 10:06

tomatoprinx requested a review from josix September 18, 2024 15:34

tomatoprinx added 3 commits January 4, 2025 14:44

add test for review stages

978f2f6

fix ruff check

e8e0e82

Merge branch 'master' into feature/add_review_stages_setting

ee689cc

tomatoprinx requested a review from mattwang44 January 6, 2025 16:17

mattwang44 reviewed Jan 11, 2025

View reviewed changes

Ritabear mentioned this pull request Jan 12, 2025

feat: update PyConTW 2024 to 2025(BackEnd) #1214

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Review Stages Setting #1204

Add Review Stages Setting #1204

tomatoprinx commented Jul 13, 2024 •

edited

Loading

codecov bot commented Jul 21, 2024 •

edited

Loading

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025 •

edited

Loading

mattwang44 Jan 11, 2025

mattwang44 Jan 11, 2025

mattwang44 commented Jan 11, 2025 •

edited

Loading

		current_review_stages_setting[tag] = value


		def date_preprocess(datetime_input_format, value):

		function Call_for_Proposals() {
		proposals_creatable.checked = true;

Add Review Stages Setting #1204

Are you sure you want to change the base?

Add Review Stages Setting #1204

Conversation

tomatoprinx commented Jul 13, 2024 • edited Loading

Types of changes

Description

Steps to Test This Pull Request

Expected behavior

Related Issue

More Information

codecov bot commented Jul 21, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattwang44 Jan 11, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mattwang44 commented Jan 11, 2025 • edited Loading

tomatoprinx commented Jul 13, 2024 •

edited

Loading

codecov bot commented Jul 21, 2024 •

edited

Loading

mattwang44 Jan 11, 2025 •

edited

Loading

mattwang44 commented Jan 11, 2025 •

edited

Loading