Skip to content

fix(soft-delete): support delegate and mixin models#2726

Merged
ymc9 merged 1 commit into
devfrom
fix/soft-delete-delegate-mixin
Jun 18, 2026
Merged

fix(soft-delete): support delegate and mixin models#2726
ymc9 merged 1 commit into
devfrom
fix/soft-delete-delegate-mixin

Conversation

@ymc9

@ymc9 ymc9 commented Jun 18, 2026

Copy link
Copy Markdown
Member

Summary

The soft-delete plugin previously broke on models whose @deletedAt marker is inherited rather than declared directly on the queried model — specifically mixin-composed models and delegate (polymorphic) models. This PR makes both work at runtime.

Mixin models

A @deletedAt declared on a type mixin is flattened into the consuming model's fields, so it already resolves correctly — added a runtime test to lock that in.

Delegate (polymorphic) models

The marker physically lives on the base table, but it surfaces on every concrete sub-model's field list (tagged with originModel). Two problems followed:

  1. Crash — the plugin emitted Article.deletedAt IS NULL, but that column only exists on the base Content. Fixed by having getDeletedAtField skip inherited (originModel) markers.
  2. Leak — a concrete delegate read is FROM Article LEFT JOIN Content. Putting the filter in the join's ON clause on a LEFT join only nulls the joined columns instead of excluding the row. Fixed by walking the base chain in the read filter and keying the IS NULL predicate off the base table in the outer WHERE.

transformJoin now skips any delegate-hierarchy member: those markers are always handled by transformSelectQuery (reconstruction joins via the outer WHERE, relation reads via their subquery's own FROM). Adding an ON-clause predicate for a hierarchy member is at best redundant and, on a LEFT reconstruction join, leaks the soft-deleted row.

Deletes already work once reads are fixed: the ORM rewrites a concrete delegate delete into a delete on the base table, which the plugin converts to an UPDATE <base> SET deletedAt.

Tests

  • soft-deletes a model whose @deletedAt is inherited from a mixin
  • soft-deletes a delegate model marked on the base (delete through both the concrete and base accessors)
  • does not update an already soft-deleted delegate row

All soft-delete tests pass (18 passing, 2 pre-existing dialect-specific skips), lint and typecheck clean.

Known limitation (out of scope)

For a polymorphic hierarchy, the @deletedAt marker should live on the root @@delegate base. A marker on a mid-level model is bypassed by deletes (the ORM cascades the delete up to the root, which has no marker, causing a hard delete). Worth a separate validation/doc follow-up.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Bug Fixes
    • Fixed soft-delete filtering logic to correctly handle polymorphic and delegate model hierarchies when @deletedAt markers are inherited from parent models or type mixins.
    • Improved handling of soft-delete conditions in joined queries to prevent incorrect filtering in complex model relationships.

The soft-delete plugin previously broke on models whose `@deletedAt`
marker is inherited rather than declared directly on the queried model:

- **Mixin models** (`@deletedAt` from a `type` mixin) now soft-delete
  correctly — the marker is flattened into the model's fields.
- **Delegate (polymorphic) models** marked on the base now filter reads
  and rewrite deletes correctly. The marker physically lives on the base
  table, so `getDeletedAtField` skips inherited (`originModel`) markers,
  and the read filter walks the base chain to key the `IS NULL` predicate
  off the base table in the outer WHERE.
- `transformJoin` skips any delegate-hierarchy member: those markers are
  always handled by `transformSelectQuery` (reconstruction joins via the
  outer WHERE, relation reads via their subquery FROM). Adding an
  ON-clause predicate on a LEFT reconstruction join would only null the
  joined columns and leak the soft-deleted row.

Adds runtime tests for the mixin case, the delegate case (delete through
both the concrete and base accessors), and a regression test ensuring
updates can't touch an already soft-deleted delegate row.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c0fed0d3-e554-4e35-8809-6438fed3c3db

📥 Commits

Reviewing files that changed from the base of the PR and between 8d46a7f and 0da3bda.

📒 Files selected for processing (2)
  • packages/plugins/soft-delete/src/plugin.ts
  • packages/plugins/soft-delete/test/soft-delete.test.ts

📝 Walkthrough

Walkthrough

The SoftDeleteHandler in the soft-delete plugin is updated to correctly handle @deletedAt markers in polymorphic/delegate model hierarchies. Join ON-clause predicates are skipped for hierarchy members, @deletedAt IS NULL conditions are resolved to the physical base-table column, and getDeletedAtField ignores fields surfaced via originModel. Three new tests cover these scenarios.

Changes

Soft-delete delegate hierarchy fix

Layer / File(s) Summary
Delegate-aware filtering and target resolution
packages/plugins/soft-delete/src/plugin.ts
transformJoin early-returns without an ON-clause predicate when the joined model is part of a delegate hierarchy. buildSoftDeleteFilterForTables resolves a per-entry soft-delete target via new helpers getSoftDeleteTarget and isInDelegateHierarchy, which walk the baseModel chain to find where @deletedAt physically lives. getDeletedAtField skips fields whose originModel is set, preventing references to non-existent sub-model columns.
Tests for mixin, delegate, and update-on-deleted
packages/plugins/soft-delete/test/soft-delete.test.ts
createSoftDeleteTestClient gains an optional extraOptions parameter. Three new test cases assert: soft-delete visibility when @deletedAt comes from a type mixin; hide-on-delete through both concrete and base accessors for a delegate hierarchy; and zero-effect updateMany/update for already soft-deleted delegate rows.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • zenstackhq/zenstack#2688: Introduced the core soft-delete @deletedAt join/query filtering and delete→update rewriting logic in plugin.ts that this PR directly modifies to fix delegate hierarchy handling.

Poem

🐇 Hoppity-hop through the delegate chain,
No phantom columns shall cause us pain!
The base table holds where deletedAt lives,
Each IS NULL check precisely gives.
Mixins and hierarchies, now aligned just right —
Soft-delete hops on, everything bright! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly describes the primary changes: fixing soft-delete plugin support for delegate and mixin models, which matches the core objectives of the PR.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/soft-delete-delegate-mixin

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.

@ymc9 ymc9 merged commit 897df21 into dev Jun 18, 2026
8 checks passed
@ymc9 ymc9 deleted the fix/soft-delete-delegate-mixin branch June 18, 2026 05:20
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