refactor: unify XBlock naming: item [BD-13] #31384

tecoholic · 2022-12-01T05:48:18Z

Description

Currently, there are various terms used to refer to XBlocks: xblocks (or blocks), descriptors, modules, or items. This makes the code a lot less approachable and understandable. Since we are getting rid of a lot of tech debt it is a good time to do a quick update of the terminology in the edx-platform to make it consistent.

In this PR:

Convert references using item to refer to XBlocks to use block (e.g. in ItemFactory).

Supporting information

This ticket was created from the work started with #31113

Testing instructions

There is nothing specific to be tested, as we are not adding or changing any functionality. However, we can just perform a general testing of LMS and Studio using the following sandbox.

Sandbox LMS: https://pr31384.sandbox.opencraft.hosting/
Sandbox Studio: https://studio.pr31384.sandbox.opencraft.hosting/

Deadline

"None"

Other information

Related PR: mitodl/edx-sga#332 (it's not a blocker, as these integration tests do not seem to be used anywhere).

openedx-webhooks · 2022-12-01T05:48:23Z

Thanks for the pull request, @tecoholic!

When this pull request is ready, tag your edX technical lead.

tecoholic · 2022-12-01T10:23:05Z

@Agrendalath I was able to replace item the ItemFactory and the get_display_items and displayable_items of the XModuleMixin. Other uses of item like load_item seem to have links to the modulestore. Should we tackle these?

Other heavy use of item is from the modulestore functions themselves. I guess, we are not touching these.

Agrendalath · 2022-12-02T13:05:16Z

@tecoholic,

Other uses of item like load_item seem to have links to the modulestore. Should we tackle these?

We already have the get_block which uses self.load_item. We could replace all uses of *.load_item with runtime.get_block (or self.get_block in a few cases) and change self.load_item in DescriptorSystem to self._load_item, to avoid using it directly.

Regarding the name of the load_item argument of the DescriptorSystem: it makes sense to keep this name in sync with the methods passed to it. However, according to this TODO, it might be a good idea to rename these methods to get_instance. I'm specifically talking about the following occurrences:

Other heavy use of item is from the modulestore functions themselves. I guess, we are not touching these.

There are external packages that use these methods. For example, ORA2 and LTI_Consumer use get_item directly. I don't think we can safely rename these without proper deprecation, so we can omit them.

@ormsbee, what do you think about these points?

ormsbee · 2022-12-05T04:51:29Z

@Agrendalath: I don't really have an opinion on the get_instance thing. That TODO was from 2012, and I honestly wouldn't read too much into it. I think it's fine to keep thing in sync with the methods passed to it.

Absolutely agree that we cannot break compatibility by changing the modulestore functions. We can add new methods and have the old ones call into them with deprecation warnings, but I'm honestly not sure if the long term simplification is worth having both methods around for the same thing for one or two release cycles.

tecoholic · 2022-12-05T12:28:40Z

@Agrendalath @ormsbee Thank you for your inputs. I have changes most of the system/runtime.load_item calls to get_block. But making the load_item private by renaming it to _load_item breaks the system due to:

CachingDescriptorSystem defining the load_item function with a different signature by adding extra kwargs. It's usage cannot be replaced with the get_block without changing its signature.
The private property overshadowing the CachingDescriptorSystem's private memeber - Lint Error

Venturing further into renaming the load_item argument and syncing all the referencing functions seems a bit unfeasible at the moment, given we can't fully get rid of the load_item calls. And also, there doesn't seem to be any references to runtime.load_item outside of the xmodule

$ ack "load_item\(" -l
xmodule/tests/test_conditional.py
xmodule/tests/xml/__init__.py
xmodule/modulestore/split_mongo/split.py
xmodule/modulestore/split_mongo/caching_descriptor_system.py
xmodule/modulestore/xml.py
xmodule/modulestore/mongo/base.py
xmodule/x_module.py

xmodule/modulestore/tests/factories.py

conf/locale/en/LC_MESSAGES/django.po

openedx/core/djangoapps/xblock/runtime/shims.py

xmodule/conditional_module.py

openedx/core/djangoapps/xblock/runtime/shims.py

As a part of naming unification, the ItemFactory class in edx-platform has been renamed to BlockFactory. This commit updates the references to ItemFactory in this repo to BlockFactory. Ref: openedx/openedx-platform#31384

Agrendalath

👍

I tested this: verified that XBlocks work correctly (especially the LibraryContentBlock)
I read through the code
I checked for accessibility issues: n/a
Includes documentation: n/a
I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository: n/a

xmodule/seq_block.py

Agrendalath · 2022-12-21T15:26:56Z

@tecoholic, please rebase the PR and squash the commits into logical chunks.

@ormsbee, would you mind doing a sanity check on this PR? Unlike in #31113, we're not breaking any compatibility here.

The only external usage of the ItemFactory was in the edx-sga XBlock's integration tests that are not a part of any pipeline. We have already opened a PR to synchronize these names there.

ormsbee · 2022-12-21T17:37:03Z

@Agrendalath: Looks sane to me. It's only changing test-related files, right? Nothing in the modulestore itself? Aside from the load_item -> get_block change, which is equivalent...?

ormsbee · 2022-12-21T17:38:15Z

FWIW, this is another change that's worth broadcasting loudly, since it will likely break folks who are actively working on branches.

Agrendalath · 2022-12-21T19:02:27Z

@ormsbee, we have additionally (as described here):

Replaced iterations over displayable_items with self, as this method was returning [self].
Replaced displayable_items with get_children, as the result is identical.
Removed these two (already deprecated) methods, as they were not used outside of the edx-platform.

These changes do not affect the modulestore, though.

FWIW, this is another change that's worth broadcasting loudly, since it will likely break folks who are actively working on branches.

Good point. I will post an announcement once we merge this.

tecoholic · 2022-12-23T07:06:42Z

@Agrendalath Thanks for the review. I have squashed the commits and rebased it on the latest changes. This is ready for merging.

As a part of naming unification, the ItemFactory class in edx-platform has been renamed to BlockFactory. This commit updates the references to ItemFactory in this repo to BlockFactory. Ref: openedx/openedx-platform#31384

tecoholic · 2023-01-10T11:19:13Z

@Agrendalath Gentle reminder about merging this before some conflict with the master branch is introduced.

Agrendalath · 2023-01-10T15:18:55Z

@ormsbee, I'm just checking if you had a chance to see my previous comment and if there is anything else to do before we schedule the merge.

As a part of naming unification, the ItemFactory class in edx-platform has been renamed to BlockFactory. This commit updates the references to ItemFactory in this repo to BlockFactory. Ref: openedx/openedx-platform#31384

ormsbee · 2023-01-20T18:34:43Z

@Agrendalath: No, go ahead and schedule the merge, ty

This removes the "displayable_blocks" property and replaces all the usages with the "child" property.

…dule

openedx-webhooks · 2023-01-23T14:05:02Z

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

Agrendalath · 2023-01-23T14:43:06Z

Forum announcement for this change: https://discuss.openedx.org/t/refactoring-xblock-references/9194.

edx-pipeline-bot · 2023-01-23T15:02:06Z

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

edx-pipeline-bot · 2023-01-23T19:52:22Z

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

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 1, 2022

tecoholic force-pushed the tecoholic/unify-xblock-naming-item branch from 70a0ceb to c8c0abb Compare December 1, 2022 07:57

Agrendalath changed the title ~~Unify XBlock naming: item~~ refactor: unify XBlock naming: item [BD-13] Dec 2, 2022

openedx-webhooks added blended PR is managed through 2U's blended developmnt program and removed open-source-contribution PR author is not from Axim or 2U labels Dec 2, 2022

Agrendalath requested changes Dec 6, 2022

View reviewed changes

tecoholic mentioned this pull request Dec 15, 2022

test: rename ItemFactory to BlockFactory in integration_tests mitodl/edx-sga#332

Merged

tecoholic force-pushed the tecoholic/unify-xblock-naming-item branch 2 times, most recently from 51ed0c5 to 2daa8ad Compare December 20, 2022 05:29

Agrendalath approved these changes Dec 21, 2022

View reviewed changes

xmodule/seq_block.py Outdated Show resolved Hide resolved

tecoholic force-pushed the tecoholic/unify-xblock-naming-item branch 3 times, most recently from ef51c95 to f8698c5 Compare December 23, 2022 06:41

tecoholic force-pushed the tecoholic/unify-xblock-naming-item branch 2 times, most recently from 7d1f581 to 5d06fec Compare December 23, 2022 07:14

0x29a mentioned this pull request Jan 4, 2023

refactor: convert module term to block [BD-13] #31475

Merged

pkulkark mentioned this pull request Jan 9, 2023

[BD-13][BB-6927] Unify xblock naming descriptor #31492

Merged

Agrendalath force-pushed the tecoholic/unify-xblock-naming-item branch from 5d06fec to dca23ca Compare January 20, 2023 19:39

tecoholic added 8 commits January 23, 2023 14:47

refactor: rename ItemFactory to BlockFactory

d417a75

refactor: rename get_displayable_items and displayable_items

851eb65

refactor: replace xmodule.load_item calls with get_block

59757ee

refactor: rename system with runtime on conditional_block

1a20033

refactor: replace get_display_blocks with get_children

b6634a8

refactor: replace displayable_blocks with child

59d8b5d

This removes the "displayable_blocks" property and replaces all the usages with the "child" property.

refactor: remove get_displayable_items and displayable_items from XMo…

7c621e6

…dule

refactor: rename display_blocks to children in seq_block

41e2f25

Agrendalath force-pushed the tecoholic/unify-xblock-naming-item branch from dca23ca to 41e2f25 Compare January 23, 2023 13:48

Agrendalath merged commit 600219b into openedx:master Jan 23, 2023

Agrendalath deleted the tecoholic/unify-xblock-naming-item branch January 23, 2023 14:04

refactor: unify XBlock naming: item [BD-13] #31384

refactor: unify XBlock naming: item [BD-13] #31384

Uh oh!

Conversation

tecoholic commented Dec 1, 2022 • edited by Agrendalath Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Other information

Uh oh!

openedx-webhooks commented Dec 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tecoholic commented Dec 1, 2022

Uh oh!

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

Uh oh!

Uh oh!

ormsbee commented Dec 5, 2022

Uh oh!

tecoholic commented Dec 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Agrendalath left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Agrendalath commented Dec 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ormsbee commented Dec 21, 2022

Uh oh!

ormsbee commented Dec 21, 2022

Uh oh!

Agrendalath commented Dec 21, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tecoholic commented Dec 23, 2022

Uh oh!

tecoholic commented Jan 10, 2023

Uh oh!

Agrendalath commented Jan 10, 2023

Uh oh!

ormsbee commented Jan 20, 2023

Uh oh!

openedx-webhooks commented Jan 23, 2023

Uh oh!

Agrendalath commented Jan 23, 2023

Uh oh!

edx-pipeline-bot commented Jan 23, 2023

Uh oh!

edx-pipeline-bot commented Jan 23, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tecoholic commented Dec 1, 2022 •

edited by Agrendalath

Loading

openedx-webhooks commented Dec 1, 2022 •

edited

Loading

Agrendalath commented Dec 2, 2022 •

edited

Loading

tecoholic commented Dec 5, 2022 •

edited

Loading

Agrendalath commented Dec 21, 2022 •

edited

Loading

Agrendalath commented Dec 21, 2022 •

edited

Loading