Skip to content
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.

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

fix: parse external_id to string instead of actor id to uuid and allo… #130

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

andrey-canon
Copy link
Contributor

Description

This PR addresses type compatibility issues within various views that involve actor_id fields, where actor_id values could represent either an email address (formatted as mailto:user@example.com) or a UUID. Previously, queries attempted to use toUUID(actor_id) for direct comparison with external_user_id in dim_user_pii, which caused errors when actor_id was not formatted as a UUID.

To resolve this, we modified the join condition for actor_id in all affected views:

  • Previous Condition: toUUID(actor_id) = users.external_user_id

  • Updated Condition:

(actor_id LIKE 'mailto:%' AND SUBSTRING(actor_id, 8) = users.email)
OR actor_id = toString(users.external_user_id)

This conditional join ensures that:

  1. When actor_id represents an email, it strips the mailto: prefix and compares the remaining string with the email field.
  2. For UUID values, actor_id is cast to a String for compatibility with external_user_id in dim_user_pii.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 29, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @andrey-canon!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @bmtcril. 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

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

@andrey-canon andrey-canon force-pushed the and/fix_external_id_searches branch from d75e579 to b4dc921 Compare October 30, 2024 15:45
@andrey-canon
Copy link
Contributor Author

Hi @bmtcril, this pr is ready to review, could you please take a o look of it? thanks :)

@bmtcril
Copy link
Contributor

bmtcril commented Oct 30, 2024

Thanks for finding and fixing this @andrey-canon ! I'll dig in as soon as I can.

@Ian2012 @saraburns1 heads up on this too

Copy link
Contributor

@Ian2012 Ian2012 left a comment

Choose a reason for hiding this comment

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

Thanks for this fix, tested locally. LGTM

One note, we still need to update Superset virtual datasets to this new format:
https://github.com/search?q=repo%3Aopenedx%2Ftutor-contrib-aspects%20toUUID&type=code

@Ian2012 Ian2012 merged commit 4139d69 into openedx:main Oct 31, 2024
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
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants