@centreon/ui 24.4.1-MON-32982-migrate-playlists-front-code.4 → 24.4.1-MON-25027-refactor-access-rights.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@centreon/ui",
-  "version": "24.4.1-MON-32982-migrate-playlists-front-code.4",
+  "version": "24.4.1-MON-25027-refactor-access-rights.3",
   "description": "Centreon UI Components",
   "scripts": {
     "eslint": "eslint ./src --ext .js,.jsx,.ts,.tsx --max-warnings 0",
@@ -85,6 +85,8 @@
     "identity-obj-proxy": "^3.0.0",
     "jest-transform-stub": "^2.0.0",
     "mochawesome": "^7.1.3",
+    "msw": "1.3.2",
+    "msw-storybook-addon": "^1.10.0",
     "puppeteer": "^13.7.0",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
@@ -157,5 +159,8 @@
   "jest-junit": {
     "suiteName": "jest tests",
     "output": "./junit.xml"
+  },
+  "msw": {
+    "workerDirectory": "public"
   }
 }

package/public/mockServiceWorker.js

@@ -2,7 +2,7 @@
 /* tslint:disable */
 
 /**
- * Mock Service Worker (1.2.1).
+ * Mock Service Worker (1.3.2).
  * @see https://github.com/mswjs/msw
  * - Please do NOT modify this file.
  * - Please do NOT serve this file on production.
@@ -300,4 +300,4 @@ function sleep(timeMs) {
 async function respondWithMock(response) {
   await sleep(response.delay)
   return new Response(response.body, response)
-}
+}

package/src/FallbackPage/FallbackPage.tsx

@@ -17,7 +17,7 @@ const useStyles = makeStyles()((theme) => ({
   logo: {
     alignSelf: 'flex-end',
     height: theme.spacing(11),
-    width: '239px'
+    width: '22rem'
   },
   message: {
     color: theme.palette.text.primary
@@ -66,9 +66,9 @@ export const FallbackPage: FC<FallbackPageProps> = typedMemo(
 
     return (
       <div className={classes.notAuthorizedContainer}>
-        <div className={classes.logo}>
+        <section className={classes.logo}>
           <CentreonLogo />
-        </div>
+        </section>
         <section className={classes.messageBlock}>
           <header>
             <Typography color="primary" fontWeight="bold" variant="h3">

package/src/InputField/Select/Autocomplete/Connected/index.tsx

@@ -33,6 +33,7 @@ import useFetchQuery from '../../../../api/useFetchQuery';
 export interface ConnectedAutoCompleteFieldProps<TData> {
   allowUniqOption?: boolean;
   baseEndpoint?: string;
+  changeIdValue: (item: TData) => number | string;
   conditionField?: keyof SelectEntry;
   field: string;
   getEndpoint: ({ search, page }) => string;
@@ -62,6 +63,7 @@ const ConnectedAutocompleteField = (
     queryKey,
     allowUniqOption,
     baseEndpoint,
+    changeIdValue,
     ...props
   }: ConnectedAutoCompleteFieldProps<TData> &
     Omit<AutocompleteFieldProps, 'options'>): JSX.Element => {
@@ -238,17 +240,24 @@ const ConnectedAutocompleteField = (
 
         const moreOptions = page > 1 ? options : [];
 
+        const formattedList = changeIdValue
+          ? newOptions.result.map((item) => ({
+              ...item,
+              id: changeIdValue(item)
+            }))
+          : newOptions.result;
+
         if (!isEmpty(labelKey) && !isNil(labelKey)) {
-          const list = newOptions.result.map((item) =>
+          const list = formattedList.map((item) =>
             renameKey({ key: labelKey, newKey: 'name', object: item })
           );
           setOptions(moreOptions.concat(list as Array<TData>));
 
           return;
         }
-        setOptions(moreOptions.concat(newOptions.result));
+        setOptions(moreOptions.concat(formattedList));
 
-        setOptions(moreOptions.concat(newOptions.result as Array<TData>));
+        setOptions(moreOptions.concat(formattedList as Array<TData>));
 
         const total = prop('total', newOptions.meta) || 1;
         const limit = prop('limit', newOptions.meta) || 1;

package/src/Listing/Cell/DataCell.tsx

@@ -107,21 +107,7 @@ const DataCell = ({
       const isCellHidden = getHiddenCondition?.(isRowSelected);
 
       if (isCellHidden) {
-        return (
-          <Cell
-            className={classes.cell}
-            isRowHighlighted={isRowHighlighted}
-            listingVariant={listingVariant}
-            onClick={(e): void => {
-              if (!clickable) {
-                return;
-              }
-              e.preventDefault();
-              e.stopPropagation();
-            }}
-            {...commonCellProps}
-          />
-        );
+        return null;
       }
 
       return (

package/src/Module/LicensedModule/LicenseCheck/index.tsx

@@ -1,7 +1,10 @@
+import * as React from 'react';
+
+import { isNil } from 'ramda';
 import { useTranslation } from 'react-i18next';
 
 import { FallbackPage } from '../../../FallbackPage/FallbackPage';
-import { MenuSkeleton, PageSkeleton, useFetchQuery } from '../../..';
+import { PageSkeleton, useFetchQuery } from '../../..';
 import { getModuleLicenseCheckEndpoint } from '../api';
 
 import { licenseDecoder } from './decoder';
@@ -14,27 +17,17 @@ import {
 
 export interface LicenseCheckProps {
   children: React.ReactElement;
-  isFederatedComponent?: boolean;
   moduleName: string;
 }
 
 interface ContentProps {
   children: React.ReactElement;
-  isFederatedComponent?: boolean;
   isValid: boolean;
 }
 
-const Content = ({
-  children,
-  isValid,
-  isFederatedComponent
-}: ContentProps): JSX.Element | null => {
+const Content = ({ children, isValid }: ContentProps): JSX.Element => {
   const { t } = useTranslation();
 
-  if (isFederatedComponent && !isValid) {
-    return null;
-  }
-
   return isValid ? (
     children
   ) : (
@@ -48,10 +41,9 @@ const Content = ({
 
 const LicenseCheck = ({
   children,
-  moduleName,
-  isFederatedComponent
+  moduleName
 }: LicenseCheckProps): JSX.Element | null => {
-  const { isError, data, isLoading } = useFetchQuery<License>({
+  const { isError, data } = useFetchQuery<License>({
     decoder: licenseDecoder,
     getEndpoint: () => getModuleLicenseCheckEndpoint(moduleName),
     getQueryKey: () => ['license', moduleName]
@@ -63,17 +55,10 @@ const LicenseCheck = ({
 
   const isValid = data?.success;
 
-  const skeleton = isFederatedComponent ? <MenuSkeleton /> : <PageSkeleton />;
-
-  return isLoading ? (
-    skeleton
+  return isNil(isValid) ? (
+    <PageSkeleton />
   ) : (
-    <Content
-      isFederatedComponent={isFederatedComponent}
-      isValid={isValid as boolean}
-    >
-      {children}
-    </Content>
+    <Content isValid={isValid as boolean}>{children}</Content>
   );
 };
 

package/src/Module/LicensedModule/index.tsx

@@ -7,17 +7,11 @@ type Props = ModuleProps & LicenseCheckProps;
 const LicensedModule = ({
   moduleName,
   children,
-  isFederatedComponent,
   ...props
 }: Props): JSX.Element => {
   return (
     <Module {...props}>
-      <LicenseCheck
-        isFederatedComponent={isFederatedComponent}
-        moduleName={moduleName}
-      >
-        {children}
-      </LicenseCheck>
+      <LicenseCheck moduleName={moduleName}>{children}</LicenseCheck>
     </Module>
   );
 };

package/src/Module/index.tsx

@@ -1,3 +1,5 @@
+import * as React from 'react';
+
 import { Provider as JotaiProvider, createStore } from 'jotai';
 
 import { createGenerateClassName, StylesProvider } from '@mui/styles';
@@ -7,7 +9,7 @@ import SnackbarProvider from '../Snackbar/SnackbarProvider';
 
 export interface ModuleProps {
   children: React.ReactElement;
-  maxSnackbars?: number;
+  maxSnackbars: number;
   seedName: string;
   store: ReturnType<typeof createStore>;
 }
@@ -15,7 +17,7 @@ export interface ModuleProps {
 const Module = ({
   children,
   seedName,
-  maxSnackbars = 3,
+  maxSnackbars,
   store
 }: ModuleProps): JSX.Element => {
   const generateClassName = createGenerateClassName({

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

@@ -0,0 +1,346 @@
+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>
+          <AccessRights
+            cancel={cancel}
+            endpoints={{
+              contact: '/contacts',
+              contactGroup: '/contact-groups'
+            }}
+            initialValues={initialValues}
+            labels={labels}
+            link={link}
+            loading={loading}
+            roles={roles}
+            submit={save}
+          />
+        </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();
+  });
+});