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

Jump to bottom

refactor: Update get block OLX view to support versions [FC-0062] #35932

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

refactor: Update get block OLX view to support versions [FC-0062] #35932

wants to merge 3 commits into from
+54 −12

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Nov 27, 2024 •
edited
Loading

Description

  • Refactor get_block_draft_olx to get_block_olx to support versions.
  • Refactor get block OLX view to support versions.
  • Which edX user roles will this change impact? "Course Author"

Supporting information

Testing instructions

Deadline

ASAP

@openedx-webhooks
Copy link

Thanks for the pull request, @ChrisChV!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/wg-maintenance-edx-platform. Tag them in a comment and let them know that your changes are ready for review.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 27, 2024
@ChrisChV ChrisChV changed the title refactor: Update Get block OLX to support versions refactor: Update Get block OLX to support versions [FC-0062] Nov 27, 2024
@ChrisChV ChrisChV changed the title refactor: Update Get block OLX to support versions [FC-0062] refactor: Update Get block OLX view to support versions [FC-0062] Nov 27, 2024
@ChrisChV ChrisChV changed the title refactor: Update Get block OLX view to support versions [FC-0062] refactor: Update get block OLX view to support versions [FC-0062] Nov 27, 2024
@ChrisChV ChrisChV mentioned this pull request Nov 27, 2024
Open
bradenmacdonald
bradenmacdonald requested changes Nov 27, 2024
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

I think this works, but I have a bunch of refactoring suggestions to make this more consistent and make our APIs even better.

openedx/core/djangoapps/xblock/runtime/learning_core_runtime.py
@@ -316,6 +312,18 @@ def save_block(self, block):
)
self.authored_data_store.mark_unchanged(block)

def get_auto_latest_version(self, version: int | LatestVersion) -> int | LatestVersion:
"""
Gets the actual LatesVersion if is `LatestVersion.AUTO`;
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Gets the actual LatesVersion if is `LatestVersion.AUTO`;
Gets the actual LatestVersion if is `LatestVersion.AUTO`;

openedx/core/djangoapps/xblock/api.py
component = get_component_from_usage_key(usage_key)
component_version = component.versioning.draft
runtime = get_runtime(user=user)
version = runtime.get_auto_latest_version(version)
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't want the get_block_olx API to accept a user param if it doesn't really need/user the user. I also don't like that this initializes the runtime just to compute the version. So I think it's better to do something like:

authored_data_mode = get_xblock_app_config().get_runtime_params()["authored_data_mode"]
if version == LatestVersion.AUTO:
    version = LatestVersion.DRAFT if authored_data_mode == AuthoredDataMode.DEFAULT_DRAFT else LatestVersion.PUBLISHED

This could be moved into a helper function.

openedx/core/djangoapps/xblock/api.py
user: UserType,
*,
version: int | LatestVersion = LatestVersion.AUTO
) -> str:
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this is technically a public API, and not marked as unstable, you should create a backwards-compatibility wrapper:

def get_block_draft_olx(usage_key: UsageKeyV2) -> str:
    """ DEPRECATED. Use get_block_olx(). Can be removed post-Teak. """
    return get_block_olx(usage_key, version=LatestVersion.DRAFT)

openedx/core/djangoapps/content_libraries/views.py
@@ -713,8 +713,13 @@ def get(self, request, usage_key_str):
Get the block's OLX
"""
key = LibraryUsageLocatorV2.from_string(usage_key_str)
version = request.query_params.get('version', None)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think that we should actually move this API endpoint to the XBlock REST API.

After this:

edx-platform/openedx/core/djangoapps/xblock/rest_api/urls.py

Lines 20 to 21 in 9cade7a

# get/post full json fields of an XBlock:
path('fields/', views.BlockFieldsView.as_view()),

I didn't do this originally because we needed to check the CAN_VIEW_THIS_CONTENT_LIBRARY permission. But now we have check_permission=CheckPerm.CAN_READ_AS_AUTHOR available, so we can implement this in the XBlock API. I think that would be much nicer, and then in the future we can access the OLX for all XBlocks consistently, not just library blocks.

Please keep this libraries "draft" OLX REST API in place for backwards compatibility but mark it as deprecated and to be removed post-Teak.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Needs Triage
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ChrisChV @openedx-webhooks @bradenmacdonald