Activity Changelog UI #909

jeffpamer · 2023-09-28T22:00:25Z

This adds a first-pass UI for the activity directive changelog. The 10 most recent modifications to an activity directive are stored in a rolling list in the database. Clicking the changelog in the activity directive form header allows viewing a list of changelog entries with diffs displayed (when possible) between each revision. From there the user can either directly restore a revision, or preview the differences between that revision and the current one and decide whether to restore from there.

There are some edges cases and strange scenarios we may likely need to iterate on from here. For instance:

I found some scenarios where I couldn't determine any changes between two revisions. Such as when creating a new preset from the activity's current parameters. This causes an entry to be written to the changelog, but no parameters change.
At the moment it doesn't seem like we have a way of differentiating multiple changes occurring as a result of using the API, or selecting a preset, etc. We may need to look into storing preset selection as one of the changes if we want to call that out specifically in the changelog.

AaronPlave · 2023-10-02T18:14:03Z

I found some scenarios where I couldn't determine any changes between two revisions. Such as when creating a new preset from the activity's current parameters. This causes an entry to be written to the changelog, but no parameters change.

Is this change revertible? And if not should it even be stored in the changelog?

src/components/activity/ActivityDirectiveChangelog.svelte

jeffpamer · 2023-10-02T21:18:12Z

Really appreciate your thorough review here @AaronPlave. I'll try to push up some changes for the more immediately actionable items shortly, but I'm unfortunately quite time restricted on how much time I can spend on Aerie this week. We might need to have a discussion about whether these pain points are blockers or can be iterated on later?

AaronPlave · 2023-10-03T16:40:29Z

Really appreciate your thorough review here @AaronPlave. I'll try to push up some changes for the more immediately actionable items shortly, but I'm unfortunately quite time restricted on how much time I can spend on Aerie this week. We might need to have a discussion about whether these pain points are blockers or can be iterated on later?

Yeah we should tag up about what tweaks, if any, are needed to get this first version out.

duranb · 2023-10-03T18:44:50Z

I found some scenarios where I couldn't determine any changes between two revisions. Such as when creating a new preset from the activity's current parameters. This causes an entry to be written to the changelog, but no parameters change.

Is this change revertible? And if not should it even be stored in the changelog?

I don't think that the creation of the preset should be revertible since it's not necessarily plan specific. You're seeing an entry in the changelog probably because upon creation, the UI also sends a query to assign after successfully creating. I think that maybe the assignment should at least be revertible if that data is tracked.

duranb

I'm seeing a small styling issue with the Restore/Preview buttons being stacked for just the "Earliest" revision. The other revision buttons are 👌🏻

duranb · 2023-10-03T22:18:46Z

Another suggestion for a different PR is maybe adding some loading state after clicking "Restore". In my plan that has 180 directives, I'm noticing that the directive's value that I restored doesn't get set until a second later after clicking "Restore". For that second I thought that I didn't click the right button.

…tivity in changelog header

jeffpamer · 2023-10-12T22:49:33Z

Pushed up a couple more changes to more generically handle diffing of objects (so we're recursively comparing them by value), so that we can display a nicer diff of changes nested in more complex parameter types. And also added tooltips for text labels that may be potentially cutoff by overflow.

AaronPlave

Looks great, I'm sure we'll have some feedback on it that will help us figure out the next iteration.

src/utilities/permissions.ts

jeffpamer · 2023-10-13T20:02:42Z

Updated the auto-close logic to look specifically for a changing selected activity ID, so we don't hit that side effect where and update to the current activity also closes the changelog. I also updated the permissions check to consider plan ownership/collaborator.

Resolved as directed. Dismissing in case we want to merge today.

* Rough first pass at fetching changelog and displaying results per activity * Basic working UI for change log, no restore or preview * Account for anchor differences * small formatting fixes and type corrections * Catch scenarios with no changes, e.g. creating a preset * remove unused data, format durations * move changelog button into activity name header * wire up effect for restoring from changelog * Close the changelog if the selected activity changes * use new changelog icon * Basic working revision preview * Add header and 'restore' action to revision preview * more efficient effective arguments construction * add Last Modified By to activity directive form * Add permission handling * fix linter errors * drive anchor offset detection from props instead of activity object * Fix tests. Add basic handling of array/struct types * Fix date formatting, username display, and padding * Display Start Time in DOY format * re-run validations with preview arguments if supplied * use revision when getting effective arguments, use current name of activity in changelog header * constrain width to always have enough room for restore/preview buttons * add more generic method for deep diffing objects * add tooltip for overflowed values * hook changelog auto-closing to a change in selected ID * Update restore permissions check to account for plan ownership

jeffpamer requested a review from a team as a code owner September 28, 2023 22:00

jeffpamer requested review from AaronPlave and duranb September 28, 2023 22:00

jeffpamer had a problem deploying to test-workflow September 28, 2023 22:00 — with GitHub Actions Failure

jeffpamer linked an issue Sep 28, 2023 that may be closed by this pull request

Implement first cut of activity change log in UI #821

Closed

jeffpamer added the feature New feature or request label Sep 28, 2023

jeffpamer had a problem deploying to test-workflow September 28, 2023 22:27 — with GitHub Actions Failure

jeffpamer had a problem deploying to test-workflow September 29, 2023 00:09 — with GitHub Actions Failure

jeffpamer had a problem deploying to test-workflow September 30, 2023 00:19 — with GitHub Actions Failure