CustomContent: Add withinDescendant parameter to API #8796
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
rtibbles
reviewed
Dec 2, 2021
packages/hashi/src/kolibri.js
Outdated
| @@ -123,6 +130,7 @@ export default class Kolibri extends BaseShim { | |||
| * @param {boolean} options.onlyContent - set to true to query only content nodes | |||
| * @param {boolean} [options.limitToChannel=true] - true to limit the | |||
| * results to the topic channel | |||
| * @param {MPTTNode} options.withinDescendant - Object to filter nodes descendant of this one | |||
There was a problem hiding this comment.
This requires that the HTML5 apps are aware of the implementation details of MPTT - perhaps it would be better for this to just be the id of the node to fetch descendants of?
We can add a descendant_of filter to the backend: https://github.com/learningequality/kolibri/blob/release-v0.15.x/kolibri/core/content/api.py#L250 that does the lookup for the node - something like:
def filter_descendant_of(self, queryset, name, value):
try:
node = ContentNode.objects.values("lft", "rght", "tree_id").get(pk=value)
except (ContentNode.DoesNotExist, ValueError):
return queryset.none()
return queryset.filter(lft__gt=node["lft"], rght__lt=node["rght"], tree_id=node["tree_id"])
There was a problem hiding this comment.
Okay, that's a better API and moving the logic to the backend simplifies the frontend logic. I'll update the PR to follow that implementation
There was a problem hiding this comment.
I've just updated the PR with the new filter and the parameter descendantOf that should be a node id.
danigm
force-pushed
the
add-withinDescendant-api
branch
from
4385631
to
a505798
Compare
This patch adds a new optional parameter to the getContentByFilter API call to be able to retrieve all descendant nodes using the MPTT model fields. With this new parameter it's possible to filter all the nodes below a specific topic node, useful when combining with other filters like kind or tags.
danigm
force-pushed
the
add-withinDescendant-api
branch
from
a505798
to
6907d4b
Compare
danigm
added a commit
to endlessm/kolibri-explore-plugin
that referenced
this pull request
Dec 3, 2021
This change adapts the API to the changes upstream in this PR: learningequality/kolibri#8796 https://phabricator.endlessm.com/T32761
rtibbles
approved these changes
Dec 7, 2021
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.
Summary
This patch adds a new optional parameter to the getContentByFilter API call to be able to retrieve all descendant nodes using the MPTT model fields.
With this new parameter it's possible to filter all the nodes below a specific topic node, useful when combining with other filters like kind or tags.