Ui/primary/handle errors by andaley · Pull Request #8787 · hashicorp/vault

andaley · 2020-04-21T00:25:24Z

Handle Errors & Display cluster states consistently

Summary of changes

Added error states to the State and Last WAL Entry cards on the Replication Primary dashboard
Large refactor to the cluster model to ensure that we show the same glyphs in the status menu and all of the dashboards
Added a new clusterStates helper to help with aforementioned consistency**
- Rolled it out on the Replication components
- Replaced old usage of cluster model properties such as drStateDisplay with this new helper
Updated stream-wals to display an check circle icon instead of a sync icon

Examples

Error state for a DR primary

Status menu on a DR primary, when cluster is in a good state

Status menu on a DR Secondary, when cluster itself is in a good state but the connection_state is bad

Questions / Feedback

The status menu "traffic light" (i.e. the green light), icon, and icon color currently indicate the state of the current cluster only. It does not reflect the connection_state. This means that if a secondary is OK, but it's connection state is bad, we still show the status menu as "green" (see example above). The dashboard will show an error, however. I left this be for now because changing the logic of the status menu seemed like a big undertaking but I'm open to ideas.
I added a defaultDisplay inside cluster-states.js in case there are other states that we're not aware of. i don't love this solution because it seems like we should be aware of all possible cluster states, but it seemed better than blowing up the app if one couldn't be found.

TODO / known issues

add tests
when enabling replication, the state card and title show up before any of the data is ready
the add secondary link is broken when cluster is a Performance Primary

…tate

andaley · 2020-04-24T00:48:56Z

+      return this.get(`${mode}.state`);
    }
-    const defaultDisp = 'Synced';
-    const displays = {


you can see these values are now part of the CLUSTER_STATES map here: https://github.com/hashicorp/vault/pull/8787/files#diff-b8f0db91f050a7646bbb0d17521230a2R20

andaley · 2020-04-24T00:50:20Z

-  }),
-
-  stateGlyph(state) {
-    const glyph = 'check-circle-outline';


this is the default glyph to display, including when state is unknown. i let this be, but maybe we shouldn't show an icon at all if state can't be found?

andaley · 2020-04-24T00:50:36Z

-  stateGlyph(state) {
-    const glyph = 'check-circle-outline';
-
-    const glyphs = {


these are also now reflected in the CLUSTER_STATES map: https://github.com/hashicorp/vault/pull/8787/files#diff-b8f0db91f050a7646bbb0d17521230a2R20

andaley · 2020-04-24T00:52:11Z

+    isSyncing: false,
+  },
+  'stream-wals': {
+    glyph: 'check-circle-outline',


i changed the glyph here to check-circle-outline instead of android-sync based off of conversations with bk that stream-wals is in fact the ideal syncing state.

andaley · 2020-04-24T00:54:00Z

-    {{else if (eq mode 'performance')}}
-      {{cluster.perfReplicationStateDisplay}}
+    {{else}}
+      {{get (cluster-states modeState) "display"}}


i haven't been able to figure out where this code is actually executed -- if anyone has any ideas please lemme know! otherwise, if i can get rid of this line it means i can get rid of all of the 'display' properties inside CLUSTER_STATES

…States helper

chelshaw

Great work! Love the state helper -- putting all of those in one place makes a ton of sense and seems to cover edge cases well. Will pull it down and play around with it, but so far looks great!

Monkeychip · 2020-04-24T16:44:05Z

+    if (title === 'States') {
+      const currentClusterisOk = clusterStates([state]).isOk;
+      const primaryIsOk = clusterStates([connection]).isOk;
+      return !(currentClusterisOk && primaryIsOk);


…handle-errors

andaley · 2020-04-24T23:28:40Z

I ended up in a bad git state, so moving this PR here: #8845

andaley added 3 commits April 20, 2020 16:48

use h3 instead of code elements

74a7fbe

use correct property names for StateDisplay

b23c1b4

WIP

4553a30

andaley changed the base branch from master to ui/replication-status-discoverability April 21, 2020 00:25

andaley added the ui label Apr 21, 2020

andaley commented Apr 21, 2020

View reviewed changes

Comment thread ui/lib/core/addon/templates/components/replication-mode-summary.hbs Outdated

andaley added 12 commits April 21, 2020 13:33

remove todo

0e39b9c

move cluster states into a map; make status menu icon match cluster s…

3ddb24b

…tate

show error in state card using the same state map in the cluster model

b64d2e9

whitespace

83c50ad

move cluster-states into a helper and update usage

ae02971

use circle success icon for stream-wals because that is the ideal state

92fb513

more refactoring of cluster state display

b25ce17

use new cluster-states helper

927c508

whitespace

448b1f0

use clusterStates helper in replication secondary card

502064c

remove extra import

def71a1

add default values for when state isn't recognized

f672ae3

andaley commented Apr 24, 2020

View reviewed changes

make sure that state exists before getting state details from cluster…

246fd51

…States helper

chelshaw reviewed Apr 24, 2020

View reviewed changes

be more strict when state cannot be found

acb3d06

Monkeychip reviewed Apr 24, 2020

View reviewed changes

andaley marked this pull request as ready for review April 24, 2020 16:50

andaley added 2 commits April 24, 2020 10:12

use brace expansion to fix linting error

d8ddb95

add tests for error states

d5b07f3

Merge branch 'ui/replication-status-discoverability' into ui/primary/…

0c028a0

…handle-errors

andaley closed this Apr 24, 2020

andaley mentioned this pull request Apr 24, 2020

Replication Primary Dashboard: handle errors #8845

Merged

andaley deleted the ui/primary/handle-errors branch March 22, 2024 21:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ui/primary/handle errors#8787

Ui/primary/handle errors#8787
andaley wants to merge 20 commits into
ui/replication-status-discoverabilityfrom
ui/primary/handle-errors

andaley commented Apr 21, 2020 •

edited

Loading

Uh oh!

Uh oh!

andaley Apr 24, 2020

Uh oh!

andaley Apr 24, 2020

Uh oh!

andaley Apr 24, 2020

Uh oh!

andaley Apr 24, 2020

Uh oh!

andaley Apr 24, 2020

Uh oh!

chelshaw left a comment

Uh oh!

Monkeychip Apr 24, 2020

Uh oh!

andaley commented Apr 24, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

andaley commented Apr 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Handle Errors & Display cluster states consistently

Examples

Error state for a DR primary

Status menu on a DR primary, when cluster is in a good state

Status menu on a DR Secondary, when cluster itself is in a good state but the connection_state is bad

Questions / Feedback

TODO / known issues

Uh oh!

Uh oh!

andaley Apr 24, 2020

Choose a reason for hiding this comment

Uh oh!

andaley Apr 24, 2020

Choose a reason for hiding this comment

Uh oh!

andaley Apr 24, 2020

Choose a reason for hiding this comment

Uh oh!

andaley Apr 24, 2020

Choose a reason for hiding this comment

Uh oh!

andaley Apr 24, 2020

Choose a reason for hiding this comment

Uh oh!

chelshaw left a comment

Choose a reason for hiding this comment

Uh oh!

Monkeychip Apr 24, 2020

Choose a reason for hiding this comment

Uh oh!

andaley commented Apr 24, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

andaley commented Apr 21, 2020 •

edited

Loading