modeling-app/CONTRIBUTING.md

Contributor Guide

Installing dependencies

Install a node version manager such as fnm.

On Windows, it's also recommended to upgrade your PowerShell version, we're using 7.

Then in the repo run the following to install and use the node version specified in .nvmrc. You might need to specify your processor architecture with --arch arm64 or --arch x64 if it's not autodetected.

fnm install --corepack-enabled
fnm use

Install the NPM dependencies with:

npm install

This project uses a lot of Rust compiled to WASM within it. We have package scripts to run rustup, see package.json for reference:

# macOS/Linux
npm run install:rust
npm run install:wasm-pack:sh

# Windows
npm run install:rust:windows
npm run install:wasm-pack:cargo

Building the app

To build the WASM layer, run:

# macOS/Linux
npm run build:wasm

# Windows
npm run build:wasm:windows

Or if you have the gh cli installed and want to download the latest main wasm bundle. Note that on Windows, you need to associate .ps1 files with PowerShell, which can be done via the right click menu, selecting C:\Program Files\PowerShell\7\pwsh.exe, and you can install tools like gh via npm run install:tools:windows.

# macOS/Linux
npm run fetch:wasm

# Windows
npm run fetch:wasm:windows

That will build the WASM binary and put in the public dir (though gitignored).

Finally, to run the web app only, run:

npm start

If you're not a Zoo employee you won't be able to access the dev environment, you should copy everything from .env.production to .env.development.local to make it point to production instead, then when you navigate to localhost:3000 the easiest way to sign in is to paste localStorage.setItem('TOKEN_PERSIST_KEY', "your-token-from-https://zoo.dev/account/api-tokens") replacing the with a real token from https://zoo.dev/account/api-tokens of course, then navigate to localhost:3000 again. Note that navigating to localhost:3000/signin removes your token so you will need to set the token again.

Development environment variables

The Copilot LSP plugin in the editor requires a Zoo API token to run. In production, we authenticate this with a token via cookie in the browser and device auth token in the desktop environment, but this token is inaccessible in the dev browser version because the cookie is considered "cross-site" (from localhost to zoo.dev). There is an optional environment variable called VITE_KC_DEV_TOKEN that you can populate with a dev token in a .env.development.local file to not check it into Git, which will use that token instead of other methods for the LSP service.

Developing in Chrome

Chrome is in the process of rolling out a new default which blocks Third-Party Cookies. If you're having trouble logging into the modeling-app, you may need to enable third-party cookies. You can enable third-party cookies by clicking on the eye with a slash through it in the URL bar, and clicking on "Enable Third-Party Cookies".

Developing with Electron

To spin up the desktop app, npm install and npm run build:wasm need to have been done before hand then:

npm run tron:start

This will start the application and hot-reload on changes.

Devtools can be opened with the usual Command-Option-I (macOS) or Ctrl-Shift-I (Linux and Windows).

To package the app for your platform with electron-builder, run npm run tronb:package:dev (or npm run tronb:package:prod to point to the .env.production variables).

Running tests

Playwright tests

Prepare these system dependencies:

• Set $token from https://zoo.dev/account/api-tokens

Snapshot tests (Google Chrome on Ubuntu only)

Only Ubuntu and Google Chrome is supported for the set of tests evaluating screenshot snapshots. If you don't run Ubuntu locally or in a VM, you may use a GitHub Codespace.

npm run playwright -- install chrome
npm run test:snapshots

You may use -- --update-snapshots as needed.

Desktop tests (Electron on all platforms)

npm run playwright -- install chromium
npm run test:e2e:desktop:local

You may use -- -g "my test" to match specific test titles, or -- path/to/file.spec.ts for a test file.

Web tests (Google Chrome on all platforms)

npm run test:e2e:web

Debugger

However, if you want a debugger I recommend using VSCode and the playwright extension, as the above command is a cruder debugger that steps into every function call which is annoying. With the extension you can set a breakpoint after waitForDefaultPlanesVisibilityChange in order to skip app loading, then the vscode debugger's "step over" is much better for being able to stay at the right level of abstraction as you debug the code.

If you want to limit to a single browser use --project="webkit" or firefox, Google Chrome Or comment out browsers in playwright.config.ts.

note chromium has encoder compat issues which is why were testing against the branded 'Google Chrome'

You may consider using the VSCode extension, it's useful for running individual threads, but some some reason the "record a test" is locked to chromium with we can't use. A work around is to us the CI npm run playwright codegen -b wk --load-storage ./store localhost:3000

Where ./store should look like this

{
  "cookies": [],
  "origins": [
    {
      "origin": "http://localhost:3000",
      "localStorage": [
        {
          "name": "store",
          "value": "{\"state\":{\"openPanes\":[\"code\"]},\"version\":0}"
        },
        {
          "name": "persistCode",
          "value": ""
        },
        {
          "name": "TOKEN_PERSIST_KEY",
          "value": "your-token"
        }
      ]
    }
  ]
}

However because much of our tests involve clicking in the stream at specific locations, it's code-gen looks await page.locator('video').click(); when really we need to use a pixel coord, so I think it's of limited use.

Unit and component tests

If you already haven't, run the following:

npm
npm run build:wasm
npm start

and finally:

npm run test:unit

For individual testing:

npm run test abstractSyntaxTree -t "unexpected closed curly brace" --silent=false

Which will run our suite of Vitest unit and React Testing Library E2E tests, in interactive mode by default.

Rust tests

Prepare these system dependencies:

• Set $KITTYCAD_API_TOKEN from https://zoo.dev/account/api-tokens
• Install just following these instructions

then run tests that target the KCL language:

npm run test:rust

Fuzzing the parser

Make sure you install cargo fuzz:

$ cargo install cargo-fuzz

$ cd rust/kcl-lib

# list the fuzz targets
$ cargo fuzz list

# run the parser fuzzer
$ cargo +nightly fuzz run parser

For more information on fuzzing you can check out this guide.

Logging

To display logging (to the terminal or console) set ZOO_LOG=1. This will log some warnings and simple performance metrics. To view these in test runs, use -- --nocapture.

To enable memory metrics, build with --features dhat-heap.

Running scripts

There are multiple scripts under the folder path ./scripts which can be used in various settings.

Pattern for a static file, npm run commands, and CI-CD checks

If you want to implement a static checker follow this pattern. Two static checkers we have are circular dependency checks in our typescript code and url checker to see if any hard coded URL is the typescript application 404s. We have a set of known files in ./scripts/known/*.txt which is the baseline.

If you improve the baseline, run the overwrite command and commit the new smaller baseline. Try not to make the baseline bigger, the CI CD will complain. These baselines are to hold us to higher standards and help implement automated testing against the repository

Output result to stdout

• npm run circular-deps

• npm run url-checker

• create a <name>.sh file that will run the static checker then output the result to stdout

Overwrite result to known .txt file on disk

If the application needs to overwrite the known file on disk use this pattern. This known .txt file will be source controlled as the baseline

• npm run circular-deps:overwrite
• npm run url-checker:overwrite

Diff baseline and current

These commands will write a /tmp/ file on disk and compare it to the known file in the repository. This command will also be used in the CI CD pipeline for automated checks

• create a diff-<name>.sh file that is the script to diff your tmp file to the baseline e.g. diff-url-checker.sh

#!/bin/bash
set -euo pipefail

npm run url-checker > /tmp/urls.txt
diff --ignore-blank-lines -w /tmp/urls.txt ./scripts/known/urls.txt

• npm run circular-deps:diff
• npm run url-checker:diff

Proposing changes

Before you submit a contribution PR to this repo, please ensure that:

• There is a corresponding issue for the changes you want to make, so that discussion of approach can be had before work begins.
• You have separated out refactoring commits from feature commits as much as possible
• You have run all of the following commands locally:
  • npm run fmt
  • npm run tsc
  • npm run test
  • Here they are all together: npm run fmt && npm run tsc && npm run test

Shipping releases

1. Create a 'Cut release $VERSION' issue

Use the Release issue template. This will be used to facilitate changelog discussions and release testing.

https://github.com/KittyCAD/modeling-app/issues/new

2. Push a new tag

Decide on a v-prefixed semver VERSION (e.g. v1.2.3) with the team and tag the repo on the latest main:

git tag $VERSION --message=""
git push origin $VERSION

This will trigger the build-apps workflow to set the version, build & sign the apps, and generate release files.

The workflow should be listed right away in this list.

3. Manually test artifacts

The release builds can be found under the out-{arch}-{platform} zip files, at the very bottom of the build-apps summary page for the workflow (triggered by the tag in step 2).

Assign someone to each section of the manual checklist generated by the issue template.

4. Bump the KCL version

Follow the instructions here to publish new crates. This ensures that the KCL accepted by the app is also accepted by the CLI.

If there are documentation changes, merge the corresponding Dependabot PRs here for the website. You can trigger Dependabot to check for updates here.

5. Publish the release

Head over to https://github.com/KittyCAD/modeling-app/releases/new, pick the newly created tag and type it in the Release title field as well.

Click Generate release notes as a starting point to discuss the changelog in the issue. Once done, make sure Set as the latest release is checked, and click Publish release.

A new publish-apps-release workflow will start and you should be able to find it here. On success, the files will be uploaded to the public bucket as well as to the GitHub release, and the announcement on Discord will be sent.

6. Close the issue

If everything is well and the release is out to the public, the issue tracking the release shall be closed.