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.

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

feat: add --lrs-urls option to transform_tracking_logs command #485

Merged
merged 1 commit into from
Feb 6, 2025
Merged

feat: add --lrs-urls option to transform_tracking_logs command #485

merged 1 commit into from
Feb 6, 2025
+179 −8

Conversation

Ali-Salman29
Copy link
Contributor

@Ali-Salman29 Ali-Salman29 commented Jan 30, 2025 •
edited
Loading

Introduced the --lrs-urls argument to allow specifying multiple LRS route URLs. This enhancement enables sending tracking logs exclusively to the designated LRSs, preventing data from being sent to all configured LRSs.

close #483

Description: Describe in a couple of sentences what this PR adds

JIRA: Link to JIRA ticket

Dependencies: dependencies on other outstanding PRs, issues, etc.

Merge deadline: List merge deadline (if any)

Installation instructions: List any non-trivial installation
instructions.

Testing instructions:

  1. Open page A
  2. Do thing B
  3. Expect C to happen
  4. If D happened instead - check failed.

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.

Author concerns: List any concerns about this PR - inelegant
solutions, hacks, quick-and-dirty implementations, concerns about
migrations, etc.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 30, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @Ali-Salman29!

This repository is currently maintained by @ziafazal.

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.

@Ali-Salman29 Ali-Salman29 requested a review from ziafazal January 30, 2025 13:55
ziafazal
ziafazal reviewed Jan 31, 2025
View reviewed changes
Copy link
Contributor

@ziafazal ziafazal left a comment

Choose a reason for hiding this comment

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

@Ali-Salman29 overall looks good. I have a suggestion and a question. Please make sure CI tests are passing when its ready.

event_routing_backends/management/commands/transform_tracking_logs.py Show resolved Hide resolved
event_routing_backends/management/commands/tests/test_transform_tracking_logs.py Show resolved Hide resolved
@Ali-Salman29 Ali-Salman29 requested a review from ziafazal January 31, 2025 15:52
ziafazal
ziafazal approved these changes Feb 6, 2025
View reviewed changes
Copy link
Contributor

@ziafazal ziafazal left a comment

Choose a reason for hiding this comment

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

👍

@Ali-Salman29 Ali-Salman29 force-pushed the alisalman/specify-lrs-in-transform-tracking-logs branch from ccc1fd1 to 6afb9c3 Compare February 6, 2025 10:33
@Ali-Salman29
feat: Add --lrs-urls option to transform_tracking_logs command
279dbbb 
- Introduced the --lrs-urls flag to specify target Learning Record Stores (LRS) by their route_url.
- Updated documentation to reflect the new usage of the --lrs-urls option.
- Added tests to ensure correct functionality when using the --lrs-urls flag.

close openedx#483
@Ali-Salman29 Ali-Salman29 force-pushed the alisalman/specify-lrs-in-transform-tracking-logs branch from 6afb9c3 to 279dbbb Compare February 6, 2025 10:40
@ziafazal ziafazal merged commit 6fe9c0a into openedx:master Feb 6, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ziafazal ziafazal ziafazal approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Feature Request: Specify Target LRS for transform_tracking_logs Command
3 participants
@Ali-Salman29 @openedx-webhooks @ziafazal