@suffolklitlab/alkiln 5.9.0-feat-url4 → 5.9.0-feat-url7

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

package/CHANGELOG.md

@@ -48,7 +48,15 @@ Format:
 ### Added
 
 - New Step: 'I go to ""' to go to any arbitrary url, not just arbitrary interview urls.
-- New navigation report messages
+- New navigation report messages.
+- Avoid waiting for "success" on sign in. Not everyone has it.
+- Allow non-local environments to get debug logs.
+
+### 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 values don't cause errors
 
 ## [5.9.0] - 2024-02-11
 

package/lib/cucumber_8_shim.js

@@ -1,4 +1,4 @@
-// TODO: Add the error message to the report. Would have to pass in `scope`.
+// 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

@@ -991,6 +991,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
@@ -1001,7 +1002,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 });
@@ -1254,7 +1256,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;
@@ -1499,7 +1504,6 @@ module.exports = {
 
     let handle = await scope.get_handle_from_field( scope, { field: field });
     // TODO: expect elem to exist
-    expect(handle).to.exist;  // I don't think this is sufficient. Maybe in function called above instead
 
     // 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
@@ -1508,18 +1512,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;
-      // } else {
-      //   return false;
-      // }
-
       if ( elem && !elem.disabled ) {
         elem.scrollIntoView(false);
+        return elem.disabled;
+      } else {
+        return false;
       }
-      return elem.disabled;
     });
 
     // If field is disabled, don't set it yet
@@ -2860,11 +2858,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

@@ -177,9 +177,8 @@ Given(/I start the interview at "([^"]+)"/, {timeout: -1}, async (file_name) =>
   // Load the right interview page
   await scope.load( scope, file_name );
   
-  // TODO: Move this above loading? Put it in `Before()` instead?
   // 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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suffolklitlab/alkiln",
-  "version": "5.9.0-feat-url4",
+  "version": "5.9.0-feat-url7",
   "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,14 @@ 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 });
+  console.log(`=================\n${ JSON.stringify(fields.ajax, null, 2) }`);
+  console.log(`-----------------\n${ JSON.stringify(result, null, 2) }`);
+  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;