feat(editor): work-item descriptions store sanitised HTML only; pages store the validated triple; hardened sanitiser

Offen
  • Stimmt etwas nicht?
#48 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Anfängerfreundlichkeit
32/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
html, rust, sql, wasm
Bereich
backend, database, security

Rechercherichtung

Start by reading the sanitizer in crates/thrust-editor-doc/src/sanitize.rs, its tests in crates/thrust-editor-doc/tests/sanitize.rs, and the migration and contract references named in the issue. Then trace the work item write path and page fallback write path, keeping the blocked-by #44 dependency in view. Done means the acceptance tests pass, the page binary validation rejects invalid Yjs data, the migration stores only the specified work-item fields, and the listed deviations and questions are recorded.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

area:app prio:p0 review:fable-2026-10-19

Context

The slice stores a work item's description as unsanitised text (crates/thrust-adapters-postgres/migrations/0001_init.sql:33; crates/thrust-contracts/src/lib.rs:97, :214; crates/thrust-core/src/lib.rs:260). The sanitiser exists only in the spike crate thrust-editor-doc, behind its sanitize feature, and only thrust-editor-worker depends on it. It provides plane_builder(), Plane's nh3 allow-list (crates/thrust-editor-doc/src/sanitize.rs:100-115); hardened_builder(), which adds value filters (:167-177); validate_binary_data (:208-233); and strip_tags (:235-237). Sanitizer::default() and validate_html_content both use the Plane builder (:192, :197-200). ADR-0012 (accepted in round 27) stores client html, json and binary verbatim at P0 (adrs/ui/0012-editor-and-i18n-reuse.md:33), as decided under Q-F5.1 in round 11 (QUESTIONS.md:153).

Problem

  • FR-14, from spike 0006: work-item descriptions carry no binary (v1 returns it null in 64 of 64; research/0008 §2.1, line 42). The v1 serializer excludes description_json (apps/api/plane/api/serializers/issue.py:73), and the web editor initialises from description_html (apps/web/core/components/editor/rich-text/description-input/root.tsx:239). Only the page fallback path builds all three forms (apps/web/core/hooks/use-page-fallback.ts).
  • Storing client JSON next to sanitised HTML therefore creates two sources of truth, one of them unsanitised.
  • FR-23: the hardened config neutralises 125 of 125 executable payloads, where Plane's allow-list neutralises 116, and it leaves all 195 editor documents unchanged. Plane's allow-list changes 66 of the 195 for exactly two reasons: it strips issue-embed-component (5 documents) and rewrites rel (61) (research/0008 §7, lines 217-229).
  • At P1 the Rust converter derives the binary from HTML (§8).

Proposal

  • Work items store description_html (sanitised) and description_stripped (strip_tags of the sanitised HTML). There is no description_json or description_binary column at P0. Compat and v1 writes accept description_json and discard it. At P1, thrust-editor-doc derives JSON and the binary on first collab open.
  • Pages store the triple the fallback path sends. The HTML is sanitised. The binary is base64-decoded and checked with validate_binary_data, as Plane's PageBinaryUpdateSerializer does (apps/api/plane/app/serializers/page.py:180-198), and also checked to decode with yrs. Plane does not do that last check, so record it with the deviations below. Pages are an M3 screen, so this half lands with the pages work.
  • Sanitiser changes:
    • Make the hardened builder the default.
    • Allow issue-embed-component and its five attributes.
    • Preserve rel (turn off ammonia's link_rel and allow rel on a).
    • Accept that ammonia 4.x output is not byte-identical to nh3's 4.0.0.
    • Sanitise in the use-case layer, so compat and v1 share one path, and record the schema version (ADR-0012).
  • Record deviations D-016 to D-020 (handoff A4.4). Build no browser-flavour renderer (Q-0012.4).

Acceptance criteria

  • The migration gives work items description_html and description_stripped, and neither description_json nor description_binary.
  • A contract test sends one payload of each of the nine classes that survive Plane's allow-list (research/0008 §7, line 225) through create and update, and reads every one back neutralised. Control: with plane_builder() as the default, the test fails.
  • allow_list_preservation_of_editor_html (crates/thrust-editor-doc/tests/sanitize.rs:15-64) asserts 195 of 195 parse-equal under the new allow-list instead of only printing counts. Control: under plane_builder() it fails (129 of 195).
  • A page write with a truncated or non-Yjs binary gets a 400, and a valid fallback triple is stored.
  • DEVIATIONS.md has D-016 to D-020, and Q-0012.2, Q-0012.4, Q-F5.1 and Q-0061.4 are answered.

References

  • Review: .agents/plans/contrail/reviews/2026-10-19-fable-architecture-review.md (FR-14, FR-23)
  • research/0008-editor-conversions.md §2.1, §5 rows 7 and 8, §5.3, §7, §8, §11
  • ADR-0012 (:33; round-29 note), ADR-0061 (round-29 note); DEVIATIONS D-012, C-5, D-016 to D-020
  • Q-F5.1, Q-0012.2, Q-0012.4, Q-0061.4
  • crates/thrust-editor-doc/src/sanitize.rs:14, :100-115, :167-237; tests/sanitize.rs:15-64, :225-243
  • Plane oracle: apps/api/plane/api/serializers/issue.py:73; apps/api/plane/app/serializers/page.py:173-198; apps/web/core/components/editor/rich-text/description-input/root.tsx:239
  • Beads: plane-byd.6

Blocked by: #44

Finding: FR-14, FR-23

Vorherrschende Sprache
Rust
Sterne
0
Forks
0
Ø Merge
1 Std. 35 Min.
Gemergte PRs (30 T.)
67

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus aRustyDev/thrust

Alle Issues in aRustyDev/thrust

Ähnliche Issues

Weitere Issues zu Rust

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.