feat(config): snapshotPathTemplate as optional funtion

[ShaMan123]

closes #33098
replaces #33420

This PR adds to possibility to pass a function to snapshotPathTemplate, allowing full runtime control over snapshot names.

    // playwright.config.ts
    import { defineConfig } from '@playwright/test';

    export default defineConfig({
      testDir: './tests',
      snapshotPathTemplate: ({ testDir, testFilePath, arg, ext }) => 
            `${testDir}/__screenshots__/${testFilePath}/${arg}${ext}`,
    });

I am not sure the name fits this functionality so it might be better to add this as a standalone option.

[ShaMan123]

functionality is stable, docs aren't

[ShaMan123]

How do I import SnapshotPathResolver into the generated .d.ts file?

[ShaMan123]

@microsoft-github-policy-service agree

[github-actions]

Test results for "tests 1"

3 fatal errors, not part of any test
46 failed
❌ [playwright-test] › expect.spec.ts:216:5 › should work with default expect matchers and esModuleInterop=false @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:793:7 › directory imports › should resolve index.js after path mapping in CJS @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:834:7 › directory imports › should resolve index.js after path mapping in ESM @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:878:7 › directory imports › should respect package.json#main after path mapping in CJS @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:925:7 › directory imports › should respect package.json#main after path mapping in ESM @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:971:7 › directory imports › should respect package.json#exports without path mapping in CJS @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1013:7 › directory imports › should respect package.json#exports without path mapping in ESM @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1055:7 › directory imports › should not respect package.json#exports after type mapping in CJS @macos-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1107:7 › directory imports › should not respect package.json#exports after type mapping in ESM @macos-latest-node18-1
❌ [playwright-test] › expect.spec.ts:216:5 › should work with default expect matchers and esModuleInterop=false @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:793:7 › directory imports › should resolve index.js after path mapping in CJS @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:834:7 › directory imports › should resolve index.js after path mapping in ESM @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:878:7 › directory imports › should respect package.json#main after path mapping in CJS @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:925:7 › directory imports › should respect package.json#main after path mapping in ESM @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:971:7 › directory imports › should respect package.json#exports without path mapping in CJS @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1013:7 › directory imports › should respect package.json#exports without path mapping in ESM @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1055:7 › directory imports › should not respect package.json#exports after type mapping in CJS @ubuntu-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1107:7 › directory imports › should not respect package.json#exports after type mapping in ESM @ubuntu-latest-node18-1
❌ [playwright-test] › expect.spec.ts:216:5 › should work with default expect matchers and esModuleInterop=false @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:793:7 › directory imports › should resolve index.js after path mapping in CJS @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:834:7 › directory imports › should resolve index.js after path mapping in ESM @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:878:7 › directory imports › should respect package.json#main after path mapping in CJS @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:925:7 › directory imports › should respect package.json#main after path mapping in ESM @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:971:7 › directory imports › should respect package.json#exports without path mapping in CJS @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:1013:7 › directory imports › should respect package.json#exports without path mapping in ESM @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:1055:7 › directory imports › should not respect package.json#exports after type mapping in CJS @ubuntu-latest-node20-1
❌ [playwright-test] › resolver.spec.ts:1107:7 › directory imports › should not respect package.json#exports after type mapping in ESM @ubuntu-latest-node20-1
❌ [playwright-test] › expect.spec.ts:216:5 › should work with default expect matchers and esModuleInterop=false @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:793:7 › directory imports › should resolve index.js after path mapping in CJS @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:834:7 › directory imports › should resolve index.js after path mapping in ESM @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:878:7 › directory imports › should respect package.json#main after path mapping in CJS @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:925:7 › directory imports › should respect package.json#main after path mapping in ESM @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:971:7 › directory imports › should respect package.json#exports without path mapping in CJS @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:1013:7 › directory imports › should respect package.json#exports without path mapping in ESM @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:1055:7 › directory imports › should not respect package.json#exports after type mapping in CJS @ubuntu-latest-node22-1
❌ [playwright-test] › resolver.spec.ts:1107:7 › directory imports › should not respect package.json#exports after type mapping in ESM @ubuntu-latest-node22-1
❌ [playwright-test] › expect.spec.ts:216:5 › should work with default expect matchers and esModuleInterop=false @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:793:7 › directory imports › should resolve index.js after path mapping in CJS @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:834:7 › directory imports › should resolve index.js after path mapping in ESM @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:878:7 › directory imports › should respect package.json#main after path mapping in CJS @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:925:7 › directory imports › should respect package.json#main after path mapping in ESM @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:971:7 › directory imports › should respect package.json#exports without path mapping in CJS @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1013:7 › directory imports › should respect package.json#exports without path mapping in ESM @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1055:7 › directory imports › should not respect package.json#exports after type mapping in CJS @windows-latest-node18-1
❌ [playwright-test] › resolver.spec.ts:1107:7 › directory imports › should not respect package.json#exports after type mapping in ESM @windows-latest-node18-1
❌ [playwright-test] › snapshot-path-template.spec.ts:109:5 › supports function arg @windows-latest-node18-1

10 flaky

⚠️ [firefox-page] › page/page-evaluate.spec.ts:403:3 › should throw for too deep reference chain @firefox-ubuntu-22.04-node18
⚠️ [webkit-library] › library/browsercontext-clearcookies.spec.ts:92:3 › should remove cookies by domain @webkit-ubuntu-22.04-node18
⚠️ [webkit-library] › library/browsercontext-har.spec.ts:244:3 › should round-trip har.zip @webkit-ubuntu-22.04-node18
⚠️ [webkit-library] › library/proxy.spec.ts:44:3 › should use proxy for second page @webkit-ubuntu-22.04-node18
⚠️ [webkit-library] › library/proxy.spec.ts:93:11 › should proxy local network requests › by default › loopback address @webkit-ubuntu-22.04-node18
⚠️ [webkit-library] › library/trace-viewer.spec.ts:109:1 › should show tracing.group in the action list with location @webkit-ubuntu-22.04-node18
⚠️ [webkit-library] › library/video.spec.ts:165:5 › screencast › should work with old options @webkit-ubuntu-22.04-node18
⚠️ [webkit-page] › page/page-leaks.spec.ts:161:5 › waitFor should not leak @webkit-ubuntu-22.04-node18
⚠️ [webkit-page] › page/page-set-input-files.spec.ts:205:3 › should upload multiple large files @webkit-ubuntu-22.04-node18
⚠️ [playwright-test] › ui-mode-test-watch.spec.ts:145:5 › should watch all @windows-latest-node18-1

37198 passed, 645 skipped
✔️✔️✔️

Merge workflow run.