Make “root” a reserved (restricted) key for Contexts #16475
Merged
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
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## 3.x #16475 +/- ##
=========================================
Coverage 21.57% 21.57%
- Complexity 10564 10566 +2
=========================================
Files 561 561
Lines 31932 31938 +6
=========================================
+ Hits 6890 6892 +2
- Misses 25042 25046 +4 ☔ View full report in Codecov by Sentry. |
theboxer
previously approved these changes
Oct 10, 2023
Jako
approved these changes
Feb 10, 2024
|
While |
Yeah, while it may or may not be needed technically, it'd be a good idea. I'll make a small update to account for casing later today... |
smg6511
force-pushed
the
3.x-issue-16457
branch
from
4d2f0dc
to
5e3fcff
Compare
Mark-H
approved these changes
Feb 13, 2024
|
Thank you @smg6511. |
Ibochkarev
approved these changes
Feb 14, 2024
Ibochkarev
added
the
pr/ready-for-merging
Adds "root" to already protected set of keys ("mgr" and "web")
Use new base class constant in canRemove conditional instead of hard-coded inline array
Ensure reserved key comparison is not case sensitive
opengeek
force-pushed
the
3.x-issue-16457
branch
from
5e3fcff
to
4f58af1
Compare
opengeek
pushed a commit
that referenced
this pull request
Feb 16, 2024
### What does it do? 1. Prevents "root" from being specified as a Context key. 2. Slightly refactors the `Create->beforeSave() `error testing conditional to use a `switch` statement so only relevant code will execute in that block. 3. Additionally, in the second commit, leverages the newly-added `RESERVED_KEYS` constant (in the `modContext` base class) in the Context processor `GetList` class. ### Why is it needed? The keyword "root" is used as the default id for all trees in the core. As such, attempting to create a Context with that key results in errors in the rendering of the Resources tree. ### How to test Attempt to create a new Context with the key "root." You should receive an error message indicating the key is reserved. ### Related issue(s)/PR(s) Resolves #16457
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.
What does it do?
Create->beforeSave()error testing conditional to use aswitchstatement so only relevant code will execute in that block.RESERVED_KEYSconstant (in themodContextbase class) in the Context processorGetListclass.Why is it needed?
The keyword "root" is used as the default id for all trees in the core. As such, attempting to create a Context with that key results in errors in the rendering of the Resources tree.
How to test
Attempt to create a new Context with the key "root." You should receive an error message indicating the key is reserved.
Related issue(s)/PR(s)
Resolves #16457