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

upcoming: [DI-20928] - Introduce label for all global filters #11118

Merged
merged 36 commits into from
Oct 22, 2024

Conversation

venkymano-akamai
Copy link
Contributor

@venkymano-akamai venkymano-akamai commented Oct 17, 2024

Description 📝

Added label for all ACLP Global filters using filter config

Changes 🔄

  1. Modify name property in FilterConfig with appropriate values
  2. Consume name property and use it as a label field all the Autocomplete filters in global filters section
  3. Enhanced the common region component to honor the noMarginTop property

Target release date 🗓️

17-10-2024

Preview 📷

Before After
Screenshot 2024-10-17 at 12 16 04 PM Screenshot 2024-10-17 at 12 15 32 PM
Screenshot 2024-10-17 at 12 16 09 PM Screenshot 2024-10-17 at 12 15 18 PM

How to test 🧪

  1. Login as mock, as still some of the endpoints are not enabled in production.
  2. Navigate to monitor tab
  3. Select any dashboard
  4. You will be able to see label / title for all the filters including dashboard selection and time duration.

As an Author I have considered 🤔

Check all that apply

  • 👀 Doing a self review
  • ❔ Our contribution guidelines
  • 🤏 Splitting feature into small PRs
  • ➕ Adding a changeset
  • 🧪 Providing/Improving test coverage
  • 🔐 Removing all sensitive information from the code and PR description
  • 🚩 Using a feature flag to protect the release
  • 👣 Providing comprehensive reproduction steps
  • 📑 Providing or updating our documentation
  • 🕛 Scheduling a pair reviewing session
  • 📱 Providing mobile support
  • ♿ Providing accessibility support

@agorthi-akamai agorthi-akamai force-pushed the feature/global_filter_titles branch from fe554f4 to c3ea831 Compare October 17, 2024 10:48
@venkymano-akamai venkymano-akamai marked this pull request as ready for review October 20, 2024 03:38
@venkymano-akamai venkymano-akamai requested review from a team as code owners October 20, 2024 03:38
@venkymano-akamai venkymano-akamai requested review from jdamore-linode and removed request for a team October 20, 2024 03:38
Copy link
Contributor

@mjac0bs mjac0bs left a comment

Choose a reason for hiding this comment

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

I'm seeing all the labels for the filters and not seeing any regressions to the core components that were modified in styles or props, so this was looking good to me.

Test coverage is passing - there was one CI e2e failure on a clone linode spec that has been consistently flaky and is unrelated to these changes.

I had left one comment about copy: "DB" vs "Database".

Comment on lines 101 to 103
name: 'DB Clusters',
neededInServicePage: false,
placeholder: 'Select a DB Cluster',
placeholder: 'Select DB Clusters',
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor, non-blocking:

How did UX feel about using DB in the copy here? (cc @gitkcosby) I couldn't find another place in Cloud Manager where we use "DB" rather than spell out "Database".

Suggested change
name: 'DB Clusters',
neededInServicePage: false,
placeholder: 'Select a DB Cluster',
placeholder: 'Select DB Clusters',
name: 'Database Clusters',
neededInServicePage: false,
placeholder: 'Select Database Clusters',

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mjac0bs , Yes upon discussion with our tech writer, we have moved from DB to Database as suggested. Also we have update the Engine filter to Database Engine and its respective placeholder to Select a Database Engine

Copy link

github-actions bot commented Oct 22, 2024

Coverage Report:
Base Coverage: 87.06%
Current Coverage: 87.06%

@@ -172,6 +173,7 @@ export const RegionSelect = <
label={label ?? 'Region'}
loading={accountAvailabilityLoading}
loadingText="Loading regions..."
noMarginTop={noMarginTop ?? false}
Copy link
Member

Choose a reason for hiding this comment

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

No need to put the ?? false. This component can accept undefined

Suggested change
noMarginTop={noMarginTop ?? false}
noMarginTop={noMarginTop}

Comment on lines 224 to 226
PopperComponent={(props: PopperProps) => (
<CustomPopper {...props} placement="bottom" />
)}
Copy link
Member

Choose a reason for hiding this comment

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

Rather than using CustomPopper directly here, think we can use MUI's slotProps to pass the prop to the underlying popper.

Suggested change
PopperComponent={(props: PopperProps) => (
<CustomPopper {...props} placement="bottom" />
)}
slotProps={{
popper: {
placement: "bottom"
},
}}

@mjac0bs mjac0bs added the Approved Multiple approvals and ready to merge! label Oct 22, 2024
@venkymano-akamai
Copy link
Contributor Author

@bnussman-akamai / @mjac0bs , thanks for the approvals, i have addressed the minor comments from both of you. since we have two approvals, it is ready for merging.

@mjac0bs mjac0bs merged commit e9b001d into linode:develop Oct 22, 2024
23 checks passed
Copy link

cypress bot commented Oct 22, 2024

Cloud Manager E2E    Run #6712

Run Properties:  status check passed Passed #6712  •  git commit e9b001dc66: upcoming: [DI-20928] - Introduce label for all global filters (#11118)
Project Cloud Manager E2E
Branch Review develop
Run status status check passed Passed #6712
Run duration 28m 02s
Commit git commit e9b001dc66: upcoming: [DI-20928] - Introduce label for all global filters (#11118)
Committer venkatmano-akamai
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 6
Tests that did not run due to a developer annotating a test with .skip  Pending 2
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 438
View all changes introduced in this branch ↗︎

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved Multiple approvals and ready to merge! Cloud Pulse
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants