Skip to content

fix: use ASPECTS_RAW_XAPI_TABLE as source for xapi events#164

Merged
bmtcril merged 3 commits intoopenedx:mainfrom
Ian2012:cag/vector-default
Mar 24, 2026
Merged

fix: use ASPECTS_RAW_XAPI_TABLE as source for xapi events#164
bmtcril merged 3 commits intoopenedx:mainfrom
Ian2012:cag/vector-default

Conversation

@Ian2012
Copy link
Contributor

@Ian2012 Ian2012 commented Mar 6, 2026

This PR make use of the ASPECTS_RAW_XAPI_TABLE variable instead of ASPECTS_VECTOR_RAW_XAPI_TABLE for consistency with the tutor plugins for Aspects. Those variables are effectively the same so it shouldn't affect most of the installations unless the ASPECTS_VECTOR_RAW_XAPI_TABLE was changed from the default.

The breaking changed is detailed on the docs

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 6, 2026
@openedx-webhooks
Copy link

openedx-webhooks commented Mar 6, 2026

Thanks for the pull request, @Ian2012!

This repository is currently maintained by @bmtcril.

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.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Mar 11, 2026
@Ian2012 Ian2012 closed this Mar 16, 2026
@Ian2012 Ian2012 reopened this Mar 16, 2026
@github-project-automation github-project-automation bot moved this from Needs Tests Run or CLA Signed to Done in Contributions Mar 16, 2026
@saraburns1
Copy link
Contributor

@Ian2012 do you need to change this in the alembic migrations too?

@Ian2012
Copy link
Contributor Author

Ian2012 commented Mar 17, 2026

No, only here. There will be only one setting for that table

@Ian2012
Copy link
Contributor Author

Ian2012 commented Mar 19, 2026

@bmtcril do we need a version bump?

@bmtcril
Copy link
Contributor

bmtcril commented Mar 19, 2026

I'm not 100% sure I understand what the downstream effects of this will be. I think it's this?

These are all fine:

  • New install - everything goes to xapi_events_all
  • Normal upgrade on instance using Vector with default settings - everything goes to xapi_events_all

Unrelated to this change, but still breaking:

  • Normal upgrade on instance that has been using Celery / Ralph with default settings - database will change from xapi to openedx but table name is still xapi_events_all, admins can change the ASPECTS_VECTOR_DATABASE to xapi or migrate data

Actual possible breaking change from this PR:

  • Update if someone has customized ASPECTS_VECTOR_RAW_XAPI_TABLE - they will need to change their customization to use ASPECTS_RAW_XAPI_TABLE instead or will need to migrate data

Does that sound right?

@Ian2012
Copy link
Contributor Author

Ian2012 commented Mar 19, 2026

Yes, it's correct

@bmtcril
Copy link
Contributor

bmtcril commented Mar 20, 2026

Ok, then yes this is a major version bump and we need to document the breaking case probably here, in the README, and again in openedx-aspects upgrade doc, and likely in the README of tutor-contrib-aspects too.

@Ian2012
Copy link
Contributor Author

Ian2012 commented Mar 20, 2026

I've added docs for this

README.rst Outdated
Breaking Changes
***************

This project uses ``ASPECTS_RAW_XAPI_TABLE`` as the source for xAPI events. If you have customized ``ASPECTS_VECTOR_RAW_XAPI_TABLE`` in your configuration, update it to use ``ASPECTS_RAW_XAPI_TABLE`` instead.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe:

As if version 7.0.0 this project uses ASPECTS_RAW_XAPI_TABLE as the source for xAPI events for both Ralph and Vector pipelines. If you have previously customized ASPECTS_VECTOR_RAW_XAPI_TABLE in your configuration, you will need to update it to use ASPECTS_RAW_XAPI_TABLE instead.

Copy link
Contributor

@bmtcril bmtcril left a comment

Choose a reason for hiding this comment

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

I think this is good to go if you can just update the PR description to make it easier to find this change later 👍

@Ian2012
Copy link
Contributor Author

Ian2012 commented Mar 24, 2026

Ok, updated

@bmtcril bmtcril merged commit 236573e into openedx:main Mar 24, 2026
4 checks passed
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

Status: Done

Development

Successfully merging this pull request may close these issues.

5 participants