@skyramp/skyramp 1.3.13 → 1.3.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@skyramp/skyramp",
-  "version": "1.3.13",
+  "version": "1.3.15",
   "description": "module for leveraging skyramp cli functionality",
   "scripts": {
     "lint": "eslint 'src/**/*.js' 'src/**/*.ts' --fix",

package/scripts/download-binary.js

@@ -4,6 +4,18 @@ const path = require('path');
 const crypto = require('crypto');
 const { S3Client, GetObjectCommand } = require("@aws-sdk/client-s3");
 
+const HEAD_TIMEOUT_MS = 30_000;      // 30s for HEAD/ETag check
+const DOWNLOAD_TIMEOUT_MS = 300_000; // 5min for binary download
+const SCRIPT_TIMEOUT_MS = 600_000;   // 10min global script timeout
+
+// Global script timeout to prevent hanging indefinitely
+const scriptTimer = setTimeout(() => {
+    log('error', `Script timed out after ${SCRIPT_TIMEOUT_MS / 1000}s. This is likely a network connectivity issue.`);
+    log('error', `Please check your network connection and retry by running: npm install @skyramp/skyramp`);
+    process.exit(1);
+}, SCRIPT_TIMEOUT_MS);
+scriptTimer.unref();
+
 function log(level, message) {
     const timestamp = new Date().toISOString();
     console.log(`[${timestamp}] [${level.toUpperCase()}] ${message}`);
@@ -79,13 +91,22 @@ async function calculateMD5(filePath) {
 
 async function getETag(url) {
     return new Promise((resolve, reject) => {
-        https.get(url, { method: 'HEAD' }, res => {
+        const req = https.get(url, { method: 'HEAD', timeout: HEAD_TIMEOUT_MS }, res => {
             if (res.statusCode !== 200) {
+                res.resume(); // Drain response to free the socket
                 reject(new Error(`HTTP ${res.statusCode}: ${url}`));
                 return;
             }
+            res.on('error', (err) => {
+                reject(new Error(`Response stream error during HEAD request: ${err.message}`));
+            });
             resolve(res.headers['etag']?.replace(/"/g, '')); // Remove quotes from ETag
-        }).on('error', (err) => {
+        });
+        req.on('timeout', () => {
+            req.destroy();
+            reject(new Error(`HEAD request timed out after ${HEAD_TIMEOUT_MS / 1000}s: ${url}`));
+        });
+        req.on('error', (err) => {
             log('error', `Error during HEAD request to ${url}: ${err.message}`);
             reject(err);
         });
@@ -119,22 +140,61 @@ async function download(url, dest, options = {}) {
             });
         } else {
             // Public URL download using https
-            https.get(url, res => {
+            let rejected = false;
+            const fail = (err) => {
+                if (rejected) return;
+                rejected = true;
+                // Clean up partial file
+                try { fs.unlinkSync(dest); } catch (_) {}
+                reject(err);
+            };
+
+            const req = https.get(url, { timeout: DOWNLOAD_TIMEOUT_MS }, res => {
                 if (res.statusCode !== 200) {
+                    res.resume(); // Drain response to free the socket
                     const error = new Error(`HTTP ${res.statusCode}: ${url}`);
                     log('error', `Failed to download ${url}: ${error.message}`);
-                    reject(error);
+                    fail(error);
                     return;
                 }
                 const file = fs.createWriteStream(dest);
+                let downloaded = 0;
+                const contentLength = parseInt(res.headers['content-length'], 10);
+                let lastLogTime = Date.now();
+
+                res.on('data', (chunk) => {
+                    downloaded += chunk.length;
+                    const now = Date.now();
+                    if (now - lastLogTime > 10_000) { // Log progress every 10s
+                        const pct = contentLength ? ` (${Math.round(downloaded / contentLength * 100)}%)` : '';
+                        log('info', `Downloading ${path.basename(dest)}: ${(downloaded / 1024 / 1024).toFixed(1)} MB${pct}`);
+                        lastLogTime = now;
+                    }
+                });
+
+                res.on('error', (err) => {
+                    file.destroy();
+                    fail(new Error(`Response stream error: ${err.message}`));
+                });
+
+                file.on('error', (err) => {
+                    res.destroy();
+                    fail(new Error(`File write error: ${err.message}`));
+                });
+
                 res.pipe(file);
                 file.on('finish', () => {
                     log('info', `Successfully downloaded ${url} to ${dest}`);
                     file.close(resolve);
                 });
-            }).on('error', (err) => {
+            });
+            req.on('timeout', () => {
+                req.destroy();
+                fail(new Error(`Download timed out after ${DOWNLOAD_TIMEOUT_MS / 1000}s: ${url}`));
+            });
+            req.on('error', (err) => {
                 log('error', `Error during download from ${url}: ${err.message}`);
-                reject(err);
+                fail(err);
             });
         }
     });
@@ -175,6 +235,23 @@ async function download(url, dest, options = {}) {
             }
 
             await download(url, file.dest, options);
+
+            // Verify downloaded file integrity via ETag/MD5
+            if (!S3_PRIVATE) {
+                try {
+                    const remoteETag = await getETag(url);
+                    const localHash = await calculateMD5(file.dest);
+                    if (remoteETag && remoteETag !== localHash) {
+                        log('error', `Hash mismatch for ${file.name}: expected ${remoteETag}, got ${localHash}`);
+                        try { fs.unlinkSync(file.dest); } catch (_) {}
+                        throw new Error(`Integrity check failed for ${file.name}. Please check your network connection and retry.`);
+                    }
+                } catch (hashErr) {
+                    if (hashErr.message.startsWith('Integrity check failed')) throw hashErr;
+                    log('warn', `Could not verify hash for ${file.name}: ${hashErr.message}`);
+                }
+            }
+
             log('info', `✅ Saved ${file.name} to ${file.dest}`);
         } catch (e) {
             log('error', `❌ Failed to process ${file.name}: ${e.message}`);

package/src/classes/MockV2.d.ts

@@ -36,6 +36,11 @@ export class MockV2 {
    */
   requestBody?: string | null;
 
+  /**
+   * Optional request form params for request-aware matching
+   */
+  requestFormParams?: Record<string, unknown> | null;
+
   /**
    * Optional data override object
    */
@@ -83,6 +88,7 @@ export class MockV2 {
     status_code: number;
     response_body: string;
     request_body?: string;
+    request_form_params?: Record<string, unknown>;
     data_override?: Record<string, unknown>;
     client_id?: string;
   };

package/src/classes/MockV2.js

@@ -38,6 +38,7 @@ class MockV2 {
       this.statusCode = options.statusCode || 201;
       this.responseBody = (options.body !== undefined ? options.body : options.responseBody) || '';
       this.requestBody = options.requestBody || null;
+      this.requestFormParams = options.requestFormParams || null;
       this.dataOverride = options.dataOverride || null;
       this.clientID = options.clientID || null;
     } else {
@@ -48,6 +49,7 @@ class MockV2 {
       this.statusCode = statusCode;
       this.responseBody = responseBody;
       this.requestBody = requestBody;
+      this.requestFormParams = null;
       this.dataOverride = dataOverride;
       this.clientID = null;
     }
@@ -70,6 +72,10 @@ class MockV2 {
       result.request_body = this.requestBody;
     }
 
+    if (this.requestFormParams !== null) {
+      result.request_form_params = this.requestFormParams;
+    }
+
     if (this.dataOverride !== null) {
       result.data_override = this.dataOverride;
     }

package/src/classes/MultipartParam.js

@@ -1,3 +1,6 @@
+const fs   = require('fs');
+const path = require('path');
+
 /**
  * The `MultipartParam` class represents a multipart/form-data parameter for file uploads or value-based content.
  * @class
@@ -8,21 +11,22 @@ class MultipartParam {
    * @constructor
    * @param {Object} options - An options object containing all parameters.
    * @param {string} options.name - The name of the multipart parameter (required).
-   * @param {string} [options.filename=""] - The filename for file uploads.
+   * @param {string} [options.filename=""] - Filename for file uploads. When this is a path to an
+   *   existing file on disk, the file is read and base64-encoded automatically and the basename
+   *   is used as the Content-Disposition filename sent to the server.
    * @param {boolean} [options.decoded=false] - Whether the content should be decoded.
    * @param {string} [options.value=null] - The value for value-based parameters.
-   * 
+   *
    * @example
-   * // File upload parameter
-   * new MultipartParam({ 
+   * // File upload — filename is a local path, content is read automatically
+   * new MultipartParam({
    *   name: 'file',
-   *   filename: 'document.pdf',
-   *   decoded: true
+   *   filename: '/path/to/document.pdf'
    * })
-   * 
+   *
    * @example
    * // Value-based parameter
-   * new MultipartParam({ 
+   * new MultipartParam({
    *   name: 'attributes',
    *   value: '{"product_id": 3}',
    *   filename: '',
@@ -33,11 +37,21 @@ class MultipartParam {
     if (typeof options !== 'object' || options === null || !('name' in options)) {
       throw new Error('MultipartParam requires an options object with a name property')
     }
-    
-    this.name = options.name
-    this.value = options.value || null
-    this.filename = options.filename || ""
+
+    this.name    = options.name
     this.decoded = options.decoded || false
+
+    const filenameOpt = options.filename || ""
+
+    if (filenameOpt && fs.existsSync(filenameOpt)) {
+      // filename is a local filesystem path — read content and use basename as display name
+      this.value    = fs.readFileSync(filenameOpt).toString('base64')
+      this.decoded  = false
+      this.filename = path.basename(filenameOpt)
+    } else {
+      this.filename = filenameOpt
+      this.value    = options.value || null
+    }
   }
 
   toJson() {

package/src/classes/RequestV2.js

@@ -36,7 +36,7 @@ class RequestV2 {
     this.pathParams = options.pathParams || {};
     this.queryParams = options.queryParams || {};
     this.formParams = options.formParams || {};
-    this.multipartParams = options.multipartParams || [];
+    this.multipartParams = options.multipartParams || options.multipart_params || [];
     this.expectedCode = options.expectedCode || '';
     this.description = options.description || '';
     this.insecure = options.insecure || false;

package/src/classes/SkyrampClient.d.ts

@@ -140,6 +140,7 @@ interface GenerateRestTestOptions {
   chainingKey?: string;
   parentRequestData?: Record<string, string> | string;
   parentStatusCode?: Record<string, string> | string;
+  parentFormParams?: Record<string, string> | string;
   requestAware?: boolean;
   providerMode?: boolean;
   consumerMode?: boolean;

package/src/classes/SkyrampClient.js

@@ -104,12 +104,14 @@ const generateRestTestWrapper = lib.func('generateRestTestWrapper', 'string', [
     'string',       // chainingKey
     'string',       // parentRequestData
     'string',       // parentStatusCode
+    'string',       // parentFormParams
     'bool',         // requestAware
     'bool',         // providerMode
     'bool',         // consumerMode
     'string',       // providerOutput (contract test)
-    'string',        // consumerOutput (contract test)
-    'bool'          // skipProvisionParents
+    'string',       // consumerOutput (contract test)
+    'bool',         // skipProvisionParents
+    'int'           // mockPort
 ]);
 const generateRestMockWrapper = lib.func('generateRestMockWrapper', 'string', [
     'string',       // uri
@@ -124,17 +126,17 @@ const generateRestMockWrapper = lib.func('generateRestMockWrapper', 'string', [
     'string',       // k8sNamespace
     'string',       // k8sConfig
     'string',       // k8sContext
+    'string',       // requestData
     'string',       // responseData
     'string',       // responseStatusCode
     'bool',         // force
     'bool',         // deployDashboard
     'bool',         // requestAware
     'string',       // formParams
-    'string',       // pathParams
-    'string',       // queryParams
     'string',       // apiSchema
     'string',       // traceFilePath
-    'string'        // entryPoint
+    'string',       // entryPoint
+    'int'           // mockPort
 ]);
 const traceCollectWrapper = lib.func('traceCollectWrapper', 'string', ['string', 'string', 'bool', 'string', 'string']);
 const analyzeOpenapiWrapper = lib.func('analyzeOpenapiWrapper', 'string', ['string', 'string']);
@@ -895,6 +897,9 @@ class SkyrampClient {
       const parentStatusCode = typeof options.parentStatusCode === 'string'
         ? options.parentStatusCode
         : JSON.stringify(options.parentStatusCode || {});
+      const parentFormParams = typeof options.parentFormParams === 'string'
+        ? options.parentFormParams
+        : JSON.stringify(options.parentFormParams || {});
 
       generateRestTestWrapper.async(
         options.testType || "",
@@ -947,12 +952,14 @@ class SkyrampClient {
         options.chainingKey || "",
         parentRequestData || "",
         parentStatusCode || "",
+        parentFormParams || "",
         options.requestAware || false,
-        options.providerMode || true,
+        options.providerMode || false,
         options.consumerMode || false,
         options.providerOutput || "",
         options.consumerOutput || "",
-        options.skipProvisionParents || true,
+        options.skipProvisionParents || false,
+        options.mockPort || 0,
         (err, res) => {
           if (err) {
             reject(err);
@@ -979,17 +986,17 @@ class SkyrampClient {
         options.k8sNamespace || "",
         options.k8sConfig || "",
         options.k8sContext || "",
+        options.requestData || "",
         options.responseData || "",
         options.responseStatusCode || "",
         options.force || false,
         options.deployDashboard || false,
         options.requestAware || false,
         options.formParams || "",
-        options.pathParams || "",
-        options.queryParams || "",
         JSON.stringify(options.apiSchema || []),
         options.traceFilePath || "",
         options.entrypoint || "",
+        options.mockPort || 0,
         (err, res) => {
           if (err) {
             reject(err);

package/src/classes/SmartPlaywright.js

@@ -1175,6 +1175,11 @@ class SkyrampPlaywrightPage {
         return newLocator
     }
 
+    frameLocator(selector) {
+        const originalFrameLocator = this._page.frameLocator(selector);
+        return new SkyrampPlaywrightFrameLocator(this, originalFrameLocator);
+    }
+
     locator(selector, options) {
         const originalLocator = this._page.locator(selector, options);
         return this.newSkyrampPlaywrightLocator(originalLocator, selector, options);
@@ -1434,5 +1439,6 @@ function expect(obj, testInfo) {
 
 module.exports = {
     newSkyrampPlaywrightPage,
+    SkyrampPlaywrightPage,
     expect,
 };

package/src/workspace.d.ts

@@ -26,7 +26,7 @@ export interface Service {
   serviceName: string;
   language?: "python" | "typescript" | "javascript" | "java";
   framework?: "playwright" | "pytest" | "robot" | "junit";
-  outputDir: string;
+  testDirectory?: string;
   api?: ServiceApi;
   runtimeDetails?: ServiceRuntimeDetails;
 }

package/src/workspace.js

@@ -26,7 +26,7 @@ const serviceSchema = z.object({
   framework: z
     .enum(['playwright', 'pytest', 'robot', 'junit'])
     .optional(),
-  outputDir: z.string().optional(),
+  testDirectory: z.string().optional(),
   api: z
     .object({
       schemaPath: z.string().optional(),