fix types of badges (#2597)

* fix types of badges * bump * fix types of badges * fix tests * fix tests * add warning to cases * fix docs * fix tests * I hope this is last fix
kyma-project · Oct 2, 2023 · c06b893 · c06b893
1 parent 74eda27
commit c06b893
Show file tree

Hide file tree

Showing 28 changed files with 71 additions and 108 deletions.
diff --git a/docs/extensibility/display-section.md b/docs/extensibility/display-section.md
@@ -211,18 +211,18 @@ Badge widgets render texts as a status badge, using a set of predefined rules to
 
 - **placeholder** - an optional property to change the default empty text placeholder `-` with a custom string.
   If the **translations** section has a translation entry with the ID that is the same as the **placeholder** string, the translation is used.
-- **highlights** - an optional map of highlight rules. Key refers to the type of highlight, while the rule can just be a plain array of values or a string containing a [JSONata](jsonata.md) rule. Allowed keys are `informative` `positive`, `negative` and `critical`.
+- **highlights** - an optional map of highlight rules. Key refers to the type of highlight, while the rule can just be a plain array of values or a string containing a [JSONata](jsonata.md) rule. Allowed keys are `information`, `success`, `warning` and `error`.
 - **description** - a [JSONata](jsonata.md) expression used to fetch additional information that will be displayed in a tooltip when hovering over the badge.
 - **copyable** - an optional flag to display a **Copy to clipboard** button next to the widget. By default set to `false`.
 
 #### Default highlight rules
 
 When no highlights are provided, the following values are automatically handled:
 
-- rendered as informative: `initial`, `pending`, `available`, `released`.
-- rendered as positive: `ready`, `bound`, `running`, `success`, `succeeded`, `ok`.
-- rendered as negative: `unknown`, `warning`.
-- rendered as critical: `error`, `failure`, `invalid`.
+- rendered as information: `initial`, `pending`, `available`, `released`.
+- rendered as success: `ready`, `bound`, `running`, `success`, `succeeded`, `ok`.
+- rendered as warning: `unknown`, `warning`.
+- rendered as error: `error`, `failure`, `invalid`.
 
 #### Example
 
@@ -231,10 +231,10 @@ When no highlights are provided, the following values are automatically handled:
   widget: Badge
   placeholder: '-'
   highlights:
-    positive:
+    success:
       - Running
       - ok
-    negative: $item < 0
+    error: $item < 0
   description: status.message
 ```
 
@@ -835,11 +835,10 @@ injections: |-
       - name: status
         widget: Badge
         highlights:
-          positive:
+          success:
             - 'OK'
-          negative:
+          error:
             - 'ERROR'
-          critical:
             - 'SKIPPED'
         source: 'status.APIRuleStatus.code ? status.APIRuleStatus.code : "UNKNOWN"'
         description: status.APIRuleStatus.desc

diff --git a/examples/injections/apirules.yaml b/examples/injections/apirules.yaml
@@ -20,11 +20,10 @@ injections: |-
       - name: status
         widget: Badge
         highlights: 
-          positive:
+          success:
             - 'OK'
-          negative:
+          error:
             - 'ERROR'
-          critical:
             - 'SKIPPED'
         source: 'status.APIRuleStatus.code ? status.APIRuleStatus.code : "UNKNOWN"'
         description: status.APIRuleStatus.desc
diff --git a/examples/injections/functions.yaml b/examples/injections/functions.yaml
@@ -17,17 +17,16 @@ injections: |-
       - name: header.status
         widget: Badge
         highlights:
-          positive:
+          success:
             - RUNNING
-          negative:
+          error:
             - FAILED
             - ERROR
-          informative:
-            - INITIALIZING
-          critical:
             - DEPLOYING
             - BUILDING
             - PENDING
+          information:
+            - INITIALIZING
         source: >-
           ($.status = undefined or $.status.conditions = undefined or
           $count($.status.conditions) = 0) ? 'INITIALIZING' :

diff --git a/examples/services/configuration.yaml b/examples/services/configuration.yaml
@@ -52,9 +52,9 @@ data:
             sort: true
             widget: Badge
             highlights:
-              positive:
+              success:
                 - 'true'
-              negative:
+              error:
                 - 'false'
       - widget: ResourceList
         source: $apirules()

diff --git a/public/schemas/schema-details.yaml b/public/schemas/schema-details.yaml
@@ -119,31 +119,23 @@ $widgets:
           type: object
           widget: FormGroup
           properties:
-            informative:
+            information:
               type: [string, array]
               widget: MultiType
               widgets:
                 string: Jsonata
                 array: SimpleList
               items:
                 type: string
-            positive:
+            success:
               type: [string, array]
               widget: MultiType
               widgets:
                 string: Jsonata
                 array: SimpleList
               items:
                 type: string
-            negative:
-              type: [string, array]
-              widget: MultiType
-              widgets:
-                string: Jsonata
-                array: SimpleList
-              items:
-                type: string
-            critical:
+            error:
               type: [string, array]
               widget: MultiType
               widgets:

diff --git a/public/schemas/schema-injections.yaml b/public/schemas/schema-injections.yaml
@@ -143,7 +143,7 @@ items:
           type: object
           widget: FormGroup
           properties:
-            informative:
+            information:
               type:
               - string
               - array
@@ -153,7 +153,7 @@ items:
                 array: SimpleList
               items:
                 type: string
-            positive:
+            success:
               type:
               - string
               - array
@@ -163,17 +163,7 @@ items:
                 array: SimpleList
               items:
                 type: string
-            negative:
-              type:
-              - string
-              - array
-              widget: MultiType
-              widgets:
-                string: Jsonata
-                array: SimpleList
-              items:
-                type: string
-            critical:
+            error:
               type:
               - string
               - array

diff --git a/public/schemas/schema-list.yaml b/public/schemas/schema-list.yaml
@@ -104,31 +104,23 @@ $widgets:
           type: object
           widget: FormGroup
           properties:
-            informative:
+            information:
               type: [string, array]
               widget: MultiType
               widgets:
                 string: Jsonata
                 array: SimpleList
               items:
                 type: string
-            positive:
+            success:
               type: [string, array]
               widget: MultiType
               widgets:
                 string: Jsonata
                 array: SimpleList
               items:
                 type: string
-            negative:
-              type: [string, array]
-              widget: MultiType
-              widgets:
-                string: Jsonata
-                array: SimpleList
-              items:
-                type: string
-            critical:
+            error:
               type: [string, array]
               widget: MultiType
               widgets:

diff --git a/resources/web/deployment.yaml b/resources/web/deployment.yaml
@@ -16,7 +16,7 @@ spec:
     spec:
       containers:
         - name: busola
-          image: europe-docker.pkg.dev/kyma-project/dev/busola-web:PR-2554
+          image: europe-docker.pkg.dev/kyma-project/dev/busola-web:PR-2597
           imagePullPolicy: Always
           resources:
             requests:

diff --git a/src/components/Clusters/views/ClusterStorageType.js b/src/components/Clusters/views/ClusterStorageType.js
@@ -8,7 +8,7 @@ export function ClusterStorageType({ clusterConfig }) {
   return (
     <StatusBadge
       resourceKind="clusters"
-      type={knownStorage.includes(storage) ? 'info' : 'warning'}
+      type={knownStorage.includes(storage) ? 'Information' : 'Warning'}
     >
       {storage || 'unknown'}
     </StatusBadge>

diff --git a/src/components/Extensibility/components/Badge.js b/src/components/Extensibility/components/Badge.js
@@ -1,6 +1,7 @@
 import React from 'react';
 import { isNil } from 'lodash';
 import { useJsonata } from '../hooks/useJsonata';
+import { useTranslation } from 'react-i18next';
 
 import { StatusBadge } from 'shared/components/StatusBadge/StatusBadge';
 import {
@@ -10,12 +11,10 @@ import {
 import { Tooltip } from 'shared/components/Tooltip/Tooltip';
 
 import './Badge.scss';
-import { useTranslation } from 'react-i18next';
 
 export function Badge({
   value,
   structure,
-  schema,
   originalResource,
   scope,
   arrayItems,

diff --git a/src/components/Extensibility/components/tests/Badge.test.js b/src/components/Extensibility/components/tests/Badge.test.js
@@ -24,34 +24,34 @@ describe('Badge', () => {
     expect(status).toHaveLength(1);
   });
 
-  it('Renders a badge with positive type for custom highlights', () => {
+  it('Renders a badge with success type for custom highlights', () => {
     const value = 'yes';
     const structure = {
       highlights: {
-        positive: ['yes', 'ok'],
+        Success: ['yes', 'ok'],
       },
     };
 
     const wrapper = shallow(<Badge value={value} structure={structure} />);
     const status = wrapper.find(StatusBadge);
     const badgeProps = status.props();
-    expect(badgeProps.type).toEqual('positive');
+    expect(badgeProps.type).toEqual('Success');
     expect(badgeProps.autoResolveType).toEqual(false);
     expect(status).toHaveLength(1);
   });
 
-  it('Renders a badge with positive type for custom highlights', () => {
+  it('Renders a badge with error type for custom highlights', () => {
     const value = -2;
     const structure = {
       highlights: {
-        negative: 'data < 0',
+        Error: 'data < 0',
       },
     };
 
     const wrapper = shallow(<Badge value={value} structure={structure} />);
     const status = wrapper.find(StatusBadge);
     const badgeProps = status.props();
-    expect(badgeProps.type).toEqual('negative');
+    expect(badgeProps.type).toEqual('Error');
     expect(badgeProps.autoResolveType).toEqual(false);
     expect(status).toHaveLength(1);
   });

diff --git a/src/components/HelmReleases/HelmReleaseStatus.js b/src/components/HelmReleases/HelmReleaseStatus.js
@@ -7,7 +7,6 @@ export function HelmReleaseStatus({ status }) {
       case 'deployed':
         return 'Success';
       case 'uninstalling':
-        return 'Error';
       case 'failed':
         return 'Error';
       case 'unknown':

diff --git a/src/components/HelmReleases/ReleaseDataPanel.js b/src/components/HelmReleases/ReleaseDataPanel.js
@@ -30,7 +30,7 @@ export function ReleaseDataPanel({ release, simpleHeader }) {
               {name}
             </Link>
             <div className="fd-margin-begin--sm">
-              <StatusBadge noTooltip type="info">
+              <StatusBadge noTooltip type="Information">
                 {t('helm-releases.headers.release-version', { version })}
               </StatusBadge>
             </div>

diff --git a/src/resources/CronJobs/CronJobConcurrencyPolicy.js b/src/resources/CronJobs/CronJobConcurrencyPolicy.js
@@ -4,7 +4,7 @@ import { StatusBadge } from 'shared/components/StatusBadge/StatusBadge';
 export function CronJobConcurrencyPolicy({ concurrencyPolicy }) {
   return (
     <StatusBadge
-      type="info"
+      type="Information"
       tooltipProps={{ position: 'bottom' }}
       resourceKind="cron-jobs"
     >

diff --git a/src/resources/Jobs/JobCompletions.js b/src/resources/Jobs/JobCompletions.js
@@ -7,7 +7,7 @@ export function JobCompletions({ job }) {
 
   const succeeded = job.status.succeeded || 0;
   const completions = job.spec.completions || 0;
-  const statusType = succeeded === completions ? 'positive' : 'informative';
+  const statusType = succeeded === completions ? 'Success' : 'Information';
 
   return (
     <TooltipBadge

diff --git a/src/resources/Jobs/JobConditions.js b/src/resources/Jobs/JobConditions.js
@@ -15,11 +15,11 @@ export function JobConditions(job) {
   ];
   const conditionTypeStatus = type => {
     if (type === 'Complete') {
-      return 'success';
+      return 'Success';
     } else if (type === 'Failed') {
-      return 'error';
+      return 'Error';
     } else {
-      return 'info';
+      return 'Information';
     }
   };
   const rowRenderer = condition => {

diff --git a/src/resources/Namespaces/NamespaceStatus.js b/src/resources/Namespaces/NamespaceStatus.js
@@ -5,11 +5,11 @@ export function NamespaceStatus({ namespaceStatus }) {
   const badgeType = status => {
     switch (status) {
       case 'Active':
-        return 'success';
+        return 'Success';
       case 'Terminating':
-        return 'info';
+        return 'Information';
       default:
-        return 'error';
+        return 'Error';
     }
   };
 

diff --git a/src/resources/PersistentVolumes/PersistentVolumeStatus.js b/src/resources/PersistentVolumes/PersistentVolumeStatus.js
@@ -6,12 +6,12 @@ export function PersistentVolumeStatus({ status }) {
     switch (status) {
       case 'Bound':
       case 'Available':
-        return 'success';
+        return 'Success';
       case 'Released':
       case 'Pending':
-        return 'info';
+        return 'Information';
       default:
-        return 'error';
+        return 'Error';
     }
   };
 

diff --git a/src/resources/Pods/ContainerStatus.js b/src/resources/Pods/ContainerStatus.js
diff --git a/src/resources/Pods/PodRestarts.js b/src/resources/Pods/PodRestarts.js