@centreon/ui 24.11.14 → 24.11.22

package/README.md

@@ -20,27 +20,57 @@ To start Storybook server, run:
 
 `pnpm storybook`
 
-# Tests
 
-We have two kind of tests:
- - Unit tests provided by Jest
- - End to End tests provided by Storyshot using Jest. Storyshot is an addon of Storybook that compares graphically our stories.
+# Add stories
 
-To run Unit tests:
+- Create a file named `index.stories.tsx` along side your component
+      
+- Add a title, the component and argTypes
+  
+  ```typescript
+  export default {
+    title: 'MyComponent',
+    Component: MyComponent,
+    argTypes: {
+      propA: { control: 'text' },
+      propB: { control: 'number' },
+    },
+  };
+  ```
 
-`pnpm test`
+- Create a playground for your component
 
-or
+  ```typescript
+    const Template: ComponentStory<typeof MyComponent> = (args) => (
+      <MyComponent {...args} />
+    );
 
-`pnpm t`
+    export const Playground = Template.bind({});
+  ```
 
-To run End to End tests:
-  - Build Storybook : `pnpm build:storybook`
-  - Run all Storyshot tests : `pnpm test:storyshot`
+- Then add your story
 
-You can also test one or more Components using the following syntax:
+  ```typescript
+    export const basic = Template.bind({});
+    basic.args = { propA: 'test', propB: 0 };
+  ```
+
+# Tests architecture
+
+There are two kinds of tests in Centreon UI.
+- Jest + RTL and Cypress: Component testing. We want to migrate from Jest to Cypress
+- Chromatic: Chromatic is a tool that snapshots our stories and better handle snapshots changes using a review process
+
+
+### Run Jest tests
+
+```bash
+pnpm t
+```
+
+### Run Cypress tests
 
 ```bash
-pnpm test:storyshot -- --story "Title" # Run Storyshot tests about Title component
-pnpm test:storyshot -- --story "Breadcrumb|Title" # Run Storyshot tests about Title and Breadcrumb components
+pnpm cypress:ui # Opens the Cypress controlled browser to debug tests
+pnpm cypress:cli # Runs tests in the terminal
 ```

package/package.json

@@ -1,17 +1,24 @@
 {
   "name": "@centreon/ui",
-  "version": "24.11.14",
+  "version": "24.11.22",
   "description": "Centreon UI Components",
-  "main": "src/index.ts",
   "scripts": {
-    "eslint": "eslint ./src --ext .js,.jsx,.ts,.tsx --max-warnings 0",
-    "eslint:fix": "pnpm eslint --fix",
-    "storybook": "start-storybook -p 9001 -c .storybook",
-    "build:storybook": "build-storybook -c .storybook -o .out",
-    "test": "node testRunner.js",
-    "test:storyshot": "pnpm test storyshots.test.js",
-    "test:ci": "node testRunner.js --silent --reporter=jest-junit"
+    "update:deps": "pnpx npm-check-updates -i --format group",
+    "lint": "biome check ./src/ --error-on-warnings",
+    "lint:fix": "pnpm lint --fix",
+    "lint:ci": "biome ci ./src/ --error-on-warnings",
+    "storybook": "storybook dev -p 9001 -c .storybook",
+    "build:storybook": "storybook build -c .storybook -o .out",
+    "test": "jest",
+    "test:storybook:local": "test-storybook --url http://127.0.0.1:9001",
+    "test:ci": "jest --silent --reporter=jest-junit",
+    "cypress:ui": "cypress open --component --browser=chrome",
+    "cypress:run:updateSnapshots": "cypress run --component --browser=chrome --env updateSnapshots=true",
+    "cypress:run:coverage": "cypress run --component --browser=chrome --env codeCoverageTasksRegistered=true",
+    "cypress:run": "cypress run --component --browser=chrome",
+    "tokens:transform": "TS_NODE_PROJECT=tsconfig.node.json ts-node style-dictionary.transform.ts"
   },
+  "type": "module",
   "sideEffects": false,
   "repository": {
     "type": "git",
@@ -21,71 +28,132 @@
     "centreon",
     "react"
   ],
-  "author": "centreon@centreon.com",
-  "license": "GPL-2.0",
+  "author": {
+    "name": "centreon@centreon.com"
+  },
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/centreon/centreon/issues"
   },
   "homepage": "https://github.com/centreon/centreon#readme",
+  "main": "src/index.ts",
+  "exports": {
+    ".": "./src/index.ts",
+    "./components": "./src/components/index.ts",
+    "./fonts/*": "./src/fonts/*",
+    "./test/testRenderer": "./test/testRenderer.tsx"
+  },
+  "files": [
+    "package.json",
+    "src/*",
+    "public/*",
+    "test/*"
+  ],
   "devDependencies": {
-    "@mdx-js/react": "^2.1.4",
-    "@storybook/addon-docs": "^6.5.16",
-    "@storybook/addon-essentials": "^6.5.11",
-    "@storybook/addon-storyshots": "^6.5.11",
-    "@storybook/addon-storyshots-puppeteer": "^6.5.11",
-    "@storybook/builder-webpack5": "^6.5.11",
-    "@storybook/manager-webpack5": "^6.5.11",
-    "@storybook/mdx2-csf": "^0.0.3",
-    "@storybook/react": "^6.5.11",
-    "@types/jest": "^27.5.0",
-    "@types/ramda": "^0.28.12",
-    "axios-mock-adapter": "^1.20.0",
-    "babel-plugin-require-context-hook": "^1.0.0",
-    "clean-webpack-plugin": "^4.0.0",
+    "@cypress/react": "^8.0.2",
+    "@cypress/webpack-dev-server": "^3.10.1",
+    "@faker-js/faker": "^8.4.1",
+    "@mdx-js/react": "^3.0.1",
+    "@simonsmith/cypress-image-snapshot": "^9.1.0",
+    "@storybook/addon-a11y": "^8.2.9",
+    "@storybook/addon-docs": "^8.2.9",
+    "@storybook/addon-essentials": "^8.2.9",
+    "@storybook/addon-interactions": "^8.2.9",
+    "@storybook/addon-themes": "^8.2.9",
+    "@storybook/blocks": "^8.2.9",
+    "@storybook/manager-api": "^8.2.9",
+    "@storybook/mdx2-csf": "^1.1.0",
+    "@storybook/preview-api": "^8.2.9",
+    "@storybook/react": "^8.2.9",
+    "@storybook/react-vite": "^8.2.9",
+    "@storybook/test": "^8.2.9",
+    "@storybook/test-runner": "^0.19.1",
+    "@storybook/theming": "^8.2.9",
+    "@testing-library/cypress": "^10.0.2",
+    "@testing-library/jest-dom": "^6.4.8",
+    "@testing-library/react": "^16.0.0",
+    "@testing-library/react-hooks": "^8.0.1",
+    "@types/jest": "^29.5.12",
+    "@types/mocha": "^10.0.7",
+    "@types/ramda": "^0.30.1",
+    "@types/react": "^18.3.3",
+    "@types/testing-library__jest-dom": "^6.0.0",
+    "@vitejs/plugin-react": "^4.3.1",
+    "@vitejs/plugin-react-swc": "^3.7.0",
+    "chai": "^5.1.1",
+    "cypress": "^13.13.3",
     "identity-obj-proxy": "^3.0.0",
-    "puppeteer": "^13.7.0",
-    "react-test-renderer": "^18.1.0",
-    "storybook-addon-mock": "^2.4.1",
-    "storybook-dark-mode": "^1.1.0"
+    "jest-transform-stub": "^2.0.0",
+    "mochawesome": "^7.1.3",
+    "msw": "2.3.5",
+    "msw-storybook-addon": "^2.0.3",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "react-test-renderer": "^18.3.1",
+    "remark-gfm": "^4.0.0",
+    "speed-measure-vite-plugin": "^1.0.1",
+    "storybook": "^8.2.9",
+    "storybook-addon-mock": "^5.0.0",
+    "storybook-dark-mode": "^4.0.2",
+    "style-dictionary": "^4.0.1",
+    "ts-node": "^10.9.2",
+    "use-resize-observer": "^9.1.0",
+    "vite": "^5.4.1",
+    "vite-plugin-istanbul": "^6.0.2",
+    "vite-plugin-svgr": "^4.2.0",
+    "vite-plugin-turbosnap": "^1.0.3"
+  },
+  "peerDependencies": {
+    "@centreon/ui-context": "file:../ui-context"
   },
   "dependencies": {
-    "@lexical/link": "0.8.0",
-    "@lexical/react": "0.8.0",
-    "@lexical/selection": "0.8.0",
-    "@lexical/utils": "0.8.0",
+    "@lexical/html": "^0.17.0",
+    "@lexical/link": "^0.17.0",
+    "@lexical/list": "^0.17.0",
+    "@lexical/react": "^0.17.0",
+    "@lexical/rich-text": "^0.17.0",
+    "@lexical/selection": "^0.17.0",
+    "@lexical/utils": "^0.17.0",
+    "@mui/material": "^5.16.7",
+    "@react-spring/web": "^9.7.4",
+    "@visx/clip-path": "^3.3.0",
+    "@visx/curve": "^3.3.0",
+    "@visx/event": "^3.3.0",
+    "@visx/group": "^3.3.0",
+    "@visx/hierarchy": "^3.3.0",
+    "@visx/legend": "^3.10.3",
+    "@visx/pattern": "^3.3.0",
+    "@visx/point": "^3.3.0",
+    "@visx/scale": "^3.5.0",
+    "@visx/shape": "^3.5.0",
+    "@visx/text": "^3.3.0",
+    "@visx/threshold": "^3.5.0",
+    "@visx/visx": "3.11.0",
+    "@visx/zoom": "^3.3.0",
     "anylogger": "^1.0.11",
-    "humanize-duration": "^3.27.3",
-    "lexical": "0.8.0",
-    "notistack": "^2.0.8",
+    "d3-array": "3.2.4",
+    "dayjs": "^1.11.12",
+    "highlight.js": "^11.10.0",
+    "html-react-parser": "^5.1.12",
+    "humanize-duration": "^3.32.1",
+    "lexical": "^0.17.0",
+    "notistack": "^3.0.1",
+    "numeral": "^2.0.6",
+    "ramda": "0.30.1",
+    "react-grid-layout": "^1.4.4",
+    "react-resizable": "^3.0.5",
+    "react-router-dom": "^6.26.1",
     "react-transition-group": "^4.4.5",
+    "sanitize-html": "^2.13.0",
     "ulog": "^2.0.0-beta.19"
   },
-  "peerDependencies": {
-    "@centreon/ui-context": "file:../ui-context",
-    "@dnd-kit/core": "6.x",
-    "@dnd-kit/sortable": "6.x",
-    "@dnd-kit/utilities": "6.x",
-    "@mui/icons-material": "5.x",
-    "@mui/lab": "5.x",
-    "@mui/material": "5.x",
-    "@mui/styles": "5.x",
-    "@tanstack/react-query": "4.x",
-    "axios": ">= 1.6.4",
-    "dayjs": "1.x",
-    "formik": "2.x",
-    "jotai": "2.x",
-    "numeral": "2.x",
-    "ramda": "0.x",
-    "react": "18.x",
-    "react-dom": "18.x",
-    "react-i18next": "12.x",
-    "react-router-dom": "6.x",
-    "resize-observer-polyfill": "1.x",
-    "ts.data.json": "2.x",
-    "tss-react": "4.x"
-  },
   "jest-junit": {
     "suiteName": "jest tests",
     "output": "./junit.xml"
+  },
+  "msw": {
+    "workerDirectory": [
+      "public"
+    ]
   }
 }

package/public/README.md

@@ -0,0 +1,39 @@
+> The assets in `public` are served as-is.
+
+
+---
+
+### `public/fonts` → `@centreon/ui/fonts` alias
+
+The `ThemeProvider` specifies the `@font-face` for MUI.
+It imports the fonts using the `@centreon/ui/fonts` alias, but does not bundle them.
+
+
+
+#### ⚠️ **note** 
+When the `@centreon/ui` package is used as non-build dependency, then the `@centreon/ui/fonts` alias need to be added in the webpack config, and configured to handle the asset types.
+```js
+// webpack.config.js
+
+// alias
+resolve: {
+  alias: {
+    '@centreon/ui/fonts': path.resolve(
+      './node_modules/@centreon/ui/public/fonts'
+    )
+  }
+}
+
+// asset types
+module: {
+  rules: [
+    {
+      generator: {
+          filename: '[name][ext]'
+      },
+      test: /\.(woff|woff2|eot|ttf|otf)$/i,
+      type: 'asset/resource'
+    }
+  ]
+}
+```

package/public/mockServiceWorker.js

@@ -0,0 +1,284 @@
+/* eslint-disable */
+/* tslint:disable */
+
+/**
+ * Mock Service Worker.
+ * @see https://github.com/mswjs/msw
+ * - Please do NOT modify this file.
+ * - Please do NOT serve this file on production.
+ */
+
+const PACKAGE_VERSION = '2.3.5'
+const INTEGRITY_CHECKSUM = '26357c79639bfa20d64c0efca2a87423'
+const IS_MOCKED_RESPONSE = Symbol('isMockedResponse')
+const activeClientIds = new Set()
+
+self.addEventListener('install', function () {
+  self.skipWaiting()
+})
+
+self.addEventListener('activate', function (event) {
+  event.waitUntil(self.clients.claim())
+})
+
+self.addEventListener('message', async function (event) {
+  const clientId = event.source.id
+
+  if (!clientId || !self.clients) {
+    return
+  }
+
+  const client = await self.clients.get(clientId)
+
+  if (!client) {
+    return
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  switch (event.data) {
+    case 'KEEPALIVE_REQUEST': {
+      sendToClient(client, {
+        type: 'KEEPALIVE_RESPONSE',
+      })
+      break
+    }
+
+    case 'INTEGRITY_CHECK_REQUEST': {
+      sendToClient(client, {
+        type: 'INTEGRITY_CHECK_RESPONSE',
+        payload: {
+          packageVersion: PACKAGE_VERSION,
+          checksum: INTEGRITY_CHECKSUM,
+        },
+      })
+      break
+    }
+
+    case 'MOCK_ACTIVATE': {
+      activeClientIds.add(clientId)
+
+      sendToClient(client, {
+        type: 'MOCKING_ENABLED',
+        payload: true,
+      })
+      break
+    }
+
+    case 'MOCK_DEACTIVATE': {
+      activeClientIds.delete(clientId)
+      break
+    }
+
+    case 'CLIENT_CLOSED': {
+      activeClientIds.delete(clientId)
+
+      const remainingClients = allClients.filter((client) => {
+        return client.id !== clientId
+      })
+
+      // Unregister itself when there are no more clients
+      if (remainingClients.length === 0) {
+        self.registration.unregister()
+      }
+
+      break
+    }
+  }
+})
+
+self.addEventListener('fetch', function (event) {
+  const { request } = event
+
+  // Bypass navigation requests.
+  if (request.mode === 'navigate') {
+    return
+  }
+
+  // Opening the DevTools triggers the "only-if-cached" request
+  // that cannot be handled by the worker. Bypass such requests.
+  if (request.cache === 'only-if-cached' && request.mode !== 'same-origin') {
+    return
+  }
+
+  // Bypass all requests when there are no active clients.
+  // Prevents the self-unregistered worked from handling requests
+  // after it's been deleted (still remains active until the next reload).
+  if (activeClientIds.size === 0) {
+    return
+  }
+
+  // Generate unique request ID.
+  const requestId = crypto.randomUUID()
+  event.respondWith(handleRequest(event, requestId))
+})
+
+async function handleRequest(event, requestId) {
+  const client = await resolveMainClient(event)
+  const response = await getResponse(event, client, requestId)
+
+  // Send back the response clone for the "response:*" life-cycle events.
+  // Ensure MSW is active and ready to handle the message, otherwise
+  // this message will pend indefinitely.
+  if (client && activeClientIds.has(client.id)) {
+    ;(async function () {
+      const responseClone = response.clone()
+
+      sendToClient(
+        client,
+        {
+          type: 'RESPONSE',
+          payload: {
+            requestId,
+            isMockedResponse: IS_MOCKED_RESPONSE in response,
+            type: responseClone.type,
+            status: responseClone.status,
+            statusText: responseClone.statusText,
+            body: responseClone.body,
+            headers: Object.fromEntries(responseClone.headers.entries()),
+          },
+        },
+        [responseClone.body],
+      )
+    })()
+  }
+
+  return response
+}
+
+// Resolve the main client for the given event.
+// Client that issues a request doesn't necessarily equal the client
+// that registered the worker. It's with the latter the worker should
+// communicate with during the response resolving phase.
+async function resolveMainClient(event) {
+  const client = await self.clients.get(event.clientId)
+
+  if (client?.frameType === 'top-level') {
+    return client
+  }
+
+  const allClients = await self.clients.matchAll({
+    type: 'window',
+  })
+
+  return allClients
+    .filter((client) => {
+      // Get only those clients that are currently visible.
+      return client.visibilityState === 'visible'
+    })
+    .find((client) => {
+      // Find the client ID that's recorded in the
+      // set of clients that have registered the worker.
+      return activeClientIds.has(client.id)
+    })
+}
+
+async function getResponse(event, client, requestId) {
+  const { request } = event
+
+  // Clone the request because it might've been already used
+  // (i.e. its body has been read and sent to the client).
+  const requestClone = request.clone()
+
+  function passthrough() {
+    const headers = Object.fromEntries(requestClone.headers.entries())
+
+    // Remove internal MSW request header so the passthrough request
+    // complies with any potential CORS preflight checks on the server.
+    // Some servers forbid unknown request headers.
+    delete headers['x-msw-intention']
+
+    return fetch(requestClone, { headers })
+  }
+
+  // Bypass mocking when the client is not active.
+  if (!client) {
+    return passthrough()
+  }
+
+  // Bypass initial page load requests (i.e. static assets).
+  // The absence of the immediate/parent client in the map of the active clients
+  // means that MSW hasn't dispatched the "MOCK_ACTIVATE" event yet
+  // and is not ready to handle requests.
+  if (!activeClientIds.has(client.id)) {
+    return passthrough()
+  }
+
+  // Notify the client that a request has been intercepted.
+  const requestBuffer = await request.arrayBuffer()
+  const clientMessage = await sendToClient(
+    client,
+    {
+      type: 'REQUEST',
+      payload: {
+        id: requestId,
+        url: request.url,
+        mode: request.mode,
+        method: request.method,
+        headers: Object.fromEntries(request.headers.entries()),
+        cache: request.cache,
+        credentials: request.credentials,
+        destination: request.destination,
+        integrity: request.integrity,
+        redirect: request.redirect,
+        referrer: request.referrer,
+        referrerPolicy: request.referrerPolicy,
+        body: requestBuffer,
+        keepalive: request.keepalive,
+      },
+    },
+    [requestBuffer],
+  )
+
+  switch (clientMessage.type) {
+    case 'MOCK_RESPONSE': {
+      return respondWithMock(clientMessage.data)
+    }
+
+    case 'PASSTHROUGH': {
+      return passthrough()
+    }
+  }
+
+  return passthrough()
+}
+
+function sendToClient(client, message, transferrables = []) {
+  return new Promise((resolve, reject) => {
+    const channel = new MessageChannel()
+
+    channel.port1.onmessage = (event) => {
+      if (event.data && event.data.error) {
+        return reject(event.data.error)
+      }
+
+      resolve(event.data)
+    }
+
+    client.postMessage(
+      message,
+      [channel.port2].concat(transferrables.filter(Boolean)),
+    )
+  })
+}
+
+async function respondWithMock(response) {
+  // Setting response status code to 0 is a no-op.
+  // However, when responding with a "Response.error()", the produced Response
+  // instance will have status code set to 0. Since it's not possible to create
+  // a Response instance with status code 0, handle that use-case separately.
+  if (response.status === 0) {
+    return Response.error()
+  }
+
+  const mockedResponse = new Response(response.body, response)
+
+  Reflect.defineProperty(mockedResponse, IS_MOCKED_RESPONSE, {
+    value: true,
+    enumerable: true,
+  })
+
+  return mockedResponse
+}

package/src/@assets/README.md

@@ -0,0 +1,5 @@
+# `src/@assets` vs `public`
+
+The assets in `src/@assets` are processed by `vite` and included in the bundle.
+The assets in `public` are served as-is.
+