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

fix: use "price" in ecommerce data loader (#4450) #4459

Merged
merged 1 commit into from
Dec 31, 2024
Merged

fix: use "price" in ecommerce data loader (#4450) #4459

merged 1 commit into from
Dec 31, 2024

Conversation

tecoholic
Copy link
Contributor

  • chore: bump upload-artifact GH task to v4

  • fix: fallback to 'price' in ecommerce api loader

The Django Oscar upgrade of ecommerce changed the
item's price field from price_excl_tax to just price causing the EcommerceApi data loader to fail.

This commit checks for the price_excl_tax key and falls back to the 'price' value.

Ref: openedx-unsupported/ecommerce#4050

  • refactor: apply review suggestion on fix

  • fix: update all references of price_excl_tax to price

  • fix: remove extra item added accidentally

@openedx-webhooks
Copy link

Thanks for the pull request, @tecoholic!

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/course-discovery-admins. 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 Oct 4, 2024
@tecoholic
Copy link
Contributor Author

@Ali-D-Akbar @AfaqShuaib09 Hi, I am raising this request for the master branch that we merged in redwood branch on #4450. Since the master of ecommerce uses django-oscar 3.2, I think we need to patch the master as well.

@tecoholic
Copy link
Contributor Author

@Ali-D-Akbar Hi, would you be kind enough to merge this PR?

DawoudSheraz
DawoudSheraz reviewed Oct 31, 2024
View reviewed changes
course_discovery/apps/course_metadata/data_loaders/api.py
@@ -573,7 +573,7 @@ def update_seats(self, body):
def update_seat(self, course_run, product_body):
stock_record = product_body['stockrecords'][0]
currency_code = stock_record['price_currency']
price = Decimal(stock_record['price_excl_tax'])
price = Decimal(stock_record.get('price_excl_tax', stock_record['price']))
Copy link
Contributor

Choose a reason for hiding this comment

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

instead of repeating this code, a util function can be added that return the price based on which argument is available. Furthermore, the docstring should explain why is there a need to check 2 keys as it wont be obvious to first time readers.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DawoudSheraz Hi, sorry, I seem to have missed this comment. Ideally we should have only on them here because, the change was introduced by the upgrade of Django Oscar, which has then been rolled back on specific branches. So, in the future it will probably get simplified once there is a consistency in the Django Oscar version used. Extracting out a dedicated utility function for a transient change seems a bit superfluous to me. If you noticed, the PR also updates the test cases to match the updated price instead of price_excl_tax.

I agree that we can enhance the docstring or even an inline comment to make this more obvious.

@mphilbrick211
Copy link

@openedx/course-discovery-maintainers - would someone be able to merge this?

@DawoudSheraz
Copy link
Contributor

@tecoholic Hi, can you update and rebase the branch? Thanks.

@tecoholic
fix: use "price" in ecommerce data loader (openedx#4450)
7760f9e 
* chore: bump upload-artifact GH task to v4

* fix: fallback to 'price' in ecommerce api loader

The Django Oscar upgrade of ecommerce changed the
item's price field from `price_excl_tax` to just `price`
causing the EcommerceApi data loader to fail.

This commit checks for the `price_excl_tax` key and
falls back to the 'price' value.

Ref: openedx-unsupported/ecommerce#4050

* refactor: apply review suggestion on fix

* fix: update all references of `price_excl_tax` to price

* fix: remove extra item added accidentally
@tecoholic tecoholic force-pushed the tecoholic/use-price-in-ecommerce-data-lodder branch from f6d429f to 7760f9e Compare December 31, 2024 01:47
@tecoholic
Copy link
Contributor Author

@DawoudSheraz Done!

@DawoudSheraz DawoudSheraz changed the title Copy of - fix: use "price" in ecommerce data loader (#4450) fix: use "price" in ecommerce data loader (#4450) Dec 31, 2024
@DawoudSheraz DawoudSheraz merged commit 8aa9d86 into openedx:master Dec 31, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DawoudSheraz DawoudSheraz DawoudSheraz left review comments

@AfaqShuaib09 AfaqShuaib09 AfaqShuaib09 approved these changes

@Ali-D-Akbar Ali-D-Akbar Ali-D-Akbar approved these changes

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

Successfully merging this pull request may close these issues.
6 participants
@tecoholic @openedx-webhooks @mphilbrick211 @DawoudSheraz @Ali-D-Akbar @AfaqShuaib09