Skip to content

Validate Apalis route queue closure (backend-5.2.1) #357

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
leynos wants to merge 6 commits into
base: main
Choose a base branch
from
+532 −830
Open

Validate Apalis route queue closure (backend-5.2.1) #357

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8c4181f
Draft Apalis route queue closure plan
leynos May 20, 2026
cbfd070
Record Apalis queue validation progress
leynos May 26, 2026
f29c996
Reconcile Apalis queue documentation
leynos May 26, 2026
4f41ac4
Record full Apalis queue gate evidence
leynos May 26, 2026
77b2f0d
Close Apalis route queue roadmap item
leynos May 26, 2026
01ad786
Record final queue review evidence
leynos May 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/backend-roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,7 @@ queue, cache, and repository ports defined in section 1.

### 5.2. Queue adapter (Apalis)

- [ ] 5.2.1. Implement `RouteQueue` using Apalis with PostgreSQL backend,
- [x] 5.2.1. Implement `RouteQueue` using Apalis with PostgreSQL backend,
replacing the current stub adapter.
- [ ] 5.2.2. Define job structs for `GenerateRouteJob` and `EnrichmentJob`.
- [ ] 5.2.3. Implement retry policies with exponential backoff and dead-letter
Expand Down
8 changes: 4 additions & 4 deletions docs/developers-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -637,7 +637,7 @@ The hexagonal boundary is enforced via visibility:
|--------------------------------------|---------------------------|--------------------------------------------|
| `ApalisRouteQueue<P>` | `pub` | Public adapter for domain use |
| `ApalisPostgresProvider` | `pub` | Production `QueueProvider` implementation |
| `GenericApalisRouteQueue<P, Q>` | Internal; not re-exported | Generic adapter implementation |
| `GenericApalisRouteQueue<P, Q>` | `pub` | Generic adapter and BDD harness seam |
| `QueueProvider` | `pub(crate)` | Test seam for provider abstraction |
| `test_helpers::FakeQueueProvider` | `pub(crate)` (test-only) | In-memory test double |
| `test_helpers::FailingQueueProvider` | `pub(crate)` (test-only) | Always-failing test double |
Expand All @@ -659,10 +659,10 @@ Public production API:

Implementation details within `outbound::queue`:

- `GenericApalisRouteQueue<P, Q>` – Declared `pub` inside the private
`apalis_route_queue` module, but not re-exported at crate root. It
- `GenericApalisRouteQueue<P, Q>` – Re-exported beside the production alias
because the BDD harness constructs the adapter with a test provider. It
parameterises the adapter over the queue provider type `Q` so tests can
substitute doubles.
substitute doubles, while production code should prefer `ApalisRouteQueue<P>`.
Comment on lines +662 to +665
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 26, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Correct spelling to match en-GB-oxendict and fix line wrapping.

Line 664 uses "parameterises" which conflicts with the en-GB-oxendict guideline requiring -ize endings. Line 665 exceeds 80 columns when indentation is included.

📝 Proposed fix 
-- `GenericApalisRouteQueue<P, Q>` – Re-exported beside the production alias
-  because the BDD harness constructs the adapter with a test provider. It
-  parameterises the adapter over the queue provider type `Q` so tests can
-  substitute doubles, while production code should prefer `ApalisRouteQueue<P>`.
+- `GenericApalisRouteQueue<P, Q>` – Re-exported beside the production alias
+  because the BDD harness constructs the adapter with a test provider. It
+  parameterizes the adapter over the queue provider type `Q` so tests can
+  substitute doubles, while production code should prefer
+  `ApalisRouteQueue<P>`.

Triage: [type:spelling] [type:docstyle]

As per coding guidelines, use en-GB-oxendict with -ize endings: 'parameterize' not 'parameterise'. Paragraphs and bullet points must be wrapped at 80 columns.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- `GenericApalisRouteQueue<P, Q>` – Re-exported beside the production alias
because the BDD harness constructs the adapter with a test provider. It
parameterises the adapter over the queue provider type `Q` so tests can
substitute doubles.
substitute doubles, while production code should prefer `ApalisRouteQueue<P>`.
- `GenericApalisRouteQueue<P, Q>` – Re-exported beside the production alias
because the BDD harness constructs the adapter with a test provider. It
parameterizes the adapter over the queue provider type `Q` so tests can
substitute doubles, while production code should prefer
`ApalisRouteQueue<P>`.
🧰 Tools
🪛 LanguageTool

[typographical] ~662-~662: Consider using an em dash in dialogues and enumerations.
Context: ...ue: - GenericApalisRouteQueue<P, Q>` – Re-exported beside the production alias...

(DASH_RULE)

[uncategorized] ~664-~664: Do not mix variants of the same word (‘parameterise’ and ‘parameterize’) within a single text.
Context: ... the adapter with a test provider. It parameterises the adapter over the queue provider typ...

(EN_WORD_COHERENCY)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/developers-guide.md` around lines 662 - 665, Update the doc paragraph
describing GenericApalisRouteQueue<P, Q> to use the en-GB-oxendict -ize
spelling: replace "parameterises" with "parameterize" and reflow the sentence(s)
so no line (including indentation) exceeds 80 characters; ensure the references
to GenericApalisRouteQueue<P, Q> and ApalisRouteQueue<P> remain intact and the
meaning (that tests substitute a queue provider Q while production uses
ApalisRouteQueue<P>) is preserved.

- `QueueProvider` – Declared `pub(crate)` inside the private
`apalis_route_queue` module. Defines `async fn push_job(&self,
payload: serde_json::Value) -> Result<(), JobDispatchError>` as the test
Expand Down
Loading