Initialize setting review / proposal stage page #782
Conversation
Codecov Report
@@ Coverage Diff @@
## master #782 +/- ##
==========================================
- Coverage 75.05% 74.67% -0.39%
==========================================
Files 80 80
Lines 3083 3107 +24
==========================================
+ Hits 2314 2320 +6
- Misses 769 787 +18
Continue to review full report at Codecov.
|
|
|
||
| .input-customized-size input{ | ||
| width: 16.2em; | ||
| } |
There was a problem hiding this comment.
nitpicking: no new line in the end of a file
|
@alice6373 for now @uranusjr will help you complete this PR. Please feel free to discuss with him if you have any thought about this PR : ) |
alice6373
force-pushed
the
page-for-setting-review-stage
branch
from
9daa732
to
1497d90
Compare
| proposals_creatable.checked = false; | ||
| proposals_editable.checked = false; | ||
| proposals_withdrawable.checked = false; | ||
| reviews_stage.value = "0"; |
|
|
||
| {% if user.is_superuser %} | ||
| <li class="{% if active == 'admin' %}active{% endif %}"> | ||
| <a href="{% url 'review_change' %}">{% trans 'Change Review' %}</a> |
There was a problem hiding this comment.
Can we call it Review Stages? "Change Review" seems a little bit imprecise here.
There was a problem hiding this comment.
Thanks for your advise. To rename, I push a new commit db4fea7. Review Stages is indeed more precise.
Codecov Report
@@ Coverage Diff @@
## master #782 +/- ##
==========================================
- Coverage 75.05% 74.26% -0.80%
==========================================
Files 80 80
Lines 3083 3132 +49
==========================================
+ Hits 2314 2326 +12
- Misses 769 806 +37
Continue to review full report at Codecov.
|
| <input name="proposals.disable.after" type="datetime-local" step="1" | ||
| placeholder="yyyy-mm-dd hh:mm:ss" required="required"> |
There was a problem hiding this comment.
I am having doubts about making this field "required" because I think we should be able to disable it by not providing any value?
And another thing is that the backend needs the format exactly as YYYY-mm-ddThh:mm:ss, you need to put the T in there, but the placeholder hints without the T. I personally think that YYYY-mm-dd hh:mm:ss should be more user-friendly, and you can consider accepting values without ss (treat missing ss as 0).
You can take a look at how django implements this here:
https://github.com/django/django/blob/master/django/forms/fields.py#L366
They take multiple possible formats and try one another, described in here https://docs.djangoproject.com/en/3.0/ref/settings/#datetime-input-formats
I think this is a little bit too much, but if you have time you can try this. The bottom line is at least make it more user friendly and the frontend hint needs to meet the backend validation criteria.
There was a problem hiding this comment.
Consider accepting values without ss -> 9ef909e
There was a problem hiding this comment.
But on the other hand, what does it mean that we should be able to disable it by not providing any value ? Is it for users to change a value individually?
There was a problem hiding this comment.
What I meant is that, proposals.disabled.after should take effect if this key / value is set. If no value is set for this key, like, an empty value, then it will never be disabled after any time.
src/users/views.py
Outdated
| fmt = '%Y-%m-%d %H:%M:%S%z' | ||
| tz_selectd = pytz.timezone(request.POST['review_timezone']) | ||
| date_time_obj = datetime.datetime.strptime( | ||
| request.POST['proposals.disable.after'], '%Y-%m-%dT%H:%M:%S') |
There was a problem hiding this comment.
I suppose this is the mismatched part. Acutally it will raise an exception without telling the user what went wrong. A better to do this is at least tell the user about the error format so that they know what happened.
There was a problem hiding this comment.
In the Google browser, datetime-local allows users to click on the date with a graphical button, but in Safari browsers it is indeed to use text input, so there is the above problem.
Refer to your suggestion and use validation error. Its changes such as d579e69. When inputting a date format that cannot be parsed, the following prompt screen will be generated.
There was a problem hiding this comment.
Yep, so here comes the validation part. If the value provided is invalid, it should return back to the frontend with some error messages so that the user know what should be fixed (usually some error message in red near the field, telling what's wrong and what should be expected)
There was a problem hiding this comment.
Thank Tom. @mattwang44 also advised me used message.error instead of debug mode to remind users.
Done !
| {% block extra_js %} | ||
| {% compress js %} | ||
| <script src="{% static 'js/reviews/review_stages.js' %}"></script> | ||
| {% endcompress %} | ||
| {% endblock extra_js %} |
There was a problem hiding this comment.
I think you should read current values from the database and show current settings on page load.
Something like
<script src="{% static 'js/reviews/review_stages.js' %}"></script>
<script>
proposals_creatable.checked = {% if proposals_creatable %}true{% else %}false;
proposals_editable.checked = {% if proposals_editable %}true{% else %}false;
proposals_withdrawable.checked = {% if proposals_withdrawable %}true{% else %}false;
reviews_stage.value = {{ reviews_stage }};
reviews_visible_to_submitters.checked = {% if reviews_visible_to_submitters %}true{% else %}false;
</script>The above is just a sample code, very ugly, but just a simple demonstration of how django template variables and javscript can be integrated together.
There was a problem hiding this comment.
There was a problem hiding this comment.
Maybe the two functions of the current review stage status and the set review stage can be presented in different pages ？Do you have more ideas ?
There was a problem hiding this comment.
uh... what I mean is that the boolean switches should represent the current set values. So that when the admin sees the page, current settings are clear. And the admin can do some minor tuning without "not knowning" what current values look like.
我想用中文可能比較好表達。原本是不會載入目前的設定的，所以每次進來這一頁都是 false、或者是空的值。這樣其實很難一目瞭然目前到底是哪一個階段，或者是說目前的設定到底是長怎樣。期待的樣子是我進來的時候，所有的值就是目前的設定。舉個很爛的例子，假設目前是 editable、withdrawable 是開的，然後突然要很臨時的開放 creatable 一小段時間，我就只要把 creatable 打開，然後時間過了我再把它關起來。我就不需要再一個一個確認其他某一個的值是什麼，然後小心翼翼的調整怕弄錯，然後改完又要再小心翼翼的改回去。
…after values without ss (seconds)
…UT_FORMATS) for pycontw-2020.proposals.disable.after & catch ValidationError
…o the form that will be submitted
There was a problem hiding this comment.
Actually, I still don't know why you don't want to load the proposals.disable.after date in the frontend like all other boolean switches.
In src/templates/default/review/review_stages.html, merely add some code we can also provide the saved datetime and put it there.
I think the same idea also holds. If proposals.disable.after is set, and an admin wants to switch the one of the switches but forget to set the time explicitly, this setting will be lost, which is also a little bit of dangerous for me.
There's also something different, did you remove the datetime picker javascript widget? I did not see it this time.
| request, 'reviews/review_stages.html', { | ||
| 'timezones': pytz.common_timezones, | ||
| 'review_stages_list': review_stages_list, | ||
| 'current_review_stages_setting': current_review_stages_setting, |
There was a problem hiding this comment.
If you go to this path, current_review_stages_setting will be empty, and all values are lost. If the user entered an invalid value for proposals.disable.after, and then corrected it, and press save, all previous states will be lost, which is dangerous.
I think this is some kind of duplicate code of the normal render() for this view. maybe you should make them the same code.
Codecov Report
@@ Coverage Diff @@
## master #782 +/- ##
==========================================
- Coverage 75.05% 74.69% -0.37%
==========================================
Files 80 84 +4
Lines 3083 3367 +284
==========================================
+ Hits 2314 2515 +201
- Misses 769 852 +83
Continue to review full report at Codecov.
|
name: Develop a configuration page for setting the review / proposal stage
about: #727
title: Initialize setting review / proposal stage page
labels: review-stages
assignees: ''
Description
Initialize setting review / proposal stage page
Steps to Test This Pull Request
Steps to reproduce the behavior:
Expected behavior
(The action corresponding to the button has not been completed.)
(Use dj-registry package)
More Information
Page Screenshots
