Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: allow to prefetch xblock aside fields #33554

Closed
wants to merge 1 commit into from
Closed

feat: allow to prefetch xblock aside fields #33554

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion lms/djangoapps/courseware/model_data.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -784,7 +784,18 @@ def _fields_to_cache(self, blocks):
for block in blocks:
for field in block.fields.values():
scope_map[field.scope].add(field)
return scope_map

try:
block = blocks[0]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why only cache from the first block?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Because the main actor here is not the XBlock itself but the asides that will be rendered alongside as those are not part of the course, but are generated dynamically.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't it problematic to cache the user_state_summary fields of the aside xblock?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, but I think this cache is per request, so every time a user requests the course content or calls an XBlock handler, the cache is regenerated.

This cache is read-write thought so being able to read the content will allow to write to it

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see so you're getting all the asides from the first block, but can't asides choose what blocks they're applied to? Is it possible that some asides would not be available on the first block but would be available on later blocks?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can do some local testing to verify that. It's true that asides choose on which blocks to render, but I'm not sure if this workflow applies to the function get_aside_from_xblock.

It seems this function always returns an aside xblock instance:

https://github.com/eduNEXT/edx-platform/blob/09a652379276551ede6070a33a7a15a65e674d4b/xmodule/modulestore/split_mongo/caching_descriptor_system.py#L420-L422

https://github.com/eduNEXT/edx-platform/blob/09a652379276551ede6070a33a7a15a65e674d4b/xmodule/modulestore/split_mongo/caching_descriptor_system.py#L403-L407

from openedx.core.lib.xblock_utils import get_aside_from_xblock # pylint: disable=import-outside-toplevel
for aside in self.asides:
xblock_aside = get_aside_from_xblock(block, aside)
for field in xblock_aside.fields.values():
scope_map[field.scope].add(field)
return scope_map
except IndexError:
# No blocks to cache
return scope_map

def get(self, key):
"""
Expand Down
Loading