feat(test-runner-visual-regression): add testName to GetNameArgs

by supplying test name to each of the extensibility points, it becomes easier to store images relative to the test itself

Author: WickyNilliams

packages/test-runner-visual-regression/README.md

@@ -76,6 +76,7 @@ type PixelMatchOptions = PixelMatchParams[5];
 export interface GetNameArgs {
   browser: string;
   name: string;
+  testFile: string;
 }
 
 export interface ImageArgs {

packages/test-runner-visual-regression/src/config.ts

@@ -11,6 +11,7 @@ type PixelMatchOptions = PixelMatchParams[5];
 export interface GetNameArgs {
   browser: string;
   name: string;
+  testFile: string;
 }
 
 export interface ImageArgs {

packages/test-runner-visual-regression/src/visualDiffCommand.ts

@@ -22,9 +22,10 @@ export async function visualDiffCommand(
   image: Buffer,
   browser: string,
   name: string,
+  testFile: string,
 ): Promise<VisualDiffCommandResult> {
   const baseDir = path.resolve(options.baseDir);
-  const baselineName = options.getBaselineName({ browser, name });
+  const baselineName = options.getBaselineName({ browser, name, testFile });
 
   const baselineImage = await options.getBaseline({
     filePath: resolveImagePath(baseDir, baselineName),
@@ -42,8 +43,8 @@ export async function visualDiffCommand(
     return { diffPercentage: -1, passed: true };
   }
 
-  const diffName = options.getDiffName({ browser, name });
-  const failedName = options.getFailedName({ browser, name });
+  const diffName = options.getDiffName({ browser, name, testFile });
+  const failedName = options.getFailedName({ browser, name, testFile });
 
   const saveFailed = async () => {
     await options.saveFailed({

packages/test-runner-visual-regression/src/visualRegressionPlugin.ts

@@ -67,7 +67,13 @@ export function visualRegressionPlugin(
             }
 
             const screenshot = (await element.screenshot({ encoding: 'binary' })) as Buffer;
-            return visualDiffCommand(mergedOptions, screenshot, session.browser.name, payload.name);
+            return visualDiffCommand(
+              mergedOptions,
+              screenshot,
+              session.browser.name,
+              payload.name,
+              session.testFile,
+            );
           }
 
           if (session.browser.type === 'playwright') {
@@ -88,7 +94,13 @@ export function visualRegressionPlugin(
             }
 
             const screenshot = await element.screenshot();
-            return visualDiffCommand(mergedOptions, screenshot, session.browser.name, payload.name);
+            return visualDiffCommand(
+              mergedOptions,
+              screenshot,
+              session.browser.name,
+              payload.name,
+              session.testFile,
+            );
           }
 
           if (session.browser.type === 'webdriver') {
@@ -106,7 +118,13 @@ export function visualRegressionPlugin(
             `;
 
             const screenshot = await browser.takeScreenshot(session.id, locator);
-            return visualDiffCommand(mergedOptions, screenshot, session.browser.name, payload.name);
+            return visualDiffCommand(
+              mergedOptions,
+              screenshot,
+              session.browser.name,
+              payload.name,
+              session.testFile,
+            );
           }
 
           throw new Error(