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

chore: harmonize and clean up list views #25961

Merged
merged 34 commits into from
Dec 4, 2023

Conversation

villebro
Copy link
Member

@villebro villebro commented Nov 12, 2023

SUMMARY

Currently, there is a lot of discrepancy between how list views look/work:

  • The "Search" filter is sometimes first or last. It is also sometimes called "Name".
  • The ordering of the other filters is highly inconsistent, and not in line with the column ordering.
  • The first column is sometimes "Name", other times the asset type, e.g. "Dashboard".
  • The Owners column is missing on Charts page.
  • The modified column is sometimes called "Modified", other times "Last modified"
  • We sometimes have the "Created by" and "Created on" columns, but usually not.

In addition, with the introduction of Tags, the list views have become very cluttered, raising the need for removing less relevant fields.

This makes the layout consistent across the following list views:

  • Annotation Layers
  • Dashboards
  • Charts
  • Datasets
  • Row Level Security
  • Databases
  • Tags
  • Alerts & Reports
  • CSS Templates
  • Saved Queries

The following changes are made:

  • The Search/Name filter is placed first. The filter name is set as "Name", as "Search" might indicate that it searches other fields, too.
  • Owners is added to all list views where relevant. This was missing on the Charts view.
  • The "Created by" and "Created at" fields are removed, as they're largely irrelevant.
  • The "Modified by" and "Modified at" fields are merged, so that the modifier is shown when hovering.
  • The "Created by" filter is replaced by "Modified by", to make it possible to search based on who last modified the asset.
  • The Filters are reordered to be in line with the column orders. This is with the exception of less commonly needed filters, like "Favorite" and "Published".
  • Single select filters are changed from plural to singular. This particularly affects the "Tags", "Owners" and "Dashboards" filters, which are now "Tag", "Owner" and "Dashboard" respectively. Note, that we may want to make these multi-select at some point, but that would require introducing an IN filter, either locally or in FAB.
  • The facepile on "Tags" is removed, as that should IMO only be used for Owners.

SCREENSHOTS

Charts

image

Dashboards

image

Dataset

image

Saved Queries

image

Row Level Security

image

Database

image

CSS Templates

image

Tags

image

Alerts & Reports

image

Annotation Layers

image

TESTING INSTRUCTIONS

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@villebro villebro marked this pull request as draft November 12, 2023 05:05
Copy link

codecov bot commented Nov 20, 2023

Codecov Report

Attention: 20 lines in your changes are missing coverage. Please review.

Comparison is base (cdbbd83) 69.21% compared to head (0b51363) 69.18%.
Report is 5 commits behind head on master.

Files Patch % Lines
...uperset-frontend/src/pages/DashboardList/index.tsx 60.00% 2 Missing and 2 partials ⚠️
superset-frontend/src/pages/Tags/index.tsx 0.00% 4 Missing ⚠️
superset-frontend/src/pages/ChartList/index.tsx 50.00% 2 Missing and 1 partial ⚠️
...end/src/features/cssTemplates/CssTemplateModal.tsx 0.00% 2 Missing ⚠️
superset-frontend/src/pages/DatasetList/index.tsx 33.33% 2 Missing ⚠️
...perset-frontend/src/pages/SavedQueryList/index.tsx 33.33% 1 Missing and 1 partial ⚠️
...erset-frontend/src/pages/AlertReportList/index.tsx 50.00% 1 Missing ⚠️
superset-frontend/src/pages/DatabaseList/index.tsx 80.00% 1 Missing ⚠️
...-frontend/src/pages/RowLevelSecurityList/index.tsx 50.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master   #25961      +/-   ##
==========================================
- Coverage   69.21%   69.18%   -0.03%     
==========================================
  Files        1941     1943       +2     
  Lines       75910    75902       -8     
  Branches     8458     8450       -8     
==========================================
- Hits        52538    52510      -28     
- Misses      21177    21207      +30     
+ Partials     2195     2185      -10     
Flag Coverage Δ
hive 53.68% <100.00%> (+<0.01%) ⬆️
javascript 56.50% <60.00%> (+<0.01%) ⬆️
mysql 78.08% <100.00%> (-0.08%) ⬇️
postgres 78.18% <100.00%> (-0.08%) ⬇️
presto 53.64% <100.00%> (+<0.01%) ⬆️
python 82.87% <100.00%> (-0.08%) ⬇️
sqlite 76.84% <100.00%> (-0.08%) ⬇️
unit 55.81% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@villebro villebro force-pushed the villebro/listview-reorder branch 2 times, most recently from e8386e2 to a21bfe5 Compare November 26, 2023 21:49
Copy link
Contributor

github-actions bot commented Dec 1, 2023

@villebro Ephemeral environment spinning up at http://34.222.153.32:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

@michael-s-molina
Copy link
Member

Thanks for the review comments @michael-s-molina - I've addressed all bugs/comments, but I'll still defer from reintroducing the creation columns until we decide on whether or not we want to keep it until 4.0.

@villebro I raised this question during the Town Hall and folks seem to be ok with removing the creator column in this PR.

@villebro
Copy link
Member Author

villebro commented Dec 1, 2023

Thanks for the review comments @michael-s-molina - I've addressed all bugs/comments, but I'll still defer from reintroducing the creation columns until we decide on whether or not we want to keep it until 4.0.

@villebro I raised this question during the Town Hall and folks seem to be ok with removing the creator column in this PR.

Thanks for raising this @michael-s-molina ! To strike a compromise, I introduced a "Modified by" filter to fill in for the removed "Created by" filter. I'll update the screens to reflect this and ping you for a final review once CI is green.

@villebro
Copy link
Member Author

villebro commented Dec 2, 2023

/testenv up FEATURE_TAGGING_SYSTEM=True

Copy link
Contributor

github-actions bot commented Dec 2, 2023

@villebro Ephemeral environment spinning up at http://34.222.234.40:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

@villebro
Copy link
Member Author

villebro commented Dec 2, 2023

/testenv up FEATURE_TAGGING_SYSTEM=True FEATURE_ALERT_REPORTS=True

Copy link
Contributor

github-actions bot commented Dec 2, 2023

@villebro Ephemeral environment spinning up at http://35.89.27.16:8080. Credentials are admin/admin. Please allow several minutes for bootstrapping and startup.

Copy link
Member

@michael-s-molina michael-s-molina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for all the consistency improvements @villebro! I left some non-blocking comments. Given the number of changed files, a second pair of 👀 would be good @kgabryje.

superset-frontend/src/components/AuditInfo/index.tsx Outdated Show resolved Hide resolved
superset-frontend/src/utils/getOwnerName.test.ts Outdated Show resolved Hide resolved
Copy link
Member

@rusackas rusackas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving as cypress codeowner

@villebro villebro merged commit 0b477e3 into apache:master Dec 4, 2023
33 checks passed
@villebro villebro deleted the villebro/listview-reorder branch December 4, 2023 19:51
Copy link
Contributor

github-actions bot commented Dec 4, 2023

Ephemeral environment shutdown and build artifacts deleted.

@michael-s-molina michael-s-molina added the v3.1 Label added by the release manager to track PRs to be included in the 3.1 branch label Dec 4, 2023
michael-s-molina pushed a commit that referenced this pull request Dec 4, 2023
josedev-union pushed a commit to Ortege-xyz/studio that referenced this pull request Jan 22, 2024
@mistercrunch mistercrunch added 🍒 3.1.0 🍒 3.1.1 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels labels Mar 8, 2024
sfirke pushed a commit to sfirke/superset that referenced this pull request Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels size/XXL v3.1 Label added by the release manager to track PRs to be included in the 3.1 branch 🍒 3.1.0 🍒 3.1.1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants