bimplus-renderer 1.8.38-updatepackages1.3 → 1.8.38

package/MOMENT_TIMEZONE_INTEGRATION_FOR_TEST.md

@@ -15,27 +15,20 @@ This solution successfully implements moment-timezone dependency injection speci
 ### 2. Test-Only Injection
 - **[test/setup/momentTimezoneInjector.js](test/setup/momentTimezoneInjector.js)**: Test setup that injects moment-timezone globally
 - **package.json**: moment-timezone installed as `devDependency` only
-- **karma-files-config.js**: Loads injector before any test files
+- **[test/setup/vitestBrowser.setup.js](test/setup/vitestBrowser.setup.js)**: Imports and injects moment-timezone before test modules
 
 ### 3. Test Configuration
 ```javascript
-// In karma-files-config.js
-files: [
-  "src/**/*.js",
-  // Load test environment setup (inject moment-timezone for tests)
-  "test/setup/momentTimezoneInjector.js",
-  // Load custom assertions first
-  "test/customAsserts.js",
-  // Load test files
-  "test/**/*.js",
-],
+// In test/setup/vitestBrowser.setup.js
+import momentTimezone from 'moment-timezone';
+globalThis.MomentTZ = globalThis.moment = momentTimezone;
 ```
 
 ## How It Works
 
 ### For Tests
-1. Karma loads the moment-timezone injector first
-2. The injector imports moment-timezone (available as dev dependency)
+1. Vitest loads the browser setup before test modules
+2. The setup imports moment-timezone (available as a dev dependency)
 3. Injects it into global scope (`window.moment`)
 4. All tests run with moment-timezone available
 5. Sun calculation tests pass with accurate timezone handling
@@ -53,7 +46,7 @@ files: [
 - `test/setup/momentTimezoneInjector.js` - Test environment setup
 
 ### Modified Files  
-- `karma-files-config.js` - Added test setup loader
+- `test/setup/vitestBrowser.setup.js` - Imports and injects moment-timezone before test modules
 - `package.json` - Added moment-timezone as devDependency
 
 ### Existing Files (Unchanged)

package/README.md

@@ -79,11 +79,79 @@ goto your application folder which uses the renderer
   npm install
 
 ### Unit testing
-With every build output is copied also to the test folder.
-To run the unit tests go to the test subfolder and run
-
-    npm install
-    npm run test
+Run tests from the renderer root. Vitest is the only installed test runner; the
+test files import Vitest APIs directly. Browser globals, fixtures, and
+test-only dependencies are initialized in `test/setup/vitestBrowser.setup.js`.
+
+```sh
+npm ci
+npx playwright install firefox
+npm test
+npm run test-chrome-headed
+npm run test-firefox-coverage
+```
+
+`npm test` runs the renderer and performance suites in headless Firefox and
+starts the Polly recording service. Every run generates Istanbul coverage at
+`coverage/lcov.info` and `coverage/index.html` for CI/CD and SonarQube.
+Jenkins must use Firefox with WebGL2; Chrome
+has memory/WebGL problems on that server. `npm run test-chrome` uses installed
+Google Chrome locally. `npm run test-chrome` and `npm run test-firefox` explicitly
+show the browser window. Both profiles run serially. The explicit modes are:
+
+| Mode | Firefox | Chrome |
+| --- | --- | --- |
+| Headed | `npm run test-firefox-headed` | `npm run test-chrome-headed` |
+| Headless | `npm run test-firefox-headless` | `npm run test-chrome-headless` |
+| Watch (headed) | `npm run test-firefox-watch` | `npm run test-chrome-watch` |
+| Coverage (headless) | `npm run test-firefox-coverage` | `npm run test-chrome-coverage` |
+
+`npm test` invokes `test-firefox-coverage`. These commands set the display mode
+explicitly, independently of `BIMPLUS_HEADLESS`.
+
+To run just one test file with Polly, use the browser's task, for example:
+
+```sh
+npx npm-run-all -p -r test-polly-listen-task "test-chrome-task -- --browser.headless=false test/tests/OverlayPollyTests.js"
+```
+
+The Vitest compatibility middleware serves `/data/` from `test/data/` and
+provides the installed `web-ifc` WASM with the correct MIME type, preserving
+the asset routes previously supplied by Karma proxies.
+
+Polly replays the checked-in HAR recordings. Older authorization entries have
+sanitized passwords but retain request IDs calculated before sanitization. The
+test helper handles these entries by matching the complete sanitized request
+and request order, without rewriting the recordings. Some legacy recordings
+also omit GLB requests because earlier Karma tests had populated IndexedDB.
+On a geometry replay miss, the helper reuses a recorded GET response for the
+same URL (including model, discipline, revision and all query parameters) and
+request fields from another HAR, ignoring only the authorization token. This
+allows isolated and filtered runs without depending on prior tests' caches.
+Locally, Polly enables `recordIfMissing`, so unmatched requests can fall through
+to the live API and be recorded. In CI, recording is disabled and missing
+recordings fail instead of falling back to the live API. A local login 401
+followed by `Cannot persist response` can therefore indicate a missing or
+unmatched recording rather than an expired recorded token.
+
+Modelviewer DDT runs are separate and require the sibling `simple-ddt-server`,
+the selected dataset, and stored reference results:
+
+```sh
+npm run test-modelviewer-ddt
+npm run test-modelviewer-ddt-long
+npm run test-vitest-modelviewer-chrome
+npm run test-vitest-modelviewer-chrome-long
+```
+
+Vitest writes JUnit output under `test-results/`. Firefox Istanbul coverage is
+written under `coverage/`, including `coverage/lcov.info` for CI artifact
+collection. Coverage instruments renderer source under `src/`, excluding
+vendored and generated worker files. Two IFC
+references differ when tested against installed `web-ifc` 0.0.77, while the
+existing references were generated with copied 0.0.75 WASM; the DDT does not
+update reference data automatically. See
+[the migration plan](KARMA_TO_VITEST_MIGRATION_PLAN.md) for remaining gates.
 
 ### Documentation
 Bimplus WebSDK uses npm documentation plugin for easy documentation generation.