New race condition: url changes, but page is not a new page

[plocket]

Currently we're checking for the url to change. Why is that? Because we had an issue where puppeteer thought the next 'page' had loaded, but it was still the same page. (This begs the question of whether we should even use .waitForNavigation(), but maybe that's a different issue.)

Now we're running across the url changing while the same page is loaded (or reloaded?) before it moves on to the next page. We need something unique to detect a true change in a page.

Current suggestion is the sought var in the _events hidden input field value. That should be unique, though we cannot be sure of that.

Note: We do not have a clear way to reproduce this bug, but it did happen consistently [ in DBD2 ].

Note: We thought of using this to detect an infinite screen (a da-specific bug) - when the sought var doesn't change, but the url changes, it may be an 'infinite screen'. That won't work exactly because of the case we just ran into. Maybe detecting multiple consecutive page changes with the same sought var would be sufficient.

[plocket]

Another option is to change scope.afterStep() to use a while. This is what the whole function would look like with this:

  afterStep: async function afterStep(scope, options = {waitForShowIf: false, navigated: false, waitForTimeout: 0}) {
    /* Common things to do after a step, including take care of errors.
    *    TODO: discuss splitting into `afterField` and `afterStep` or something. Or just change name
    *    TODO: Update to latest cucumberjs, which as `AfterStep` */

    // Use a while loop until the below does not error with `Error: Execution context was destroyed`
    let error_id_elem;
    while ( true ) {
      try {
        error_id_elem = await scope.page.$('#da-retry');
        break;
      } catch ( err ) {}
    }

    // If there's an error, throw it
    if ( error_id_elem ) {
      let error_elem = await scope.page.$('blockquote')
      let error_handle = await error_elem.getProperty( 'textContent' );
      let error_text = await error_handle.jsonValue();

      throw error_text;
    }

    // RESET
    if ( options.navigated ) { scope.navigated = true; }
    else { scope.navigated = false; }

    // WAITING
    if ( options.waitForShowIf ) { await scope.waitForShowIf(scope); }
    // Plain old waiting. Yeah, I abstracted it into here so only
    // one thing was being called at the end
    if ( options.waitForTimeout ) { await scope.page.waitFor( options.waitForTimeout ); }
  },  // Ends afterStep

This might be an ok temporary measure.