update

chanzuckerberg · Sep 10, 2024 · a727924 · a727924
1 parent 91c6f97
commit a727924
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 13 deletions.
diff --git a/.github/workflows/e2e-tests.yml b/.github/workflows/e2e-tests.yml
@@ -1,13 +1,7 @@
 name: E2E Tests
 
-<<<<<<< HEAD
-=======
-<<<<<<< HEAD
-=======
 # (thuang): Chromatic recommends ONLY running on push instead of pull_request
 # https://www.chromatic.com/docs/github-actions/#recommended-configuration-for-build-events
->>>>>>> 33889da2 (test: SCE-6 e2e tests tabilize snapshots)
->>>>>>> a52cbd54 (test: SCE-6 e2e tests tabilize snapshots)
 on: push
 
 env:
@@ -154,13 +148,7 @@ jobs:
       - name: Download all workflow run artifacts
         uses: actions/download-artifact@v4
         with:
-<<<<<<< HEAD
-=======
-<<<<<<< HEAD
-=======
           # (thuang): Matches the `name` and `path` specified in `Upload Chromatic artifacts` step
->>>>>>> 33889da2 (test: SCE-6 e2e tests tabilize snapshots)
->>>>>>> a52cbd54 (test: SCE-6 e2e tests tabilize snapshots)
           path: /home/runner/work/single-cell-explorer/single-cell-explorer/client/playwright-report/chromatic-archives
           pattern: chromatic-report-*
           merge-multiple: true

diff --git a/client/__tests__/e2e/cellxgeneActions.ts b/client/__tests__/e2e/cellxgeneActions.ts
@@ -864,6 +864,14 @@ export async function assertUndoRedo(
 
 const WAIT_FOR_GRAPH_AS_IMAGE_TIMEOUT_MS = 10_000;
 
+/**
+ * (thuang): Captures a snapshot of the graph on the canvas element as an image
+ * for Chromatic snapshot testing.
+ *
+ * NOTE: Use this function only for tests that absolutely require graph
+ * snapshots, as the image layer and graph can sometimes be out of sync,
+ * potentially leading to false positives in Chromatic if excessive screenshots are taken.
+ */
 export async function snapshotTestGraph(
   page: Page,
   name: string,

diff --git a/client/playwright.config.ts b/client/playwright.config.ts
@@ -84,7 +84,7 @@ export default defineConfig<ChromaticConfig>({
      * (thuang): Default is `0.063`, but it's too sensitive for our use case.
      * @see: https://www.chromatic.com/docs/threshold/#setting-the-threshold
      */
-    diffThreshold: 0.15,
+    // diffThreshold: 0.15,
     acceptDownloads: true,
     /* Maximum time each action such as `click()` can take. Defaults to 0 (no limit). */
     actionTimeout: 0,