Skip to content

docs(docs): refresh batch-parallel-execution INITIAL post-PRP-33 (#280)#283

Merged
w7-mgfcode merged 1 commit into
devfrom
docs/batch-parallel-execution-prp33-status
May 25, 2026
Merged

docs(docs): refresh batch-parallel-execution INITIAL post-PRP-33 (#280)#283
w7-mgfcode merged 1 commit into
devfrom
docs/batch-parallel-execution-prp33-status

Conversation

@w7-mgfcode
Copy link
Copy Markdown
Owner

@w7-mgfcode w7-mgfcode commented May 25, 2026

Summary

  • PRP-33 batch-runner MVP shipped in feat(batch): implement batch-runner MVP per PRP-33 (#280) #281, including forward-compat columns max_parallel, running_items, cancelled_items on batch_job and schema classes BatchSubmitRequest / BatchSubmitResponse.
  • The parallel-execution INITIAL was written assuming the MVP did not exist yet — refreshed so it reflects the merged MVP and is ready for PRP generation.

Changes

  • "Depends on" → PRP-33 batch-runner MVP (merged in #281).
  • § Data Model Delta — rewritten: PRP-33 shipped the three columns forward-compat; this PRP activates them. No new migration required.
  • § API Delta — renamed BatchCreateRequestBatchSubmitRequest, BatchResponseBatchSubmitResponse (matches app/features/batch/schemas.py:116,164).
  • § Backend Service Shape (module-layout tree) + § Frontend Touchpoints — same rename + drop stale "NEW — owned by MVP" wording on models.py / schemas.py (they are shipped by PRP-33).
  • Test-file NEW (this INITIAL) annotations preserved (test_runner.py, test_routes_cancel.py, test_runner_chaos.py are genuinely net-new).

Test plan

  • Docs-only diff — markdown only, no code paths touched.
  • grep -nE "(BatchCreateRequest|BatchResponse[^.]|not yet scaffolded|NEW — owned by MVP)" PRPs/INITIAL/INITIAL-batch-parallel-execution.md returns empty.

Summary by Sourcery

Refresh the batch parallel-execution INITIAL PRP to align with the shipped batch-runner MVP and forward-compat schema.

Documentation:

  • Update the INITIAL batch parallel-execution proposal to reference PRP-33 batch-runner MVP and its merged status.
  • Clarify that max_parallel, running_items, and cancelled_items columns were shipped by PRP-33 and are activated by this PRP without new migrations.
  • Rename documented batch API schemas from BatchCreateRequest/BatchResponse to BatchSubmitRequest/BatchSubmitResponse across API, backend layout, and type-safety sections.
  • Adjust backend module layout commentary to mark models.py and schemas.py as shipped by PRP-33 rather than new to this INITIAL.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 25, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Refreshes the INITIAL batch parallel-execution PRP doc to align with the already-shipped PRP-33 batch-runner MVP, clarifying that the DB columns are already present, renaming API schema types to match the current code, and updating backend/frontend/test touchpoint descriptions accordingly.

Entity relationship diagram for activated batch_job parallel-execution columns

erDiagram
    batch_job {
        int max_parallel
        int running_items
        int cancelled_items
        string status
    }

    batch_job ||--o{ batch_job_item : has
Loading

File-Level Changes

Change Details Files
Align the PRP dependency and data model description with the already-merged PRP-33 batch-runner MVP.
  • Update the Depends-on reference to explicitly point to PRP-33 batch-runner MVP (merged in feat(batch): implement batch-runner MVP per PRP-33 (#280) #281) instead of a not-yet-built MVP.
  • Rewrite the Data Model Delta section to state that max_parallel, running_items, and cancelled_items already exist as forward-compat columns shipped by PRP-33 rather than being added by this INITIAL.
  • Adjust the batch_job column table to reflect that the three columns are shipped by PRP-33 and this PRP only activates their behavior.
  • Update the migration policy text to clarify that no new migration is required and that this PRP only adds behavior on top of the existing schema.
PRPs/INITIAL/INITIAL-batch-parallel-execution.md
Rename batch API schema types in the PRP to match the implemented MVP code.
  • Rename BatchCreateRequest to BatchSubmitRequest in the request schema example and throughout the document.
  • Rename BatchResponse to BatchSubmitResponse in the response schema example and all API/contract mentions, including DELETE /batch/{batch_id} responses.
  • Update references in the backend module layout tree to show schemas.py exporting BatchSubmitRequest/BatchSubmitResponse shipped by PRP-33.
  • Update the Type-safety gate section to reference BatchSubmitResponse.* fields instead of BatchResponse.*.
PRPs/INITIAL/INITIAL-batch-parallel-execution.md
Tighten backend/frontend module layout and test touchpoint descriptions to reflect what shipped in PRP-33 vs what this INITIAL adds.
  • In the backend module layout tree, change models.py and schemas.py comments from NEW/owned by MVP to shipped by PRP-33, clarifying ownership and current status.
  • Clarify that this INITIAL fills in the runner behavior (service.py/runner.py) while routes and tests are new, without implying models/schemas are new.
  • Preserve NEW (this INITIAL) annotations for genuinely new test files, ensuring the doc still signals which tests come from this PRP.
PRPs/INITIAL/INITIAL-batch-parallel-execution.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 25, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 16f9695b-9821-4f6d-a433-04ab2919d9c2

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/batch-parallel-execution-prp33-status

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • In the header Scope: line you still describe the batch-runner MVP as "(unbuilt)", which is now stale given the dependency has shipped; consider updating that phrase to avoid confusion about the current state of the MVP.
  • In the cancelled_items description you mention "once DELETE /batch/{id} lands"; it might help to be explicit whether this INITIAL includes that route or if it is expected from a separate PRP, so readers understand when writes to this counter actually begin.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- In the header `Scope:` line you still describe the batch-runner MVP as "(unbuilt)", which is now stale given the dependency has shipped; consider updating that phrase to avoid confusion about the current state of the MVP.
- In the `cancelled_items` description you mention "once `DELETE /batch/{id}` lands"; it might help to be explicit whether this INITIAL includes that route or if it is expected from a separate PRP, so readers understand when writes to this counter actually begin.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@w7-mgfcode w7-mgfcode merged commit c9428db into dev May 25, 2026
8 checks passed
@w7-mgfcode w7-mgfcode deleted the docs/batch-parallel-execution-prp33-status branch May 25, 2026 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant