Skip to content

Load fake Catalog Pathways into event_sink.catalog_pathway - #286

Merged
bmtcril merged 1 commit into
openedx:mainfrom
eduNEXT:fmo/pathway-sink
Nov 10, 2026
Merged

bmtcril merged 1 commit into
openedx:mainfrom
eduNEXT:fmo/pathway-sink

Conversation

@felipemontoya

Copy link
Copy Markdown
Member

Generates fake Catalog Pathways and writes them to event_sink.catalog_pathway
from every backend (ClickHouse, Ralph, Vector, chdb/S3, CSV).

  • Pathways are spread across the configured orgs and rotate through the Pathway
    Categories (Master's Degree, Annual Training, Professional Certificate), so
    each org gets pathways of different categories.
  • New config keys: num_catalog_pathways (default 6, set to 0 to disable) and
    first_catalog_pathway_id (default 100001, kept high so fake ids don't collide
    with real pathways dumped by the LMS).
  • CSV backend writes catalog_pathways.csv.gz.
  • README and default_config.yaml document the new keys.

Requires the tutor-contrib-aspects migration 0042_event_sink_pathways,
which creates the table. On older Aspects installs, set num_catalog_pathways: 0.

Tests: generator tests cover defaults, the id offset, disabling, and the
org/category spread for 1, 2, 3 and 5 orgs. The CSV backend test checks the
pathway row count.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Nov 3, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @felipemontoya!

This repository is currently maintained by @openedx/xapi-db-load-maintainers.

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.

@codecov

codecov Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 97.24138% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 90.26%. Comparing base (c6b7512) to head (6fb1dfd).

Files with missing lines Patch % Lines
xapi_db_load/backends/chdb.py 94.44% 0 Missing and 2 partials ⚠️
xapi_db_load/backends/clickhouse.py 95.83% 0 Missing and 1 partial ⚠️
xapi_db_load/generate_load_async.py 98.03% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #286      +/-   ##
==========================================
+ Coverage   89.90%   90.26%   +0.35%     
==========================================
  Files          36       36              
  Lines        2843     2988     +145     
  Branches      307      322      +15     
==========================================
+ Hits         2556     2697     +141     
  Misses        260      260              
- Partials       27       31       +4     
Flag Coverage Δ
unittests 90.26% <97.24%> (+0.35%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bmtcril

bmtcril commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

One small thing then I can merge and release. This should be a feat!: commit since it writes to tables that don't exist in earlier versions and will require a full version bump.

@felipemontoya

Copy link
Copy Markdown
Member Author

@bmtcril I squashed the commits and did the fix on the conventional commit

@bmtcril
bmtcril enabled auto-merge November 10, 2026 12:34
Requires v2.2.0 from the platform-plugin-aspects
auto-merge was automatically disabled November 10, 2026 14:29

Head branch was pushed to by a user without write access

@bmtcril
bmtcril merged commit fbc29d5 into openedx:main Nov 10, 2026
7 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Nov 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants