Merge pull request #399 from fractal-analytics-platform/remove-coverage

Removed coverage setup from Playwright tests and CI

Author: zonia3000

.github/workflows/coverage.yaml

@@ -1,6 +1,10 @@
 name: End-to-end tests
 
-on: [workflow_call]
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['main']
 
 jobs:
   end_to_end_tests:
@@ -36,12 +40,3 @@ jobs:
 
       - name: Run Playwright tests
         run: npx playwright test --workers=1
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: playwright-coverage
-          path: coverage-playwright/
-          retention-days: 30
-
-    env:
-      ENABLE_COVERAGE: "true"

.github/workflows/end_to_end_tests.yaml

@@ -1,6 +1,10 @@
 name: Unit tests
 
-on: [workflow_call]
+on:
+  push:
+    branches: ['main']
+  pull_request:
+    branches: ['main']
 
 jobs:
   unit_tests:
@@ -26,13 +30,4 @@ jobs:
         run: npm install
 
       - name: Run vitest tests
-        run: npx vitest run --coverage.enabled --coverage.provider=istanbul --coverage.include=src --coverage.reporter=json --coverage.all
-
-      - uses: actions/upload-artifact@v3
-        with:
-          name: unit-coverage
-          path: coverage-unit/
-          retention-days: 30
-
-    env:
-      ENABLE_COVERAGE: "true"
+        run: npx vitest run

.github/workflows/unit_tests.yaml

@@ -1,5 +1,9 @@
 *Note: Numbers like (\#123) point to closed Pull Requests on the fractal-web repository.*
 
+# Unreleased
+
+* Removed coverage setup from Playwright tests and CI (\#399).
+
 # 0.8.2
 
 * Improvements on worflow task form (\#393):

.nycrc

@@ -3,6 +3,8 @@
 Steps to release a new `fractal-web` version:
 
 * Update `CHANGELOG.md` on `main` branch, replacing the "Unreleased" temporary title with the desidered version number
+* Update the `version-compatibility.md` doc page
+* Commit the changes
 * Execute `npm version <major|minor|patch>`
 * Execute `git push origin main`
 * Execute `git push origin <new-version-tag>`

CHANGELOG.md

@@ -18,24 +18,15 @@ To execute the tests seeing the browser add the `--headed` flag or the `--debug`
 
 ## Coverage
 
+> Warning: code coverage results are not reliable at the moment
+
 Coverage for the unit tests:
 
 ```
-ENABLE_COVERAGE=true npx vitest run --coverage.enabled --coverage.provider=istanbul --coverage.include=src --coverage.reporter=json --coverage.all
+npx vitest --coverage
 ```
 
-Warning: coverage takes some time using the option `--coverage.all`.
-
-Coverage for the playwright tests is automatically collected when running `ENABLE_COVERAGE=true npx playwright test`.
-
-To generate a merged html report:
-
-```
-mkdir coverage-all
-cp coverage-playwright/* coverage-all
-cp coverage-unit/* coverage-all
-npx nyc report --report-dir ./coverage-html --temp-dir ./coverage-all --reporter=html --exclude-after-remap false
-```
+Warning: coverage takes some time, since we are using the option `{ all: true }`.
 
 ### Local `fractal-server` instance
 

docs/development/release.md

@@ -4,5 +4,6 @@ The following table shows which `fractal-server` versions are compatible with wh
 
 | fractal-web | fractal-server |
 |-------------|----------------|
-| 0.8.0       | 1.4.2          |
+| 0.8.2       | 1.4.2          |
 | 0.8.1       | 1.4.2          |
+| 0.8.0       | 1.4.2          |

docs/development/tests.md

@@ -39,7 +39,7 @@ export default defineConfig({
 
 	webServer: [
 		{
-			command: './tests/start-test-server.sh 1.4.2a5',
+			command: './tests/start-test-server.sh 1.4.2',
 			port: 8000,
 			waitForPort: true,
 			stdout: 'pipe',

docs/version-compatibility.md

@@ -14,16 +14,14 @@ export async function responseError(response) {
  * Used for example to handle the displaying of the error alert when using the ConfirmActionButton.
  */
 export class AlertError extends Error {
-	/** @type {null | { loc: string[], msg: string } | string} */
-	simpleValidationMessage;
-
 	/**
 	 * @param {any} reason
 	 * @param {number|null} statusCode
 	 */
 	constructor(reason, statusCode = null) {
 		super();
 		this.reason = reason;
+		/** @type {null | { loc: string[], msg: string } | string} */
 		this.simpleValidationMessage = getSimpleValidationMessage(reason, statusCode);
 	}