Observe Swift task cancellation between bounded order-processing steps

Cancellation is cooperative in Swift. A canceled task may continue a loop unless the operation or loop observes cancellation. Check at safe boundaries before starting another side effect, while preserving a recovery policy for effects already underway.

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 Vapor boundary

Save this illustrative integration module as Sources/App/process.swift.

import Foundation

func processOrders(_ ids: [UUID], apply: @Sendable (UUID) async throws -> Void) async throws {
    for id in ids {
        try Task.checkCancellation()
        try await apply(id)
    }
}

The order, inventory, or resource-lifetime scenario is adapted from Perch’s public order-service source at commit 4af67af. This Vapor implementation is an illustrative adaptation.

Integrate with your application

Run this function inside a request-owned or application-owned structured task, with a bounded batch of IDs. apply must propagate cancellation or have a documented timeout, and external operations need stable idempotency/reconciliation. Do not assume an HTTP disconnect automatically cancels every task created by your service; wire task ownership explicitly. A cancellation check stops the next iteration, not a database or payment operation that already committed.

Exercise the boundary and failure paths

Add regression tests for these cases in your existing Vapor 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:

swift test --filter ProcessingCancellationTests

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:

try Task.checkCancellation()

with:

// Remove the source span shown above.

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-vapor-swift-cancellation-check.yaml at the repository root, keeping your existing perch.yaml:

- name: processing-observes-task-cancellation
  where: "Sources/App/process.swift"
  ensure: >-
    processOrders must call Task.checkCancellation before starting each next order operation.

Install and authenticate the CLI once, then check the current working file:

npm install -g @lakeday/perch
perch login
perch check Sources/App/process.swift --rules processing-observes-task-cancellation --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.

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/.

1. Install Perch using Node 22 or newer and sign in once:

npm install -g @lakeday/perch
perch login

2. Download the pack, inspect it, and extract it from your repository root. The extraction preserves any existing files:

curl -fL 'https://frameworkrecipes.dev/vapor/swift-cancellation-check/rule-pack.zip' -o 'perch-guide-vapor-swift-cancellation-check.zip'
unzip -n 'perch-guide-vapor-swift-cancellation-check.zip'

The installed rule is .perch/rules/perch-guide-vapor-swift-cancellation-check.yaml. Its selector matches Sources/App/process.swift in this example; adapt the selector to your application file before checking an existing project.

3. 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

4. Ask the agent to edit the implementation and check the saved requirement:

Use the installed Perch skill while editing Sources/App/process.swift. Preserve processing-observes-task-cancellation. Run perch check Sources/App/process.swift --rules processing-observes-task-cancellation --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.

5. After repairing a finding, run the same check again and inspect the result:

perch check Sources/App/process.swift --rules processing-observes-task-cancellation --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

• docs.swift.org reference
• docs.vapor.codes reference

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.