Skip to content

chore: make upgrade #226

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
Merged
merged 2 commits into from
Sep 5, 2025
Merged

chore: make upgrade #226

merged 2 commits into from
Sep 5, 2025

Conversation

@samuelallan72
Copy link
Contributor

@samuelallan72 samuelallan72 commented Aug 29, 2025 •
edited
Loading

Description

Upgrade all python dependencies using make upgrade. This also fixes the make compile-requirements process; it was previously broken with unresolvable dependencies.

Supporting information

Testing instructions

  • Verify nothing has broken as part of bumping the dependencies. This may need to be manually tested in a sandbox.
  • Verify you can successfully run make compile-dependencies now.

Merge checklist:
Check off if complete or not applicable:

  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Manual testing instructions provided
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

@samuelallan72
chore: make upgrade
2aca238 
Upgrade all python dependencies using `make upgrade`.
This also fixes the `make compile-requirements` process;
it was previously broken with unresolvable dependencies.
@openedx-webhooks
Copy link

openedx-webhooks commented Aug 29, 2025

Thanks for the pull request, @samuelallan72!

This repository is currently maintained by @openedx/wg-maintainers-forums.

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 Aug 29, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Aug 29, 2025
@samuelallan72 samuelallan72 self-assigned this Aug 29, 2025
@samuelallan72 samuelallan72 mentioned this pull request Aug 29, 2025
Open
7 tasks
@bradenmacdonald
Copy link

bradenmacdonald commented Sep 2, 2025

@samuelallan72 Can you fix the quality issue?

@samuelallan72
fix: fix minor bugs caught by updated type checker
f83e44f 
- `backend.get_thread` can return None. Unlikely in this case, but
  possible if the thread was somehow deleted before being retrieved
  again.
- returning group_ids at the end of `get_group_ids_from_params` could
  result in an unexpected type and value being returned, depending on
  what sanitation has been done on the params.
@samuelallan72
Copy link
Contributor Author

samuelallan72 commented Sep 3, 2025

Thanks for the reminder for this PR @bradenmacdonald , updated! :)

@bradenmacdonald
Copy link

bradenmacdonald commented Sep 4, 2025

make compile-requirements is working now, but it did generate some additional changes when I ran it.

bradenmacdonald
bradenmacdonald approved these changes Sep 4, 2025
View reviewed changes
Copy link

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

LGTM, other than the if thread is None part which I don't have context for. The version bumps don't seem to be causing any issues.

forum/api/threads.py
thread = backend.get_thread(thread_id)
if thread is None:
log.error(
"Forumv2RequestError for update thread request - retrieving updated thread to send in response."
Copy link

@bradenmacdonald bradenmacdonald Sep 4, 2025

Choose a reason for hiding this comment

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

Suggested change
"Forumv2RequestError for update thread request - retrieving updated thread to send in response."
"ForumV2RequestError for update thread request - retrieving updated thread to send in response."

This is the only part I wasn't sure about. It says "retrieving updated thread" but I don't see it doing that here.

Copy link
Contributor Author

@samuelallan72 samuelallan72 Sep 4, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

The general flow in this method (pseudocode) is:

  • thread: Thread = validate_object("CommentThread", id) # raises error if doesn't exist
  • update_thread()
  • thread: Thread|None = get_thread(id) # returns None if doesn't exist

So on line 265, thread should be the thread after the updates on line 263. However, nothing in the type system guarantees the thread wasn't deleted between line 263 and line 264. So the check is to keep the types happy, although there's a very very small chance of that happening.

Alternatively, we can change the get_thread call on line 265 to validate_object("CommentThread", id), which will raise an error instead or returning None. I'm not sure if there's any particular reason to use one over the other though, which is why I left it as-is and just focused on fixing the type error.

@bradenmacdonald
Copy link

bradenmacdonald commented Sep 4, 2025

@taimoor-ahmed-1 could you please review?

@samuelallan72
Copy link
Contributor Author

samuelallan72 commented Sep 4, 2025

@bradenmacdonald

but it did generate some additional changes when I ran it.

I guess it wouldn't take long before there's a new patch release of something at least. Let me know if I should run make upgrade again and commit the updates, or if it should remain as-is for review purposes? :)

@bradenmacdonald
Copy link

bradenmacdonald commented Sep 5, 2025

Nah, all good.

@taimoor-ahmed-1 taimoor-ahmed-1 merged commit c43688f into openedx:master Sep 5, 2025
14 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Sep 5, 2025
@samuelallan72 samuelallan72 deleted the samuel/make-upgrade branch September 5, 2025 05:57
@bradenmacdonald
Copy link

bradenmacdonald commented Sep 5, 2025

Thanks @taimoor-ahmed-1 !

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

Reviewers

@taimoor-ahmed-1 taimoor-ahmed-1 taimoor-ahmed-1 approved these changes

+1 more reviewer

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@samuelallan72 samuelallan72

Labels

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

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@samuelallan72 @openedx-webhooks @bradenmacdonald @taimoor-ahmed-1