@probolabs/playwright 1.5.0-rc.8 → 1.5.0-rc.9

package/dist/index.cjs

@@ -1315,6 +1315,16 @@ const highlighterCode = "(function (global, factory) {\n    typeof exports === '
     };
 
     // --- Code generation utilities for Probo Labs Playwright scripts ---
+    /**
+     * Converts a test suite name to a Playwright tag (slugify + @ prefix).
+     * Playwright tags must start with @.
+     */
+    function slugifyTag(tag) {
+        if (!tag || typeof tag !== 'string')
+            return '@untagged';
+        const slug = slugify(tag);
+        return slug ? `@${slug}` : '@untagged';
+    }
     /**
      * Extracts environment variable names from parameter table rows
      * by parsing ${process.env.VAR_NAME} patterns from parameter values
@@ -1623,6 +1633,13 @@ const highlighterCode = "(function (global, factory) {\n    typeof exports === '
     }).join(',\n    ')}
   ];
   ` : '';
+        // Playwright tags for test suite filtering (e.g. npx playwright test --grep @sanity)
+        const playwrightTags = options.testSuiteTags && options.testSuiteTags.length > 0
+            ? options.testSuiteTags.map(slugifyTag).filter((t) => t !== '@untagged')
+            : [];
+        const describeTagOption = playwrightTags.length > 0
+            ? `{ tag: [${playwrightTags.map((t) => `'${t}'`).join(', ')}] }, `
+            : '';
         const proboConstructor = hasAiInteractions ? `
   const probo = new Probo({
     scenarioName: '${options.scenarioName}',
@@ -1699,7 +1716,7 @@ ${hasSecrets ? `import { config } from 'dotenv';
         }
     });
 
-  test.describe('${options.scenarioName}', () => {
+  test.describe('${options.scenarioName}', ${describeTagOption}() => {
     test.beforeEach(async ({ page }) => {
       // set the ProboPlaywright instance to the current page
       ppw.setPage(page);
@@ -1775,7 +1792,7 @@ ${hasSecrets ? `import { config } from 'dotenv';
      * Generate package.json content for a Playwright test project
      */
     function generatePackageJson(options) {
-        const { name, hasSecrets = false, testScript = 'npx playwright test', playwrightTestVersion = DEFAULT_PLAYWRIGHT_TEST_VERSION } = options;
+        const { name, hasSecrets = false, testScript = 'npx playwright test', playwrightTestVersion = DEFAULT_PLAYWRIGHT_TEST_VERSION, probolabsPlaywrightVersion = 'latest' } = options;
         return `{
   "name": "${name}",
   "version": "1.0.0",
@@ -1786,7 +1803,7 @@ ${hasSecrets ? `import { config } from 'dotenv';
   },
   "dependencies": {
     "@playwright/test": "${playwrightTestVersion}",
-    "@probolabs/playwright": "latest"${hasSecrets ? ',\n    "dotenv": "latest"' : ''}
+    "@probolabs/playwright": "${probolabsPlaywrightVersion}"${hasSecrets ? ',\n    "dotenv": "latest"' : ''}
   }
 }`;
     }
@@ -6130,12 +6147,12 @@ export default class ProboReporter implements Reporter {
             return response.json();
         }
         /**
-         * Fetch all scenarios for a project from the backend API
+         * Fetch all scenarios for a project from the backend API (light endpoint includes test_suite_tags)
          */
         static async fetchProjectScenarios(projectId, apiToken, apiUrl) {
             const normalizedUrl = this.normalizeApiUrl(apiUrl);
-            // Scenarios endpoint is at root level, not under /api/
-            const url = `${normalizedUrl}/scenarios/?project_id=${projectId}`;
+            // Use api/scenarios/light/ to get test_suite_tags for Playwright tagging
+            const url = `${normalizedUrl}/api/scenarios/light/?project_id=${projectId}`;
             const response = await fetch(url, {
                 method: 'GET',
                 headers: {
@@ -6273,6 +6290,7 @@ export default class ProboReporter implements Reporter {
                 scenarioName: scenarioData.name,
                 interactions: interactions,
                 rows: rows,
+                ...((options === null || options === void 0 ? void 0 : options.testSuiteTags) && options.testSuiteTags.length > 0 ? { testSuiteTags: options.testSuiteTags } : {}),
             };
             return generateCode(codeOptions, settings, viewPort);
         }
@@ -6332,14 +6350,15 @@ export default class ProboReporter implements Reporter {
             if (scenarios.length === 0) {
                 throw new Error(`No scenarios found in project "${projectData.name}" (ID: ${projectId})`);
             }
-            // Generate code for each scenario
+            // Generate code for each scenario (with test_suite_tags for Playwright tagging)
             const scenarioResults = await Promise.all(scenarios.map(async (scenario) => {
                 try {
-                    const code = await this.generateCodeForScenario(scenario.id, apiToken, apiUrl, options);
+                    const code = await this.generateCodeForScenario(scenario.id, apiToken, apiUrl, { ...options, testSuiteTags: scenario.test_suite_tags });
                     return {
                         scenarioId: scenario.id,
                         scenarioName: scenario.name,
                         code: code,
+                        testSuiteTags: scenario.test_suite_tags,
                     };
                 }
                 catch (error) {
@@ -6366,15 +6385,13 @@ export default class ProboReporter implements Reporter {
         }
     }
     /**
-     * Gets the default test suite directory path
+     * Gets the project directory path (unified for test suite runs and export).
+     * Path: ~/.probium/projects/{projectId}-{projectName-slugified}/
      */
-    function getDefaultTestSuiteDir(testSuiteId, testSuiteName) {
-        const baseDir = path__namespace.join(os__namespace.homedir(), '.probium', 'test-suites');
-        if (testSuiteName) {
-            const sanitizedName = slugify(testSuiteName);
-            return path__namespace.join(baseDir, `${testSuiteId}-${sanitizedName}`);
-        }
-        return path__namespace.join(baseDir, testSuiteId.toString());
+    function getProjectDir(projectId, projectName) {
+        const baseDir = path__namespace.join(os__namespace.homedir(), '.probium', 'projects');
+        const sanitizedName = projectName ? slugify(projectName) : `project-${projectId}`;
+        return path__namespace.join(baseDir, `${projectId}-${sanitizedName}`);
     }
     /**
      * Count total tests by scanning spec files
@@ -6569,36 +6586,67 @@ export default class ProboReporter implements Reporter {
             throw new Error(`Test suite "${testSuiteName}" not found in project "${projectName}"`);
         }
         /**
-         * Generate all files for a test suite
+         * Fetch test suite details (project id, project name, test suite name)
+         */
+        static async fetchTestSuiteDetails(testSuiteId, apiToken, apiUrl) {
+            var _a, _b, _c;
+            const baseUrl = apiUrl.endsWith('/') ? apiUrl.slice(0, -1) : apiUrl;
+            const response = await fetch$1(`${baseUrl}/test-suites/${testSuiteId}/`, {
+                method: 'GET',
+                headers: {
+                    'Authorization': `Token ${apiToken}`,
+                    'Content-Type': 'application/json',
+                },
+            });
+            if (!response.ok) {
+                const errorText = await response.text();
+                throw new Error(`Failed to fetch test suite ${testSuiteId}: ${response.status} ${errorText}`);
+            }
+            const data = await response.json();
+            const projectId = (_a = data.project) !== null && _a !== void 0 ? _a : data.project_id;
+            const projectName = (_b = data.project_name) !== null && _b !== void 0 ? _b : `project-${projectId}`;
+            const testSuiteName = (_c = data.name) !== null && _c !== void 0 ? _c : `suite-${testSuiteId}`;
+            if (!projectId) {
+                throw new Error(`Test suite ${testSuiteId} has no project`);
+            }
+            return { projectId, projectName, testSuiteName };
+        }
+        /**
+         * Generate all files for a test suite (writes to project-level directory)
          */
         static async generateTestSuiteFiles(testSuiteId, apiToken, apiUrl, outputDir, testSuiteName, includeReporter = true, runId) {
-            const testSuiteDir = outputDir || getDefaultTestSuiteDir(testSuiteId, testSuiteName);
-            // Generate code for all scenarios
+            const { projectId, projectName, testSuiteName: resolvedSuiteName } = await this.fetchTestSuiteDetails(testSuiteId, apiToken, apiUrl);
+            const projectDir = outputDir || getProjectDir(projectId, projectName);
+            await this.generateTestSuiteOnlyFiles(testSuiteId, apiToken, apiUrl, projectDir, testSuiteName !== null && testSuiteName !== void 0 ? testSuiteName : resolvedSuiteName, includeReporter, runId);
+        }
+        /**
+         * Generate files only for the scenarios that participate in the test suite.
+         * Used by the recorder app test-suite runner so only suite specs are written; then we run npx playwright test normally.
+         */
+        static async generateTestSuiteOnlyFiles(testSuiteId, apiToken, apiUrl, outputDir, testSuiteName, includeReporter = true, runId) {
+            var _a;
+            const { projectId } = await this.fetchTestSuiteDetails(testSuiteId, apiToken, apiUrl);
             const codeGenResult = await ProboCodeGenerator.generateCodeForTestSuite(testSuiteId, apiToken, apiUrl);
             if (codeGenResult.scenarios.length === 0) {
-                throw new Error(`No scenarios found in test suite ${testSuiteId}. Cannot generate test files.`);
+                throw new Error(`No scenarios found in test suite "${codeGenResult.testSuiteName}" (ID: ${testSuiteId}). Cannot generate test files.`);
             }
-            // Delete everything in the test suite directory except node_modules
-            // This ensures a clean state while preserving dependencies for faster subsequent runs
-            if (fs__namespace.existsSync(testSuiteDir)) {
+            const projectDir = outputDir;
+            if (fs__namespace.existsSync(projectDir)) {
                 try {
-                    const nodeModulesPath = path__namespace.join(testSuiteDir, 'node_modules');
+                    const nodeModulesPath = path__namespace.join(projectDir, 'node_modules');
                     const hasNodeModules = fs__namespace.existsSync(nodeModulesPath);
-                    // Temporarily move node_modules out of the way if it exists
                     let tempNodeModulesPath = null;
                     if (hasNodeModules) {
-                        tempNodeModulesPath = path__namespace.join(testSuiteDir, '..', `node_modules.temp.${testSuiteId}`);
-                        // Remove temp directory if it exists from a previous failed run
+                        tempNodeModulesPath = path__namespace.join(projectDir, '..', `node_modules.temp.${projectId}`);
                         if (fs__namespace.existsSync(tempNodeModulesPath)) {
                             fs__namespace.rmSync(tempNodeModulesPath, { recursive: true, force: true });
                         }
                         fs__namespace.renameSync(nodeModulesPath, tempNodeModulesPath);
                         console.log(`📦 Preserved node_modules temporarily`);
                     }
-                    // Delete everything in the directory
-                    const entries = fs__namespace.readdirSync(testSuiteDir, { withFileTypes: true });
+                    const entries = fs__namespace.readdirSync(projectDir, { withFileTypes: true });
                     for (const entry of entries) {
-                        const entryPath = path__namespace.join(testSuiteDir, entry.name);
+                        const entryPath = path__namespace.join(projectDir, entry.name);
                         try {
                             if (entry.isDirectory()) {
                                 fs__namespace.rmSync(entryPath, { recursive: true, force: true });
@@ -6611,36 +6659,33 @@ export default class ProboReporter implements Reporter {
                             console.warn(`⚠️  Failed to delete ${entry.name}:`, error);
                         }
                     }
-                    console.log(`🗑️  Cleaned test suite directory (preserved node_modules)`);
-                    // Move node_modules back
+                    console.log(`🗑️  Cleaned project directory (preserved node_modules)`);
                     if (hasNodeModules && tempNodeModulesPath) {
                         fs__namespace.renameSync(tempNodeModulesPath, nodeModulesPath);
                         console.log(`📦 Restored node_modules`);
                     }
                 }
                 catch (error) {
-                    console.warn(`⚠️  Failed to clean test suite directory ${testSuiteDir}:`, error);
-                    // Continue anyway - we'll overwrite files as needed
+                    console.warn(`⚠️  Failed to clean project directory ${projectDir}:`, error);
                 }
             }
-            // Ensure directories exist (will recreate after deletion)
-            ensureDirectoryExists(testSuiteDir);
-            const testsDir = path__namespace.join(testSuiteDir, 'tests');
+            ensureDirectoryExists(projectDir);
+            const testsDir = path__namespace.join(projectDir, 'tests');
             ensureDirectoryExists(testsDir);
-            // Save each scenario's code to a .spec.ts file
+            const seenSlugs = new Map();
             for (const scenario of codeGenResult.scenarios) {
-                const fileName = `${slugify(scenario.scenarioName)}.spec.ts`;
+                const slug = slugify(scenario.scenarioName);
+                const count = (_a = seenSlugs.get(slug)) !== null && _a !== void 0 ? _a : 0;
+                seenSlugs.set(slug, count + 1);
+                const fileName = count > 0 ? `${slug}-${scenario.scenarioId}.spec.ts` : `${slug}.spec.ts`;
                 const filePath = path__namespace.join(testsDir, fileName);
                 fs__namespace.writeFileSync(filePath, scenario.code, 'utf-8');
                 console.log(`✅ Generated test file: ${filePath}`);
             }
-            // Generate package.json
-            await this.generatePackageJson(testSuiteDir, codeGenResult);
-            // Generate playwright.config.ts with runId if available
-            await this.generatePlaywrightConfig(testSuiteDir, includeReporter, runId);
-            // Generate custom reporter file for live progress streaming (only if requested)
+            await this.generatePackageJson(projectDir, codeGenResult);
+            await this.generatePlaywrightConfig(projectDir, includeReporter, runId);
             if (includeReporter) {
-                await this.generateProboReporter(testSuiteDir);
+                await this.generateProboReporter(projectDir);
             }
         }
         /**
@@ -6684,7 +6729,8 @@ export default class ProboReporter implements Reporter {
             const packageJsonContent = generatePackageJson({
                 name: sanitizedName,
                 hasSecrets: hasSecrets,
-                testScript: 'npx playwright test'
+                testScript: 'npx playwright test',
+                probolabsPlaywrightVersion: process.env.PROBO_PLAYWRIGHT_VERSION || 'latest',
             });
             const filePath = path__namespace.join(outputDir, 'package.json');
             fs__namespace.writeFileSync(filePath, packageJsonContent, 'utf-8');
@@ -6714,7 +6760,8 @@ export default class ProboReporter implements Reporter {
          */
         static async runTestSuite(testSuiteId, apiToken, apiUrl, testSuiteName, runId, options = {}) {
             const { outputDir, includeReporter = true, playwrightArgs = [], skipRunCreation = false, onStatusUpdate, onStdout, onStderr, onReporterEvent, } = options;
-            const testSuiteDir = outputDir || getDefaultTestSuiteDir(testSuiteId, testSuiteName);
+            const details = await this.fetchTestSuiteDetails(testSuiteId, apiToken, apiUrl);
+            const projectDir = outputDir || getProjectDir(details.projectId, details.projectName);
             let currentRunId = runId;
             try {
                 // Create run record if not provided and not skipping run creation
@@ -6742,9 +6789,9 @@ export default class ProboReporter implements Reporter {
                 }
                 // Generate all files (with runId if available for run-specific report directories)
                 console.log(`📝 Generating test suite files for test suite ${testSuiteId}...`);
-                await this.generateTestSuiteFiles(testSuiteId, apiToken, apiUrl, testSuiteDir, testSuiteName, includeReporter, currentRunId);
+                await this.generateTestSuiteFiles(testSuiteId, apiToken, apiUrl, projectDir, testSuiteName, includeReporter, currentRunId);
                 // Count total tests
-                const testsTotal = countTotalTests(testSuiteDir);
+                const testsTotal = countTotalTests(projectDir);
                 if (currentRunId && testsTotal > 0) {
                     await updateRunStatus(currentRunId, testSuiteId, { tests_total: testsTotal }, apiToken, apiUrl);
                     if (onStatusUpdate) {
@@ -6752,10 +6799,10 @@ export default class ProboReporter implements Reporter {
                     }
                 }
                 // Install dependencies
-                console.log(`📦 Installing dependencies in ${testSuiteDir}...`);
+                console.log(`📦 Installing dependencies in ${projectDir}...`);
                 try {
                     const npmExecutable = findNpmExecutable();
-                    const { stdout: installStdout, stderr: installStderr } = await execAsync(`${npmExecutable} install`, { cwd: testSuiteDir, timeout: 300000 } // 5 minute timeout for install
+                    const { stdout: installStdout, stderr: installStderr } = await execAsync(`${npmExecutable} install`, { cwd: projectDir, timeout: 300000 } // 5 minute timeout for install
                     );
                     console.log('✅ Dependencies installed successfully');
                     if (installStdout)
@@ -6795,7 +6842,7 @@ export default class ProboReporter implements Reporter {
                 console.log(`🌐 Installing Playwright Chromium browser...`);
                 try {
                     const npxExecutable = findNpxExecutable();
-                    const { stdout: browserStdout, stderr: browserStderr } = await execAsync(`${npxExecutable} playwright install chromium`, { cwd: testSuiteDir, timeout: 300000 } // 5 minute timeout for browser install
+                    const { stdout: browserStdout, stderr: browserStderr } = await execAsync(`${npxExecutable} playwright install chromium`, { cwd: projectDir, timeout: 300000 } // 5 minute timeout for browser install
                     );
                     console.log('✅ Playwright Chromium browser installed successfully');
                     if (browserStdout)
@@ -6809,7 +6856,7 @@ export default class ProboReporter implements Reporter {
                     // or the error will be caught when trying to run tests
                 }
                 // Run Playwright tests with streaming output
-                console.log(`🚀 Running Playwright tests in ${testSuiteDir}...`);
+                console.log(`🚀 Running Playwright tests in ${projectDir}...`);
                 if (playwrightArgs.length > 0) {
                     console.log(`🧪 Playwright extra args: ${playwrightArgs.join(' ')}`);
                 }
@@ -6831,7 +6878,7 @@ export default class ProboReporter implements Reporter {
                     // Use spawn for streaming output
                     const npxExecutable = findNpxExecutable();
                     const testProcess = child_process.spawn(npxExecutable, ['playwright', 'test', ...playwrightArgs], {
-                        cwd: testSuiteDir,
+                        cwd: projectDir,
                         shell: true,
                         stdio: ['ignore', 'pipe', 'pipe'],
                         env: {
@@ -7017,8 +7064,8 @@ export default class ProboReporter implements Reporter {
                         console.log(success ? '✅ Tests completed successfully' : (isTestFailure ? '⚠️ Tests completed with failures' : '❌ Test execution failed'));
                         // Parse final statistics from metadata/stdout as fallback
                         let parsedStats = null;
-                        if (fs__namespace.existsSync(path__namespace.join(testSuiteDir, 'playwright-report'))) {
-                            parsedStats = parseStatisticsFromMetadata(testSuiteDir);
+                        if (fs__namespace.existsSync(path__namespace.join(projectDir, 'playwright-report'))) {
+                            parsedStats = parseStatisticsFromMetadata(projectDir);
                         }
                         if (!parsedStats) {
                             parsedStats = parsePlaywrightStatistics(stdout);
@@ -7220,7 +7267,8 @@ export default class ProboReporter implements Reporter {
          * Generate all files for a project (all scenarios)
          */
         static async generateProjectFiles(projectId, apiToken, apiUrl, outputDir, projectName, includeReporter = true) {
-            const projectDir = outputDir || getDefaultTestSuiteDir(projectId, projectName || `project-${projectId}`);
+            var _a;
+            const projectDir = outputDir || getProjectDir(projectId, projectName || `project-${projectId}`);
             // Generate code for all scenarios
             const codeGenResult = await ProboCodeGenerator.generateCodeForProject(projectId, apiToken, apiUrl);
             if (codeGenResult.scenarios.length === 0) {
@@ -7274,9 +7322,12 @@ export default class ProboReporter implements Reporter {
             ensureDirectoryExists(projectDir);
             const testsDir = path__namespace.join(projectDir, 'tests');
             ensureDirectoryExists(testsDir);
-            // Save each scenario's code to a .spec.ts file
+            const seenSlugs = new Map();
             for (const scenario of codeGenResult.scenarios) {
-                const fileName = `${slugify(scenario.scenarioName)}.spec.ts`;
+                const slug = slugify(scenario.scenarioName);
+                const count = (_a = seenSlugs.get(slug)) !== null && _a !== void 0 ? _a : 0;
+                seenSlugs.set(slug, count + 1);
+                const fileName = count > 0 ? `${slug}-${scenario.scenarioId}.spec.ts` : `${slug}.spec.ts`;
                 const filePath = path__namespace.join(testsDir, fileName);
                 fs__namespace.writeFileSync(filePath, scenario.code, 'utf-8');
                 console.log(`✅ Generated test file: ${filePath}`);
@@ -7290,6 +7341,18 @@ export default class ProboReporter implements Reporter {
                 await this.generateProboReporter(projectDir);
             }
         }
+        /**
+         * Export project code to a directory.
+         * If outputDir is provided, creates a subfolder {outputDir}/{projectId}-{projectNameSlug}/ and writes there.
+         * Otherwise writes to the default project dir (~/.probium/projects/...).
+         */
+        static async exportProjectCode(projectId, apiToken, apiUrl, outputDir, projectName, includeReporter = false) {
+            const targetDir = outputDir
+                ? path__namespace.join(outputDir, `${projectId}-${slugify(projectName || `project-${projectId}`)}`)
+                : getProjectDir(projectId, projectName);
+            await this.generateProjectFiles(projectId, apiToken, apiUrl, targetDir, projectName, includeReporter);
+            return targetDir;
+        }
         /**
          * Run all scenarios in a project
          * Generates files, installs dependencies, and executes tests
@@ -7298,7 +7361,7 @@ export default class ProboReporter implements Reporter {
         static async runProjectScenarios(projectId, apiToken, apiUrl, projectName, options = {}) {
             const { outputDir, includeReporter = false, // CLI mode - no custom reporter
             playwrightArgs = [], onStdout, onStderr, } = options;
-            const projectDir = outputDir || getDefaultTestSuiteDir(projectId, projectName || `project-${projectId}`);
+            const projectDir = outputDir || getProjectDir(projectId, projectName || `project-${projectId}`);
             try {
                 // Generate all files
                 console.log(`📝 Generating test files for project ${projectId}...`);
@@ -7890,6 +7953,7 @@ export default class ProboReporter implements Reporter {
     exports.extractRequiredEnvVars = extractRequiredEnvVars;
     exports.findClosestVisibleElement = findClosestVisibleElement;
     exports.generateCode = generateCode;
+    exports.getProjectDir = getProjectDir;
     exports.getRequiredEnvVars = getRequiredEnvVars;
     exports.interpolateWithParams = interpolateWithParams;