Skip to content
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.

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

feat: allow editors to summarise operations in "History" timeline #4283

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

jessicamcinchak
Copy link
Member

@jessicamcinchak jessicamcinchak commented Feb 9, 2025

A small indepedent feature that we need to support both templates and publishing tickets in this SOW (similar to flows being published & offline by default) is the ability for editors to insert "comments" into the current "History" timeline.

The "History" timeline currently reads from operations and displays a human translation of the JSON OT. Operations will remain the only timeline items that can be "restored", but the "comments" will allow editors to insert notes which essentially act like subheaders on the timeline between groups of operations to contextualise the bigger picture (eg "Implemented new CIL Form 1") between publishes (which may still include 1,000s of individual node operations).

These will enable us to show more friendly change logs on publish as well as help templated flow users understand how the source template content has been changing.

It's in our interest to introduce this feature early, not under the "TEMPLATES" feature flag, so that editors can actually start using it in the meantime even though we are not adjusting the "Check for changes to publish" dialog just yet.

Todo:

  • Create new table & fkey relationships flow_change_logs
  • Add basic UI for teamEditors to insert comments about their flows
  • Display comments in current "History" timeline alongside operations
    • Add a second subscription and simply concat+sort responses? Make a new view to subscribe to in single go or try the _stream query option in Hasura? (If a view-based approach, should we join published flows too?)

Copy link

github-actions bot commented Feb 9, 2025

🤖 Hasura Change Summary compared a subset of table metadata including permissions:

Tracked Tables (1)

  • public.flow_change_logs permissions:

    insert select update delete
    demoUser
    platformAdmin
    teamEditor
    24 added column permissions
    insert select update
    demoUser ➕ actor_id
    ➕ comment
    ➕ flow_id
    ➕ actor_id
    ➕ comment
    ➕ created_at
    ➕ flow_id
    ➕ id
    platformAdmin
    teamEditor

Updated Tables (1)

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