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.

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

fix: skip setting fields that are not in scope_mappings [FC-0076] #815

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

rpenido
Copy link

@rpenido rpenido commented Jan 28, 2025

Description

This PR adds a check to the set_many function to ignore the _field_data from scopes that are not loaded.

Context

This fixes an error on the meilisearch index update after saving the Survey Xblock.

cms-1          | 2025-01-28 19:36:18,402 ERROR 2163 [celery_utils.logged_task] [user 4] [ip 172.18.0.1] logged_task.py:48 - [9d7cda4b-afd2-404f-a39c-7a185c486907] failed due to Traceback (most recent call last):
cms-1          |   File "/openedx/venv/lib/python3.11/site-packages/celery/app/trace.py", line 453, in trace_task
cms-1          |     R = retval = fun(*args, **kwargs)
cms-1          |                  ^^^^^^^^^^^^^^^^^^^^
cms-1          |   File "/openedx/venv/lib/python3.11/site-packages/celery/app/autoretry.py", line 38, in run
cms-1          |     return task._orig_run(*args, **kwargs)
cms-1          |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
cms-1          |   File "/openedx/venv/lib/python3.11/site-packages/edx_django_utils/monitoring/internal/code_owner/utils.py", line 195, in new_function
cms-1          |     return wrapped_function(*args, **kwargs)
cms-1          |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
cms-1          |   File "/openedx/edx-platform/openedx/core/djangoapps/content/search/tasks.py", line 57, in upsert_library_block_index_doc
cms-1          |     api.upsert_library_block_index_doc(usage_key)
cms-1          |   File "/openedx/edx-platform/openedx/core/djangoapps/content/search/api.py", line 639, in upsert_library_block_index_doc
cms-1          |     searchable_doc_for_library_block(library_block_metadata)
cms-1          |   File "/openedx/edx-platform/openedx/core/djangoapps/content/search/documents.py", line 381, in searchable_doc_for_library_block
cms-1          |     block = xblock_api.load_block(xblock_metadata.usage_key, user=None)
cms-1          |             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
cms-1          |   File "/openedx/edx-platform/openedx/core/djangoapps/xblock/api.py", line 117, in load_block
cms-1          |     return runtime.get_block(usage_key, version=version)
cms-1          |            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
cms-1          |   File "/openedx/edx-platform/openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py", line 229, in get_block
cms-1          |     block.force_save_fields(block._get_fields_to_save())  # pylint: disable=protected-access
cms-1          |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
cms-1          |   File "/mnt/xblock/xblock/core.py", line 531, in force_save_fields
cms-1          |     self._field_data.set_many(self, fields_to_save_json)
cms-1          |   File "/mnt/xblock/xblock/field_data.py", line 164, in set_many
cms-1          |     field_data.set_many(block, new_update_dict)
cms-1          |     ^^^^^^^^^^^^^^^^^^^
cms-1          | AttributeError: 'NoneType' object has no attribute 'set_many'

The underlying issue is that the _get_fields_to_save() returns the choices field from the user_state scope.

cms-1          | block._get_fields_to_save() ['feedback', 'max_submissions', 'private_results', 'answers', 'block_name', 'choices', 'display_name', 'questions']

As the LearningCoreXBlockRuntime doesn't have the Scope.user_state, the get_block function throws an error.

We should also investigate why we are getting the choices field on _get_fields_to_save() response, but for the sake of robustness, I think it would also worth it to ignore Scope.user_state fields here.

Testing instructions

  • Edit a Survey block on the Library Authoring page and check the error above
  • Checkout the current PR and mount it on your tutor stack
  • Check that the error is gone and the block document is updated successfully

Private ref: FAL-4033

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 28, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jan 28, 2025

Thanks for the pull request, @rpenido!

This repository is currently maintained by @openedx/axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.


Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@rpenido rpenido force-pushed the rpenido/fal-4033-skip-saving-field-if-no-scope-mapping branch from e1c857c to a064796 Compare January 28, 2025 18:37
@rpenido rpenido force-pushed the rpenido/fal-4033-skip-saving-field-if-no-scope-mapping branch from a064796 to e0df689 Compare January 28, 2025 19:31
@rpenido rpenido marked this pull request as ready for review January 28, 2025 20:03
@rpenido rpenido changed the title fix: skip setting fields that are not in scope_mappings fix: skip setting fields that are not in scope_mappings [FC-0076] Jan 29, 2025
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Jan 29, 2025
Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 Fixes the issue, thanks @rpenido !

@@ -687,7 +687,7 @@ class XBlock(Plugin, Blocklike, metaclass=_HasChildrenMetaclass):

# These are dynamically managed by the awful hackery of _HasChildrenMetaclass.
# We just declare their types here to make static analyzers happy.
# Note that children is only defined iff has_children is defined and True.
# Note that children is only defined if has_children is defined and True.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: this comment change can be reverted -- iff is a shorthand term for "if and only if"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Ready for Review
Development

Successfully merging this pull request may close these issues.

4 participants