feat: Recent Objects #6103

ozyx · 2023-01-09T17:22:24Z

Describe your changes:

Adds a "Recent Objects" draggable pane to the main left pane. Keeps track of the 20 most recently visited objects. Includes but distinguishes between objects and alias by displaying the objects' full paths and whether or not it is an alias. A target button next to each list item will scroll the object into view in the main tree. If an object or alias is deleted, its corresponding entries (and its children) in the Recent Objects list will also be removed.

Also adds the ability to persist the position of any Pane with a label attribute. Makes the left pane, inspector pane, and Recent Objects panes' positions persistent.

Screen.Recording.2023-01-09.at.9.32.14.AM.mov

TODO:

Final sanding and shimming for UI/UX @charlesh88 @rukmini-bose
Tests, lots of them (will detail out) @ozyx - will be taken care of in [e2e] More automated tests for Recent Objects #6150
a11y @ozyx

All Submissions:

Have you followed the guidelines in our Contributing document?
Have you checked to ensure there aren't other open Pull Requests for the same update/change?
Is this change backwards compatible? For example, developers won't need to change how they are calling the API or how they've extended core plugins such as Tables or Plots.

Author Checklist

Changes address original issue?
Tests included and/or updated with changes?
Command line build passes?
Has this been smoke tested?
Testing instructions included in associated issue OR is this a dependency/testcase change?

Reviewer Checklist

Changes appear to address issue?
Reviewer has tested changes by following the provided instructions?
Changes appear not to be breaking changes?
Appropriate automated tests included?
Code style and in-line documentation are appropriate?
Has associated issue been labelled unverified? (only applicable if this PR closes the issue)
Has associated issue been labelled bug? (only applicable if this PR is for a bug fix)

This reverts commit bb516d6.

This reverts commit 0b2dc1e.

- Now throws an error if `getRelativeObjectPath` is passed a malformed `navigationPath` - If the generated `objectPath` does not contain 'ROOT', add it - Update some comments, fix some types - Make `get` error message a bit more informative

- Adds the ability to pass in a custom objectPath to the ObjectPath component which will override the OriginalPath it displays by default

- Filter out deleted recents on re-render

- Registers/unregisters compositionCollection remove handlers for composable objects in RecentObjects. - Removes items and their children from the RecentObjects list upon deletion.

…s to appear on hover

ozyx · 2023-01-17T17:19:13Z

95% ready for review, have one failing e2e test to fix

akhenry · 2023-01-17T18:30:48Z

Let's merge this and file a followup for vertical collapse and for the flashing highlight in the tree.

src/api/objects/ObjectAPI.js

scottbell

Looking good @ozyx! I had some review comments

src/ui/layout/RecentObjectsList.vue

scottbell · 2023-01-17T19:14:37Z

src/ui/layout/RecentObjectsList.vue

+         * and registers composition listeners for composable objects.
+         */
+        getSavedRecentItems() {
+            const savedRecentsString = localStorage.getItem(LOCAL_STORAGE_KEY__RECENT_OBJECTS);


Do we want to move any of this to the ObjectAPI?

Good question. We save/load state to localStorage in the same way in mct-tree, so this is certainly mostly boilerplate that can be extracted. I've heard some discussion about revamping localStorage management, not sure if ObjectAPI would be the place though. @akhenry I'm deflecting to you, thoughts?

Either way, feels like something that would warrant its own separate issue/PR

Agree about a separate PR, was mainly curious about architecture here.

scottbell · 2023-01-17T19:19:09Z

Is it supposed to be hidden by default?

It works well though! I like being able to drop recently viewed onto compositions - very handy.

Screen.Recording.2023-01-17.at.8.17.52.PM.mov

ozyx · 2023-01-17T19:29:51Z

Is it supposed to be hidden by default?

Yes, but this part (vertical pane collapse) is currently under construction

@rukmini-bose

- WIP: Styling to be added by @rukmini-bose

davetsay

This looks awesome. I made some comments inline. It looks like you can ignore the vue linting props ones. That used to be a warning. Don't know what changed. Code is clean and well organized. Ideally I would like some of this logic, especially the shared logic with the other trees, extracted out of view/vue logic, but that's for another day.

Need to be fixed.

actions seem broken now (duplicate, move)

Should be fixed

doesn't react to non router changes (aka editing name from browse bar)

UI observations @charlesh88

same color highlight may be okay... but the recent items highlight doesn't go away which then makes it harder to distinguish what is selected and what is just highlighted
it is way more visibly clear and attention drawing than the tree itself. this might be a good thing. just pointing that out

src/api/objects/ObjectAPI.js

src/ui/components/ObjectPath.vue

src/ui/layout/Layout.vue

src/ui/layout/RecentObjectsListItem.vue

src/ui/layout/pane.vue

davetsay · 2023-01-18T22:49:14Z

src/ui/router/ApplicationRouter.js

@@ -390,9 +390,9 @@ class ApplicationRouter extends EventEmitter {
     *
     * @param {string} hash new hash for url
     */
-    hashChaged(hash) {
-        this.emit('change:hash', hash);
+    hashChanged(hash) {


👏 👏 👏

- Fixes an issue with calls to `router.navigate()`. It turns out that if the url passed in has query params in it, the navigation becomes unreliable. Will need further investigation, but for now I've updated the usages of that function and left a comment on the method specifying the format of the hash.

- min-height on vertical pane element. - Font-size, margins tightened up and aligned.

davetsay

really nice job and you fixed all the comments super fast

ozyx added 30 commits December 30, 2022 13:32

feat: add pane for recently viewed

298e9eb

feat: add method getRelativeObjectPath()

b5a2194

feat(WIP): first cut of RecentObjects component

39e9d2a

refactor: fix typo

8372306

fix: emit after changing hash

b8b6b0f

feat(WIP): no duplicates in recent objects

eb150a8

feat(WIP): enforce max number of recent items

bb516d6

refactor(WIP): move common tree logic into a mixin

0b2dc1e

style: make width consistent across both trees

510215e

Revert "feat(WIP): enforce max number of recent items"

ece7ec0

This reverts commit bb516d6.

Revert "refactor(WIP): move common tree logic into a mixin"

378ec21

This reverts commit 0b2dc1e.

feat(WIP): GrandSearchResult recent objects POC

ef15792

fix: identifier regexp works for telemetry also

f733683

fix: no need for regex, actually

b1e187b

fix: handle short or invalid paths

94b3696

fix: key on navigationPath

a6e5e7b

fix: keep the 'ROOT'

91364b5

feat: ObjectPath can show original or relative path

097aa73

refactor: new component for RecentObjectListItems

572ea22

style: add a semicolon 🙃

1731131

refactor: update aria-label and obj destructure

e203154

refactor: use const

a655455

fix: ensure valid navigationPath before continuing

29b5ba3

fix: drop '/ROOT' in objectPathToUrl

e1d57f4

test(fix): setPath to something Open MCT would set it to

891e34f

feat: getRelativeObjectPath to provide mutables if possible

34928fa

feat: custom ObjectPath to override OriginalPath

80cf650

- Adds the ability to pass in a custom objectPath to the ObjectPath component which will override the OriginalPath it displays by default

fix: make RecentObjectsListItem more reactive

7b70fdd

- Filter out deleted recents on re-render

fix: remove items and their children from recents on delete

b91d311

- Registers/unregisters compositionCollection remove handlers for composable objects in RecentObjects. - Removes items and their children from the RecentObjects list upon deletion.

Fix alias arrows using flex. Fix pathway spacing. Fix for target icon…

c6cf1df

…s to appear on hover

rukmini-bose self-assigned this Jan 13, 2023

ozyx requested a review from scottbell January 17, 2023 17:17

ozyx marked this pull request as ready for review January 17, 2023 17:18

scottbell reviewed Jan 17, 2023

View reviewed changes

src/api/objects/ObjectAPI.js Show resolved Hide resolved

scottbell reviewed Jan 17, 2023

View reviewed changes

ozyx and others added 5 commits January 17, 2023 16:58

feat: add class to tree items when targeted

8ae3eb2

- WIP: Styling to be added by @rukmini-bose

fix: initialize to empty string instead of null

dfcff4a

test: fix test selector

2b2c772

Add flash animation to target object

b1eb81e

style: remove is-targeted class on animationend

72f2609

davetsay requested changes Jan 18, 2023

View reviewed changes

ozyx added 2 commits January 19, 2023 11:17

refactor: identifier -> keyString

026e784

chore: fix vue lint issues

05f6b04

ozyx requested a review from davetsay January 19, 2023 19:24

ozyx and others added 5 commits January 19, 2023 13:50

test(e2e): Add test for RecentObjects and stubs

33c99cb

fix: use transactions in Duplicate & Move actions

3acd79a

fix: Use transactions for LinkAction

21e942a

Misc tweaks

9c193e3

- min-height on vertical pane element. - Font-size, margins tightened up and aligned.

rukmini-bose removed their assignment Jan 20, 2023

scottbell approved these changes Jan 20, 2023

View reviewed changes

davetsay approved these changes Jan 20, 2023

View reviewed changes

Merge branch 'master' into mct6053-recent-objects-mark-ii

0efbe4f

davetsay merged commit f98a2cd into master Jan 20, 2023

davetsay deleted the mct6053-recent-objects-mark-ii branch January 20, 2023 18:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Recent Objects #6103

feat: Recent Objects #6103

ozyx commented Jan 9, 2023 •

edited

ozyx commented Jan 17, 2023

akhenry commented Jan 17, 2023

scottbell left a comment

scottbell Jan 17, 2023

ozyx Jan 17, 2023

scottbell Jan 17, 2023

scottbell commented Jan 17, 2023 •

edited

ozyx commented Jan 17, 2023

davetsay left a comment

davetsay Jan 18, 2023

davetsay left a comment

feat: Recent Objects #6103

feat: Recent Objects #6103

Conversation

ozyx commented Jan 9, 2023 • edited

Describe your changes:

All Submissions:

Author Checklist

Reviewer Checklist

ozyx commented Jan 17, 2023

akhenry commented Jan 17, 2023

scottbell left a comment

Choose a reason for hiding this comment

scottbell Jan 17, 2023

Choose a reason for hiding this comment

ozyx Jan 17, 2023

Choose a reason for hiding this comment

scottbell Jan 17, 2023

Choose a reason for hiding this comment

scottbell commented Jan 17, 2023 • edited

ozyx commented Jan 17, 2023

davetsay left a comment

Choose a reason for hiding this comment

davetsay Jan 18, 2023

Choose a reason for hiding this comment

davetsay left a comment

Choose a reason for hiding this comment

ozyx commented Jan 9, 2023 •

edited

scottbell commented Jan 17, 2023 •

edited