Member codes docs #2595
Merged
Member codes docs #2595
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 1. Add a field `<fieldname>-override` to the relevant model. This should be a `BooleanField` defaulting to `False`. | ||
| 2. On `Form`s connected to the model, manipulate the `helper.layout` to show/hide the new field according to the value of the field you're implementing soft validation on (e.g. the `validate_member_code` method of `TrainingRequestForm` in [`/extforms/forms.py`](../../amy/extforms/forms.py) shows and hides the `member_code_override` field according to the validity of the `member_code`). | ||
| 3. Build validation carefully for the override and the field it relates to. The override should only be required and `True` if the related field is invalid. In other cases, it should be `False` - this may require updating the value during validation (e.g. the `validate_member_code` method again). | ||
| 4. Consider adding a filter to help admins find objects where the override was used. Beware that the default `django_filters.BooleanFilter` is not quite appropriate - typically you will want *all* results to be shown when the filter is `False`, and only results that use the override to be shown when the filter is `True` (e.g. `invalid_member_code` filter in `TrainingRequestFilter` in [/extrequests/filters.py](../../amy/extrequests/filters.py)). |
There was a problem hiding this comment.
Consider absolute link to the file in GitHub repository.
| **Method**: | ||
|
|
||
| 1. Add a field `<fieldname>-override` to the relevant model. This should be a `BooleanField` defaulting to `False`. | ||
| 2. On `Form`s connected to the model, manipulate the `helper.layout` to show/hide the new field according to the value of the field you're implementing soft validation on (e.g. the `validate_member_code` method of `TrainingRequestForm` in [`/extforms/forms.py`](../../amy/extforms/forms.py) shows and hides the `member_code_override` field according to the validity of the `member_code`). |
There was a problem hiding this comment.
Consider absolute link to the file in GitHub repository.
|
|
||
| ## Feature flag | ||
|
|
||
| The `ENFORCE_MEMBER_CODES` [feature flag](../feature_flags.md) controls whether validity checks are performed on member codes. If set to `True` in the Django admin panel, validity checks will be performed on all submissions. If set to `False`, no checks will be performed (i.e. all codes will be accepted). The value of the flag does **not** affect whether the `member_code` field is displayed on forms or in views. |
There was a problem hiding this comment.
Need to switch the feature flag ENFORCE_MEMBER_CODES on before release 4.3.
pbanaszkiewicz
approved these changes
Dec 11, 2023
|
Approved. This should be merged before releasing 4.3. Some additional changes were mentioned during the review. |
|
@maneesha @froggleston are we releasing member codes in v4.3? If so, I suppose I should work on resolving conflicts here and eventually merging this PR? |
|
We have not had a chance to test any of this so I think we should wait on this. |
pbanaszkiewicz
force-pushed
the
feature/member-codes-docs
branch
from
43c6fd1
to
6cf5fad
Compare
|
Merging in v4.3 since this contains instructions for the upcoming deployment and the project was merged and deployed to test environment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses #2576 except for the admin guide updates.
Merge when ready to release v4.3.