How can I use the runtime hooks feature?

[vinaysshenoy]

Is there a sample on how to use the runtime hooks feature somewhere? I need to process the image before it gets saved in some cases, but I am having trouble getting the runtime hooks to actually works.

I have added this function in transformSnapshot.cjs:

function onBeforeWriteToDisc(buffer, destination, testPath, currentTestName) {
    return buffer
}

And then referred to it when configuring the library:

addMatchImageSnapshotCommand({
  failureThreshold: 0.02,
  comparisonMethod: "ssim",
  failureThresholdType: "percent",
  runtimeHooksPath: require.resolve('./transformSnapshots.cjs')
})

When I run the test, however, this fails with the following error:

cypress_runner.js:139983 Error: Couldn't import ./cypress/support/transformSnapshots.cjs: Cannot find module './cypress/support/transformSnapshots.cjs'
Require stack:
- /Users/vinaysshenoy/Dev/Qweebi/qweebi-unity-tests/node_modules/jest-image-snapshot/src/diff-snapshot.js
- /Users/vinaysshenoy/Dev/Qweebi/qweebi-unity-tests/node_modules/@simonsmith/cypress-image-snapshot/plugin.js
- /Users/vinaysshenoy/Dev/Qweebi/qweebi-unity-tests/cypress.config.ts
- /Users/vinaysshenoy/Library/Caches/Cypress/13.15.2/Cypress.app/Contents/Resources/app/packages/server/lib/plugins/child/run_require_async_child.js
- /Users/vinaysshenoy/Library/Caches/Cypress/13.15.2/Cypress.app/Contents/Resources/app/packages/server/lib/plugins/child/require_async_child.js
    at writeFileWithHooks (/Users/vinaysshenoy/Dev/Qweebi/qweebi-unity-tests/node_modules/jest-image-snapshot/src/diff-snapshot.js:219:13)
    at diffImageToSnapshot (/Users/vinaysshenoy/Dev/Qweebi/qweebi-unity-tests/node_modules/jest-image-snapshot/src/diff-snapshot.js:338:9)
    at Object.runImageDiffAfterScreenshot [as handler] (/Users/vinaysshenoy/Dev/Qweebi/qweebi-unity-tests/node_modules/@simonsmith/cypress-image-snapshot/plugin.js:98:62)
From previous event:
    at Promise.longStackTracesCaptureStackTrace [as _captureStackTrace] (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:3486:19)
    at Promise._then (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:1239:17)
    at Promise.then (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:1132:17)
    at next (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:144025:64)
    at <unknown> (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:144046:16)
    at tryCatcher (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:1807:23)
    at Promise._settlePromiseFromHandler (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:1519:31)
    at Promise._settlePromise (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:1576:18)
    at Promise._settlePromise0 (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:1621:10)
    at Promise._settlePromises (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:1701:18)
    at <unknown> (https://make-dev.qweebi.com/__cypress/runner/cypress_runner.js:2392:25)

Can someone point me to an example which shows how to use this properly?

[simonsmith]

The stack trace indicates it's an issue with the path to your module