enso/app/ide-desktop/lib/dashboard
somebody1234 cbf6d41e4c
More E2E tests; export default classes from modules (#8730)
This is a prerequisite for adding a CI action for E2E tests.

- Fix E2E tests
- Remove visual regression testing (VRT) and associated fixtures (screenshots) for now
- Switch dashboard almost fully to Vite, from ESBuild, to match GUI2's build tooling.
- Add some new E2E tests:
- Creating assets
- Deleting assets
- Creating assets from the samples on the home page
- Sort assets
- Includes fixes for sorting:
- Group sorted assets by type again (regression) (see https://github.com/enso-org/cloud-v2/issues/554)
- Make sorting by title, case insensitive. This is because it is more intuitive for non-programmers if all items with uppercase names *aren't* separated from those with lowercase names - especially since the Windows FS is case-insensitive.
- Normalization of Unicode letters is *not* currently being done. It can potentially be added later.
- Double-clicking *anywhere* on a directory row now expands it. Previously it was only being expanded when double clicking
- Add recursive label adding/removal to mirror backend
- Note: The current implementation is not exactly the same as the backend's implementation.
- Fix https://github.com/enso-org/cloud-v2/issues/872
- Unset "saved project details" (for opening the last open project) if fetching it produces an error.

# Important Notes
- All tests pass. (run `npm run test:e2e` in `app/ide-desktop/lib/dashboard`)
- All `npm` commands should be run in `app/ide-desktop/lib/dashboard`. `dashboard:*` npm scripts have been removed from `app/ide-desktop` to prevent a mess.
- `npm run dev` confirmed to still work. Note that it has not been changed as it was already using Vite.
- `npm run build` now uses `vite build`. This has been tested using a local HTTP server that supports `404.html`.
- Other cases have been tested:
- `npm run test:e2e` works (all tests pass)
- `./run ide build` works
- `./run ide watch` works
- `./run ide2 build` works
- `./run gui watch` works
2024-01-31 11:35:41 +00:00
..
e2e More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
src More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
.gitignore Dashboard tests (#7656) 2023-10-11 10:24:33 +00:00
.prettierignore More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
.prettierrc.cjs More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
404.html More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
esbuild-config.ts Change dashboard to use 2 spaces for indentation (#8798) 2024-01-22 21:26:15 +00:00
index.html More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
package.json More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
playwright.config.ts More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
postcss.config.js Change dashboard to use 2 spaces for indentation (#8798) 2024-01-22 21:26:15 +00:00
README.md More unit tests for dashboard (#8586) 2024-01-09 10:43:18 +00:00
tailwind.config.js More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
tsconfig.json More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
vite.config.ts More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
vite.test.config.ts More E2E tests; export default classes from modules (#8730) 2024-01-31 11:35:41 +00:00
vitest.config.ts Change dashboard to use 2 spaces for indentation (#8798) 2024-01-22 21:26:15 +00:00

Dashboard

The dashboard is the entrypoint into the application. It includes project management, project sharing, and user accounts and authentication.

Folder structure

  • mock/: Overrides for specific files in src/ when running Playwright tests.
  • test-component/: Contains component tests.
  • test-e2e/: Contains end-to-end tests.
  • **/__tests__/: Contains all unit tests. Unit tests MUST be in a __tests__/ subfolder, not beside the module they are testing.
  • src/: The dashboard application.
    • index.html: The sole HTML file used by this SPA. It imports the TS entry point.
    • authentication/src/: The main body of the app.
      • index.tsx: The TS entry point.
      • providers/: Contains React Contexts used by the main app.
      • components/: Contains the root component for the app.
      • dashboard/: The main body of the app. Directly in the folder, there are some utility modules that do not belong elsewhere.
        • components/: Contains all components used by the main app.
        • events/: Custom discriminated unions used to communicate messages between unrelated components.
      • authentication/: The authentication flow. This includes login, registration, and changing passwords.
        • components/: Contains all components used by the authentication flow.
        • providers/: Contains React Contexts required for authentication, and used by the main app.