@suffolklitlab/alkiln 5.9.0 → 5.10.0-fix-typing1

package/.github/workflows/github_server.yml

@@ -91,5 +91,5 @@ jobs:
           #### to debug the docker install step
           #### Use a "tag expression" to specify which tagged tests to run (https://cucumber.io/docs/cucumber/api/#tag-expressions)
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
-          # ALKILN_VERSION: 2column
+          ALKILN_VERSION: url
 

package/.github/workflows/playground.yml

@@ -44,6 +44,11 @@ jobs:
       # relative paths to action files
       - uses: actions/checkout@v3
 
+      - name: Pause between triggers
+        if: (github.event_name == 'pull_request' && ! github.event.pull_request.head.repo.fork)
+        shell: bash
+        run: sleep 30
+
       #### Developer note: you'll need to replace `.` with the path to
       #### the repo and branch and leave off the trailing `/`
       #### For example suffolkLITLab/ALKiln@v5
@@ -55,4 +60,4 @@ jobs:
           #### to debug the docker install step
           # ALKILN_TAG_EXPRESSION: @a_tag_expression
           #### Developer note: you probalby don't need this
-          # ALKILN_VERSION: 2column
+          ALKILN_VERSION: url

package/CHANGELOG.md

@@ -43,7 +43,30 @@ Format:
 - 
 -->
 
-<!-- ## [Unreleased] -->
+## [Unreleased]
+
+### Fixed
+
+- Fixes the issue that typing is too fast for some fields, like Ajax comboboxes. See [#857](https://github.com/SuffolkLITLab/ALKiln/issues/857).
+
+## [5.10.0] - 2024-02-22
+
+### Added
+
+- New Step: 'I go to ""' to go to any arbitrary url, not just arbitrary interview urls.
+- New navigation report messages.
+- Allow non-local environments to get debug logs. For example, the GitHub console during a workflow run.
+
+### Changed
+
+- Avoid waiting for "success" on sign in. Not everyone has it.
+- Detect signature page variable names with the trigger variable name as a fallback to the `_save_as` input. If a server's config has its `restrict input variables` value set to `True`, the #trigger value is the only way for ALKiln to know which variable the signature is setting. Add an error to the report if ALKiln is unable to find either of those.
+
+### Internal
+
+- Handle non-existence of `elem` more robustly when checking for `elem.disabled`
+- Add a pause between pull request tests and push tests when the PR is coming from our own repo
+- Make getting page field values more robust by doing more to ensure that undefined option `value`s don't cause errors. For example, ajax combobox `select` options don't always have `value`s
 
 ## [5.9.0] - 2024-02-11
 

package/lib/cucumber_8_shim.js

@@ -1,3 +1,4 @@
+// TODO: Add the error message to the report. Would have add a `scope` parameter
 module.exports = async function wrapPromiseWithTimeout (
   promise,
   timeoutInMilliseconds,

package/lib/scope.js

@@ -626,7 +626,7 @@ module.exports = {
 
     reports.addToReport(scope,{
       type: `row`,
-      value: `Trying to load the interview at "${interview_url}"`
+      value: `Trying to load the interview at "${ interview_url }"`
     });
 
     if ( !scope.page ) { scope.page = await scope.browser.newPage(); }
@@ -641,8 +641,9 @@ module.exports = {
       // If the page didn't load because it took to long to load
       if ( error.name === `TimeoutError` ) {
 
-        let non_reload_report_msg = `Timeout error occurred when ALKiln tried to go to the interview url`;
+        let non_reload_report_msg = `Timeout error occurred when ALKiln tried to go to the interview at ${ interview_url }`;
         await scope.handle_page_timeout_error( scope, { non_reload_report_msg, error });
+        // TODO: Should this throw to avoid multiple error messages?
 
       // If the page didn't load because of any other reason
       } else {
@@ -650,7 +651,7 @@ module.exports = {
         // Throw any non-timeout error
         reports.addToReport( scope, {
           type: `error`,
-          value: `Error occurred when ALKiln tried to go to the interview url`
+          value: `Error occurred when ALKiln tried to go to the interview at ${ interview_url }`
         });
         throw( error );
       }  // ends if error is timeout error
@@ -658,10 +659,12 @@ module.exports = {
     }  // ends try/catch
 
     let load_result = await scope.getLoadData( scope );
-    // Errors, or reaching timeout, causes an exception and is shown to the developer at the end
+    // da page invalidation errors or timeout will show an error to the developer at the end
     if ( load_result.error ) {
-      reports.addToReport(scope, { type: `error`, value: `On final attempt to load interview, got "${ load_result.error }"` });
+      reports.addToReport(scope, { type: `error`, value: `On final attempt to load interview at "${ interview_url }", got "${ load_result.error }"` });
       expect( load_result.error ).to.equal( '' );
+    } else {
+      reports.addToReport(scope, { type: `info`, value: `Successfully found the interview at "${ interview_url }"` });
     }
 
     return scope.page;
@@ -693,6 +696,11 @@ module.exports = {
 
       // or if they cause some other kind of error
       } else {
+        reports.addToReport(scope, {
+          type: `error`,
+          value: `ALKiln got an error when it tried to load the interview page`,
+          data: error
+        });
         throw error;
       }  // ends if error.name.includes(`TimeoutError`)
     });  // ends Promise.race()
@@ -869,7 +877,29 @@ module.exports = {
       if ( $(`#dasigpage`).length > 0 && $(`#dasigpage`)[0].name ) {
         field_data.selector = `#daquestion canvas`;
         field_data.tag = `canvas`;
-        not_decoded_name = $( `input[name="_save_as"]` ).attr( `value` );
+
+        // If da server's config value of `restrict input variables`
+        // set to True, `_save_as` should work to get the var name
+        if ( $( `input[name="_save_as"]` ).length > 0 ) {
+          not_decoded_name = $( `input[name="_save_as"]` ).attr( `value` );
+
+        // If not, the author will have to use the trigger var HTML element
+        // or we can't get the var name being set for the signature
+        } else if ( trigger !== `` ) {
+          not_decoded_name = trigger;
+
+        // If we have neither of those, we need to tell the user we can't
+        // set this variable this way. We can't test this without a
+        // server that has that special config value set to `True`
+        } else {
+          reports.addToReport(scope, {
+            type: `error`,
+            value: `You cannot sign a signature page this way because the `
+              + `interview's HTML is missing data. Use the "I sign" Step `
+              + `instead. You can also read documentation about `
+              + `how to create the "trigger" HTML.`
+          });
+        }
       }
       
       // The selector we'll use to set the DOM node's value later
@@ -983,6 +1013,7 @@ module.exports = {
     /* Return variable names and values combined in ways that can
     * try to match table rows. Tables can have two properties:
     * variable name and value. */
+    if ( session_vars.get_debug() ) { console.log(`scope.getPossibleTableRowMatchers() var_names:`, var_names, `values:`, values); }
     let possible_table_rows = [];
     for ( let var_name of var_names ) {
       // Inputs like textareas don't have values
@@ -993,7 +1024,8 @@ module.exports = {
           // Modified from https://stackoverflow.com/a/8571649/11416267
           // DA doesn't use `==` to pad base 64
           // TODO: How are 'None', 'True', and 'False' being handled?
-          if (value !== 'None' && value !== 'True' && value !== 'False'
+          if (value !== undefined && value !== null
+              && value !== 'None' && value !== 'True' && value !== 'False'
               && value.match(da_base64_regex)) {
             let value_decoded = fromBase64(value);
             let values_decoded = scope.decodeFully( scope, { expr_str: value_decoded });
@@ -1246,7 +1278,10 @@ module.exports = {
     let options = [];
     let option_nodes = $select.find( `option` );
     for ( let opt of option_nodes ) {
-      options.push( opt.attribs.value );
+      // Some options don't have a value, like for ajax comboboxes
+      if ( opt.attribs.value !== undefined ) {
+        options.push( opt.attribs.value );
+      }
       // Dropdowns created w/ objects are base64 encoded; but it's handled in getPossibleTableRowMatchers
     }
     return options;
@@ -1490,6 +1525,7 @@ module.exports = {
     }
 
     let handle = await scope.get_handle_from_field( scope, { field: field });
+    // TODO: expect elem to exist
 
     // After each previous input, figure out if this input is (now/still) disabled
     // TODO: Consider testing for disabled this before we get the matching row
@@ -1498,8 +1534,12 @@ module.exports = {
       // sometimes it blocks nodes from clicks. Scroll item to the bottom instead.
       // Note: I'm not sure how we'd get in here if `elem` didn't exist, but
       // I once got an error here that I couldn't read `.disabled` of `null`.
-      if ( elem && !elem.disabled ) { elem.scrollIntoView(false); }
-      return elem.disabled;
+      if ( elem && !elem.disabled ) {
+        elem.scrollIntoView(false);
+        return elem.disabled;
+      } else {
+        return false;
+      }
     });
 
     // If field is disabled, don't set it yet
@@ -1531,7 +1571,9 @@ module.exports = {
 
   get_handle_from_field: async function ( scope, { field }) {
     /** Get the element's puppeteer handle using the field's selector. */
-
+    if ( session_vars.get_debug() ) {
+      console.log(`scope.get_handle_from_field() field.selector:`, field.selector );
+    }
     let handle = await scope.page.evaluateHandle(( selector ) => {
       let elem = document.querySelector( selector );
       // If the element has a sibling that's a label, we need to
@@ -1758,7 +1800,9 @@ module.exports = {
         // Authors should enter the time like 12:34 PM, but we shouldn't type ":", space, or M.
         let answer_time = answer.replace(":", "").replace(" ", "").replace("M", "");
         await handle.focus();
-        await handle.type( answer );
+        let delay = 0;
+        if ( session_vars.get_debug() ) { delay = 25; }
+        await handle.type( answer, { delay });
         await handle.press(`Enter`);
         await scope.afterStep(scope, { waitForShowIf: true });
       } else {
@@ -1932,9 +1976,16 @@ module.exports = {
 
   setText: async function ( scope, { handle, answer }) {
     // Set text in some kind of field (input text, input date, textarea, etc.)
-    await handle.evaluate( el => { el.value = '' });
+    // First set the value to part of the string
+    const to_set = answer.slice(0, -3);
+    const to_type = answer.slice(-3);
+    await handle.evaluate(( elem, text ) => {
+      elem.value = text;
+    }, to_set );
+    // Then type the last three characters of the string with a
+    // good pause to let the field register the interaction
     await handle.focus();
-    await handle.type( answer );
+    await handle.type( to_type, { delay: 100 });
   },
 
   draw_signature: async function ( scope, name ) {
@@ -2060,6 +2111,8 @@ module.exports = {
       }  // ends for every non-submit-button field on the page
     }  // ends while fields are still being set
 
+    if ( session_vars.get_debug() ) { await scope.page.waitForTimeout(2000); }
+
     // Press a continue button with a story table variable name if it exists
     let did_navigate = false;
     let error = {};
@@ -2838,11 +2891,6 @@ module.exports = {
       let elem = await scope.page.$( `button[name="submit"]` );
       await scope.tapElementAndNavigate( scope, { elem });
 
-      // Wait to see the success message.
-      // This is a bit of an assumption and needs success and failure testing
-      // TODO: use a Promise.race to fail faster.
-      await scope.page.waitForSelector( `.datopcenter .alert-success` );
-
       reports.addToReport( scope, {
         type: `row`,
         value: `Signed into ${ session_vars.get_da_server_url() }/user/sign-in successfully.`

package/lib/steps.js

@@ -114,7 +114,7 @@ Before(async (scenario) => {
 
   // Create browser, which can't be created in BeforeAll() where .driver doesn't exist for some reason
   if (!scope.browser) {
-    if (session_vars.get_origin() === 'playground') {
+    if ( session_vars.get_origin() !== `local` ) {
       // Will only run in the Playground outside of a sandbox. TODO: There's a
       // better way to do this, though it's more complicated. See comments in
       // https://github.com/SuffolkLITLab/ALKiln/issues/661
@@ -178,11 +178,12 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   await scope.load( scope, file_name );
   
   // The page timeout is set in here too in case someone set a custom timeout
-  // before a page was loaded.
+  // just before a page was loaded for the Scenario. Move this to just after page creation?
   // The function itself won't really timeout here, so we don't need to wrap it in
   // a custom timeout
   await scope.page.setDefaultTimeout( scope.timeout );  // overrides outer default timeout
 
+  // TODO: Move this to the `download` Step and only do it once per scenario
   // Allow developer to save download files
   let custom_download_behavior_timeout = new Promise(async ( resolve, reject ) => {
     let page_timeout = setTimeout(function() {reject( `Took too long to set download behavior.` ); }, scope.timeout);
@@ -236,6 +237,8 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
     }  // ends if this is the file the developer expected
   });  // ends page.on 'response'
 
+  // TODO: Wrap everything in this step in this timeout? Or is this Step's timeout different?
+  // Wait for navigation
   let custom_afterStep_timeout = new Promise(async ( resolve, reject ) => {
     let page_timeout = setTimeout(function() { reject(`\`afterStep()\` took too long.`); }, scope.timeout);
     // self-invoke an anonymous async function so we don't have to
@@ -251,6 +254,22 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   await custom_afterStep_timeout;
 });
 
+Given(/I go to "([^"]+)"/i, {timeout: -1}, async ( url ) => {
+  /** Navigate to an arbitrary url. What you do after that depends on you. There's
+   *    a limited amount ALKiln can do on a non-docassemble page or a very customized
+   *    docassemble page.
+   *
+   * @params {string} A valid url */
+  let result = await wrapPromiseWithTimeout(
+    scope.page.goto( url, { waitUntil: 'domcontentloaded', timeout: scope.timeout }),
+    scope.timeout,
+    `It took to long to get to "${ url }"`
+  );
+
+  reports.addToReport(scope, { type: `info`, value: `Successfully went to "${ url }"` });
+  return result;
+});
+
 Given(/I (?:sign|log) ?(?:in)?(?:on)?(?:to the server)? with(?: the email)? "([^"]+)" and(?: the password)? "([^"]+)"(?: SECRETs)?/i, {timeout: -1}, async ( email, password ) => {
   /** Uses the names of environment variables (most often GitHub SECRETs) to
   *     log into an account on the user's server. Must be SECRETs to stay secure.

package/lib/utils/session_vars.js

@@ -294,7 +294,7 @@ session_vars.set_sources_paths = function ( paths ) {
   }
 
   console.info(
-    `ALKiln info: Did find "sources" folder(s) at "${ existing_paths.join('", "') }".`
+    `ALKiln SUCCESS: Did find "sources" file(s) at "${ existing_paths.join('", "') }".`
   )
 
   // Otherwise, store valid paths

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.9.0",
+  "version": "5.10.0fix-typing1",
   "description": "Integrated automated end-to-end testing with docassemble, puppeteer, and cucumber.",
   "main": "lib/index.js",
   "scripts": {

package/tests/unit_tests/fields.fixtures.js

@@ -1108,6 +1108,76 @@ fields.object_multiselect = [
   }, 
 ];
 
+// ============================
+// Ajax combobox
+// ============================
+fields.ajax = [
+  {
+    "selector": "#daquestion input[name=\"ZmF2b3JpdGVfd29yZA\"]",
+    "tag": "input",
+    "guesses": [
+      {
+        "var": "ZmF2b3JpdGVfd29yZA",
+        "value": ""
+      },
+      {
+        "var": "favorite_word",
+        "value": ""
+      }
+    ],
+    "type": "hidden",
+    "trigger": ""
+  },
+  {
+    "selector": "#daquestion input[id=\"ZmF2b3JpdGVfd29yZA\"][class=\"form-control da-ajax-combobox\"]",
+    "tag": "input",
+    "guesses": [
+      {
+        "var": "ZmF2b3JpdGVfd29yZA",
+        "value": ""
+      },
+      {
+        "var": "favorite_word",
+        "value": ""
+      }
+    ],
+    "type": "text",
+    "trigger": ""
+  },
+  {
+    "selector": "#daquestion select[id=\"ZmF2b3JpdGVfd29yZAcombobox\"][class=\"form-control da-ajax-combobox\"]",
+    "tag": "select",
+    "guesses": [
+      {
+        "var": "ZmF2b3JpdGVfd29yZAcombobox",
+        "value": ""
+      },
+      {
+        "var": "favorite_word\u0007(��\u001b�",
+        "value": ""
+      }
+    ],
+    "type": "",
+    "trigger": ""
+  },
+  {
+    "selector": "#daquestion button[id=\"da-continue-button\"][class=\"btn btn-da btn-primary\"]",
+    "tag": "button",
+    "guesses": [
+      {
+        "var": "da-continue-button",
+        "value": ""
+      },
+      {
+        "var": "u���{b��n�m�",
+        "value": ""
+      }
+    ],
+    "type": "submit",
+    "trigger": ""
+  }
+];
+
 
 // ============================
 // mixed quotes

package/tests/unit_tests/getAllFields.test.js

@@ -33,8 +33,8 @@ chai.config.truncateThreshold = 0
 it(`creates the right data for standard fields`, async function() {
   // 18 fields (03/15/21)
   let result = await getAllFields( scope, { html: html.standard });
-//   console.log(`=================\n${ JSON.stringify(fields.standard, null, 2) }`);
-//   console.log(`-----------------\n${ JSON.stringify(result, null, 2) }`);
+  // console.log(`=================\n${ JSON.stringify(fields.standard, null, 2) }`);
+  // console.log(`-----------------\n${ JSON.stringify(result, null, 2) }`);
   expect( result ).to.deep.equalInAnyOrder( fields.standard );
 });
 
@@ -148,6 +148,12 @@ it(`creates the right data for a dropdown created with an object`, async functio
   expect( result ).to.deep.equalInAnyOrder(fields.object_dropdown );
 });
 
+// Ajax
+it('creates the right data for an `ajax` combobox', async function() {
+  let result = await getAllFields( scope, { html: html.ajax });
+  expect( result ).to.deep.equalInAnyOrder(fields.ajax );
+});
+
 // ============================
 // DOM for mixed quotes test in getMatchingRows.test.js
 // ============================

package/tests/unit_tests/html.fixtures.js

@@ -789,6 +789,62 @@ html.object_dropdown = `
     </form>
 </div>`;
 
+html.ajax = `
+<div id="daquestion" aria-labelledby="dapagetitle" role="main" class="tab-pane fade show active offset-lg-3 col-lg-6 offset-md-2 col-md-8">
+  <form aria-labelledby="daMainQuestion" action="/interview?i=docassemble.base:data/questions/examples/fields-ajax.yml" id="daform" class="form-horizontal daformfields" method="POST" novalidate="novalidate">
+    <div class="da-page-header">
+      <h1 class="h3" id="daMainQuestion">What is your favorite word?</h1>
+      <div class="daclear"></div>
+    </div>
+    <div
+      class="da-container da-form-group row darequired da-field-container da-field-container-datatype-text da-field-container-inputtype-ajax">
+      <label for="ZmF2b3JpdGVfd29yZA" class="col-md-4 col-form-label da-form-label datext-right" >Word</label>
+      <div class="col-md-8 dafieldpart">
+        <div class="combobox-container">
+          <input type="hidden" name="ZmF2b3JpdGVfd29yZA" value="" />
+          <div class="input-group">
+            <input type="text" role="combobox" aria-autocomplete="list" aria-expanded="false" aria-activedescendant="" autocomplete="off" id="ZmF2b3JpdGVfd29yZA" aria-controls="ZmF2b3JpdGVfd29yZAmenu" aria-owns="ZmF2b3JpdGVfd29yZAmenu" placeholder="" required="required" class="form-control da-ajax-combobox"/>
+            <ul role="listbox" class="typeahead typeahead-long dropdown-menu" id="ZmF2b3JpdGVfd29yZAmenu"></ul>
+            <div class="input-group-append">
+              <button class="btn btn-outline-secondary dacomboboxtoggle" type="button" tabindex="-1" aria-label="Dropdown" aria-expanded="false" aria-controls="ZmF2b3JpdGVfd29yZAmenu">
+                <svg class="svg-inline--fa fa-caret-down"></svg
+                ><!-- <span class="fas fa-xmark"></span> Font Awesome fontawesome.com -->
+              </button>
+            </div>
+          </div>
+        </div>
+        <select data-action="wordlist" data-trig="4" alt="Input box" class="form-control da-ajax-combobox" id="ZmF2b3JpdGVfd29yZAcombobox" required="" style="display: none;">
+          <option selected="selected"></option>
+        </select>
+      </div>
+    </div>
+    <fieldset class="da-button-set da-field-buttons">
+      <legend class="visually-hidden">
+        Press one of the following buttons:
+      </legend>
+      <button class="btn btn-da btn-primary" id="da-continue-button" type="submit">
+        Continue
+      </button>
+    </fieldset>
+    <input
+      type="hidden"
+      name="csrf_token"
+      value="ImI4NDAyMmI3Mjc4NGY3MDlkMTRiNGE5OTQzZDhmZTVhYWY5NzQwNzUi.ZdVoHQ.GLQUgOWjNag9f7jGSiO9ZvHDoEc"
+    />
+    <input type="hidden" name="_question_name" value="Question_0" />
+    <input type="hidden" name="_tracker" value="2" />
+    <input type="hidden" name="_visible" value="" />
+    <input
+      type="hidden"
+      name="_varnames"
+      value="eyJYMlpwWld4a1h6QSI6ICJabUYyYjNKcGRHVmZkMjl5WkEifQ"
+    />
+  </form>
+</div>`;
+
+// ============================
+// quotes
+// ============================
 html.mixed_quotes = `
 <div id="daquestion" aria-labelledby="dapagetitle" role="main" class="tab-pane fade show active offset-xl-3 offset-lg-3 col-xl-6 col-lg-6 offset-md-2 col-md-8">
     <div data-variable="ZG91YmxlX3F1b3RlX2RpY3RbJ2RvdWJsZV9xdW90ZV9rZXknXQ" id="trigger" aria-hidden="true" style="display: none;"></div>
@@ -892,5 +948,4 @@ html.mixed_quotes = `
     </form>
 </div>`;
 
-
 module.exports = html;