Fixes testStartedAt issue in electron when using beforeSuite

[anirudh-modi]

Problem

I am trying to use a helper in our BeforeSuite, however, when I run the tests in UI, I am getting an error named testStartedAt. Below is the error for the same.

Some observations

• The same test is passing when i run the codecept without electron
• When I run the same test by replacing the BeforeSuite with Before it works in ui mode also

What do you get instead?

 "before all" hook: BeforeSuite for "Homepage":
     testStartedAt is required
      at RealtimeReporterHelper._mapStep (node_modules/@codeceptjs/ui/lib/codeceptjs/realtime-reporter.helper.js:209:5)
      at /Users/anirudhmodi/Documents/hackit/codecept-demo/node_modules/@codeceptjs/ui/lib/codeceptjs/realtime-reporter.helper.js:137:16

// example_test.js
Feature('Github homepage');

BeforeSuite(async ({ I }) => {

    // Will wait for 3000ms and then load
    await I.performSetup(3000);
    I.amOnPage('https://github.com/codeceptjs/ui');
});

Scenario('Homepage', ({ I }) => {
    I.grabAttributeFrom('.author');
});

// PageHelper.js

const Helper = require('@codeceptjs/helper');

class PageHelper extends Helper {
    performSetup(n) {
        return new Promise((resolve, reject) => {
            setTimeout(() => {
                resolve();
            },n);
        });
    }
}
module.exports = PageHelper;

Sample repo for the problem

The problem can be replicated by running the npm run codeceptjs:ui in this repo.
https://github.com/anirudh-modi/codecept-demo

Solution

After looking at the code I found that for the function _mapSteps, testStartedAt is a required param.

ui/lib/codeceptjs/realtime-reporter.helper.js

Line 209 in 2bddb06

assert(testStartedAt, 'testStartedAt is required');

this.testStartedAt is only initialized during _before function present in the file realtime-reporter.helper.js. Below is the code

ui/lib/codeceptjs/realtime-reporter.helper.js

Line 302 in 2bddb06

async _before(t) {

async _before(t) {
    if (!this._isEnabled(t)) return;

    t.retries(0); // disable retries in web ui
    this.test = t;
    this.testStartedAt = Date.now();
    this.step = undefined;
    this.metaStep = undefined;
    this.loggedMetaSteps = [];
    this.cachedStackFrameInTest = undefined;

    wsEvents.rtr.testBefore(mapSuiteAndTest(this.testStartedAt, this.suite, this.test));
  }

However for the _beforeSuite it is not initialized

ui/lib/codeceptjs/realtime-reporter.helper.js

Line 295 in 2bddb06

async _beforeSuite(suite) {

async _beforeSuite(suite) {  
    if (!this._isEnabled()) return;
    this.suite = suite; 

    wsEvents.rtr.suiteBefore(mapSuiteAndTest(Date.now(), this.suite, this.test));
  }

Simply, declaring this.testStartedAt in _beforeSuite was not sufficient, as, _mapSteps is dependent on the this.test.id which remains undefined as during the _beforeSuite this.test is not initialized.

ui/lib/codeceptjs/realtime-reporter.helper.js

Line 241 in 2bddb06

testId: this.test.id,

return {
      id: step.id,
      testId: this.test.id,
      at: Date.now() - testStartedAt,
      startedAt: step.startTime,
      duration: Date.now() - step.startTime,
      actor: 'I',
      humanized: step.humanize(),
      humanizedArgs: step.humanizeArgs(),
      status: step.status,
      name: step.name,
      args: mapArgs(step.args),
      store: Object.assign({}, store),
      snapshot,
      logs: step.logs || [],
      section: this._generateSection(step.metaStep),
      metaStep: this._mapMetaStep(step.metaStep),
      returnValue: step.returnValue,
      command: step.command,
      stack
    };

[anirudh-modi]

Hi, what is the procedure to get reviews on this PR and ensuring it gets merged? I have explained the problem I had faced, and also given a sample repository where the problem can be replicated.

@DavertMik @hubidu

[DavertMik]

@anirudh-modi Thanks for a very deep investigation! The PR looks good to me.

[DavertMik]

I will also make a patch release right now

[anirudh-modi]

@DavertMik Thanks alot!!! I really appreciate the merge!!
Please, let me know if anything else needs to be done from my side.. I will ensure the same..

[github-actions]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀