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

feat: Enable library blocks using settings [FC-0076] #36292

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

feat: Enable library blocks using settings [FC-0076] #36292

wants to merge 7 commits into from
+50 −3

Conversation

ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented Feb 24, 2025 •
edited
Loading

Description

LIBRARY_ENABLED_BLOCKS added to verify enabled blocks in get_allowed_block_types

Supporting information

Testing instructions

Deadline

No Rush

Other information

N/A

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

Thanks for the pull request, @ChrisChV!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

@ChrisChV ChrisChV mentioned this pull request Feb 24, 2025
Open
@ChrisChV ChrisChV force-pushed the chris/FAL-3994-create-advanced-blocks-libraries branch from 9c496a0 to c69dfae Compare February 24, 2025 19:04
@ChrisChV ChrisChV force-pushed the chris/FAL-3994-create-advanced-blocks-libraries branch from c69dfae to 1a284c8 Compare February 24, 2025 19:13
kdmccormick
kdmccormick requested changes Feb 24, 2025
View reviewed changes
cms/envs/production.py Outdated
Comment on lines 701 to 706
# .. setting_name: LIBRARY_ENABLED_BLOCKS
# .. setting_default: ['problem', 'video', 'html', 'drag-and-drop-v2']
# .. setting_description: List of block types that are enabled to be created/used
# .. in libraries. Both basic blocks and advanced blocks can be included.
# .. In the future, advanced block configuration will be handled individually per library.
# .. eg ['problem', 'video', 'drag-and-drop-v2]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# .. setting_name: LIBRARY_ENABLED_BLOCKS
# .. setting_default: ['problem', 'video', 'html', 'drag-and-drop-v2']
# .. setting_description: List of block types that are enabled to be created/used
# .. in libraries. Both basic blocks and advanced blocks can be included.
# .. In the future, advanced block configuration will be handled individually per library.
# .. eg ['problem', 'video', 'drag-and-drop-v2]

Settings only need to be annotated once. This is already annotated in common.py.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Deleted here 0574923

cms/envs/production.py Outdated
Comment on lines 707 to 710
LIBRARY_ENABLED_BLOCKS = ENV_TOKENS.get(
'LIBRARY_ENABLED_BLOCKS',
['problem', 'video', 'html', 'drag-and-drop-v2', 'google-calendar', 'google-document'],
)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
LIBRARY_ENABLED_BLOCKS = ENV_TOKENS.get(
'LIBRARY_ENABLED_BLOCKS',
['problem', 'video', 'html', 'drag-and-drop-v2', 'google-calendar', 'google-document'],
)

Why does production.py need a default beyond the default that common.py already declares? If google-calendar and google-document are reasonable items to have in the defaults list, then pls include them in the common.py list as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, that was a mistake, we should not add google-document or google-calendar yet, it was deleted here: 0574923

cms/envs/common.py Outdated
# .. setting_default: ['problem', 'video', 'html', 'drag-and-drop-v2']
# .. setting_description: List of block types that are enabled to be created/used
# .. in libraries. Both basic blocks and advanced blocks can be included.
# .. In the future, advanced block configuration will be handled individually per library.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# .. In the future, advanced block configuration will be handled individually per library.
# .. In the future, this list will be configurable for each individual library.

By "advanced block configuration", we are talking specifically about this list, right? If so, let's just be explicit.

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 updated the comment of this setting and I added the TODO comment in the api. I think it's better this way

cms/envs/common.py Outdated
# .. setting_description: List of block types that are enabled to be created/used
# .. in libraries. Both basic blocks and advanced blocks can be included.
# .. In the future, advanced block configuration will be handled individually per library.
# .. eg ['problem', 'video', 'drag-and-drop-v2]
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# .. eg ['problem', 'video', 'drag-and-drop-v2]

The default is a good enough example

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Deleted: c3336cc#diff-a16fd1c6cf75bdebdf97a2633b533d39e43975c6e98af58787ed6af1282eca71L2943

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 24, 2025
bradenmacdonald
bradenmacdonald approved these changes Feb 25, 2025
View reviewed changes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rpenido rpenido rpenido approved these changes

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

@kdmccormick kdmccormick kdmccormick approved these changes

@feanil feanil Awaiting requested review from feanil

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: In Eng Review
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@ChrisChV @openedx-webhooks @rpenido @bradenmacdonald @kdmccormick @mphilbrick211