@centreon/ui 23.10.65-develop.0 → 23.10.66

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centreon/ui",
-  "version": "23.10.65-develop.0",
+  "version": "23.10.66",
   "description": "Centreon UI Components",
   "scripts": {
     "eslint": "eslint ./src --ext .js,.jsx,.ts,.tsx --max-warnings 0",

package/src/Dashboard/Dashboard.styles.ts

@@ -79,7 +79,12 @@ export const useDashboardItemStyles = makeStyles<{ hasHeader: boolean }>()(
       '&:hover': {
         backgroundColor: theme.palette.action.hover
       },
-      cursor: 'move',
+      '&[data-canMove="false"]': {
+        cursor: 'default'
+      },
+      '&[data-canMove="true"]': {
+        cursor: 'move'
+      },
       padding: theme.spacing(0.5, 2)
     },
     widgetPadding: {

package/src/Dashboard/Item.tsx

@@ -15,6 +15,7 @@ import { useMemoComponent } from '../utils';
 import { useDashboardItemStyles } from './Dashboard.styles';
 
 interface DashboardItemProps {
+  canMove?: boolean;
   children: ReactElement;
   className?: string;
   disablePadding?: boolean;
@@ -37,7 +38,8 @@ const Item = forwardRef(
       onMouseUp,
       onTouchEnd,
       id,
-      disablePadding = false
+      disablePadding = false,
+      canMove = false
     }: DashboardItemProps,
     ref: ForwardedRef<HTMLDivElement>
   ): ReactElement => {
@@ -66,6 +68,7 @@ const Item = forwardRef(
               <div
                 {...listeners}
                 className={classes.widgetHeader}
+                data-canMove={canMove}
                 data-testid={`${id}_move_panel`}
               >
                 {header}

package/src/Graph/Gauge/Gauge.stories.tsx

@@ -134,3 +134,13 @@ export const withRangeThresholds: Story = {
   },
   render: Template
 };
+
+export const RawValue: Story = {
+  args: {
+    data: dataLastWeek,
+    displayAsRaw: true,
+    thresholdTooltipLabels: ['Warning', 'Critical'],
+    thresholds: [0.5, 0.6]
+  },
+  render: Template
+};

package/src/Graph/Gauge/Gauge.tsx

@@ -7,11 +7,18 @@ import { Metric } from '../common/timeSeries/models';
 import ResponsiveGauge from './ResponsiveGauge';
 
 interface Props {
+  baseColor?: string;
   data?: LineChartData;
+  displayAsRaw?: boolean;
   thresholds: Thresholds;
 }
 
-export const Gauge = ({ thresholds, data }: Props): JSX.Element | null => {
+export const Gauge = ({
+  thresholds,
+  data,
+  displayAsRaw,
+  baseColor
+}: Props): JSX.Element | null => {
   if (!data) {
     return null;
   }
@@ -22,6 +29,8 @@ export const Gauge = ({ thresholds, data }: Props): JSX.Element | null => {
     <Responsive.ParentSize>
       {({ width, height }) => (
         <ResponsiveGauge
+          baseColor={baseColor}
+          displayAsRaw={displayAsRaw}
           height={height}
           metric={metric}
           thresholds={thresholds}

package/src/Graph/Gauge/PieData.tsx

@@ -16,7 +16,8 @@ const PieData = ({
   metric,
   adaptedMaxValue,
   thresholds,
-  radius
+  radius,
+  baseColor
 }: Omit<
   GaugeProps,
   'width' | 'height' | 'showTooltip' | 'hideTooltip' | 'thresholdTooltipLabels'
@@ -24,13 +25,12 @@ const PieData = ({
   const theme = useTheme();
 
   const pieData = [metric.data[0], adaptedMaxValue - metric.data[0]];
-  const pieColor = !thresholds.enabled
-    ? theme.palette.success.main
-    : getColorFromDataAndTresholds({
-        data: metric.data[0],
-        theme,
-        thresholds
-      });
+  const pieColor = getColorFromDataAndTresholds({
+    baseColor,
+    data: metric.data[0],
+    theme,
+    thresholds
+  });
 
   const getDataColor = scaleOrdinal({
     domain: pieData,

package/src/Graph/Gauge/ResponsiveGauge.tsx

@@ -7,7 +7,7 @@ import { Tooltip } from '@visx/visx';
 import { Box, Fade, useTheme } from '@mui/material';
 
 import { Metric } from '../common/timeSeries/models';
-import { formatMetricValue } from '../common/timeSeries';
+import { formatMetricValueWithUnit } from '../common/timeSeries';
 import { getColorFromDataAndTresholds } from '../common/utils';
 import { margins } from '../common/margins';
 
@@ -15,7 +15,8 @@ import Thresholds from './Thresholds';
 import PieData from './PieData';
 import { GaugeProps } from './models';
 
-interface Props extends Pick<GaugeProps, 'thresholds'> {
+interface Props extends Pick<GaugeProps, 'thresholds' | 'baseColor'> {
+  displayAsRaw?: boolean;
   height: number;
   metric: Metric;
   width: number;
@@ -30,7 +31,9 @@ const ResponsiveGauge = ({
   width,
   height,
   thresholds,
-  metric
+  metric,
+  displayAsRaw,
+  baseColor
 }: Props): JSX.Element => {
   const svgRef = useRef<SVGSVGElement>(null);
 
@@ -50,28 +53,36 @@ const ResponsiveGauge = ({
   const centerY = innerHeight / 2;
   const centerX = innerWidth / 2;
   const radius = Math.min(innerWidth, innerHeight) / 2;
-  const thresholdValues = flatten([
-    pluck('value', thresholds.warning),
-    pluck('value', thresholds.critical)
-  ]);
+  const thresholdValues = thresholds.enabled
+    ? flatten([
+        pluck('value', thresholds.warning),
+        pluck('value', thresholds.critical)
+      ])
+    : [0];
   const adaptedMaxValue = Math.max(
     metric.maximum_value || 0,
     Math.max(...thresholdValues) * 1.1,
     head(metric.data) as number
   );
 
-  const pieColor = !thresholds.enabled
-    ? theme.palette.success.main
-    : getColorFromDataAndTresholds({
-        data: metric.data[0],
-        theme,
-        thresholds
-      });
+  const pieColor = getColorFromDataAndTresholds({
+    baseColor,
+    data: metric.data[0],
+    theme,
+    thresholds
+  });
 
   const svgTop = svgRef.current?.getBoundingClientRect().top || 0;
   const svgLeft = svgRef.current?.getBoundingClientRect().left || 0;
 
-  const isSmallHeight = height < 250;
+  const isSmallWidget = height < 240;
+
+  const gaugeValue = formatMetricValueWithUnit({
+    base: 1000,
+    isRaw: displayAsRaw,
+    unit: metric.unit,
+    value: metric.data[0]
+  });
 
   return (
     <Box sx={{ position: 'relative' }}>
@@ -87,6 +98,7 @@ const ResponsiveGauge = ({
           />
           <PieData
             adaptedMaxValue={adaptedMaxValue}
+            baseColor={baseColor}
             metric={metric}
             radius={radius}
             thresholds={thresholds}
@@ -97,18 +109,15 @@ const ResponsiveGauge = ({
           style={{
             fill: pieColor,
             ...theme.typography.h3,
-            fontSize: Math.min(width, height) / 7
+            fontSize:
+              Math.min(width, height) / 7 -
+              (isSmallWidget ? 0 : (gaugeValue?.length || 0) * 2)
           }}
           textAnchor="middle"
           x="50%"
-          y={isSmallHeight ? 140 : 100 + Math.min(width, height) / 3}
+          y={isSmallWidget ? 130 : height - height / 2.3}
         >
-          {formatMetricValue({
-            base: 1000,
-            unit: metric.unit,
-            value: metric.data[0]
-          })}{' '}
-          {metric.unit}
+          {gaugeValue}
         </text>
       </svg>
       <Fade in={tooltipOpen && thresholds.enabled}>

package/src/Graph/Gauge/Thresholds.tsx

@@ -16,7 +16,7 @@ const Thresholds = ({
   showTooltip,
   hideTooltip,
   metric
-}: Omit<GaugeProps, 'width' | 'height'>): JSX.Element => {
+}: Omit<GaugeProps, 'width' | 'height'>): JSX.Element | null => {
   const theme = useTheme();
 
   const criticalThresholdValues = pluck('value', thresholds.critical);
@@ -65,30 +65,7 @@ const Thresholds = ({
   });
 
   if (!thresholds.enabled) {
-    return (
-      <Pie
-        data={successThresholdArc}
-        endAngle={-Math.PI / 2}
-        innerRadius={radius - thresholdThickness}
-        outerRadius={radius}
-        pieSortValues={() => -1}
-        pieValue={(d) => d.value}
-        startAngle={Math.PI / 2}
-      >
-        {(pie) => (
-          <AnimatedPie<{ name: string; value: number }>
-            {...pie}
-            animate
-            getColor={(arc) => successThresholdScaleOrdinal(arc.data.name)}
-            getKey={(arc) => `${arc.data.name}_${arc.data.value}`}
-            hideTooltip={hideTooltip}
-            metric={metric}
-            showTooltip={showTooltip}
-            thresholds={thresholds}
-          />
-        )}
-      </Pie>
-    );
+    return null;
   }
 
   const arcs = [

package/src/Graph/Gauge/models.ts

@@ -3,6 +3,7 @@ import { Metric } from '../common/timeSeries/models';
 
 export interface GaugeProps {
   adaptedMaxValue: number;
+  baseColor?: string;
   height: number;
   hideTooltip: () => void;
   metric: Metric;

package/src/Graph/SingleBar/ResponsiveSingleBar.tsx

@@ -9,7 +9,7 @@ import { useSpring, animated } from '@react-spring/web';
 import { alpha, Box, Fade, useTheme } from '@mui/material';
 
 import {
-  formatMetricValue,
+  formatMetricValueWithUnit,
   getMetricWithLatestData
 } from '../common/timeSeries';
 import { Metric } from '../common/timeSeries/models';
@@ -34,16 +34,21 @@ const ResponsiveSingleBar = ({
   data,
   thresholds,
   width,
-  height
+  height,
+  displayAsRaw,
+  baseColor
 }: Props): JSX.Element => {
   const theme = useTheme();
 
   const metric = getMetricWithLatestData(data) as Metric;
   const latestMetricData = head(metric.data) as number;
-  const thresholdValues = flatten([
-    pluck('value', thresholds.warning),
-    pluck('value', thresholds.critical)
-  ]);
+  const thresholdValues = thresholds.enabled
+    ? flatten([
+        pluck('value', thresholds.warning),
+        pluck('value', thresholds.critical)
+      ])
+    : [0];
+
   const adaptedMaxValue = Math.max(
     metric.maximum_value || 0,
     Math.max(...thresholdValues) * 1.1,
@@ -66,6 +71,7 @@ const ResponsiveSingleBar = ({
   const barColor = useMemo(
     () =>
       getColorFromDataAndTresholds({
+        baseColor,
         data: latestMetricData,
         theme,
         thresholds
@@ -81,12 +87,12 @@ const ResponsiveSingleBar = ({
       x="50%"
       y={25}
     >
-      {formatMetricValue({
+      {formatMetricValueWithUnit({
         base: 1000,
+        isRaw: displayAsRaw,
         unit: metric.unit,
         value: metric.data[0]
-      })}{' '}
-      {metric.unit}
+      })}
     </text>
   );
 

package/src/Graph/SingleBar/SingleBar.stories.tsx

@@ -156,3 +156,13 @@ export const rangeThresholds: Story = {
   },
   render: Template
 };
+
+export const RawValue: Story = {
+  args: {
+    data: dataLastWeek,
+    displayAsRaw: true,
+    thresholdTooltipLabels: ['Warning', 'Critical'],
+    thresholds: [0.5, 1.5]
+  },
+  render: Template
+};

package/src/Graph/SingleBar/ThresholdLine.tsx

@@ -4,13 +4,11 @@ import { useTheme } from '@mui/material';
 
 import { groupMargin } from './Thresholds';
 
-const lineMargin = 10;
-
-const thresholdLineHeight = 60 + 2 * lineMargin;
-
+export const barHeight = 72;
 export const margin = 40;
 
-export const barHeight = 50;
+const lineMargin = 10;
+const thresholdLineHeight = barHeight + 2 * lineMargin;
 
 interface Props {
   hideTooltip: () => void;

package/src/Graph/SingleBar/models.ts

@@ -1,6 +1,8 @@
 import { LineChartData, Thresholds } from '../common/models';
 
 export interface SingleBarProps {
+  baseColor?: string;
   data?: LineChartData;
+  displayAsRaw?: boolean;
   thresholds: Thresholds;
 }

package/src/Graph/Text/Text.stories.tsx

@@ -52,3 +52,16 @@ export const critical: Story = {
   },
   render: Template
 };
+
+export const rawValue: Story = {
+  args: {
+    data: dataLastWeek,
+    displayAsRaw: true,
+    labels: {
+      critical: 'Critical',
+      warning: 'Warning'
+    },
+    thresholds: [0.5, 1.5]
+  },
+  render: Template
+};

package/src/Graph/Text/Text.tsx

@@ -4,7 +4,7 @@ import { Typography, useTheme } from '@mui/material';
 
 import { LineChartData, Thresholds } from '../common/models';
 import {
-  formatMetricValue,
+  formatMetricValueWithUnit,
   getMetricWithLatestData
 } from '../common/timeSeries';
 import { getColorFromDataAndTresholds } from '../common/utils';
@@ -12,7 +12,9 @@ import { getColorFromDataAndTresholds } from '../common/utils';
 import { useTextStyles } from './Text.styles';
 
 interface Props {
+  baseColor?: string;
   data?: LineChartData;
+  displayAsRaw?: boolean;
   labels: {
     critical: string;
     warning: string;
@@ -23,7 +25,9 @@ interface Props {
 export const Text = ({
   thresholds,
   data,
-  labels
+  displayAsRaw,
+  labels,
+  baseColor
 }: Props): JSX.Element | null => {
   const theme = useTheme();
   const { classes } = useTextStyles();
@@ -37,20 +41,21 @@ export const Text = ({
   const metricUnit = metric?.unit ?? '';
 
   const color = getColorFromDataAndTresholds({
+    baseColor,
     data: metricValue,
     theme,
     thresholds
   });
 
   const warningThresholdLabels = thresholds.warning.map(({ value }) =>
-    formatMetricValue({
+    formatMetricValueWithUnit({
       unit: metricUnit,
       value
     })
   );
 
   const criticalThresholdLabels = thresholds.critical.map(({ value }) =>
-    formatMetricValue({
+    formatMetricValueWithUnit({
       unit: metricUnit,
       value
     })
@@ -58,24 +63,26 @@ export const Text = ({
 
   return (
     <div className={classes.graphText}>
-      <Typography sx={{ color }} variant="h3">
-        {formatMetricValue({
-          unit: metricUnit,
-          value: metricValue
-        })}{' '}
-        {metricUnit}
+      <Typography sx={{ color }} variant="h2">
+        <strong>
+          {formatMetricValueWithUnit({
+            isRaw: displayAsRaw,
+            unit: metricUnit,
+            value: metricValue
+          })}
+        </strong>
       </Typography>
       {thresholds.enabled && (
         <div className={classes.thresholds}>
           <Typography sx={{ color: 'warning.main' }} variant="h5">
             {labels.warning}
             {': '}
-            {warningThresholdLabels.join(' - ')} {metricUnit}
+            {warningThresholdLabels.join(' - ')}
           </Typography>
           <Typography sx={{ color: 'error.main' }} variant="h5">
             {labels.critical}
             {': '}
-            {criticalThresholdLabels.join(' - ')} {metricUnit}
+            {criticalThresholdLabels.join(' - ')}
           </Typography>
         </div>
       )}

package/src/Graph/common/timeSeries/index.test.ts

@@ -335,10 +335,10 @@ describe('timeSeries', () => {
   describe(timeSeries.formatMetricValue, () => {
     const cases: Array<TestCase> = [
       [218857269, '', 1000, '218.86m'],
-      [218857269, '', 1024, '208.72M'],
+      [218857269, '', 1024, '208.72 M'],
       [0.12232323445, '', 1000, '0.12'],
-      [1024, 'B', 1000, '1K'],
-      [1024, 'B', 1024, '1K'],
+      [1024, 'B', 1000, '1 KB'],
+      [1024, 'B', 1024, '1 KB'],
       [null, 'B', 1024, null]
     ];
 
@@ -504,3 +504,106 @@ describe('timeSeries', () => {
     });
   });
 });
+
+describe('Format value with unit', () => {
+  const units = [
+    'B',
+    'bytes',
+    'bytespersecond',
+    'B/s',
+    'B/sec',
+    'o',
+    'octets',
+    'b/s',
+    'b',
+    'ms',
+    '%',
+    ''
+  ];
+
+  const getExpectedResult = (unit): string => {
+    if (unit === '') {
+      return '324.23m';
+    }
+
+    return `309.21 M${unit}`;
+  };
+
+  const humanReadableTestCases = units.map((unit) => {
+    if (unit === '%') {
+      return {
+        expectedResult: '45.56%',
+        unit,
+        value: 45.55678
+      };
+    }
+
+    if (unit === 'ms') {
+      return {
+        expectedResult: '34.23 seconds',
+        unit,
+        value: 34232
+      };
+    }
+
+    return {
+      expectedResult: getExpectedResult(unit),
+      unit,
+      value: 324234232.34233
+    };
+  });
+
+  const rawTestCases = units.map((unit) => {
+    if (unit === '%') {
+      return {
+        expectedResult: '45.55678%',
+        unit,
+        value: 45.55678
+      };
+    }
+
+    if (unit === 'ms') {
+      return {
+        expectedResult: '34232 ms',
+        unit,
+        value: 34232
+      };
+    }
+
+    return {
+      expectedResult:
+        unit === '' ? '324234232.34233 ' : `324234232.34233 ${unit}`,
+      unit,
+      value: 324234232.34233
+    };
+  });
+
+  describe('Format the value as human readable', () => {
+    it.each(humanReadableTestCases)(
+      'formats the value with $unit',
+      ({ value, unit, expectedResult }) => {
+        expect(
+          timeSeries.formatMetricValueWithUnit({
+            unit,
+            value
+          })
+        ).toEqual(expectedResult);
+      }
+    );
+  });
+
+  describe('Format the value as raw', () => {
+    it.each(rawTestCases)(
+      'formats the value with $unit',
+      ({ value, unit, expectedResult }) => {
+        expect(
+          timeSeries.formatMetricValueWithUnit({
+            isRaw: true,
+            unit,
+            value
+          })
+        ).toEqual(expectedResult);
+      }
+    );
+  });
+});