@appliqation/automation-sdk 2.1.1 → 2.1.3

package/README.md

@@ -105,7 +105,8 @@ const appliqationConfig = {
   batchSubmit: true,             // Batch results for efficiency
   batchSize: 50,                 // Results per batch
   logOrphans: true,              // Log tests without UUID mappings
-  logLevel: 'INFO'               // INFO, DEBUG, ERROR
+  logLevel: 'INFO',              // INFO, DEBUG, ERROR
+  rejectUnauthorized: false      // Set to false for self-signed certificates in dev
 };
 
 module.exports = defineConfig({
@@ -655,6 +656,31 @@ npm install dotenv
 
 ---
 
+#### ❌ Error: "unable to verify the first certificate" or SSL errors
+
+**Cause:** Using self-signed SSL certificates in development environment
+
+**Fix:**
+
+Add `rejectUnauthorized: false` to your SDK configuration in `playwright.config.js`:
+
+```javascript
+const appliqationConfig = {
+  baseUrl: process.env.APPLIQATION_BASE_URL,
+  apiKey: process.env.APPLIQATION_API_KEY,
+  projectKey: process.env.APPLIQATION_PROJECT_KEY,
+  environment: process.env.APPLIQATION_ENVIRONMENT,
+  title: process.env.APPLIQATION_RUN_TITLE,
+
+  // Add this for self-signed certificates
+  rejectUnauthorized: false  // ⚠️ Only use in development!
+};
+```
+
+**⚠️ Security Note:** Only use `rejectUnauthorized: false` in development environments with self-signed certificates. In production with valid SSL certificates, remove this setting or set it to `true`.
+
+---
+
 #### ❌ Results not appearing in portal
 
 **Possible causes:**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appliqation/automation-sdk",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "Appliqation Automation SDK with API key authentication, custom run titles, and framework-specific reporters",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -13,6 +13,14 @@
       "require": "./src/reporters/playwright/index.js",
       "import": "./src/reporters/playwright/index.js"
     },
+    "./playwright/global-setup": {
+      "require": "./src/playwright/global-setup.js",
+      "import": "./src/playwright/global-setup.js"
+    },
+    "./playwright/fixture": {
+      "require": "./src/playwright/fixture.js",
+      "import": "./src/playwright/fixture.js"
+    },
     "./cypress": {
       "require": "./src/reporters/cypress/index.js",
       "import": "./src/reporters/cypress/index.js"

package/src/playwright/global-setup.js

@@ -140,12 +140,13 @@ function extractSDKConfig(config) {
  * Get JWT token from Appliqation API
  *
  * @param {Object} sdkConfig - SDK configuration
- * @returns {Promise<Object>} JWT data { jwt_token, run_id }
+ * @returns {Promise<Object>} JWT data { jwt_token, run_id, user_id, project_id }
  */
 async function getJWTToken(sdkConfig) {
-  const endpoint = `${sdkConfig.baseUrl.replace(/\/$/, '')}/api/automation/run/create`;
+  // STEP 1: Create automation run
+  const createRunEndpoint = `${sdkConfig.baseUrl.replace(/\/$/, '')}/api/automation/run/create`;
 
-  const payload = {
+  const runPayload = {
     project_key: sdkConfig.projectKey,
     scenario_id: sdkConfig.scenarioId || 0,
     environment: sdkConfig.environment,
@@ -156,7 +157,7 @@ async function getJWTToken(sdkConfig) {
   };
 
   try {
-    const response = await axios.post(endpoint, payload, {
+    const runResponse = await axios.post(createRunEndpoint, runPayload, {
       headers: {
         'Content-Type': 'application/json',
         'X-API-Key': sdkConfig.apiKey,
@@ -167,14 +168,39 @@ async function getJWTToken(sdkConfig) {
       validateStatus: (status) => status < 500,
     });
 
-    if (response.status !== 200 && response.status !== 201) {
-      throw new Error(`API returned status ${response.status}: ${response.data?.message || 'Unknown error'}`);
+    if (runResponse.status !== 200 && runResponse.status !== 201) {
+      throw new Error(`Run creation failed: ${runResponse.status} - ${runResponse.data?.message || 'Unknown error'}`);
+    }
+
+    const runId = runResponse.data.run_id;
+
+    // STEP 2: Get browser session JWT token
+    const jwtEndpoint = `${sdkConfig.baseUrl.replace(/\/$/, '')}/api/auth/jwt/browser`;
+
+    const jwtPayload = {
+      api_key: sdkConfig.apiKey
+    };
+
+    const jwtResponse = await axios.post(jwtEndpoint, jwtPayload, {
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      httpsAgent: new https.Agent({
+        rejectUnauthorized: false, // Allow self-signed certs in dev
+      }),
+      validateStatus: (status) => status < 500,
+    });
+
+    if (jwtResponse.status !== 200) {
+      throw new Error(`JWT generation failed: ${jwtResponse.status} - ${jwtResponse.data?.message || 'Unknown error'}`);
     }
 
     return {
-      jwt_token: response.data.jwt_token,
-      run_id: response.data.run_id,
-      metadata: response.data.metadata,
+      jwt_token: jwtResponse.data.jwt_token,
+      run_id: runId,
+      user_id: jwtResponse.data.user_id,
+      project_id: jwtResponse.data.project_id,
+      expires_in: jwtResponse.data.expires_in,
     };
 
   } catch (error) {
@@ -197,25 +223,40 @@ async function setupBrowserWithJWT(sdkConfig, jwtToken) {
     headless: true,
   });
 
-  const context = await browser.newContext({
-    ignoreHTTPSErrors: true, // Allow self-signed certs in dev
-  });
+  try {
+    // Extract domain from baseUrl for cookie
+    const baseUrl = sdkConfig.baseUrl.replace(/\/$/, '');
+    const urlObj = new URL(baseUrl);
+    const domain = urlObj.hostname;
+
+    // Create context with JWT cookie BEFORE navigating
+    const context = await browser.newContext({
+      ignoreHTTPSErrors: true, // Allow self-signed certs in dev
+    });
 
-  const page = await context.newPage();
+    // Set JWT cookie
+    await context.addCookies([{
+      name: 'appliqation_jwt',
+      value: jwtToken,
+      domain: domain,
+      path: '/',
+      httpOnly: true,
+      secure: baseUrl.startsWith('https'),
+      sameSite: 'Lax'
+    }]);
 
-  try {
-    // Navigate to app with JWT token in query parameter
-    const appUrl = sdkConfig.appUrl.replace(/\/$/, '');
-    const separator = appUrl.includes('?') ? '&' : '?';
-    const urlWithToken = `${appUrl}${separator}qonsole_token=${encodeURIComponent(jwtToken)}`;
+    console.log(`   ✓ JWT cookie set for domain: ${domain}`);
 
-    console.log(`   Navigating to: ${appUrl}...`);
-    await page.goto(urlWithToken, {
+    const page = await context.newPage();
+
+    // Navigate to app (no query parameter needed)
+    console.log(`   Navigating to: ${baseUrl}...`);
+    await page.goto(baseUrl, {
       waitUntil: 'networkidle',
       timeout: 30000,
     });
 
-    // Wait a bit for session to be established
+    // Wait for authentication to be processed
     await page.waitForTimeout(2000);
 
     // Verify authentication worked
@@ -224,14 +265,16 @@ async function setupBrowserWithJWT(sdkConfig, jwtToken) {
       throw new Error('JWT authentication failed - redirected to login page');
     }
 
-    // Save authenticated state
+    console.log('   ✓ Browser authenticated successfully');
+
+    // Save authenticated state with cookie
     const authDir = path.resolve('.auth');
     if (!fs.existsSync(authDir)) {
       fs.mkdirSync(authDir, { recursive: true });
     }
 
     await context.storageState({ path: '.auth/jwt.json' });
-    console.log('   ✓ Authenticated state saved');
+    console.log('   ✓ Authenticated state saved to .auth/jwt.json');
 
   } catch (error) {
     throw new Error(`Browser setup failed: ${error.message}`);