fix: use "price" in ecommerce data loader

tecoholic commented 1 month ago

Description

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 handled the exception and falls back to the 'price' value.

Ref: https://github.com/openedx/ecommerce/pull/4050

Additional information

The same as #4291.

Testing instructions

Reproduce Issue

Setup Tutor 18 (Redwood) dev env with the plugins ecommerce and discovery enabled
Clone course-discovery.
Add a tutor mount for the course-discovery.
Create a course or import the demo course.
Setup admin user for ecommerce and discovery
Add a course seat in http://ecommerce.local.edly.io:8130/courses/ for the test course

Run the following from Discovery Shell to set the ecommerce API url. NOTE: trying the same in Discovery admin fails due to URL validation.

from course_discovery.apps.core.models import Partner
p = Partner.objects.get(short_code="dev")
p.ecommerce_api_url = "http://ecommerce:8130/api/v2/"
p.save()

Run ./manage.py refresh_course_metadata --partner dev. It should fail with the KeyError price_excl_tax.

Testing the fix from PR

Checkout the PR branch
Run ./manage.py refresh_course_metadata --partner dev again. This time, it should run successfully.

openedx-webhooks commented 1 month ago

Thanks for the pull request, @tecoholic!

What's next?

Please work through the following steps to get your changes ready for engineering review:

:radio_button: 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.

:radio_button: 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

:radio_button: 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.

:radio_button: 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

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

tecoholic commented 1 month ago

@AfaqShuaib09 Thanks for the suggestion. I have applied it to the PR.

tecoholic commented 1 month ago

@AfaqShuaib09 I raised the with the fix for just the one place where I encountered an error. If other functions also need to be updated, I can do that. But I am not sure what those functions do. So, anyone can confirm those functions need to be updated, I can recreate update the PR accordingly.

Ali-D-Akbar commented 1 month ago

@AfaqShuaib09 I raised the with the fix for just the one place where I encountered an error. If other functions also need to be updated, I can do that. But I am not sure what those functions do. So, anyone can confirm those functions need to be updated, I can recreate update the PR accordingly.

Hi there! I do agree with Afaq since this field was previously added in the aforementioned closed PR. Also, I believe adding it in update_entitlement and validate_stockrecord is also the right way since both of these functions are used in EcommerceApi Data Loader and having the correct price value should be the right thing else it will result in failure again.

tecoholic commented 1 month ago

@AfaqShuaib09 @Ali-D-Akbar Hi, thanks for confirming. I have updated the references in the mentioned functions and the mock data as well. Can you kindly review?

Note: All the CI checks for Python 3.8 seems to be failing due to a setuptools error. I want to highlight that course-discovery tutor template for redwood uses Python 3.12. So we can safely disregard the 3.8 failures.

tecoholic commented 1 month ago

@Ali-D-Akbar Hi, can you kindly review this change and merge it?

cc: @AfaqShuaib09

tecoholic commented 1 month ago

@Ali-D-Akbar Thank you.

openedx / course-discovery