Add tests for static_react_task example

.github/workflows/cypress-end-to-end-tests.yml

@@ -0,0 +1,51 @@
+name: cypress-end-to-end-tests
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  static-react-task:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 🔀 Checking out repo
+        uses: actions/checkout@v2
+      - name: 🐍 Installing python
+        uses: actions/setup-python@v2
+
+      - name: 🪨 Setup Node
+        uses: actions/setup-node@v1
+        with:
+          node-version: 16
+
+      - name: 🤖 Install Mephisto
+        run: pip install -e .
+
+      - name: 🖋 Create data directory
+        run: |
+          cd ~
+          mkdir mephisto
+          cd mephisto
+          mkdir data
+
+      - name: 📂 Set the data directory
+        run: |
+          mephisto config core.main_data_directory ~/mephisto/data
+
+      - name: 📦 Setting up mephisto-task package
+        run: |
+          cd packages/mephisto-task
+          yarn install
+          yarn build
+          npm link
+
+      - name: ⌛️ Running cypress tests
+        uses: cypress-io/[email protected]
+        with:
+          install: false
+          project: ./examples/static_react_task/webapp
+          config-file: ./cypress.config.js
+          start: python examples/static_react_task/run_task.py mephisto.task.post_install_script=link_mephisto_task.sh
+          wait-on: "http://localhost:3000/?worker_id=x&assignment_id=1"
+          command-prefix: yarn dlx
+          headless: true

CONTRIBUTING.md

@@ -14,7 +14,49 @@ We actively welcome your pull requests.
 5. Make sure your code lints.
 6. If you haven't already, complete the Contributor License Agreement ("CLA").
 
-### Task Contributions
+## Cypress Testing
+For cypress testing the base url is: http://localhost:3000/?worker_id=x&assignment_id=1
+
+### Running end to end tests on a task:
+1. Run the task by running python run_task.py in the appropriate task folder
+2. In a separate terminal window go into the webapp directory and run `npm run test`
+3. This should open a cypress app
+4. It is advised to test in Chrome(Chrome, Electron, and Firefox are all the options) as this browser works well with Cypress.
+5. After clicking one of the spec files, the tests from that spec will automatically run
+
+### Troubleshooting:
+### There may be a case where there is a baseUrl mismatch.
+
+For example:
+Suppose you ran the toxicity detection task and then closed it. This would use assignmentId=1 and assignmentId=2. 
+
+If you then ran the mnist task, for example, then assignmentId=3 and assignmentId=4 would be used. While this task is running you can choose to run cypress tests in a different terminal window by going into the webapp folder and running `npm run test`.
+
+These tests will fail because the base url of http://localhost:3000/?worker_id=x&assignment_id=1 is not associated with the mnist task, it is associated with the toxicity detection task. The correct react-elements will not show up.
+
+There is a way to fix this:
+* You can change the base url(found in the cypress.config.js file in the webapp folder) to the current url that you are on. 
+    * Make sure to reset the baseUrl back to default("/") if contributing to the repo as the GitHub action will fail otherwise.
+
+## Local Package Development
+If you are modifying either the `mephisto-task` or `mephisto-worker-experience` packages you probably want to see your changes propagate to the task that you are working on.
+
+The easiest way to do this is to run a task by doing:
+```bash
+python run_task.py mephisto.task.post_install_script=link_mephisto_task.sh mephisto.task.force_rebuild=true
+```
+
+Setting `mephisto.task.force_rebuild=true` runs `npm build` before running your task. By default the task is only rebuilt if a file is changed in the webapp, not if a linked package is changed.
+
+Setting `mephisto.task.post_install_script=link_mephisto_task.sh` runs the `link_mephisto_task.sh` script after `npm install` is ran and before the task is started. This script should be located in the webapp folder of the task. While this script can do many things, for local package development the primary purpose of it is to link to a local package.
+
+Alternatively, these values can be set in the task's hydra_configs/conf yaml file if you want to forgo typing the above and just type
+```bash
+python run_task.py
+```
+instead.
+
+## Task Contributions
 Generally we encourage people to provide their own blueprints as part of the repo in which they release their code, though if someone creates a strong case for an abstract `Blueprint` that is generally applicable we'd be happy to review it.
 
 ## Contributor License Agreement ("CLA")

examples/remote_procedure/mnist/run_task.py

@@ -65,7 +65,12 @@ def handle_with_model(
     )
 
     task_dir = cfg.task_dir
-    build_custom_bundle(task_dir)
+
+    build_custom_bundle(
+        task_dir,
+        force_rebuild=cfg.mephisto.task.force_rebuild,
+        post_install_script=cfg.mephisto.task.post_install_script,
+    )
 
     operator.launch_task_run(cfg.mephisto, shared_state)
     operator.wait_for_runs_then_shutdown(skip_input=True, log_rate=30)