Skip to content

Conversation

@asajjad2
Copy link
Contributor

@asajjad2 asajjad2 commented May 21, 2025

What are the relevant tickets?

#232, #6807

Description (What does it do?)

This PR fixes a compatibility issue with the create_user_task signal handler when using Celery's task message protocol version 2, which has been the default for several years.

Currently, the signal handler fails with the following error:

TypeError: tuple indices must be integers or slices, not str

This occurs because the handler expects a protocol v1-style task body (a dictionary), while protocol v2 passes the body as a tuple. Although the exception is caught and logged internally by Celery, it might be preventing UserTaskStatus from being created reliably in affected cases.

Changes

The changes mainly follows the workaround suggested in the issue:

  • Updated create_user_task to detect the task protocol version and normalize the body to the expected format.
  • Added utility functions to convert protocol v2 bodies and headers into a protocol v1-compatible structure.
  • Ensured backward compatibility with protocol v1.

@openedx-webhooks
Copy link

openedx-webhooks commented May 21, 2025

Thanks for the pull request, @asajjad2!

This repository is currently maintained by @usamasadiq.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 21, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions May 21, 2025
@pdpinch
Copy link

pdpinch commented May 27, 2025

asajjad2's work should be covered by the MIT entity agreement. I added him to the MIT Staff and GitHub Details google sheet back in February.

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

codecov bot commented May 27, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (179f02e) to head (9b0bf42).
⚠️ Report is 8 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #422   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        17    +1     
  Lines          435       460   +25     
  Branches        47        51    +4     
=========================================
+ Hits           435       460   +25     
Flag Coverage Δ
unittests 100.00% <100.00%> (ø)

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.

@e0d
Copy link

e0d commented May 27, 2025

@asajjad2 Looks like there are some test and quality check failures. Can you have a look. The issue with your CLA should be fixed a little later today when the batch job runs.

@e0d
Copy link

e0d commented Jun 5, 2025

@asajjad2
I've added you to the openedx-triage team as you are covered under an entity CLA. This will mean that tests will run automatically when you submit a pull request in the future. Please look for an invitation in your email and accept it.

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jun 5, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Tests Run or CLA Signed to Waiting on Author in Contributions Jun 12, 2025
@pdpinch
Copy link

pdpinch commented Jun 20, 2025

@asajjad2 can you try re-running the tests on this PR?

@asajjad2 asajjad2 force-pushed the areeb/create-user-task-signal-v2 branch from 6dc46e1 to 5ca72bb Compare June 23, 2025 12:09
@pdpinch
Copy link

pdpinch commented Jun 23, 2025

@e0d the tests are failing with the error:

The job was not started because recent account payments have failed or your spending limit needs to be increased. Please check the 'Billing & plans' section in your settings

Is there an issue with openedx's Billing and Plans? Or is this on MIT?

@e0d
Copy link

e0d commented Jun 23, 2025

@pdpinch I think this was an issue on our side caused by a mysterious .03 charge. I've re-run them. It does look like there's a commit lint issue.

@UsamaSadiq UsamaSadiq merged commit 3142282 into openedx:master Jun 24, 2025
13 checks passed
@github-project-automation github-project-automation bot moved this from Waiting on Author to Done in Contributions Jun 24, 2025
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

Archived in project

Development

Successfully merging this pull request may close these issues.

6 participants