jest-image-snapshot 4.1.0 → 4.2.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [4.2.0](https://github.com/americanexpress/jest-image-snapshot/compare/v4.1.0...v4.2.0) (2020-08-29)
+
+
+### Features
+
+* add obsolete snapshot reporting ([#222](https://github.com/americanexpress/jest-image-snapshot/issues/222)) ([47da7c2](https://github.com/americanexpress/jest-image-snapshot/commit/47da7c23495037e869ee68154218e5d73e1e8cd5))
+
 # [4.1.0](https://github.com/americanexpress/jest-image-snapshot/compare/v4.0.2...v4.1.0) (2020-07-23)
 
 

package/README.md

@@ -160,6 +160,28 @@ expect.extend({ toMatchImageSnapshot });
 ### jest.retryTimes()
 Jest supports [automatic retries on test failures](https://jestjs.io/docs/en/jest-object#jestretrytimes). This can be useful for browser screenshot tests which tend to have more frequent false positives. Note that when using jest.retryTimes you'll have to use a unique customSnapshotIdentifier as that's the only way to reliably identify snapshots.
 
+### Removing Outdated Snapshots
+
+Unlike jest-managed snapshots, the images created by `jest-image-snapshot` will not be automatically removed by the `-u` flag if they are no longer needed. You can force `jest-image-snapshot` to remove the files by including the `outdated-snapshot-reporter` in your config and running with the environment variable `JEST_IMAGE_SNAPSHOT_TRACK_OBSOLETE`.
+
+```json
+{
+  "jest": {
+    "reporters": [
+      "default",
+      "jest-image-snapshot/src/outdated-snapshot-reporter.js"
+    ]
+  }
+}
+```
+
+**WARNING: Do not run a *partial* test suite with this flag as it may consider snapshots of tests that weren't run to be obsolete.**
+
+```bash
+export JEST_IMAGE_SNAPSHOT_TRACK_OBSOLETE=1
+jest
+```
+
 ### Recommendations when using SSIM comparison
 Since SSIM calculates differences in structural similarity by building a moving 'window' over an images pixels, it does not particularly benefit from pixel count comparisons, especially when you factor in that it has a lot of floating point arithmetic in javascript.  However, SSIM gains two key benefits over pixel by pixel comparison:
 - Reduced false positives (failing tests when the images look the same)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jest-image-snapshot",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Jest matcher for image comparisons. Most commonly used for visual regression testing.",
   "main": "src/index.js",
   "engines": {

package/src/index.js

@@ -18,6 +18,7 @@ const path = require('path');
 const Chalk = require('chalk').constructor;
 const { diffImageToSnapshot, runDiffImageToSnapshot } = require('./diff-snapshot');
 const fs = require('fs');
+const OutdatedSnapshotReporter = require('./outdated-snapshot-reporter');
 
 const timesCalled = new Map();
 
@@ -180,6 +181,7 @@ function configureToMatchImageSnapshot({
     const snapshotsDir = customSnapshotsDir || path.join(path.dirname(testPath), SNAPSHOTS_DIR);
     const diffDir = customDiffDir || path.join(snapshotsDir, '__diff_output__');
     const baselineSnapshotPath = path.join(snapshotsDir, `${snapshotIdentifier}-snap.png`);
+    OutdatedSnapshotReporter.markTouchedFile(baselineSnapshotPath);
 
     if (snapshotState._updateSnapshot === 'none' && !fs.existsSync(baselineSnapshotPath)) {
       return {

package/src/outdated-snapshot-reporter.js

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2020 American Express Travel Related Services Company, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License
+ * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+/* eslint-disable class-methods-use-this */
+
+const fs = require('fs');
+const path = require('path');
+
+const TOUCHED_FILE_LIST_PATH = path.join(
+  process.cwd(),
+  '.jest-image-snapshot-touched-files'
+);
+
+const IS_ENABLED = !!process.env.JEST_IMAGE_SNAPSHOT_TRACK_OBSOLETE;
+
+class OutdatedSnapshotReporter {
+  /* istanbul ignore next - test coverage in child process */
+  static markTouchedFile(filePath) {
+    if (!IS_ENABLED) return;
+    const touchedListFileDescriptor = fs.openSync(TOUCHED_FILE_LIST_PATH, 'as');
+    fs.writeSync(touchedListFileDescriptor, `${filePath}\n`);
+    fs.closeSync(touchedListFileDescriptor);
+  }
+
+  /* istanbul ignore next - test coverage in child process */
+  static readTouchedFileListFromDisk() {
+    if (!fs.existsSync(TOUCHED_FILE_LIST_PATH)) return [];
+
+    return Array.from(
+      new Set(
+        fs
+          .readFileSync(TOUCHED_FILE_LIST_PATH, 'utf-8')
+          .split('\n')
+          .filter(file => file && fs.existsSync(file))
+      )
+    );
+  }
+
+  /* istanbul ignore next - test coverage in child process */
+  onRunStart() {
+    if (!IS_ENABLED) return;
+    if (fs.existsSync(TOUCHED_FILE_LIST_PATH)) {
+      fs.unlinkSync(TOUCHED_FILE_LIST_PATH);
+    }
+  }
+
+  /* istanbul ignore next - test coverage in child process */
+  onRunComplete() {
+    if (!IS_ENABLED) return;
+    const touchedFiles = OutdatedSnapshotReporter.readTouchedFileListFromDisk();
+    const imageSnapshotDirectories = Array.from(
+      new Set(touchedFiles.map(file => path.dirname(file)))
+    );
+    const allFiles = imageSnapshotDirectories
+      .map(dir => fs.readdirSync(dir).map(file => path.join(dir, file)))
+      .reduce((a, b) => a.concat(b), [])
+      .filter(file => file.endsWith('-snap.png'));
+    const obsoleteFiles = allFiles.filter(
+      file => !touchedFiles.includes(file)
+    );
+
+    if (fs.existsSync(TOUCHED_FILE_LIST_PATH)) {
+      fs.unlinkSync(TOUCHED_FILE_LIST_PATH);
+    }
+
+    obsoleteFiles.forEach((file) => {
+      process.stderr.write(`Deleting outdated snapshot "${file}"...\n`);
+      fs.unlinkSync(file);
+    });
+  }
+}
+
+module.exports = OutdatedSnapshotReporter;