Skip to content

feat: pull entity data from PublishableEntity instances #348

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
ormsbee merged 3 commits into from
Aug 6, 2025
Merged

feat: pull entity data from PublishableEntity instances #348

ormsbee merged 3 commits into from
Aug 6, 2025

Conversation

@dwong2708
Copy link
Contributor

@dwong2708 dwong2708 commented Jul 31, 2025 •
edited
Loading

Resolves: #345

Changes included:

  • Retrieve data from PublishableEntity and PublishableEntityVersion instances instead of relying on subclasses like Component.
  • Introduce a get_entities function to handle entity retrieval.

@dwong2708 dwong2708 marked this pull request as ready for review July 31, 2025 21:53
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jul 31, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented Jul 31, 2025 •
edited
Loading

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @axim-engineering.

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.

1 similar comment
@openedx-webhooks
Copy link

openedx-webhooks commented Jul 31, 2025

Thanks for the pull request, @dwong2708!

This repository is currently maintained by @axim-engineering.

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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Jul 31, 2025
@dwong2708 dwong2708 requested a review from ormsbee July 31, 2025 21:53
ormsbee
ormsbee requested changes Jul 31, 2025
View reviewed changes
@dwong2708 dwong2708 requested a review from ormsbee August 1, 2025 22:16
ormsbee
ormsbee requested changes Aug 2, 2025
View reviewed changes
Copy link
Contributor

@ormsbee ormsbee left a comment

Choose a reason for hiding this comment

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

Some really minor requests. Thank you.

tests/openedx_learning/apps/authoring/publishing/test_api.py Outdated
assert subsection_change.affected_by.first().cause == unit_change


class GeneralTestCase(TestCase):
Copy link
Contributor

@ormsbee ormsbee Aug 2, 2025

Choose a reason for hiding this comment

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

Please call this EntitiesTestCase and narrow the scope of it to be queries on entities. Even if that only amounts to one or two test methods for now. Please also change the docstring to reflect this scope.

Copy link
Contributor Author

@dwong2708 dwong2708 Aug 4, 2025

Choose a reason for hiding this comment

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

Done, thanks

openedx_learning/apps/authoring/backup_restore/toml.py Outdated
draft.add("version_num", entity.versioning.draft.version_num)
entity_table.add("draft", draft)
if current_draft_version:
draft = tomlkit.table()
Copy link
Contributor

@ormsbee ormsbee Aug 2, 2025

Choose a reason for hiding this comment

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

Nit: It might be clearer to call this a draft_table so it's clear at a glance that this is not a Draft model object.

Copy link
Contributor Author

@dwong2708 dwong2708 Aug 4, 2025

Choose a reason for hiding this comment

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

Totally agree, changed. Thanks

tests/openedx_learning/apps/authoring/publishing/test_api.py Outdated

@classmethod
def setUpTestData(cls) -> None:
cls.now = datetime(2024, 1, 28, 16, 45, 30, tzinfo=timezone.utc)
Copy link
Contributor

@ormsbee ormsbee Aug 2, 2025

Choose a reason for hiding this comment

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

Nit: This isn't important, but I generally try to use a start date that reflects when this test was added.

Copy link
Contributor Author

@dwong2708 dwong2708 Aug 4, 2025

Choose a reason for hiding this comment

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

I see. Changed. Thanks

@dwong2708 dwong2708 requested a review from ormsbee August 4, 2025 18:35
@dwong2708 dwong2708 force-pushed the dwong2708/pulling-data-from-interfaces branch from cc16ab8 to 7999ace Compare August 4, 2025 18:36
@mphilbrick211 mphilbrick211 added the mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). label Aug 5, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Aug 5, 2025
@ormsbee ormsbee merged commit abe53ce into openedx:main Aug 6, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Aug 6, 2025
@ormsbee ormsbee mentioned this pull request Sep 4, 2025
Closed
@ormsbee ormsbee mentioned this pull request Dec 30, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ormsbee ormsbee ormsbee approved these changes

Assignees

No one assigned

Labels

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). 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.

Make entity data retrieval extensible

4 participants

@dwong2708 @openedx-webhooks @ormsbee @mphilbrick211