feat: remove field-data binding from the runtime [FC-0026] #32357

Agrendalath · 2023-06-02T15:22:38Z

Description

The goal of FC-0026 is to remove the XBlock-specific handling from the prepare_runtime_for_user function. This part handles the field-data. Please take a look at the review comments that explain each significant change.

Supporting information

Private-ref: BB-7448

Testing instructions

Ensure that XBlocks work correctly in the LMS, Preview, and Studio. Check that importing and exporting the course works.

openedx-webhooks · 2023-06-02T15:22:43Z

Thanks for the pull request, @Agrendalath!

As a core committer in this repo, you can merge this once the pull request is approved per the core committer reviewer requirements and according to the agreement with your edX Champion.

Agrendalath · 2023-06-02T15:24:11Z

lms/djangoapps/courseware/tests/test_views.py

We're removing lots of these block-agnostic queries by moving out the DateLookupFieldData initialization out of the runtime preparation:

SELECT "schedules_schedule"."id", "schedules_schedule"."created", "schedules_schedule"."modified", "schedules_schedule"."enrollment_id", "schedules_schedule"."active", "schedules_schedule"."start_date", "schedules_schedule"."upgrade_deadline" FROM "schedules_schedule" INNER JOIN "student_courseenrollment" ON ("schedules_schedule"."enrollment_id" = "student_courseenrollment"."id") WHERE ("student_courseenrollment"."course_id" = 'course-v1:org.0+course_0+Run_0' AND "student_courseenrollment"."user_id" = 1) LIMIT 21

edx-pipeline-bot · 2023-06-13T13:04:29Z

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

edx-pipeline-bot · 2023-06-13T13:26:31Z

EdX Release Notice: This PR has been deployed to the production environment.

edx-pipeline-bot · 2023-06-13T13:43:08Z

EdX Release Notice: This PR has been deployed to the staging environment in preparation for a release to production.

edx-pipeline-bot · 2023-06-13T14:02:39Z

EdX Release Notice: This PR has been deployed to the production environment.

Agrendalath · 2023-06-21T15:13:14Z

lms/djangoapps/courseware/block_render.py

We already add these as wrappers in https://github.com/openedx/edx-platform/blob/3413277a63860a84e5fc5b6dea70a52efbd45296/lms/djangoapps/courseware/block_render.py#L658-L665.

Agrendalath · 2023-06-21T15:29:01Z

lms/djangoapps/courseware/block_render.py

I did not find any direct usage of this service.

We bind the field_data in the XModuleMixin: https://github.com/openedx/edx-platform/blob/0b455e0336fa54199fd992c2ce83a81c07dd07c2/xmodule/x_module.py#L649-L659

Then, we have the following wrappers for accessing field-data; none of them uses the service.

Mongo: https://github.com/openedx/edx-platform/blob/dac1c5abe1193ce51297d6aa6db32742b2f6cedc/xmodule/modulestore/mongo/base.py#L317-L322

Split Mongo: https://github.com/openedx/edx-platform/blob/fbaa2e5a68374502d10de95faf60cdb009f83715/xmodule/modulestore/split_mongo/caching_descriptor_system.py#L226-L239

New runtime: https://github.com/openedx/edx-platform/blob/aa85257b1913b3837216f2c3412e5c1e7114398e/openedx/core/djangoapps/xblock/runtime/runtime.py#L227-L235

@Agrendalath, since the service is being removed, do we need @XBlock.needs("field-data")?

Regarding removing @XBlock.needs('field-data'): The field-data service in general is still used; it's just this particular way of setting the student-bound wrapped field data that is no longer used. I think :)

Though I also think that the field-data service is always "needed" so it's probably not necessary to use the @XBlock.needs decorator.

Nice catch! We use field-data as a service but never reach the service declaration checks because of its special handling.

I removed these decorators in cca07d635fcc8001515704647fd713f46626c8b5.

Agrendalath · 2023-06-21T15:30:08Z

xmodule/services.py

We don't need this - it's already handled in bind_for_student: https://github.com/openedx/edx-platform/blob/0b455e0336fa54199fd992c2ce83a81c07dd07c2/xmodule/x_module.py#L630-L631

Agrendalath · 2023-06-21T15:30:23Z

lms/djangoapps/courseware/block_render.py

We don't need this - it's already handled in bind_for_student: https://github.com/openedx/edx-platform/blob/0b455e0336fa54199fd992c2ce83a81c07dd07c2/xmodule/x_module.py#L630-L631

Agrendalath · 2023-06-21T15:41:16Z

@0x29a, @bradenmacdonald, this is ready for review. I did plenty of regression checks, but please let me know if you are aware of some specific edge cases we should verify.

0x29a

Nit: let's remove this too.

Otherwise 👍

I tested every built-in problem, course import and export.
I read through the code, also I don't remember finding any place that uses field-data service.

bradenmacdonald

I just read through the code and will rely on you two for testing... This looks great though. A very nice cleanup and I'm pleasantly surprised that we can just remove and simplify things like this, with no other changes. Excellent.

cms/djangoapps/contentstore/tests/test_i18n.py

cms/djangoapps/contentstore/views/tests/test_preview.py

bradenmacdonald · 2023-06-23T16:34:42Z

lms/djangoapps/courseware/block_render.py

Regarding removing @XBlock.needs('field-data'): The field-data service in general is still used; it's just this particular way of setting the student-bound wrapped field data that is no longer used. I think :)

Though I also think that the field-data service is always "needed" so it's probably not necessary to use the @XBlock.needs decorator.

Agrendalath · 2023-06-23T17:39:05Z

Thank you for your reviews, @0x29a and @bradenmacdonald!

@ormsbee, would you like to take a look at this before we schedule the merge?

ormsbee

I have pretty much exactly @bradenmacdonald's reaction to this.

openedx-webhooks · 2023-06-30T13:06:21Z

@Agrendalath 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-pipeline-bot · 2023-06-30T14:09:18Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2023-06-30T14:33:02Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2023-06-30T14:33:43Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2023-06-30T14:53:39Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2023-06-30T15:13:49Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2023-06-30T15:38:42Z

2U Release Notice: This PR has been deployed to the edX production environment.

Agrendalath self-assigned this Jun 2, 2023

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core committer labels Jun 2, 2023

Agrendalath changed the title ~~feat: remove field data binding from the runtime [FC-0026]~~ feat: remove field-data binding from the runtime [FC-0026] Jun 2, 2023

Agrendalath commented Jun 2, 2023

View reviewed changes

Agrendalath force-pushed the agrendalath/fc-0026-field-data branch 4 times, most recently from 4254929 to 3413277 Compare June 21, 2023 15:10

Agrendalath commented Jun 21, 2023

View reviewed changes

Agrendalath marked this pull request as ready for review June 21, 2023 15:41

Agrendalath requested a review from bradenmacdonald June 21, 2023 15:43

Agrendalath force-pushed the agrendalath/fc-0026-field-data branch from 3413277 to 4719ca9 Compare June 21, 2023 19:38

Agrendalath mentioned this pull request Jun 22, 2023

feat: reuse runtime services and wrappers between XBlocks [FC-0026] #32420

Merged

0x29a approved these changes Jun 23, 2023

View reviewed changes

bradenmacdonald approved these changes Jun 23, 2023

View reviewed changes

ormsbee approved these changes Jun 26, 2023

View reviewed changes

Agrendalath force-pushed the agrendalath/fc-0026-field-data branch from 0ffd938 to d492163 Compare June 26, 2023 17:19

Agrendalath added 2 commits June 26, 2023 19:21

feat: remove field data binding from the runtime

5f46ea5

feat: remove field-data service from runtime initialization

6c435bb

Agrendalath force-pushed the agrendalath/fc-0026-field-data branch from d492163 to 6c435bb Compare June 26, 2023 17:21

Agrendalath merged commit 80374ed into openedx:master Jun 30, 2023

Agrendalath deleted the agrendalath/fc-0026-field-data branch June 30, 2023 13:06

This was referenced Jul 13, 2023

Revert "feat: remove field-data binding from the runtime [FC-0026]" #32740

Merged

Revert "Revert "feat: remove field-data binding from the runtime [FC-0026]" (openedx#32740)" #32737

Merged

feat: remove field-data binding from the runtime [FC-0026] #32357

feat: remove field-data binding from the runtime [FC-0026] #32357

Uh oh!

Conversation

Agrendalath commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Uh oh!

openedx-webhooks commented Jun 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

edx-pipeline-bot commented Jun 13, 2023

Uh oh!

edx-pipeline-bot commented Jun 13, 2023

Uh oh!

edx-pipeline-bot commented Jun 13, 2023

Uh oh!

edx-pipeline-bot commented Jun 13, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Agrendalath Jun 23, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Agrendalath commented Jun 21, 2023

Uh oh!

0x29a left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Agrendalath commented Jun 23, 2023

Uh oh!

ormsbee left a comment

Choose a reason for hiding this comment

Uh oh!

openedx-webhooks commented Jun 30, 2023

Uh oh!

edx-pipeline-bot commented Jun 30, 2023

Uh oh!

edx-pipeline-bot commented Jun 30, 2023

Uh oh!

edx-pipeline-bot commented Jun 30, 2023

Uh oh!

edx-pipeline-bot commented Jun 30, 2023

Uh oh!

edx-pipeline-bot commented Jun 30, 2023

Uh oh!

edx-pipeline-bot commented Jun 30, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Agrendalath commented Jun 2, 2023 •

edited

Loading

openedx-webhooks commented Jun 2, 2023 •

edited

Loading

Agrendalath Jun 23, 2023 •

edited

Loading