* Add UTM parameters to Dashboard login buttons
* Revert "Add UTM parameters to Dashboard login buttons"
This reverts commit 568f12e3cb.
* Add UTM parameters to Dashboard login buttons
* utmCode camel case
Co-authored-by: Zach Bloomquist <github@chary.us>
* Add desktop-gui integration tests for utm code
* Add server unit tests for utm code
Co-authored-by: Zach Bloomquist <github@chary.us>
Desktop GUI
The Desktop GUI is the react application that is rendered by Electron. This acts as the visual user interface you see when running: cypress open.
The Desktop GUI has the following responsibilities:
- Allow users to log in through the Dashboard Service.
- Allow users to add and remove projects to be tested in Cypress in global mode.
- Initialize the server to run on a specific project.
- Allow users to choose a specific browser to run tests within.
- Display the list of specs of a running project.
- Initialize the run of a specific spec file or all spec files chosen by the user.
- Notify users of updates to Cypress and initialize update process.
- Set up projects to be recorded.
- Display recently recorded runs for the project.
- Display the resolved configuration of a running project.
- Display other project and user settings such as Node.js version, proxy settings, and experiments.
Building
For development
## from repo root
yarn build --scope @packages/desktop-gui
For production
## from repo root
yarn build-prod --scope @packages/desktop-gui
Developing
NOTE: Currently, if you want to work on the code around logging in, viewing runs, or setting up new projects to record, this requires connecting to a locally running API server.
Our API server is only accessible to Cypress employees at the moment. If you want to work with the code, we recommend working within the Cypress tests for the Desktop-Gui. There are lots of tests mocking our API server around logging in, seeing runs, and setting up projects.
Watching
This watches and compiles all changes as you make them.
- Runs
*.jsand*.jsxthrough babel and bundles with browserify intodist - Compiles
*.scssfiles intodist
## from repo root
yarn watch --scope @packages/desktop-gui
Running
You can also run all of the Desktop GUI's tests locally. We don't really recommend this because it takes a long time, and we have this process optimized by load balancing the tests across multiple workers in CI.
It's usually easier to run the tests in the GUI, commit, and then see if anything broke elsewhere.
First, start local http server
## from repo root
yarn workspace @packages/desktop-gui start
Then run Cypress with
## from repo root
yarn workspace @packages/desktop-gui cypress:run
Testing
In Cypress
This project is tested with Cypress itself. It acts exactly like any other Cypress project.
First, start local http server
## from repo root
yarn workspace @packages/desktop-gui start
Then open Cypress with
## from repo root
yarn workspace @packages/desktop-gui cypress:open