upcoming: [DI-18419] - API error handling for global filters and dashboard component in ACLP #11170
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 22 commits
October 28, 2024 16:09
nikhagra-akamai
approved these changes
Oct 28, 2024
venkymano-akamai
requested review from
dwiley-akamai and
hkhalil-akamai
and removed request for
a team
|
This should be ready for review from the team ✅ |
| @@ -105,12 +107,20 @@ export const CloudPulseDashboard = (props: DashboardProperties) => { | |||
| Boolean(resourceList) | |||
| ); | |||
|
|
|||
| if (isDashboardApiError) { | |||
| return renderErrorState('Failed to fetch the dashboard details'); | |||
There was a problem hiding this comment.
For this and other errors: it's convention to end error messages with a period.
| <ErrorState errorText="Failed to get jwe token" /> | ||
| </Grid> | ||
| ); | ||
| return renderErrorState('Failed to get jwe token'); |
There was a problem hiding this comment.
Should "jwe" be capitalized? Also, since this is a user-facing message, maybe we should remove "jwe" altogether?
Suggested change
| return renderErrorState('Failed to get jwe token'); | |
| return renderErrorState('Failed to get token.'); |
| } | ||
|
|
||
| if (dashboardsError.length > 0) { | ||
| return `Unable to load ${dashboardsError.slice(0, -1)}`; | ||
| return `Failed to fetch the dashboards`; |
There was a problem hiding this comment.
We can use regular single quotes here instead of backticks since there's no string interpolation now.
|
Coverage Report: ✅ |
added 5 commits
October 29, 2024 10:03
|
@dwiley-akamai / @hkhalil-akamai , addressed the comments and added error messages as per suggestion from tech writer, please check once |
hkhalil-akamai
approved these changes
Oct 29, 2024
| @@ -16,7 +16,7 @@ export const CloudPulseDashboardRenderer = React.memo( | |||
| const { dashboard, filterValue, timeDuration } = props; | |||
|
|
|||
| const selectDashboardAndFilterMessage = | |||
| 'Select Dashboard and filters to visualize metrics.'; | |||
| 'Select dashboard and filters to visualize metrics.'; | |||
There was a problem hiding this comment.
Can we consult the tech writer about this suggestion?
Suggested change
| 'Select dashboard and filters to visualize metrics.'; | |
| 'Select a dashboard and filters to visualize metrics.'; |
| @@ -129,7 +127,7 @@ export const RenderWidgets = React.memo( | |||
| !Boolean(resourceList?.length) | |||
| ) { | |||
| return renderPlaceHolder( | |||
| 'Select Dashboard, Region and Resource to visualize metrics' | |||
| 'Select dashboard and filters to visualize metrics.' | |||
There was a problem hiding this comment.
Same comment as above -- could this be more appropriate? I am not sure.
Suggested change
| 'Select dashboard and filters to visualize metrics.' | |
| 'Select a dashboard and filters to visualize metrics.' |
bnussman-akamai
approved these changes
Oct 30, 2024
bnussman-akamai
added
Approved
Cloud Manager E2E
|
||||||||||||||||||||||||||||
| Project |
Cloud Manager E2E
|
| Branch Review |
develop
|
| Run status |
|
| Run duration | 26m 43s |
| Commit |
|
| Committer | venkatmano-akamai |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
2
|
Pending
|
2
|
Skipped
|
0
|
Passing
|
445
|
| 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description 📝
Added code for handling API errors in global filters and dashboard component
Changes 🔄
Target release date 🗓️
11-11-2024
Preview 📷
How to test 🧪
(monitor/services, monitor/services/:serviceType/dashboards, /regions, linode/instances in case of linode dashboard, databases/instances incase of dbaas dashboard) instead of returning a valid response, you can return HttpResponse.error() and see the error messages one by one.
As an Author I have considered 🤔
Check all that apply