@centreon/ui 23.10.1-sync-dev-23-10-x-develop-oss.0 → 23.10.1-sync-release-34346.0

package/src/Typography/EllipsisTypography.tsx

@@ -0,0 +1,18 @@
+import { Box, Typography, TypographyProps } from '@mui/material';
+
+const EllipsisTypography = (props: TypographyProps): JSX.Element => {
+  return (
+    <Box sx={{ width: '100%' }}>
+      <Typography
+        sx={{
+          overflow: 'hidden',
+          textOverflow: 'ellipsis',
+          whiteSpace: 'nowrap'
+        }}
+        {...props}
+      />
+    </Box>
+  );
+};
+
+export default EllipsisTypography;

package/src/Typography/Subtitle.tsx

@@ -0,0 +1,55 @@
+import { ReactNode } from 'react';
+
+import { type, equals } from 'ramda';
+import { useTranslation } from 'react-i18next';
+
+import { Typography } from '@mui/material';
+import HelpOutlineIcon from '@mui/icons-material/HelpOutline';
+
+import { Tooltip } from '../components';
+
+interface Props {
+  children: ReactNode;
+  secondaryLabel?: string | Array<string>;
+}
+
+const Subtitle = ({ children, secondaryLabel }: Props): JSX.Element => {
+  const { t } = useTranslation();
+
+  const containsSeveralSecondaryLabels = equals(type(secondaryLabel), 'Array');
+
+  return (
+    <Typography variant="subtitle1">
+      <strong>{children}</strong>
+      {secondaryLabel && (
+        <Tooltip
+          aria-label={
+            containsSeveralSecondaryLabels
+              ? secondaryLabel[0]
+              : (secondaryLabel as string)
+          }
+          followCursor={false}
+          label={
+            containsSeveralSecondaryLabels ? (
+              <>
+                {secondaryLabel.map((label) => (
+                  <p key={label}>{t(label)}</p>
+                ))}
+              </>
+            ) : (
+              t(secondaryLabel)
+            )
+          }
+          placement="right"
+        >
+          <HelpOutlineIcon
+            color="primary"
+            sx={{ ml: 1, verticalAlign: 'middle' }}
+          />
+        </Tooltip>
+      )}
+    </Typography>
+  );
+};
+
+export default Subtitle;

package/src/api/buildListingEndpoint/models.ts

@@ -52,7 +52,8 @@ export type Operator =
   | '$lk'
   | '$nk'
   | '$in'
-  | '$ni';
+  | '$ni'
+  | '$rg';
 
 export type ConditionValue = {
   [value in Operator]?: string | Array<string>;

package/src/api/customFetch.ts

@@ -1,4 +1,4 @@
-import { equals } from 'ramda';
+import { equals, isNil, startsWith } from 'ramda';
 import { JsonDecoder } from 'ts.data.json';
 
 import { Method } from './useMutationQuery';
@@ -22,6 +22,7 @@ export interface CatchErrorProps {
 }
 
 interface CustomFetchProps<T> {
+  baseEndpoint?: string;
   catchError?: (props: CatchErrorProps) => void;
   decoder?: JsonDecoder.Decoder<T>;
   defaultFailureMessage?: string;
@@ -42,10 +43,18 @@ export const customFetch = <T>({
   defaultFailureMessage = 'Something went wrong',
   isMutation = false,
   payload,
-  method = 'GET'
+  method = 'GET',
+  baseEndpoint = './api/latest'
 }: CustomFetchProps<T>): Promise<T | ResponseError> => {
   const defaultOptions = { headers, method, signal };
 
+  const formattedEndpoint =
+    !isNil(baseEndpoint) &&
+    !startsWith(baseEndpoint, endpoint) &&
+    !startsWith('./api/internal.php', endpoint)
+      ? `${baseEndpoint}${endpoint}`
+      : endpoint;
+
   const options = isMutation
     ? {
         ...defaultOptions,
@@ -53,7 +62,7 @@ export const customFetch = <T>({
       }
     : defaultOptions;
 
-  return fetch(endpoint, options)
+  return fetch(formattedEndpoint, options)
     .then((response) => {
       if (equals(response.status, 204)) {
         return {

package/src/api/useFetchQuery/index.ts

@@ -1,4 +1,4 @@
-import { useEffect, useMemo } from 'react';
+import { useEffect, useMemo, useRef } from 'react';
 
 import 'ulog';
 import {
@@ -10,16 +10,18 @@ import {
 } from '@tanstack/react-query';
 import { JsonDecoder } from 'ts.data.json';
 import anylogger from 'anylogger';
-import { has, includes, not, omit } from 'ramda';
+import { has, includes, isNil, not, omit } from 'ramda';
 
 import { CatchErrorProps, customFetch, ResponseError } from '../customFetch';
 import useSnackbar from '../../Snackbar/useSnackbar';
 import { useDeepCompare } from '../../utils';
 
 export interface UseFetchQueryProps<T> {
+  baseEndpoint?: string;
   catchError?: (props: CatchErrorProps) => void;
   decoder?: JsonDecoder.Decoder<T>;
   defaultFailureMessage?: string;
+  doNotCancelCallsOnUnmount?: boolean;
   fetchHeaders?: HeadersInit;
   getEndpoint: (params?: PrefetchEndpointParams) => string;
   getQueryKey: () => QueryKey;
@@ -54,14 +56,19 @@ const useFetchQuery = <T extends object>({
   fetchHeaders,
   isPaginated,
   queryOptions,
-  httpCodesBypassErrorSnackbar = []
+  httpCodesBypassErrorSnackbar = [],
+  baseEndpoint,
+  doNotCancelCallsOnUnmount = false
 }: UseFetchQueryProps<T>): UseFetchQueryState<T> => {
+  const dataRef = useRef<T | undefined>(undefined);
+
   const { showErrorMessage } = useSnackbar();
 
   const queryData = useQuery<T | ResponseError, Error>(
     getQueryKey(),
     ({ signal }): Promise<T | ResponseError> =>
       customFetch<T>({
+        baseEndpoint,
         catchError,
         decoder,
         defaultFailureMessage,
@@ -96,6 +103,7 @@ const useFetchQuery = <T extends object>({
       queryKey,
       ({ signal }): Promise<T | ResponseError> =>
         customFetch<T>({
+          baseEndpoint,
           catchError,
           decoder,
           defaultFailureMessage,
@@ -137,6 +145,7 @@ const useFetchQuery = <T extends object>({
       getQueryKey(),
       ({ signal }): Promise<T | ResponseError> =>
         customFetch<T>({
+          baseEndpoint,
           catchError,
           decoder,
           defaultFailureMessage,
@@ -153,10 +162,18 @@ const useFetchQuery = <T extends object>({
     [queryData.data]
   );
 
+  if (!isNil(data)) {
+    dataRef.current = data;
+  }
+
   const errorData = queryData.data as ResponseError | undefined;
 
   useEffect(() => {
     return (): void => {
+      if (doNotCancelCallsOnUnmount) {
+        return;
+      }
+
       queryClient.cancelQueries(getQueryKey());
     };
   }, []);
@@ -166,8 +183,8 @@ const useFetchQuery = <T extends object>({
   }, useDeepCompare([queryData.data]));
 
   return {
-    ...omit(['data'], queryData),
-    data,
+    ...omit(['data', 'error'], queryData),
+    data: dataRef.current,
     error: errorData?.isError ? omit(['isError'], errorData) : null,
     fetchQuery,
     prefetchNextPage,

package/src/api/useGraphQuery/index.ts

@@ -92,6 +92,9 @@ const useGraphQuery = ({
     : getStartEndFromTimePeriod(timePeriodToUse as number);
 
   const definedMetrics = metrics.filter((metric) => metric);
+  const formattedDefinedMetrics = definedMetrics.map((metric) =>
+    encodeURIComponent(metric)
+  );
 
   const {
     data: graphData,
@@ -115,7 +118,7 @@ const useGraphQuery = ({
 
       return `${endpoint}&start=${startAndEnd.start}&end=${
         startAndEnd.end
-      }&metric_names=[${definedMetrics.join(',')}]`;
+      }&metric_names=[${formattedDefinedMetrics.join(',')}]`;
     },
     getQueryKey: () => [
       'graph',

package/src/api/useMutationQuery/index.ts

@@ -23,6 +23,7 @@ export enum Method {
 }
 
 export type UseMutationQueryProps<T, TMeta> = {
+  baseEndpoint?: string;
   catchError?: (props: CatchErrorProps) => void;
   decoder?: JsonDecoder.Decoder<T>;
   defaultFailureMessage?: string;
@@ -49,7 +50,8 @@ const useMutationQuery = <T extends object, TMeta>({
   method,
   onMutate,
   onError,
-  onSuccess
+  onSuccess,
+  baseEndpoint
 }: UseMutationQueryProps<T, TMeta>): UseMutationQueryState<T> => {
   const { showErrorMessage } = useSnackbar();
 
@@ -62,6 +64,7 @@ const useMutationQuery = <T extends object, TMeta>({
       const { _meta, ...payload } = _payload || {};
 
       return customFetch<T>({
+        baseEndpoint,
         catchError,
         decoder,
         defaultFailureMessage,
@@ -78,7 +81,14 @@ const useMutationQuery = <T extends object, TMeta>({
     {
       onError,
       onMutate,
-      onSuccess
+      onSuccess: (data, variables, context) => {
+        if (data?.isError) {
+          onError?.(data, variables, context);
+
+          return;
+        }
+        onSuccess?.(data, variables, context);
+      }
     }
   );
 

package/src/components/Form/AccessRightsV2/AccessRights.cypress.spec.tsx

@@ -0,0 +1,350 @@
+import { Provider, createStore } from 'jotai';
+
+import { Method, SnackbarProvider, TestQueryProvider } from '../../..';
+
+import { AccessRights } from './AccessRights';
+import {
+  buildResult,
+  emptyAccessRights,
+  labels,
+  removedAccessRights,
+  roles,
+  simpleAccessRights,
+  updatedAccessRights
+} from './storiesData';
+
+const initialize = ({
+  initialValues = simpleAccessRights,
+  loading = false,
+  link = 'link'
+}): unknown => {
+  const cancel = cy.stub();
+  const save = cy.stub();
+
+  cy.interceptAPIRequest({
+    alias: 'getContacts',
+    method: Method.GET,
+    path: '**/contacts?**',
+    response: buildResult(false)
+  });
+  cy.interceptAPIRequest({
+    alias: 'getContactGroups',
+    method: Method.GET,
+    path: '**/contact-groups?**',
+    response: buildResult(true)
+  });
+
+  cy.mount({
+    Component: (
+      <SnackbarProvider>
+        <TestQueryProvider>
+          <Provider store={createStore()}>
+            <AccessRights
+              cancel={cancel}
+              endpoints={{
+                contact: '/contacts',
+                contactGroup: '/contact-groups'
+              }}
+              initialValues={initialValues}
+              labels={labels}
+              link={link}
+              loading={loading}
+              roles={roles}
+              submit={save}
+            />
+          </Provider>
+        </TestQueryProvider>
+      </SnackbarProvider>
+    )
+  });
+
+  return {
+    cancel,
+    save
+  };
+};
+
+describe('Access rights', () => {
+  it('displays the access rights in loading state', () => {
+    initialize({ loading: true });
+
+    cy.contains('Share dashboard with').should('be.visible');
+    cy.contains('Contact').should('be.visible');
+    cy.contains('Contact group').should('be.visible');
+    cy.findByLabelText('Add a contact').should('be.visible');
+    cy.findByTestId('add_role').should('be.disabled');
+    cy.findByTestId('add').should('be.disabled');
+    cy.findByLabelText('Copy link').should('be.visible');
+    cy.findByLabelText('Cancel').should('be.visible');
+    cy.findByLabelText('Save').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the access rights without link', () => {
+    initialize({ link: null });
+
+    cy.findByLabelText('Copy link').should('not.exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the access rights with an empty list', () => {
+    initialize({ initialValues: emptyAccessRights });
+
+    cy.contains('The contact list is empty').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays the access rights with an empty list', () => {
+    initialize({});
+
+    simpleAccessRights.forEach(({ name, email, isContactGroup, role }) => {
+      cy.contains(name).should('be.visible');
+      cy.contains(email).should('be.visible');
+      cy.get(`[data-groupChip="${name}"]`).should(
+        isContactGroup ? 'be.visible' : 'not.exist'
+      );
+      cy.findByTestId(`role-${name}`).should('have.value', role);
+      cy.findByTestId(`remove-${name}`).should('be.visible');
+    });
+
+    cy.makeSnapshot();
+  });
+
+  it('displays a removed chip when the corresponding icon is clicked', () => {
+    initialize({});
+
+    cy.findByTestId(`remove-Leah McGlynn`).should(
+      'have.attr',
+      'data-removed',
+      'false'
+    );
+
+    cy.findByTestId(`remove-Leah McGlynn`).click();
+
+    cy.findByTestId(`remove-Leah McGlynn`).should(
+      'have.attr',
+      'data-removed',
+      'true'
+    );
+    cy.contains(labels.list.removed).should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('restores the contact when the contact is removed and the corresponding icon is clicked', () => {
+    initialize({});
+
+    cy.findByTestId(`remove-Leah McGlynn`).click();
+
+    cy.findByTestId(`remove-Leah McGlynn`).should(
+      'have.attr',
+      'data-removed',
+      'true'
+    );
+    cy.contains(labels.list.removed).should('be.visible');
+
+    cy.findByTestId(`remove-Leah McGlynn`).click();
+
+    cy.findByTestId(`remove-Leah McGlynn`).should(
+      'have.attr',
+      'data-removed',
+      'false'
+    );
+    cy.contains(labels.list.removed).should('not.exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('submits the new acces rights list without the removed contact', () => {
+    const { save } = initialize({});
+
+    cy.findByTestId(`remove-Leah McGlynn`).click();
+
+    cy.findByTestId(`remove-Leah McGlynn`).should(
+      'have.attr',
+      'data-removed',
+      'true'
+    );
+    cy.contains(labels.list.removed).should('be.visible');
+    cy.contains('1 removed').should('be.visible');
+
+    cy.contains(labels.actions.save)
+      .click()
+      .then(() => {
+        expect(save).to.have.been.calledWith(removedAccessRights);
+      });
+
+    cy.makeSnapshot();
+  });
+
+  it('submits the new acces rights list with the updated contact', () => {
+    const { save } = initialize({});
+
+    cy.findByTestId(`role-Leah McGlynn`).parent().click();
+
+    cy.get('li[data-value="editor"]').click();
+    cy.contains(labels.list.updated).should('be.visible');
+    cy.contains('1 updated').should('be.visible');
+
+    cy.contains(labels.actions.save)
+      .click()
+      .then(() => {
+        expect(save).to.have.been.calledWith(updatedAccessRights);
+      });
+
+    cy.makeSnapshot();
+  });
+
+  it('removes the updated chip when the contact role is updated and its initial role is assigned back', () => {
+    initialize({});
+
+    cy.findByTestId(`role-Leah McGlynn`).parent().click();
+
+    cy.get('li[data-value="editor"]').click();
+    cy.contains(labels.list.updated).should('be.visible');
+
+    cy.get('li[data-value="viewer"]').click();
+    cy.contains(labels.list.updated).should('not.exist');
+
+    cy.makeSnapshot();
+  });
+
+  it('retrieves contacts when the contact radio is selected', () => {
+    initialize({});
+
+    cy.contains(labels.add.contact).click();
+    cy.findByLabelText(labels.add.autocompleteContact).click();
+
+    cy.waitForRequest('@getContacts');
+
+    cy.makeSnapshot();
+  });
+
+  it('retrieves contact groups when the contact group radio is selected', () => {
+    initialize({});
+
+    cy.contains(labels.add.contactGroup).click();
+    cy.findByLabelText(labels.add.autocompleteContactGroup).click();
+
+    cy.waitForRequest('@getContactGroups');
+
+    cy.makeSnapshot();
+  });
+
+  it('adds the contact as viewer when a contact is selected and the corresponding button is clicked', () => {
+    initialize({});
+
+    cy.contains(labels.add.contact).click();
+    cy.findByLabelText(labels.add.autocompleteContact).click();
+
+    cy.waitForRequest('@getContacts');
+
+    cy.contains('Entity 10').click();
+
+    cy.findByTestId('add').click();
+
+    cy.contains('Entity 10').should('be.visible');
+
+    cy.findByTestId('role-Entity 10').should('have.value', 'viewer');
+    cy.contains(labels.list.added).should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('adds the contact group as editor when a contact group is selected and the corresponding button is clicked', () => {
+    initialize({});
+
+    cy.contains(labels.add.contactGroup).click();
+    cy.findByLabelText(labels.add.autocompleteContactGroup).click();
+
+    cy.waitForRequest('@getContactGroups');
+
+    cy.contains('Entity Group 10').click();
+    cy.findByTestId('add_role').parent().click();
+    cy.get('li[data-value="editor"]').click();
+    cy.findByTestId('add').click();
+
+    cy.contains('Entity Group 10').should('be.visible');
+
+    cy.findByTestId('role-Entity Group 10').should('have.value', 'editor');
+    cy.contains(labels.list.added).should('be.visible');
+    cy.contains('1 added').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('displays statistics when a contact is added, a contact is updated and a contact is removed', () => {
+    initialize({});
+
+    cy.contains(labels.add.contactGroup).click();
+    cy.findByLabelText(labels.add.autocompleteContactGroup).click();
+
+    cy.waitForRequest('@getContactGroups');
+
+    cy.contains('Entity Group 10').click();
+    cy.findByTestId('add_role').parent().click();
+    cy.get('li[data-value="editor"]').click();
+    cy.findByTestId('add').click();
+
+    cy.contains('Entity Group 10').should('be.visible');
+
+    cy.findByTestId(`role-Leah McGlynn`).parent().click();
+    cy.get('li[data-value="editor"]').click();
+
+    cy.findByTestId('remove-Jody Blanda').click();
+
+    cy.contains('1 added | 1 updated | 1 removed').should('be.visible');
+
+    cy.makeSnapshot();
+  });
+
+  it('clears the autocomplete when a contact is selected and the contact type is changed', () => {
+    initialize({});
+
+    cy.contains(labels.add.contact).click();
+    cy.findByLabelText(labels.add.autocompleteContact).click();
+
+    cy.waitForRequest('@getContacts');
+
+    cy.contains('Entity 10').click();
+    cy.findByLabelText(labels.add.autocompleteContact).should(
+      'have.value',
+      'Entity  10'
+    );
+
+    cy.contains(labels.add.contactGroup).click();
+    cy.findByLabelText(labels.add.autocompleteContactGroup).should(
+      'have.value',
+      ''
+    );
+
+    cy.makeSnapshot();
+  });
+
+  it('removes the contact from the list when the contact has been to the list and the corresponding button is clicked', () => {
+    initialize({});
+
+    cy.contains(labels.add.contact).click();
+    cy.findByLabelText(labels.add.autocompleteContact).click();
+
+    cy.waitForRequest('@getContacts');
+
+    cy.contains('Entity 10').click();
+
+    cy.findByTestId('add').click();
+
+    cy.contains('Entity 10').should('be.visible');
+
+    cy.contains(labels.list.added).should('be.visible');
+
+    cy.findByTestId('remove-Entity 10').click();
+
+    cy.contains('Entity 10').should('not.exist');
+    cy.contains(labels.list.added).should('not.exist');
+
+    cy.makeSnapshot();
+  });
+});