From cb0ee5aa419849427b4de5b553ef734d22840cae Mon Sep 17 00:00:00 2001
From: Sidharth Vinod <sidharthv96@gmail.com>
Date: Fri, 19 Jan 2024 13:17:14 +0530
Subject: [PATCH] Use pixelmatch for image comparison

---
 cSpell.json                 |  1 +
 cypress/support/commands.js | 22 +++++++++++++---------
 2 files changed, 14 insertions(+), 9 deletions(-)

diff --git a/cSpell.json b/cSpell.json
index 82c1c81c4..4b8772347 100644
--- a/cSpell.json
+++ b/cSpell.json
@@ -102,6 +102,7 @@
     "pathe",
     "pbrolin",
     "phpbb",
+    "pixelmatch",
     "plantuml",
     "playfair",
     "pnpm",
diff --git a/cypress/support/commands.js b/cypress/support/commands.js
index 7a77b3ba6..6fc1fe17d 100644
--- a/cypress/support/commands.js
+++ b/cypress/support/commands.js
@@ -26,12 +26,16 @@
 
 import { addMatchImageSnapshotCommand } from 'cypress-image-snapshot/command';
 
-addMatchImageSnapshotCommand({
-  comparisonMethod: 'ssim',
-  failureThreshold: 0.01,
-  failureThresholdType: 'percent',
-  customDiffConfig: {
-    ssim: 'fast',
-  },
-  blur: 1,
-});
+// The SSIM comparison method can be used if the pixelmatch is throwing lots of false positives.
+// SSIM actually does not catch minute changes in the image, so it is not as accurate as pixelmatch.
+// addMatchImageSnapshotCommand({
+//   comparisonMethod: 'ssim',
+//   failureThreshold: 0.01,
+//   failureThresholdType: 'percent',
+//   customDiffConfig: {
+//     ssim: 'fast',
+//   },
+//   blur: 1,
+// });
+
+addMatchImageSnapshotCommand();