[CMSUI] - History route #30

Activity

1. sneridagh

   added

   04 type: enhancementmaking existing stuff bettermaking existing stuff better

   on Feb 5, 2025
2. sneridagh

   added this to Auroraon Feb 5, 2025
3. sneridagh

   added the

   Feature

   issue type on Feb 5, 2025
4. sneridagh

   added

   06 type: plip task

   and removed

   04 type: enhancementmaking existing stuff bettermaking existing stuff better

   on Feb 6, 2025
5. github-project-automation

   added this to Bucharest Sprint 2025on Mar 18, 2025
6. sneridagh

   removed this from Bucharest Sprint 2025on Mar 20, 2025
7. pnicolli

   moved this to Todo in Auroraon Oct 18, 2025
8. github-project-automation

   added this to Beethoven Sprint 2026on Dec 10, 2025
9. github-project-automation

   moved this to Backlog in Beethoven Sprint 2026on Dec 10, 2025
10. arybakov05

    added this to Pole Position Sprint 2026on May 26, 2026
11. github-project-automation

    moved this to Backlog in Pole Position Sprint 2026on May 26, 2026
12. sneridagh

    added a parent issue on Jun 4, 2026

    • @plone/cmsui - Aurora CMSUI as a standalone app #3
13. github-project-automation

    added this to Bucharest Sprint 2025on Jun 4, 2026
14. sneridagh

    transferred this issue fromplone/voltoon Jun 4, 2026
15. 9 remaining items

    Load more
16. mliebischer

    added 6 commits that reference this issue on Jun 11, 2026

    Show pending and error feedback in the revert dialog (#30)

    ...

    e5ebe28

    Harden the History list rendering (#30)

    ...

    3206138

    Translate the History toolbar button label (#30)

    ...

    70d8e6c

    Extend test coverage for the History view (#30)

    ...

    ce7cfb5

    Add the Plone Site type to the content type map (#30)

    ...

    c5a953e

    Add news fragments for the aurora and client changes (#30)

    b01174c
17. arybakov05

    moved this from Todo to In Progress in Auroraon Jun 11, 2026
18. mliebischer

    added a commit that references this issue on Jun 11, 2026

    Show workflow state transitions in the History list (#30)

    ...

    cd2f0aa
19. mliebischer commented on Jun 11, 2026

    

    mliebischer

    on Jun 11, 2026 · Pinned by mliebischer

    Last edited by mliebischer

    More actions

    Status update (2026-06-12)

    PR #120 implements the history list part of this issue, including revert with a confirmation dialog and viewing older revisions, covered by unit, integration, and Playwright acceptance tests.

    Done in #120

    • @@history route (Quanta Table, styled to match @@contents: breadcrumb, layout width, status dot, relative timestamps with an absolute-date tooltip).
    • Per-row actions menu on versioning entries: Review changes is rendered disabled until the diff view exists, View this revision, Revert to this version (destructive red, with a confirmation dialog incl. pending and error feedback).
      
    • "View this revision" works end to end: the content middleware resolves the ?version query parameter, and a getContent bug was fixed where the expand parameter was dropped whenever a version was requested (@plone/client).
    • Workflow rows show the state transition Volto-style (Publish (Private → Published), using the backend-translated state titles) — without Volto's literal undefined when no previous state exists. Resolved 2026-06-12: this wording is final (see the resolved questions below).
    • The History toolbar button is hidden on the site root (Plone Site has no history — same guard as Volto's More.jsx); the site root type was added to the ContentTypeMap in @plone/types.
    • Anonymous visitors are redirected to the login on published content and cannot access old revisions (backend permission, covered by a test).

    Remaining in this issue

    • Diff / "Review changes" view (per the Figma frame Operative - Review changes): Base/Compare version selects, unified/split display toggle, field-by-field diff (deletions red, insertions green). Data via getHistoryVersion, comparison computed client-side. Maps to Volto's Diff.jsx / DiffField.jsx.

    • Known bug (Change notes entered in the edit form are never submitted #129): change notes entered in @@edit do not show up in the History "Change note" column. The column renders the comments field from @history correctly; the likely cause is that the edit form never submits the change note with the save request (Volto's form sends changeNote).

    Open questions

    Resolved questions (with @pnicolli & @jmevissen) (kept for context)

    Table-header … menu — resolved 2026-06-12: deliberately NOT implemented. Likely over-designed in Figma (the designers may not have known Plone that deeply); no good use case for configurable columns on the History route.

    Table-header … menu: the Figma frame has a … control in the table header, separate from the per-row actions menu.
    
    Its menu is not shown in the design, and there is no equivalent in Volto. What should it do (column configuration)? Same as on folder contents frame on Figma? Confirm whether the History view needs it (it has only a few fixed columns).

    Action labels for workflow transitions — resolved 2026-06-12: the Volto-style transition_title (prev → state) labels shipped in #120 are final; the Figma wording ("Created in Private", "Published from Private") is not adopted.

    Action labels for workflow transitions: the frame shows "Created in Private" and "Published from Private", but only for create/publish.
    
    The REST @history payload gives transition_title and the resulting state_title; the previous state has to be derived. Confirm the wording rule for the remaining transitions (e.g. submit, retract, reject) so the labels read well and stay translatable. Interim, shipped in #120: Volto-style transition_title (prev → state) labels using the backend-translated state titles.

    Quanta Modal width — resolved 2026-06-12: tracked in #130, will be fixed there later (not in this issue).

    Quanta Modal width (filed as #130): Modal.quanta hardcodes w-full max-w-[90vw] and ignores a passed className (unlike Dialog.quanta, which merges it). The Figma design shows much narrower confirmation modals; this affects all Quanta Modal consumers (DeleteModal, UploadModal, the revert dialog).

    CMSUI stylesheets / Metropolis font — resolved 2026-06-12: will be fixed centrally later (CMSUI-wide stylesheet/layout consolidation), not in this issue.

    CMSUI stylesheets / Metropolis font: @plone/components/dist/quanta.css (which carries the Metropolis body font) is only loaded by the contents layout route, so all cmsui routes render in the fallback font. Should the cmsui layout load basic.css/quanta.css too, pending the quanta-tailwind migration?

    Row-actions popover — resolved 2026-06-12: will be fixed centrally later via a shared component (see the upcoming "CMSUI main template / shared layout parts" issue), not in this issue. The styling deviation from @@contents stays a known limitation of #120 until then.

    Row-actions popover: the History row menu uses the Quanta Menu and so differs in styling and behavior from @@contents' local ItemActionsPopover (icon trigger, plain popover list, red destructive item). Aligning them needs a shared actions-popover component — cmsui must not depend on contents, and duplicating the contents implementation was deliberately avoided. Which package should host it?

    The breadcrumb mirrors @plone/contents' inline Quanta breadcrumb — resolved 2026-06-12: will be fixed centrally via the shared CMSUI layout parts, see #137.

    The breadcrumb mirrors @plone/contents' inline Quanta breadcrumb instead of sharing a component

    Locale strategy for dates — resolved 2026-06-12: nothing left to decide in the History route. The decision (Aurora-managed locale instead of the browser locale) and the central fix belong to #68 (Formatted Date component); the History view follows once that lands.

    Locale strategy for dates: react-aria's useDateFormatter follows the browser locale (no I18nProvider is set), while UI strings follow the i18next app language — two locale sources on the same screen (affects @@contents as well). Should the locale be managed by Aurora instead? (Raised in #68, the Formatted Date component port, where this needs to be decided anyway.)

    Known limitations / follow-ups (deliberately out of scope for #120)

    These should be solved globally in Aurora, not inline in this route:

    • Workflow state colors are a local mapping (the status dot) that mirrors @plone/contents' ReviewState; unknown states fall back to a neutral dot. Like Volto's config/Workflows.js, this needs a single, configurable mapping of review state to color (custom workflows, themes), consolidated into one shared component used by both @plone/contents and @plone/cmsui — tracked in Configurable workflow state colors #128.
      
    • Relative-time formatting ("2 minutes ago") still lives in the view; extraction into a shared helper, like in @plone/helpers or the utility registry, for reuse across the app is a follow-up.
    • ?version is honored globally by the content middleware: a hand-crafted /@@edit/...?version=N URL loads the old revision into the edit form. A guard limiting ?version to public content paths (Volto behavior: only the public view passes the version to getContent) was implemented and verified in Add History route (#30) #120, but pulled out again so the behavior can be designed separately (pathname heuristic vs. explicit per-route opt-in) — tracked in Decide how the content middleware should scope the ?version query parameter (introduced by #120) #138.
20. mliebischer

    added a commit that references this issue on Jun 12, 2026

    Restrict ?version to public content paths in the middleware (#30)

    04e5654
21. jmevissen

    added a sub-issue on Jun 12, 2026

    • Change notes entered in the edit form are never submitted #129
22. mliebischer

    pinned a comment on Jun 12, 2026
23. mliebischer

    marked this as blocked on Jun 12, 2026

    • Decide how the content middleware should scope the ?version query parameter (introduced by #120) #138
24. mliebischer

    moved this from In progress to ToDo in Pole Position Sprint 2026on Jun 16, 2026
25. pnicolli

    moved this from ToDo to In progress in Pole Position Sprint 2026on Jun 20, 2026