Skip to content

Conversation

@marslanabdulrauf
Copy link
Contributor

Related Ticket

#590

Description:

This PRs

  1. Adds support to configure STORAGE_KWARGS from settings

Reasons

  1. To support backward compatibility before upgrade edx-val to django 5.2 -- even the STORAGE_CLASS was none we were consuming STORAGE_KWARGS from VIDEO_TRANSCRIPTS_SETTINGS
  2. And to support configuring STORAGE_KWARGS on user's DEFAULT_FILE_STORAGE/STORAGES

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

Thanks for the pull request, @marslanabdulrauf!

This repository is currently unmaintained.

🔘 Find a technical reviewer To get help with finding a technical reviewer, reach out to the community contributions project manager for this PR:
  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your project manager.
  2. Find their GitHub handle here.

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.

Details
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.

Copy link

@blarghmatey blarghmatey left a comment

Choose a reason for hiding this comment

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

Thanks!

@codecov
Copy link

codecov bot commented Oct 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.86%. Comparing base (aab27ec) to head (71df494).
⚠️ Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #593      +/-   ##
==========================================
+ Coverage   94.84%   94.86%   +0.01%     
==========================================
  Files          33       33              
  Lines        3337     3350      +13     
  Branches      128      129       +1     
==========================================
+ Hits         3165     3178      +13     
  Misses        154      154              
  Partials       18       18              
Flag Coverage Δ
unittests 94.86% <100.00%> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Oct 27, 2025
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Oct 27, 2025
@marslanabdulrauf
Copy link
Contributor Author

Hi @feanil could you please take a look ?

@marslanabdulrauf
Copy link
Contributor Author

Hi @feanil ,

We are using VIDEO_IMAGE_SETTINGS and VIDEO_TRANSCRIPTS_SETTINGS in edx-platform > cms > urls.py. Should we update the edx-platform to start consuming new settings ?

I used the same setting name for STORAGES, I think we can work on that as well, don't like *_settings in STORAGES

@feanil
Copy link
Contributor

feanil commented Nov 6, 2025

@marslanabdulrauf yes, I think we do want to update to using the new settings but that should also fall back to the old settings which might make it a little complicated but feels correct.

@marslanabdulrauf
Copy link
Contributor Author

I have updated the PR and gave precedence to Django 5.2 STORAGES over custom settings for both transcripts and images.

Custom settings key (same): VIDEO_TRANSCRIPTS_SETTINGS
STORAGES key: video_transcripts_storage

I will create a follow-up PR in edx-platform as well to update the usage if VIDEO_TRANSCRIPTS_SETTINGS and VIDEO_IMAGES_SETTINGS to get storage related settings from STORAGE (Django 5.2) dict.

@marslanabdulrauf marslanabdulrauf force-pushed the marslan/590-storage-kwargs branch from aeb08b0 to 54ecba1 Compare November 10, 2025 11:05
@marslanabdulrauf
Copy link
Contributor Author

@feanil could you please take another look ?

@e0d
Copy link

e0d commented Nov 17, 2025

@marslanabdulrauf It looks like there's a failing check, can you have a look?

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Nov 17, 2025
@e0d e0d moved this from Needs Tests Run or CLA Signed to Waiting on Author in Contributions Nov 17, 2025
@marslanabdulrauf marslanabdulrauf force-pushed the marslan/590-storage-kwargs branch from dc122e9 to 8401fd0 Compare November 18, 2025 12:43
@marslanabdulrauf
Copy link
Contributor Author

Looks like Codecov is failing now. Could you please take a look ? @e0d
Cc @feanil

Copy link
Contributor

@feanil feanil left a comment

Choose a reason for hiding this comment

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

Generally makes sense, one note on naming and also don't forget to document the change on the Verawood operator notes site: https://openedx.atlassian.net/wiki/spaces/COMM/pages/5331222534/Verawood+-+Operator+Release+Notes or the Ulmo equivalent if the plan is to backport this.

edxval/utils.py Outdated
# For Django 5.x, pick options if available
options = getattr(settings, 'STORAGES', {}).get('default', {}).get('OPTIONS', {})
storages_config = getattr(settings, 'STORAGES', {})
storage_key = settings_key.replace("SETTINGS", "storage")
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 think we need to add storage as a suffix here. The key is inside the storages dictionary so just calling it STORAGES['video_transcripts'] should be clear enough.

@feanil
Copy link
Contributor

feanil commented Nov 18, 2025

I re-ran the failed test and it got past the codecov error, but it looks like there is a legit Pact error to dig into now @marslanabdulrauf

@marslanabdulrauf
Copy link
Contributor Author

Hey @feanil I don't have access to add/edit https://openedx.atlassian.net/wiki/spaces/COMM/pages/5331222534/Verawood+-+Operator+Release+Notes

And I am not sure if this Pack Provider Verification is something related to me.

@feanil
Copy link
Contributor

feanil commented Nov 24, 2025

@marslanabdulrauf if you create an account and login, you should be able to edit that page. If that's not working let me know your username in atlassian and I can dig into why. The pact issue is related to some 2U specific testing, that doesn't work correctly from forks, I can remake this PR as a branch to verify that the pact issue is okay once everything else is all set.

@marslanabdulrauf
Copy link
Contributor Author

Updated: https://openedx.atlassian.net/wiki/spaces/COMM/pages/5331222534/Verawood+-+Operator+Release+Notes

And Deprecation added for legacy settings

@marslanabdulrauf
Copy link
Contributor Author

Hi @feanil, were you able to remake this PR to see if the Pact issue is fixed ?

@feanil feanil merged commit 20ba4da into openedx:master Dec 2, 2025
20 of 21 checks passed
@github-project-automation github-project-automation bot moved this from Waiting on Author to Done in Contributions Dec 2, 2025
@feanil
Copy link
Contributor

feanil commented Dec 2, 2025

@marslanabdulrauf I updated the description on the wiki to link to this PR and to add the key in the new storages data structure for transcripts and tested this via a separate PR so it's all set. v3.2.0 has been pushed to PyPI

@marslanabdulrauf
Copy link
Contributor Author

Thanks @feanil it looks great.

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

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

7 participants