From 08e1682784f73f6bbfa7716ad98bc26b01c0451f Mon Sep 17 00:00:00 2001
From: Mark Noonan <mark@cypress.io>
Date: Thu, 26 May 2022 10:08:15 -0400
Subject: [PATCH] chore: compare `cy.screenshot` images in percy (#21598)

Confirmed both pending tests are green in CI, Circle CI reports "GitHub returned status 500 adding commit status of success"
---
 circle.yml                                     | 10 ++++++++++
 packages/app/src/pages/Specs/Runner.vue        | 18 ++++++++++++++++++
 packages/app/src/runner/ResizablePanels.vue    |  6 ++++--
 packages/app/src/runner/SpecRunnerOpenMode.vue |  2 +-
 .../src/runner/screenshot/screenshot.cy.tsx    | 18 ++++++++++++++++++
 packages/app/src/specs/InlineSpecListTree.vue  |  4 ++--
 packages/driver/src/cy/commands/screenshot.ts  |  6 ++++++
 7 files changed, 59 insertions(+), 5 deletions(-)

diff --git a/circle.yml b/circle.yml
index 669824c1d034..e9147b2832a9 100644
--- a/circle.yml
+++ b/circle.yml
@@ -524,6 +524,16 @@ commands:
             PERCY_ENABLE=${PERCY_TOKEN:-0} \
             PERCY_PARALLEL_TOTAL=-1 \
             $cmd yarn workspace @packages/<<parameters.package>> cypress:run:<<parameters.type>> --browser <<parameters.browser>> --record --parallel --group <<parameters.package>>-<<parameters.type>>
+      - run:
+          command: |
+            if [[ <<parameters.package>> == 'app' && <<parameters.percy>> == 'true' && -d "packages/app/cypress/screenshots/runner/screenshot/screenshot.cy.tsx/percy" ]]; then
+              PERCY_PARALLEL_NONCE=$CIRCLE_SHA1 \
+              PERCY_ENABLE=${PERCY_TOKEN:-0} \
+              PERCY_PARALLEL_TOTAL=-1 \
+              yarn percy upload packages/app/cypress/screenshots/runner/screenshot/screenshot.cy.tsx/percy
+            else
+              echo "skipping percy screenshots uploading"
+            fi
       - store_test_results:
           path: /tmp/cypress
       - store_artifacts:
diff --git a/packages/app/src/pages/Specs/Runner.vue b/packages/app/src/pages/Specs/Runner.vue
index e8c6a4778f6d..e8d500e712eb 100644
--- a/packages/app/src/pages/Specs/Runner.vue
+++ b/packages/app/src/pages/Specs/Runner.vue
@@ -147,6 +147,24 @@ iframe.aut-iframe {
   background: white;
 }
 
+.is-screenshotting #main-pane {
+  overflow: auto !important;
+}
+
+.is-screenshotting.screenshot-scrolling #main-pane {
+  overflow: visible !important;
+}
+
+#resizable-panels-root {
+  overflow-x: auto;
+  overflow-y: hidden;
+}
+
+.is-screenshotting #resizable-panels-root {
+  overflow-x: visible;
+  overflow-y: visible;
+}
+
 iframe.spec-iframe {
     border: none;
     height: 0;
diff --git a/packages/app/src/runner/ResizablePanels.vue b/packages/app/src/runner/ResizablePanels.vue
index 2aeab33998be..a9f1d4ad14d7 100644
--- a/packages/app/src/runner/ResizablePanels.vue
+++ b/packages/app/src/runner/ResizablePanels.vue
@@ -1,9 +1,10 @@
 <template>
   <div
-    class="flex overflow-y-hidden"
+    id="resizable-panels-root"
+    class="flex"
     :class="{
       'select-none': panel1IsDragging || panel2IsDragging,
-      'overflow-x-auto': !isFirefox
+      'overflow-x-hidden': isFirefox
     }"
     @mouseup="handleMouseup"
     @mousemove="handleMousemove"
@@ -209,4 +210,5 @@ watchEffect(() => {
 
 // TODO: UNIFY-1704 - avoid special case for FF
 const isFirefox = window.__CYPRESS_BROWSER__?.family === 'firefox'
+
 </script>
diff --git a/packages/app/src/runner/SpecRunnerOpenMode.vue b/packages/app/src/runner/SpecRunnerOpenMode.vue
index aff406560b98..eb8701095478 100644
--- a/packages/app/src/runner/SpecRunnerOpenMode.vue
+++ b/packages/app/src/runner/SpecRunnerOpenMode.vue
@@ -13,7 +13,7 @@
     />
     <ResizablePanels
       v-else
-      :style="{width: `calc(100vw - ${collapsedNavBarWidth}px)`}"
+      :style="{width: `calc(100vw - ${screenshotStore.isScreenshotting ? 0 : collapsedNavBarWidth}px)`}"
       :offset-left="collapsedNavBarWidth"
       :max-total-width="windowWidth - collapsedNavBarWidth"
       :initial-panel1-width="specsListWidthPreferences"
diff --git a/packages/app/src/runner/screenshot/screenshot.cy.tsx b/packages/app/src/runner/screenshot/screenshot.cy.tsx
index d3c244bce3c5..150f6afd7854 100644
--- a/packages/app/src/runner/screenshot/screenshot.cy.tsx
+++ b/packages/app/src/runner/screenshot/screenshot.cy.tsx
@@ -37,6 +37,20 @@ const Layout: FunctionalComponent = () => {
 
 const captureTypes = ['fullPage', 'viewport', 'runner'] as const
 
+function removeGlobalStyles () {
+  // To help with consistency over time when diffing the images produce in this test
+  // this function removes global app styles after mounting,
+  // so that only the CSS injected by the component will be applied.
+
+  cy.get('style').each((item) => {
+    if (item[0].dataset.cy !== 'injected-style-tag') {
+      item.remove()
+    }
+  })
+
+  return cy.get('style').should('have.length', 1)
+}
+
 describe('screenshot', () => {
   captureTypes.forEach((capture) => {
     it(`takes a standard screenshot with viewport: ${capture}`, () => {
@@ -45,6 +59,7 @@ describe('screenshot', () => {
         styles,
       })
 
+      removeGlobalStyles()
       cy.screenshot(`percy/component_testing_takes_a_screenshot_viewport_${capture}`, { capture })
     })
   })
@@ -55,6 +70,7 @@ describe('screenshot', () => {
       styles,
     })
 
+    removeGlobalStyles()
     cy.screenshot('percy/component_testing_screenshot_custom_viewport_screenshot')
   })
 
@@ -64,6 +80,7 @@ describe('screenshot', () => {
       styles,
     })
 
+    removeGlobalStyles()
     cy.screenshot('percy/component_testing_screenshot_long_viewport')
   })
 
@@ -134,6 +151,7 @@ describe('screenshot', () => {
       }
 
       mount(() => <Comp />, { style }).then(() => {
+        removeGlobalStyles()
         cy.screenshot(`percy/large_component_hardcoded_size_viewport_${viewport[0]}_${viewport[1]}`, { capture: 'viewport' })
         cy.screenshot(`percy/large_component_hardcoded_size_fullPage_${viewport[0]}_${viewport[1]}`, { capture: 'fullPage' })
       })
diff --git a/packages/app/src/specs/InlineSpecListTree.vue b/packages/app/src/specs/InlineSpecListTree.vue
index fd6177238a03..8fd7a79f3985 100644
--- a/packages/app/src/specs/InlineSpecListTree.vue
+++ b/packages/app/src/specs/InlineSpecListTree.vue
@@ -1,7 +1,7 @@
 <template>
   <div
     v-bind="containerProps"
-    class="pt-8px specs-list-container overflow-y-auto overflow-x-hidden"
+    class="pt-8px specs-list-container overflow-hidden"
   >
     <ul
       v-bind="wrapperProps"
@@ -157,7 +157,7 @@ a::before {
 }
 
 /** h-[calc] was getting dropped so moved to styles. Virtual list requires defined height. */
-/** Header is 64px, padding-bottom is 8px **/
+/** Header is 64px, padding-top is 8px **/
 .specs-list-container {
   height: calc(100vh - 64px - 8px);
 }
diff --git a/packages/driver/src/cy/commands/screenshot.ts b/packages/driver/src/cy/commands/screenshot.ts
index a5920a9a35c8..38deb62b069e 100644
--- a/packages/driver/src/cy/commands/screenshot.ts
+++ b/packages/driver/src/cy/commands/screenshot.ts
@@ -98,6 +98,10 @@ const scrollOverrides = (win, doc) => {
   // hide scrollbars
   doc.documentElement.style.overflow = 'hidden'
 
+  // this body class is used to set some other overflow-related CSS
+  // around the resizable panels in the Runner
+  document.querySelector('body')?.classList.add('screenshot-scrolling')
+
   // in the case that an element might change size on scroll
   // we trigger a scroll event to ensure that all elements are
   // at their final size before we calculate the total height
@@ -112,6 +116,8 @@ const scrollOverrides = (win, doc) => {
       doc.body.style.overflowY = originalBodyOverflowY
     }
 
+    document.querySelector('body')?.classList.remove('screenshot-scrolling')
+
     return win.scrollTo(originalX, originalY)
   }
 }