@mablhq/mabl-cli 2.11.6 → 2.12.7

package/mablscript/mobile/steps/EnterTextStep.js

@@ -17,6 +17,9 @@ class EnterTextStep extends MablStepV2_1.MablStepV2 {
         return vars;
     }
     stepDescription() {
+        if ((0, stepUtil_1.isPasswordField)(this.descriptor.find)) {
+            return (0, stepUtil_1.getDescriptionForMobileStepDescriptor)(`Enter password in`, this.descriptor);
+        }
         return (0, stepUtil_1.getDescriptionForMobileStepDescriptor)(`Enter text "${this.descriptor.text}" in`, this.descriptor);
     }
     static fromYaml(_stepName, stepDescriptor) {

package/mablscript/mobile/steps/stepUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isStepWithFind = exports.humanizeCustomFind = exports.getElementDescriptionFromMobileFindDescriptor = exports.getDescriptionForMobileStepDescriptor = exports.getSimpleIOSElementName = exports.getSimpleAndroidElementName = void 0;
+exports.isPasswordField = exports.isStepWithFind = exports.humanizeCustomFind = exports.getElementDescriptionFromMobileFindDescriptor = exports.getDescriptionForMobileStepDescriptor = exports.getSimpleIOSElementName = exports.getSimpleAndroidElementName = void 0;
 const domUtil_1 = require("../../../domUtil");
 const mablscriptFind_1 = require("../../../mablscriptFind");
 function getSimpleAndroidElementName(className) {
@@ -35,24 +35,49 @@ function getElementDescriptionFromMobileFindDescriptor(descriptor) {
         }
         const selector = findTarget.selector;
         if (selector.android && Object.keys(selector.android).length) {
-            if (selector.android.text) {
-                return `element with text "${(0, domUtil_1.normalizeText)(selector.android.text)}"`;
-            }
-            return `"${getSimpleAndroidElementName(selector.android.class)}" element`;
+            return buildElementDescriptionForAndroid(findTarget);
         }
         else if (selector.iOS) {
-            if (selector.iOS.name) {
-                return `"${selector.iOS.name}" element`;
-            }
-            if (selector.iOS.label) {
-                return `element with text "${(0, domUtil_1.normalizeText)(selector.iOS.label)}"`;
-            }
-            return `the "${getSimpleIOSElementName(selector.iOS.type)}" element`;
+            return buildElementDescriptionForiOS(findTarget);
         }
     }
     return 'unknown element';
 }
 exports.getElementDescriptionFromMobileFindDescriptor = getElementDescriptionFromMobileFindDescriptor;
+function buildElementDescriptionForAndroid(findTarget) {
+    var _a, _b, _c;
+    const selector = findTarget.selector;
+    if (!selector.android) {
+        return `unknown android element`;
+    }
+    const description = `"${getSimpleAndroidElementName(selector.android.class)}" element`;
+    if ((_a = selector.android) === null || _a === void 0 ? void 0 : _a.hint) {
+        return `${description} with hint "${(0, domUtil_1.normalizeText)(selector.android.hint)}"`;
+    }
+    if ((_b = selector.android) === null || _b === void 0 ? void 0 : _b.text) {
+        return `${description} with text "${(0, domUtil_1.normalizeText)(selector.android.text)}"`;
+    }
+    if ((_c = selector.android) === null || _c === void 0 ? void 0 : _c.contentDesc) {
+        return `${description} with content-desc "${(0, domUtil_1.normalizeText)(selector.android.contentDesc)}"`;
+    }
+    return description;
+}
+function buildElementDescriptionForiOS(findTarget) {
+    const selector = findTarget.selector;
+    if (!selector.iOS) {
+        return `unknown iOS element`;
+    }
+    if (selector.iOS.name) {
+        return `"${selector.iOS.name}" element`;
+    }
+    const simpleDescription = selector.iOS.type
+        ? `"${getSimpleIOSElementName(selector.iOS.type)}" element`
+        : `element`;
+    if (selector.iOS.label) {
+        return `${simpleDescription} with label "${(0, domUtil_1.normalizeText)(selector.iOS.label)}"`;
+    }
+    return simpleDescription;
+}
 function getDescriptionForWebViewFindDescriptor(webViewElementDescriptor) {
     if ((0, domUtil_1.isFindElementDescriptor)(webViewElementDescriptor.webView.descriptor)) {
         return (0, mablscriptFind_1.humanizeFindOneDescriptor)(webViewElementDescriptor.webView.descriptor.findTarget);
@@ -72,3 +97,17 @@ function isStepWithFind(value) {
     return !!(value === null || value === void 0 ? void 0 : value.find);
 }
 exports.isStepWithFind = isStepWithFind;
+function isPasswordField(descriptor) {
+    var _a, _b;
+    if ((0, domUtil_1.isMobileFindSpecification)(descriptor === null || descriptor === void 0 ? void 0 : descriptor.findTarget)) {
+        if (((_a = descriptor.findTarget.selector.android) === null || _a === void 0 ? void 0 : _a.password) === true) {
+            return true;
+        }
+        if (((_b = descriptor.findTarget.selector.iOS) === null || _b === void 0 ? void 0 : _b.type) ===
+            'XCUIElementTypeSecureTextField') {
+            return true;
+        }
+    }
+    return false;
+}
+exports.isPasswordField = isPasswordField;

package/mablscript/mobile/tests/steps/GeneralHumanization.mobiletest.js

@@ -41,7 +41,7 @@ describe('Humanization of steps work', () => {
             },
         };
         const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
-        expect(step.stepDescription()).toEqual(`Tap on element with text "Click here for more"`);
+        expect(step.stepDescription()).toEqual(`Tap on "Button" element with label "Click here for more"`);
     });
     it('Humanizes an iOS Tap step properly when only type is available', () => {
         const stepYaml = {
@@ -61,7 +61,7 @@ describe('Humanization of steps work', () => {
             },
         };
         const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
-        expect(step.stepDescription()).toEqual(`Tap on the "Button" element`);
+        expect(step.stepDescription()).toEqual(`Tap on "Button" element`);
     });
     it('Humanizes an android Tap step properly when text is available', () => {
         const stepYaml = {
@@ -82,7 +82,7 @@ describe('Humanization of steps work', () => {
             },
         };
         const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
-        expect(step.stepDescription()).toEqual(`Tap on element with text "submit form"`);
+        expect(step.stepDescription()).toEqual(`Tap on "Button" element with text "submit form"`);
     });
     it('Humanizes an android Tap step properly when only class is available', () => {
         const stepYaml = {
@@ -133,7 +133,7 @@ describe('Humanization of steps work', () => {
                     findTarget: {
                         selector: {
                             iOS: {
-                                type: 'XCUIElementTypeButton',
+                                type: 'XCUIElementTypeTextField',
                                 label: 'add name here',
                             },
                         },
@@ -142,7 +142,7 @@ describe('Humanization of steps work', () => {
             },
         };
         const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
-        expect(step.stepDescription()).toEqual(`Enter text "Bailey" in element with text "add name here"`);
+        expect(step.stepDescription()).toEqual(`Enter text "Bailey" in "TextField" element with label "add name here"`);
     });
     it('Humanizes an android Enter Text step properly using android text', () => {
         const stepYaml = {
@@ -153,7 +153,7 @@ describe('Humanization of steps work', () => {
                     findTarget: {
                         selector: {
                             android: {
-                                class: 'android.widget.Button',
+                                class: 'android.widget.EditText',
                                 text: 'submit form',
                             },
                         },
@@ -162,6 +162,143 @@ describe('Humanization of steps work', () => {
             },
         };
         const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
-        expect(step.stepDescription()).toEqual(`Enter text "Bailey" in element with text "submit form"`);
+        expect(step.stepDescription()).toEqual(`Enter text "Bailey" in "EditText" element with text "submit form"`);
+    });
+    it('humanizes an android button with contentDesc attribute', () => {
+        const stepYaml = {
+            Tap: {
+                find: {
+                    findType: domUtil_1.FindType.FIND_ONE,
+                    findTarget: {
+                        selector: {
+                            android: {
+                                displayed: true,
+                                resourceId: '',
+                                package: 'com.polar.android.debug',
+                                checkable: false,
+                                clickable: true,
+                                index: 0,
+                                focusable: true,
+                                alternateXPaths: [
+                                    '//android.widget.Button[@content-desc="MySeltzer"',
+                                ],
+                                contentDesc: 'MySeltzer',
+                                enabled: true,
+                                longClickable: false,
+                                password: false,
+                                xpath: '//hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.Button',
+                                bounds: '[42,616][465,784]',
+                                focused: false,
+                                checked: false,
+                                text: '',
+                                class: 'android.widget.Button',
+                                scrollable: false,
+                                selected: false,
+                            },
+                        },
+                    },
+                },
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
+        expect(step.stepDescription()).toEqual(`Tap on "Button" element with content-desc "MySeltzer"`);
+    });
+    it('humanizes an android text field that contains a password', () => {
+        const stepYaml = {
+            EnterText: {
+                text: 'superSecretClassified',
+                find: {
+                    findType: domUtil_1.FindType.FIND_ONE,
+                    findTarget: {
+                        selector: {
+                            android: {
+                                displayed: true,
+                                resourceId: '',
+                                package: 'com.polar.android.debug',
+                                checkable: false,
+                                clickable: true,
+                                index: 0,
+                                focusable: true,
+                                alternateXPaths: [],
+                                enabled: true,
+                                longClickable: false,
+                                password: true,
+                                xpath: '//hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.Button',
+                                bounds: '[42,616][465,784]',
+                                focused: false,
+                                checked: false,
+                                text: '',
+                                class: 'android.widget.EditText',
+                                scrollable: false,
+                                selected: false,
+                            },
+                        },
+                    },
+                },
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
+        expect(step.stepDescription()).toEqual(`Enter password in "EditText" element`);
+    });
+    it('humanizes an iOS text field that contains a password', () => {
+        const stepYaml = {
+            EnterText: {
+                text: 'iWillNeverTell',
+                find: {
+                    findType: domUtil_1.FindType.FIND_ONE,
+                    findTarget: {
+                        selector: {
+                            android: {},
+                            iOS: {
+                                type: 'XCUIElementTypeSecureTextField',
+                                name: 'Password field',
+                                label: 'Password field',
+                                enabled: true,
+                            },
+                        },
+                    },
+                },
+                type: 'tap',
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
+        expect(step.stepDescription()).toEqual(`Enter password in "Password field" element`);
+    });
+    it('humanizes an android text field that has a hint attribute', () => {
+        const stepYaml = {
+            Tap: {
+                find: {
+                    findType: domUtil_1.FindType.FIND_ONE,
+                    findTarget: {
+                        selector: {
+                            android: {
+                                displayed: true,
+                                resourceId: '',
+                                package: 'com.polar.android.debug',
+                                checkable: false,
+                                clickable: true,
+                                index: 0,
+                                focusable: true,
+                                alternateXPaths: [],
+                                enabled: true,
+                                longClickable: false,
+                                password: false,
+                                hint: 'Search for the things',
+                                xpath: '//hierarchy/android.widget.FrameLayout/android.widget.LinearLayout/android.widget.EditText',
+                                bounds: '[42,616][465,784]',
+                                focused: false,
+                                checked: false,
+                                text: '',
+                                class: 'android.widget.EditText',
+                                scrollable: false,
+                                selected: false,
+                            },
+                        },
+                    },
+                },
+            },
+        };
+        const step = (0, StepTestsUtil_1.loadRawStepIntoMablStep)(stepYaml);
+        expect(step.stepDescription()).toEqual(`Tap on "EditText" element with hint "Search for the things"`);
     });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mablhq/mabl-cli",
-  "version": "2.11.6",
+  "version": "2.12.7",
   "license": "SEE LICENSE IN LICENSE.txt",
   "description": "The official mabl command line interface tool",
   "main": "index.js",

package/resources/pdf-viewer/embeddedPdfDetection.js

@@ -117,7 +117,7 @@ mablEmbeddedPdfDetector = () => {
       const pdfUrl = pdfElement.src || pdfElement.data;
       const pdfFileName = mablGetPdfFilenameFromUrl(pdfUrl);
 
-      const embeddedPdfMablId = '__mabl_pdf_viewer_' + idSanitize(pdfFileName);
+      const embeddedPdfMablId = createEmbeddedPdfMablId(pdfFileName);
       // Mark the embedded PDF element so that we can find it to replace it later
       pdfElement.setAttribute(
         MABL_EMBEDDED_PDF_DETECTED_FLAG,
@@ -125,7 +125,7 @@ mablEmbeddedPdfDetector = () => {
       );
 
       // Signal embedded PDF detection and pending download
-      // Wait for PDF to be downloaded by PageFrameContextTracker before continuing
+      // Wait for PDF event be acknowledged by PageFrameContextTracker before continuing
       await window.dispatchMablEvent({
         type: MESSAGE_TYPE_EMBEDDED_PDF_DETECTED,
         baseUri,
@@ -133,6 +133,8 @@ mablEmbeddedPdfDetector = () => {
         pdfFileName,
       });
 
+      mablDownloadEmbeddedPdf(pdfFileName, pdfUrl);
+
       // Trigger replacement of the embedded PDF with an interactable version served by PDF server
       window.dispatchMablEvent({
         type: MESSAGE_TYPE_EMBEDDED_PDF_MARKED,
@@ -168,10 +170,6 @@ mablEmbeddedPdfDetector = () => {
     }
     return true;
   }
-
-  function idSanitize(originalId) {
-    return originalId && originalId.replace(/[^a-zA-Z0-9.-]/g, '_');
-  }
 };
 
 const CHECK_INTERVAL_IN_MILLIS = 300;
@@ -180,6 +178,14 @@ let checkTimer;
 const checkStartTime = Date.now();
 const MABL_DEFAULT_PDF_NAME = 'mablPdf';
 
+function mablPdfIdSanitize(originalId) {
+  return originalId && originalId.replace(/[^a-zA-Z0-9.-]/g, '_');
+}
+
+function createEmbeddedPdfMablId(pdfFileName) {
+  return '__mabl_pdf_viewer_' + mablPdfIdSanitize(pdfFileName);
+}
+
 function documentHasDocType() {
   return document.doctype && document.doctype.name;
 }
@@ -200,6 +206,16 @@ function mablGetPdfFilenameFromUrl(pdfUrl) {
   return pdfUrl.startsWith('blob:') ? 'blob_pdf' : pdfFileName;
 }
 
+function mablDownloadEmbeddedPdf(fileName, pdfUrl) {
+  const aTag = document.createElement('a');
+  aTag.style.display = 'none';
+  document.body.appendChild(aTag);
+  aTag.href = pdfUrl;
+  aTag.setAttribute('download', fileName);
+  aTag.click();
+  document.body.removeChild(aTag);
+}
+
 if (!documentHasDocType()) {
   // If this is executed too quickly, the DOCTYPE has not been loaded yet
   // so wait a bit before checking again.

package/util/downloadUtil.js

@@ -29,7 +29,7 @@ const fs = __importStar(require("fs"));
 const fsExtra = __importStar(require("fs-extra"));
 const util = __importStar(require("util"));
 const testsUtil_1 = require("../commands/tests/testsUtil");
-const AWAIT_DOWNLOAD_MAX_TIMEOUT_MILLIS = 30000;
+const AWAIT_DOWNLOAD_MAX_TIMEOUT_MILLIS = 60000;
 const FILE_MIN_STABLE_TIME_MILLIS = 3000;
 const AWAIT_DOWNLOAD_POLLING_INTERVAL_MILLISECONDS = 500;
 function getAwaitDownloadTimeout() {