Cypress configuration error when adding code to before:run Node event listener

[trav-giv]

I am trying to set up the Cypress before:run listener to run some code to setup the test environment before any test in the suite is run, as well as set some environment variables to be used throughout testing. In order to retrieve an authToken to hit our system APIs, I have a function that programmatically retrieves a token through our Cognito service. When I import that function (from a .js file) into my cypress.config.ts and call that imported function in the on('before:run) listener, I get this TypeError:

My cypress.config.ts file:

import { defineConfig } from 'cypress';
import { secrets } from './cypress/support/secrets';
import { Get_Token } from './cypress/support/api_utils/aws_integration';
import fetch from 'node-fetch';

export default defineConfig({
  projectId: secrets.cypress.projectId,
  e2e: {
    setupNodeEvents(on, config) {
      // implement node event listeners here
      on('before:run', async () => {
        try {
          let authToken = await Get_Token('admin');

          const resetResponse = await fetch('https://api.giv.care/s1/system-test-environment-reset', {
            method: 'POST',
            body: JSON.stringify({
              agency_id: secrets.cypress.agency_id,
              admin_cognito: secrets.cypress.admin_cognito,
              caregiver_cognito: secrets.cypress.caregiver_cognito,
            }),
            headers: {
              'Authorization': authToken,
              'Accept': 'application/json, text/plain, */*',
              'Content-Type': 'application/json',
            },
          });

          if (!resetResponse.ok && resetResponse.status !== 403) {
            throw new Error(`Response status: ${resetResponse.status}`);
          }
        } catch (error) {
          console.error(error.message);
        }
      });
    },
    baseUrl: 'http://localhost:4200',
    defaultCommandTimeout: 25000,
    requestTimeout: 10000,
    responseTimeout: 45000,
    scrollBehavior: 'center',
    testIsolation: false,
    specPattern: [
      'cypress/e2e/smoke/_login.cy.ts',
      'cypress/e2e/smoke/shifts/*.cy.ts',
      'cypress/e2e/smoke/**/*.cy.ts',
    ],
    experimentalInteractiveRunEvents: true,
  },
  env: {
    agency_id: secrets.cypress.agency_id,
    admin_phone: secrets.cypress.admin_phone,
    caregiver_phone: secrets.cypress.caregiver_phone,
    password: secrets.cypress.password,
    admin_cognito: secrets.cypress.admin_cognito,
    caregiver_cognito: secrets.cypress.caregiver_cognito,
  },
  retries: {
    experimentalStrategy: 'detect-flake-and-pass-on-threshold',
    experimentalOptions: {
      maxRetries: 2,
      passesRequired: 1,
    },
    openMode: false,
    runMode: true,
  },
});

And please let me know if there is anything else you need to see from my code in diagnosing this issue.

[trav-giv]

I return with a solution, sort of. It turns out I was trying to do the right thing in the wrong place.

My original intention was to set up a script that resets the environment and seeds the database each time Cyprress is launched, either with npx cypress open or npx cypess run or when being un in our GitHub Actions pipeline. As pat of the setup, I needed to pass some id values to my test run from objects created during seeding. I thought the place to do this was within the on('before:run') hook.

✅ Instead I ran the script a level higher in the setupNodeEvents(on, config) block. The API calls are made to reset the test environment and seed the database, then set environment variables with the returned id values, and finally return config to pass the resolved config object to my test run!