[Dashboard] Add "Creator" column to dashboard listing page #182256

Dosant · 2024-05-01T15:13:17Z

Summary

close #182253

This PR adds a creator column to the dashboard's listing page:

if none of the dashboards have a creator, the column is not rendered
if creator is empty, then the cell is empty
the column is not sortable because on the table level we only have user ids and it doesn't make sense to sort by them. I prefer to not block the dashboard rendering with the additional getAllUsers request to make the column sortable. Now the users are only fetched on the cell level during rendering, so we only fetch visible users. I hope this is an OK tradeoff that favors table's first paint and simplicity of implementation

Dosant · 2024-05-02T07:28:32Z

/ci

…fix'

…eator-column

Dosant · 2024-05-02T07:45:25Z

/ci

Dosant · 2024-05-02T11:46:19Z

/ci

elasticmachine · 2024-05-02T13:00:20Z

Pinging @elastic/kibana-presentation (Team:Presentation)

elasticmachine · 2024-05-02T13:00:20Z

Pinging @elastic/appex-sharedux (Team:SharedUX)

Heenawter

Not sure if there is an easier way to test the "No user" situation (imported dashboards get metadata injected, so even manually removing it won't work) - but I ended up checking out a PR from before #179344 was merged and ran that in order to create the "No user" dashboards. (Please let me know if there is an easier way 🙈)

In this test, I noticed that the "Created by" column only gets filtered out on hard refresh:

Screen.Recording.2024-05-02.at.9.51.06.AM.mov

This isn't the best UX, but also not sure how common of an experience this will be?

I prefer to not block the dashboard rendering with the additional getAllUsers request to make the column sortable.

💯 I think performance of the listing page is much more important than sorting. That being said, we could still render the listing page and show a loading state for just the creator column, no? And, assuming if we resolve what I noted above, this column could still be hidden if, after the request is completed, none of the dashboards have created-by metadata.

That being said, none of the things I've mentioned here (or in the attached comments) are blockers - so I'm approving :) So excited to see this work! 🎉

Heenawter · 2024-05-02T15:15:27Z

packages/content-management/table_list_view_table/src/components/user_avatar_tip.tsx

+    return (
+      <UserAvatarTipComponent
+        user={query.data.user}
+        avatar={query.data.data.avatar}
+        size={'s'}
+        data-test-subj={`userAvatarTip-${query.data.user.username}`}
+      />
+    );


Not a blocker, but we see similar truncation issues that the "Created by" filter had:

cc @elastic/kibana-security

Haha, thanks :) I fixed the popover but didn't notice the toolip

Good find @Heenawter ! @Dosant should I create an issue for any of our teams to handle that or are you planning to fix it in this PR?

I'll create an issue

Heenawter · 2024-05-02T15:57:49Z

packages/content-management/table_list_view_table/src/__jest__/created_by_column.test.tsx

+  test("shouldn't render created by column when createdBy is disabled", async () => {
+    render(<TableListView {...requiredProps} />);
+
+    // wait until first render
+    expect(await screen.findByTestId('itemsInMemTable')).toBeVisible();
+
+    expect(() => screen.getByTestId(/tableHeaderCell_createdBy/)).toThrow();
+  });


Nice 🎉 Good to have this test since it's not an easy situation to encounter.

Heenawter · 2024-05-02T16:12:31Z

packages/content-management/table_list_view_table/src/components/user_avatar_tip.tsx

+  const query = useQuery(
+    ['user-profile', props.uid],
+    async () => {
+      return getUserProfile(props.uid);
+    },
+    { staleTime: Infinity }
+  );


Because we are only using the uid as our query key here, it looks like the custom avatars don't get refetched until after a hard refresh:

Screen.Recording.2024-05-02.at.9.13.37.AM.mov

I don't consider this to be a blocker by any means, because I don't think it's critical that this gets updated right away necessarily - especially if this would impact performance. But figured it was worth noting.

Dosant · 2024-05-03T07:55:53Z

Not sure if there is an easier way to test the "No user" situation (imported dashboards get metadata injected, so even manually removing it won't work) - but I ended up checking out a PR from before #179344 was merged and ran that in order to create the "No user" dashboards. (Please let me know if there is an easier way 🙈)

I think when you install some "managed" dashboards from integrations, they usually won't have creator, because they are created by the internal user.
There is also an edge case that there is no creator when you create a dashboard using API with API KEY

I noticed that the "Created by" column only gets filtered out on hard refresh:
This isn't the best UX, but also not sure how common of an experience this will be?

It seems that this logic was written for "last_updated_at" column and I think it was intentional to prevent unwanted table shift layouts. I think this fine. But your screenshot made me want to add a question icon tip next to "Creator" column label explaining that only new dashboards get creator.

sebelga

LGTM! Tested locally and works as expected 👍

sebelga · 2024-05-03T09:33:04Z

Because we are only using the uid as our query key here, it looks like the custom avatars don't get refetched until after a hard refresh

We should be able to refetch when component mounts with react query retryOnMount maybe?

Dosant · 2024-05-03T11:55:05Z

@elasticmachine merge upstream

…a into d/2024-05-01-creator-column

kibana-ci · 2024-05-03T13:55:56Z

💚 Build Succeeded

Buildkite Build
Commit: e3a85c4

Metrics [docs]

Module Count

Fewer modules leads to a faster build time

id	before	after	diff
`dashboard`	462	465	+3
`eventAnnotationListing`	535	538	+3
`filesManagement`	165	168	+3
`graph`	273	276	+3
`maps`	1182	1185	+3
`visualizations`	428	431	+3
total			+18

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`dashboard`	397.1KB	399.1KB	+2.0KB
`eventAnnotationListing`	203.3KB	205.3KB	+2.0KB
`filesManagement`	91.9KB	93.9KB	+2.0KB
`graph`	391.1KB	393.1KB	+2.0KB
`maps`	3.0MB	3.0MB	+2.0KB
`visualizations`	276.5KB	278.5KB	+2.0KB
total			+12.0KB

History

💚 Build #207477 succeeded 1f604fb
💔 Build #207403 failed e65737a
💔 Build #207402 failed 4c6ffd6

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

cc @Dosant

creator column

4c6ffd6

kibanamachine and others added 3 commits May 2, 2024 07:34

[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…

78bd3d5

…fix'

Merge branch 'main' of github.com:elastic/kibana into d/2024-05-01-cr…

d01adbc

…eator-column

improve batching logic

e65737a

fix mock

1f604fb

Dosant marked this pull request as ready for review May 2, 2024 12:59

Dosant requested a review from a team as a code owner May 2, 2024 12:59

Dosant added release_note:enhancement Team:Presentation Presentation Team for Dashboard, Input Controls, and Canvas Team:SharedUX Team label for AppEx-SharedUX (formerly Global Experience) Component:TableListView labels May 2, 2024

Dosant requested review from sebelga and Heenawter May 2, 2024 13:02

Dosant self-assigned this May 2, 2024

Heenawter approved these changes May 2, 2024

View reviewed changes

sebelga approved these changes May 3, 2024

View reviewed changes

Merge branch 'main' into d/2024-05-01-creator-column

92339a4

Dosant mentioned this pull request May 3, 2024

<UserAvatarTip/> doesn't handle long names well #182561

Closed

Dosant added 2 commits May 3, 2024 14:30

add a tip to the column, changing wording based on feedback

ba7a097

Merge branch 'd/2024-05-01-creator-column' of github.com:Dosant/kiban…

e3a85c4

…a into d/2024-05-01-creator-column

Dosant enabled auto-merge (squash) May 3, 2024 12:32

Dosant merged commit bf64717 into elastic:main May 3, 2024
24 checks passed

kibanamachine added v8.15.0 backport:skip This commit does not require backporting labels May 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dashboard] Add "Creator" column to dashboard listing page #182256

[Dashboard] Add "Creator" column to dashboard listing page #182256

Dosant commented May 1, 2024 •

edited

Loading

Dosant commented May 2, 2024

Dosant commented May 2, 2024

Dosant commented May 2, 2024

elasticmachine commented May 2, 2024

elasticmachine commented May 2, 2024

Heenawter left a comment •

edited

Loading

Heenawter May 2, 2024

Dosant May 3, 2024

azasypkin May 3, 2024

Dosant May 3, 2024

Heenawter May 2, 2024

Heenawter May 2, 2024

Dosant commented May 3, 2024

sebelga left a comment

sebelga commented May 3, 2024 •

edited

Loading

Dosant commented May 3, 2024

kibana-ci commented May 3, 2024

[Dashboard] Add "Creator" column to dashboard listing page #182256

[Dashboard] Add "Creator" column to dashboard listing page #182256

Conversation

Dosant commented May 1, 2024 • edited Loading

Summary

Dosant commented May 2, 2024

Dosant commented May 2, 2024

Dosant commented May 2, 2024

elasticmachine commented May 2, 2024

elasticmachine commented May 2, 2024

Heenawter left a comment • edited Loading

Choose a reason for hiding this comment

Heenawter May 2, 2024

Choose a reason for hiding this comment

Dosant May 3, 2024

Choose a reason for hiding this comment

azasypkin May 3, 2024

Choose a reason for hiding this comment

Dosant May 3, 2024

Choose a reason for hiding this comment

Heenawter May 2, 2024

Choose a reason for hiding this comment

Heenawter May 2, 2024

Choose a reason for hiding this comment

Dosant commented May 3, 2024

sebelga left a comment

Choose a reason for hiding this comment

sebelga commented May 3, 2024 • edited Loading

Dosant commented May 3, 2024

kibana-ci commented May 3, 2024

💚 Build Succeeded

Metrics [docs]

Module Count

Async chunks

History

Dosant commented May 1, 2024 •

edited

Loading

Heenawter left a comment •

edited

Loading

sebelga commented May 3, 2024 •

edited

Loading