Create a Django outbox event atomically with the order change
An on_commit callback runs after commit but does not make message delivery durable. Store the event in the transaction and let a retrying worker publish it. Moving create outside the block makes a failed event insert leave a confirmed order without a delivery record.
Save this requirement in Perch and check it after each agent edit. The rule gives your agent a named check to run, a finding to repair, and the same command to recheck.
Implement the Django boundary
Save this illustrative integration module as orders/confirmation.py.
from django.db import transaction
from .models import Order, OutboxEvent
def confirm_order(actor, order_id):
with transaction.atomic():
order = (Order.objects.select_for_update()
.get(pk=order_id, tenant_id=actor.tenant_id))
if order.status != "pending":
raise ValueError("Order already transitioned")
order.status = "confirmed"
order.save(update_fields=["status"])
OutboxEvent.objects.create(
event_key=f"order-confirmed:{order.pk}",
payload={"order_id": order.pk, "tenant_id": actor.tenant_id},
)
return order.pk
The order, inventory, or resource-lifetime scenario is adapted from Perch’s public order-service source at commit 4af67af. This Django implementation is an illustrative adaptation.
Integrate with your application
Give OutboxEvent a JSONField payload and unique event_key. The worker should claim events in a separate transaction, publish with an idempotency key, and mark completion only after the delivery acknowledgement. Test transaction boundaries on PostgreSQL. This service establishes a durable event record, not exactly-once delivery.
Exercise the boundary and failure paths
| Scenario | Expected outcome |
|---|---|
| Event insert succeeds | Order and event commit |
| Event insert violates a constraint | Order transition rolls back |
| Worker loses acknowledgement | Delivery may repeat; consumer deduplicates |
| Another tenant submits the same id | Scoped lookup rejects it |
Add regression tests for these cases in your existing Django test project. Use separate connections or deliberately reordered completion where the case involves concurrency; a sequential happy-path test does not exercise that failure. Run the test command after creating the matching test file or suite:
python manage.py test orders.tests.test_outbox
The scenarios above specify tests to implement. A completed Perch source check below is separate from running these application integration tests.
Introduce the specific agent regression
In a throwaway copy, replace this source span:
OutboxEvent.objects.create(
with:
OutboxEvent.objects.create(
Run the relevant negative test and the Perch command on that broken copy. Restore the corrected source before committing the application. The supplied mutation reproduces the exact regression for the rule check.
Preserve the requirement as a Perch rule
Save this in .perch/rules/perch-guide-django-durable-outbox.yaml at the repository root, keeping your existing perch.yaml:
- name: outbox-same-atomic-block
where: "orders/confirmation.py"
ensure: >-
OutboxEvent.objects.create must run inside the same transaction.atomic block as order.save. Moving event insertion after the atomic block breaks the rule.
Install and authenticate the CLI once, then check the current working file:
npm install -g @lakeday/perch
perch login
perch check orders/confirmation.py --rules outbox-same-atomic-block --json
Use Node 22 or newer. The framework can use another language; Perch’s CLI remains a Node command. A gated finding exits 3. Exits 1 or 2 mean the check did not complete and must be reported as a blocker.
Inspect the captured rule check
On 2026-10-14, Perch using jev-latest checked the exact fixed and broken source provided here. The capture records SHA-256 hashes of both sources and the requirement.
| Source control | Exit | Outcome |
|---|---|---|
| Broken | 3 | Rule finding |
| Corrected | 0 | No rule finding |
The rule distinguished these controls in this run. Raw Perch capture · Exact sources and mutation.
Install the rule pack and configure your agent
Download this rule pack ZIP · Download the YAML rules · Agent task. The pack contains the rule, its example paths and the repair/recheck instructions. Review the where selector before using it in an existing project. Keep your root perch.yaml; install this rule as a separate file under .perch/rules/.
- Install Perch using Node 22 or newer and sign in once:
npm install -g @lakeday/perch
perch login
- Download the pack, inspect it, and extract it from your repository root. The extraction preserves any existing files:
curl -fL 'https://frameworkrecipes.dev/django/durable-outbox/rule-pack.zip' -o 'perch-guide-django-durable-outbox.zip'
unzip -n 'perch-guide-django-durable-outbox.zip'
The installed rule is .perch/rules/perch-guide-django-durable-outbox.yaml. Its selector matches orders/confirmation.py in this example; adapt the selector to your application file before checking an existing project.
- Configure the coding agent you use. Run one of these commands:
Claude Code:
perch setup claude-code
Codex:
perch setup codex
Cursor:
perch setup cursor
Pi:
perch setup pi
- Ask the agent to edit the implementation and check the saved requirement:
Use the installed Perch skill while editing orders/confirmation.py. Preserve outbox-same-atomic-block. Run perch check orders/confirmation.py --rules outbox-same-atomic-block --json after the edit. Read each finding and the affected code, fix the implementation, and run the identical check again after the fix. Keep the rule and regression tests intact. Run the application's relevant regression tests and report the commands and actual results. Exit 3 means a rule finding; exit 1 or 2 means the check did not complete. Report an unavailable or incomplete check as blocked. Do not claim the application tests ran if only the Perch check ran.
- After repairing a finding, run the same check again and inspect the result:
perch check orders/confirmation.py --rules outbox-same-atomic-block --json
Commit the downloaded rule and the installed agent configuration with your application. The rule file adds no guarantee of correctness; keep the regression tests from this guide.
With the base reference fetched, use perch scan --since origin/main --filter type=lint in CI.
Framework references and verification scope
The dated capture records the source check shown above. Implement the adapters, schema and regression tests described in this guide in your application. Unchanged requests reuse cached answers; fresh model judgments can vary. Model analysis sends relevant source to the configured service.