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

package/dist/cli.js

@@ -321,6 +321,16 @@ const DEFAULT_RECORDER_SETTINGS = {
 };
 
 // --- 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
@@ -620,6 +630,13 @@ function scriptTemplate(options, settings, viewPort) {
     }).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}',
@@ -696,7 +713,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);
@@ -735,7 +752,7 @@ const DEFAULT_PLAYWRIGHT_TEST_VERSION = '^1.57.0';
  * 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",
@@ -746,7 +763,7 @@ function generatePackageJson(options) {
   },
   "dependencies": {
     "@playwright/test": "${playwrightTestVersion}",
-    "@probolabs/playwright": "latest"${hasSecrets ? ',\n    "dotenv": "latest"' : ''}
+    "@probolabs/playwright": "${probolabsPlaywrightVersion}"${hasSecrets ? ',\n    "dotenv": "latest"' : ''}
   }
 }`;
 }
@@ -1139,12 +1156,12 @@ class ProboCodeGenerator {
         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: {
@@ -1282,6 +1299,7 @@ class ProboCodeGenerator {
             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);
     }
@@ -1341,14 +1359,15 @@ class ProboCodeGenerator {
         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) {
@@ -1375,15 +1394,13 @@ function ensureDirectoryExists(dir) {
     }
 }
 /**
- * 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.join(os.homedir(), '.probium', 'test-suites');
-    if (testSuiteName) {
-        const sanitizedName = slugify(testSuiteName);
-        return path.join(baseDir, `${testSuiteId}-${sanitizedName}`);
-    }
-    return path.join(baseDir, testSuiteId.toString());
+function getProjectDir(projectId, projectName) {
+    const baseDir = path.join(os.homedir(), '.probium', 'projects');
+    const sanitizedName = projectName ? slugify(projectName) : `project-${projectId}`;
+    return path.join(baseDir, `${projectId}-${sanitizedName}`);
 }
 /**
  * Count total tests by scanning spec files
@@ -1578,36 +1595,67 @@ class TestSuiteRunner {
         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.existsSync(testSuiteDir)) {
+        const projectDir = outputDir;
+        if (fs.existsSync(projectDir)) {
             try {
-                const nodeModulesPath = path.join(testSuiteDir, 'node_modules');
+                const nodeModulesPath = path.join(projectDir, 'node_modules');
                 const hasNodeModules = fs.existsSync(nodeModulesPath);
-                // Temporarily move node_modules out of the way if it exists
                 let tempNodeModulesPath = null;
                 if (hasNodeModules) {
-                    tempNodeModulesPath = path.join(testSuiteDir, '..', `node_modules.temp.${testSuiteId}`);
-                    // Remove temp directory if it exists from a previous failed run
+                    tempNodeModulesPath = path.join(projectDir, '..', `node_modules.temp.${projectId}`);
                     if (fs.existsSync(tempNodeModulesPath)) {
                         fs.rmSync(tempNodeModulesPath, { recursive: true, force: true });
                     }
                     fs.renameSync(nodeModulesPath, tempNodeModulesPath);
                     console.log(`📦 Preserved node_modules temporarily`);
                 }
-                // Delete everything in the directory
-                const entries = fs.readdirSync(testSuiteDir, { withFileTypes: true });
+                const entries = fs.readdirSync(projectDir, { withFileTypes: true });
                 for (const entry of entries) {
-                    const entryPath = path.join(testSuiteDir, entry.name);
+                    const entryPath = path.join(projectDir, entry.name);
                     try {
                         if (entry.isDirectory()) {
                             fs.rmSync(entryPath, { recursive: true, force: true });
@@ -1620,36 +1668,33 @@ class TestSuiteRunner {
                         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.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.join(testSuiteDir, 'tests');
+        ensureDirectoryExists(projectDir);
+        const testsDir = path.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.join(testsDir, fileName);
             fs.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);
         }
     }
     /**
@@ -1693,7 +1738,8 @@ class TestSuiteRunner {
         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.join(outputDir, 'package.json');
         fs.writeFileSync(filePath, packageJsonContent, 'utf-8');
@@ -1723,7 +1769,8 @@ class TestSuiteRunner {
      */
     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
@@ -1751,9 +1798,9 @@ class TestSuiteRunner {
             }
             // 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) {
@@ -1761,10 +1808,10 @@ class TestSuiteRunner {
                 }
             }
             // 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)
@@ -1804,7 +1851,7 @@ class TestSuiteRunner {
             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)
@@ -1818,7 +1865,7 @@ class TestSuiteRunner {
                 // 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(' ')}`);
             }
@@ -1840,7 +1887,7 @@ class TestSuiteRunner {
                 // Use spawn for streaming output
                 const npxExecutable = findNpxExecutable();
                 const testProcess = spawn(npxExecutable, ['playwright', 'test', ...playwrightArgs], {
-                    cwd: testSuiteDir,
+                    cwd: projectDir,
                     shell: true,
                     stdio: ['ignore', 'pipe', 'pipe'],
                     env: {
@@ -2026,8 +2073,8 @@ class TestSuiteRunner {
                     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.existsSync(path.join(testSuiteDir, 'playwright-report'))) {
-                        parsedStats = parseStatisticsFromMetadata(testSuiteDir);
+                    if (fs.existsSync(path.join(projectDir, 'playwright-report'))) {
+                        parsedStats = parseStatisticsFromMetadata(projectDir);
                     }
                     if (!parsedStats) {
                         parsedStats = parsePlaywrightStatistics(stdout);
@@ -2229,7 +2276,8 @@ class TestSuiteRunner {
      * 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) {
@@ -2283,9 +2331,12 @@ class TestSuiteRunner {
         ensureDirectoryExists(projectDir);
         const testsDir = path.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.join(testsDir, fileName);
             fs.writeFileSync(filePath, scenario.code, 'utf-8');
             console.log(`✅ Generated test file: ${filePath}`);
@@ -2299,6 +2350,18 @@ class TestSuiteRunner {
             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.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
@@ -2307,7 +2370,7 @@ class TestSuiteRunner {
     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}...`);