Merge branch 'main' into ryanrosello-og/playwright-test-coverage

.github/workflows/cargo-test.yml

@@ -4,7 +4,6 @@ on:
       - main
     paths:
       - 'src/wasm-lib/**.rs'
-      - 'src/wasm-lib/**.hbs'
       - '**/Cargo.toml'
       - '**/Cargo.lock'
       - '**/rust-toolchain.toml'
@@ -14,7 +13,6 @@ on:
   pull_request:
     paths:
       - 'src/wasm-lib/**.rs'
-      - 'src/wasm-lib/**.hbs'
       - '**/Cargo.toml'
       - '**/Cargo.lock'
       - '**/rust-toolchain.toml'

.github/workflows/playwright.yml

@@ -237,6 +237,7 @@ jobs:
         VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
         VITE_KC_SKIP_AUTH: true
         token: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
+        GENERATE_PLAYWRIGHT_COVERAGE: true
     - name: send to axiom
       if: always()
       shell: bash
@@ -256,6 +257,18 @@ jobs:
         path: playwright-report/
         retention-days: 30
         overwrite: true
+    - name: Debug artifact name
+      if: ${{ !cancelled() && (success() || failure()) }}
+      run: |
+        echo "Artifact name: playwright-coverage-${{ runner.os }}-${{ matrix.shardIndex }}-${{ github.sha }}"
+    - uses: actions/upload-artifact@v4
+      if: ${{ !cancelled() && (success() || failure()) }}
+      with:
+        name: playwright-coverage-${{ runner.os }}-${{ matrix.shardIndex }}-${{ github.sha }}
+        path: "./.nyc_output/*.json"
+        retention-days: 30
+        overwrite: true
+        include-hidden-files: true
 
 
   playwright-electron:
@@ -263,7 +276,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-14]
-    timeout-minutes: 60
+    timeout-minutes: 40
     runs-on: ${{ matrix.os }}
     needs: check-rust-changes
     steps:
@@ -416,6 +429,8 @@ jobs:
         VITE_KC_DEV_TOKEN: ${{ secrets.KITTYCAD_API_TOKEN_DEV }}
         VITE_KC_SKIP_AUTH: true
         IS_UBUNTU: ${{ startsWith(matrix.os, 'ubuntu') && 'true' || 'false' }}
+        # TODO set to true, see: https://github.com/KittyCAD/modeling-app/issues/3885
+        GENERATE_PLAYWRIGHT_COVERAGE: false
         #DEBUG: 'pw:browser*'
     - name: send to axiom
       if: ${{ !cancelled() && (success() || failure()) && !startsWith(matrix.os, 'windows') }}
@@ -436,3 +451,59 @@ jobs:
         path: playwright-report/
         retention-days: 30
         overwrite: true
+    # TODO uncomment the following, see: https://github.com/KittyCAD/modeling-app/issues/3885 
+    # - uses: actions/upload-artifact@v4
+    #   if: ${{ always() }}
+    #   with:
+    #     name: playwright-coverage-${{ runner.os }}-${{ github.sha }}
+    #     path: .nyc_output/
+    #     retention-days: 30
+    #     overwrite: true
+
+
+  # only run this job after all shards above have completed
+  # TBC: do we want to separate coverage reports by OS?
+  # the Job below combines both chrome and webkit coverage reports
+  merge-coverage-reports:
+    # Merge reports after playwright-tests, even if some shards have failed
+    if: ${{ !cancelled() }}
+    needs: [playwright-chrome]
+    # only report on ubuntu (Google chrome) for now
+    # needs: [playwright-ubuntu, playwright-macos]
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
+      with:
+        node-version-file: '.nvmrc'
+        cache: 'yarn'
+    - name: Install dependencies
+      run: yarn
+    - name: Ensure .all_coverage_reports directory exists
+      run: mkdir -p .all_coverage_reports
+    - name: List all artifacts
+      run: |
+        echo "Available artifacts:"
+        gh api -H "Accept: application/vnd.github+json" /repos/${{ github.repository }}/actions/artifacts --jq '.artifacts[].name'
+      env:
+        GH_TOKEN: ${{ github.token }}
+    - name: Download coverage reports from GitHub Actions Artifacts
+      uses: actions/download-artifact@v4
+      with:
+        path: .all_coverage_reports
+        pattern: playwright-coverage-*
+        merge-multiple: true
+
+    - name: Merge all coverage reports from all shards into a single json report
+      run: npx nyc merge .all_coverage_reports ./.nyc_output/coverage.json
+
+    - name: Generate HTML coverage report
+      run: npx nyc report --reporter=html || true
+
+    - name: Upload Convertage HTML report
+      uses: actions/upload-artifact@v4
+      with:
+        name: coverage-report-${{ github.sha }}
+        path: coverage
+        retention-days: 14

.gitignore

@@ -62,7 +62,7 @@ Mac_App_Distribution.provisionprofile
 src/wasm-lib/pkg
 
 venv
-.vite/
+.nyc_output/*.vite/
 
 # electron
 out/

.prettierignore

@@ -5,7 +5,6 @@ coverage
 
 # Ignore Rust projects:
 *.rs
-*.hbs
 target
 src/wasm-lib/pkg
 src/wasm-lib/kcl/bindings

docs/kcl/index.md

@@ -64,7 +64,6 @@ layout: manual
 * [`m`](kcl/m)
 * [`max`](kcl/max)
 * [`min`](kcl/min)
-* [`mirror2d`](kcl/mirror2d)
 * [`mm`](kcl/mm)
 * [`offsetPlane`](kcl/offsetPlane)
 * [`patternCircular2d`](kcl/patternCircular2d)
@@ -78,7 +77,6 @@ layout: manual
 * [`profileStart`](kcl/profileStart)
 * [`profileStartX`](kcl/profileStartX)
 * [`profileStartY`](kcl/profileStartY)
-* [`rem`](kcl/rem)
 * [`revolve`](kcl/revolve)
 * [`segAng`](kcl/segAng)
 * [`segEndX`](kcl/segEndX)

docs/kcl/legAngX.md

@@ -16,23 +16,20 @@ legAngX(hypotenuse: number, leg: number) -> number
 
 * `utilities`
 
-
-### Arguments
-
-| Name | Type | Description | Required |
-|----------|------|-------------|----------|
-| `hypotenuse` | `number` |  | Yes |
-| `leg` | `number` |  | Yes |
-
-### Returns
-
-`number` 
-
-
 ### Examples
 
 ```js
 legAngX(5, 3)
 ```
 
+### Arguments
+
+* `hypotenuse`: `number` (REQUIRED)
+* `leg`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
 

docs/kcl/legAngY.md

@@ -16,23 +16,20 @@ legAngY(hypotenuse: number, leg: number) -> number
 
 * `utilities`
 
-
-### Arguments
-
-| Name | Type | Description | Required |
-|----------|------|-------------|----------|
-| `hypotenuse` | `number` |  | Yes |
-| `leg` | `number` |  | Yes |
-
-### Returns
-
-`number` 
-
-
 ### Examples
 
 ```js
 legAngY(5, 3)
 ```
 
+### Arguments
+
+* `hypotenuse`: `number` (REQUIRED)
+* `leg`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
 

docs/kcl/legLen.md

@@ -16,23 +16,20 @@ legLen(hypotenuse: number, leg: number) -> number
 
 * `utilities`
 
-
-### Arguments
-
-| Name | Type | Description | Required |
-|----------|------|-------------|----------|
-| `hypotenuse` | `number` |  | Yes |
-| `leg` | `number` |  | Yes |
-
-### Returns
-
-`number` 
-
-
 ### Examples
 
 ```js
 legLen(5, 3)
 ```
 
+### Arguments
+
+* `hypotenuse`: `number` (REQUIRED)
+* `leg`: `number` (REQUIRED)
+
+### Returns
+
+`number`
+
+
 

docs/kcl/types.md

@@ -13,16 +13,14 @@ arrays can hold objects and vice versa.
 
 `true` or `false` work when defining values.
 
-## Constant declaration
+## Variable declaration
 
-Constants are defined with the `let` keyword like so:
+Variables are defined with the `let` keyword like so:
 
 ```
 let myBool = false
 ```
 
-Currently you cannot redeclare a constant.
-
 ## Array
 
 An array is defined with `[]` braces. What is inside the brackets can

docs/kcl/types/AngledLineData.md

@@ -1,45 +0,0 @@
----
-title: "AngledLineData"
-excerpt: "Data to draw an angled line."
-layout: manual
----
-
-Data to draw an angled line.
-
-
-
-**This schema accepts any of the following:**
-
-An angle and length with explicitly named parameters
-
-
-**Type:** `object`
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `angle` |`number` (`double`)| The angle of the line (in degrees). | No |
-| `length` |`number` (`double`)| The length of the line. | No |
-
-
-----
-An angle and length given as a pair
-
-
-**Type:** `array`
-
-
-
-
-
-
-----
-
-
-
-
-

docs/kcl/types/AngledLineThatIntersectsData.md

@@ -1,23 +0,0 @@
----
-title: "AngledLineThatIntersectsData"
-excerpt: "Data for drawing an angled line that intersects with a given line."
-layout: manual
----
-
-Data for drawing an angled line that intersects with a given line.
-
-
-**Type:** `object`
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `angle` |`number` (`double`)| The angle of the line. | No |
-| `intersectTag` |`object`| The tag of the line to intersect with. | No |
-| `offset` |`number` (`double`)| The offset from the intersecting line. | No |
-
-

docs/kcl/types/AngledLineToData.md

@@ -1,22 +0,0 @@
----
-title: "AngledLineToData"
-excerpt: "Data to draw an angled line to a point."
-layout: manual
----
-
-Data to draw an angled line to a point.
-
-
-**Type:** `object`
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `angle` |`number` (`double`)| The angle of the line. | No |
-| `to` |`number` (`double`)| The point to draw to. | No |
-
-

docs/kcl/types/ArcData.md

@@ -1,53 +0,0 @@
----
-title: "ArcData"
-excerpt: "Data to draw an arc."
-layout: manual
----
-
-Data to draw an arc.
-
-
-
-**This schema accepts any of the following:**
-
-Angles and radius with an optional tag.
-
-
-**Type:** `object`
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `angleEnd` |`number` (`double`)| The end angle. | No |
-| `angleStart` |`number` (`double`)| The start angle. | No |
-| `radius` |`number` (`double`)| The radius. | No |
-
-
-----
-Center, to and radius with an optional tag.
-
-
-**Type:** `object`
-
-
-
-
-## Properties
-
-| Property | Type | Description | Required |
-|----------|------|-------------|----------|
-| `center` |`array`| The center. | No |
-| `radius` |`number` (`double`)| The radius. | No |
-| `to` |`array`| The to point. | No |
-
-
-----
-
-
-
-
-