@centreon/ui 23.10.53 → 23.10.54

package/package.json

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

package/src/utils/index.ts

@@ -17,3 +17,4 @@ export * from './panelSize';
 export * from './sanitizedHTML';
 export * from './docsURL';
 export * from './useInfiniteScrollListing';
+export * from './useLicenseExpirationWarning';

package/src/utils/translatedLabel.ts

@@ -0,0 +1,2 @@
+export const labelLicenseWarning = (module, daysUntilExpiration): string =>
+  `The ${module} license will expire in ${daysUntilExpiration} days`;

package/src/utils/useLicenseExpirationWarning.cypress.spec.tsx

@@ -0,0 +1,137 @@
+import dayjs from 'dayjs';
+
+import { TestQueryProvider, Method, SnackbarProvider } from '@centreon/ui';
+
+import { labelLicenseWarning } from './translatedLabel';
+
+import { useLicenseExpirationWarning } from '.';
+
+const getMockedResponse = (expirationDate): object => ({
+  result: {
+    module: {
+      entities: [
+        {
+          description: 'Centreon Auto Discovery',
+          id: 'centreon-autodiscovery-server',
+          label: 'Centreon',
+          license: {
+            expiration_date: expirationDate,
+            host_limit: -1,
+            host_usage: 1,
+            is_valid: true,
+            required: true
+          },
+          type: 'module',
+          version: {
+            available: '23.10.0',
+            current: '23.10.0',
+            installed: true,
+            outdated: false
+          }
+        },
+        {
+          description: 'Centreon License Manager',
+          id: 'centreon-license-manager',
+          label: 'Centreon',
+          license: {
+            required: false
+          },
+          type: 'module',
+          version: {
+            available: '23.10.0',
+            current: '23.10.0',
+            installed: true,
+            outdated: false
+          }
+        },
+        {
+          description: 'Centreon Monitoring Connectors Manager',
+          id: 'centreon-pp-manager',
+          label: 'Centreon',
+          license: {
+            required: false
+          },
+          type: 'module',
+          version: {
+            available: '23.10.0',
+            current: '23.10.0',
+            installed: true,
+            outdated: false
+          }
+        }
+      ],
+      pagination: {
+        limit: 3,
+        offset: 0,
+        total: 3
+      }
+    },
+    widget: {
+      entities: [],
+      pagination: {
+        limit: 0,
+        offset: 0,
+        total: 0
+      }
+    }
+  },
+  status: true
+});
+
+const mockRequest = ({ expirationDate }: { expirationDate }): void => {
+  cy.interceptAPIRequest({
+    alias: 'getLicenseInformations',
+    method: Method.GET,
+    path: '**internal.php?object=centreon_module&action=list',
+    response: getMockedResponse(expirationDate)
+  });
+};
+
+const TestComponent = (): JSX.Element => {
+  useLicenseExpirationWarning({
+    module: 'centreon-autodiscovery-server'
+  });
+
+  return <div />;
+};
+
+const TestWithQueryProvider = (): JSX.Element => {
+  return (
+    <TestQueryProvider>
+      <SnackbarProvider>
+        <TestComponent />
+      </SnackbarProvider>
+    </TestQueryProvider>
+  );
+};
+
+const initialize = (): void => {
+  cy.viewport('macbook-13');
+
+  cy.mount({
+    Component: <TestWithQueryProvider />
+  });
+};
+
+const currentDate = dayjs();
+
+describe('License', () => {
+  beforeEach(initialize);
+
+  it('does not display any warning message when the license expires in more than 15 days from the current date', () => {
+    mockRequest({ expirationDate: currentDate.add(20, 'day') });
+
+    cy.waitForRequest('@getLicenseInformations');
+
+    cy.findByText(
+      labelLicenseWarning('centreon-autodiscovery-server', 20)
+    ).should('not.exist');
+  });
+  it('displays a warning message when the license expires within 15 days', () => {
+    mockRequest({ expirationDate: currentDate.add(10.5, 'day') });
+
+    cy.findByText(labelLicenseWarning('centreon-autodiscovery-server', 10));
+
+    cy.matchImageSnapshot();
+  });
+});

package/src/utils/useLicenseExpirationWarning.ts

@@ -0,0 +1,52 @@
+import { useEffect } from 'react';
+
+import dayjs from 'dayjs';
+import { path, pipe, propEq, find, lt, isNil } from 'ramda';
+import { useTranslation } from 'react-i18next';
+
+import { useFetchQuery, useSnackbar } from '..';
+
+import { labelLicenseWarning } from './translatedLabel';
+
+const legacyBaseEndpoint = './api/internal.php';
+const extensionsEndpoint = `${legacyBaseEndpoint}?object=centreon_module&action=list`;
+
+interface Props {
+  module: string;
+}
+
+export const useLicenseExpirationWarning = ({ module }: Props): void => {
+  const { t } = useTranslation();
+  const { showWarningMessage } = useSnackbar();
+
+  const { fetchQuery } = useFetchQuery({
+    getEndpoint: () => extensionsEndpoint,
+    getQueryKey: () => [module]
+  });
+
+  const currentDate = dayjs();
+
+  const getExpirationDate = pipe(
+    path(['result', 'module', 'entities']),
+    find(propEq('id', module)),
+    path(['license', 'expiration_date'])
+  ) as (data) => string;
+
+  useEffect(() => {
+    fetchQuery().then((response) => {
+      const expirationDate = getExpirationDate(response);
+      if (isNil(expirationDate)) {
+        return;
+      }
+
+      const daysUntilExpiration = dayjs(expirationDate).diff(
+        currentDate,
+        'day'
+      );
+
+      if (lt(daysUntilExpiration, 15)) {
+        showWarningMessage(t(labelLicenseWarning(module, daysUntilExpiration)));
+      }
+    });
+  }, []);
+};