Skip to content

Upstream contribution roadmap: PR waves independent of enhanced YouTube API access #3

Description

@djbclark

Goal

Upstream generally useful SuperBrain changes—including changes that support YouTube-related workflows—as small, independently reviewable pull requests while holding back features that depend on YouTube approving enhanced YouTube Data API access or increased quota.

This replaces the earlier broad upstream PR approach with fresh branches based on sidinsearch/superbrain:main. Each PR should contain one behavior, focused tests, and no unrelated fork/operator configuration.

Wave 1 — independent correctness fixes

  • Separate the live backend API probe from unit-test discovery.
  • Make mobile delta sync consume every backend page before advancing its sync cursor.

These PRs are independent and may be reviewed in parallel. They support the reliability of YouTube-oriented SuperBrain workflows but do not call or require enhanced access to the YouTube Data API.

Wave 2 — persistence and worker safety

  • Extract generic SQLite concurrency hardening: per-thread connections, WAL/busy-timeout behavior, atomic work claiming, stale-work recovery, and focused generic tests.

Submit this after the delta-sync PR to avoid overlapping database changes. Keep it focused on generic database and worker safety; exclude OAuth, subscription discovery, playlist synchronization, quota handling, and other approval-dependent API functionality.

Wave 3 — configurable taxonomy

Because this is a major feature, first open an upstream design issue and obtain maintainer direction. Then submit sequentially:

  • Configurable taxonomy core, validation, classifier integration, fallback behavior, and focused tests.
  • Dynamic taxonomy endpoint and Android category UI, after the core merges.
  • Metadata-only recategorization with dry-run/apply, filters, backups, and concise documentation, after the core merges.

These taxonomy changes can organize YouTube content, but they remain independent of enhanced YouTube Data API quota or approval.

Enhanced-API work explicitly held back

Upstream design discussion: sidinsearch/superbrain#6 — opt-in YouTube subscription organization and private category playlist sync.

Do not include any of the following in upstream PRs until the enhanced YouTube API-access proposal has been discussed with upstream and the required Google/YouTube approvals are ready:

  • YouTube OAuth secrets, consent/connection flows, or subscription discovery.
  • Category-to-YouTube-playlist creation, bulk backfill, quota waiting, or automatic activation.
  • YouTube API privacy/terms/compliance pages and screenshots.

Also deferred to keep contribution scope focused

  • WebSub/reconciliation, Watch Later or browser-cookie playlist import, and transcript downloading may be reconsidered later only as cleanly decoupled contributions with their own policy and scope review.
  • Fork-specific omlx/reference-database behavior and opinionated provider/model defaults remain out of scope for upstream PRs.

The production/multi-user YouTube work remains tracked separately in #1 and #2. It is not a dependency for contributions that are technically and operationally independent of enhanced YouTube API approval.

Submission rules

  • Start each branch from the then-current upstream main; do not reuse the mixed historical branch.
  • Keep no more than two independent PRs open at once.
  • Include focused automated tests and the exact verification commands/results in every PR.
  • Scan each diff for OAuth, quota, credentials, compliance, or other approval-dependent API functionality before pushing.
  • Mark a PR ready for review only after its focused checks pass, its final diff has been reviewed for scope, and it no longer carries known follow-up edits.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions