strapi/tests/e2e/utils/restart.ts

import execa from 'execa';

import type { Page } from '@playwright/test';

// Function to check modal visibility
const isModalVisible = async (page: Page) => {
  return page.isVisible('text="Waiting for restart..."');
};

/**
 * Wait for a restart modal to appear, but instead of failing if it doesn't, attempt to
 * refresh the page and see if it comes back up
 */
export const waitForRestart = async (page, timeout = 60000) => {
  const initialWaitForModal = 5000; // Time to wait for the modal to initially appear
  let elapsedTime = 0;
  const checkInterval = 1000; // Check every 1 second
  const reloadTimeout = 15000; // 15 seconds before trying to reload

  // Initially wait for the modal to become visible
  try {
    await page.waitForSelector('text="Waiting for restart..."', {
      state: 'visible',
      timeout: initialWaitForModal,
    });
  } catch (error) {
    console.log('The modal did not become visible within the initial wait period.');
    throw error; // Or handle this scenario as appropriate
  }

  // Now wait until the modal is not visible or until the reloadTimeout
  let modalVisible = await isModalVisible(page);
  while (modalVisible && elapsedTime < reloadTimeout) {
    await new Promise((r) => setTimeout(r, checkInterval));
    elapsedTime += checkInterval;
    modalVisible = await isModalVisible(page);
  }

  // If modal is still visible after reloadTimeout, reload the page and wait again
  if (modalVisible) {
    console.log("Restart overlay didn't disappear after 15 seconds. Reloading page...");
    await page.reload({ waitUntil: 'domcontentloaded' });
    // Optionally, wait again for the modal to disappear after reloading
  }

  // Final check to ensure the modal has disappeared
  if (await isModalVisible(page)) {
    throw new Error('Restart overlay did not disappear after waiting and reloading.');
  }

  console.log('Restart overlay has disappeared, proceeding with the test.');
};

// TODO: Find a better way to restart a Strapi test app (signal, etc...)
export const restart = async () => {
  if (!process.env.TEST_APP_PATH) {
    console.warn('Could not restart the application because TEST_APP_PATH not set');
    return;
  }

  const filepath = 'src/force-restart-from-playwright-instance.js';

  console.log('Forcing a restart...');

  await execa('touch', [filepath], {
    stdio: 'inherit',
    cwd: process.env.TEST_APP_PATH,
  });

  await delay(1);

  await execa('rm', [filepath], {
    stdio: 'inherit',
    cwd: process.env.TEST_APP_PATH,
  });

  // TODO:  This is both a waste of time and flaky.
  //        We need to find a way to access playwright server output and watch for the "up" log to appear
  await pollHealthCheck();
};

export const delay = (seconds: number) => {
  return new Promise((resolve) => setTimeout(resolve, seconds * 1000));
};

export const pollHealthCheck = async (interval = 1000, timeout = 30000) => {
  const url = `http://127.0.0.1:${process.env.PORT ?? 1337}/_health`;
  console.log(`Starting to poll: ${url}`);

  let elapsed = 0;

  while (elapsed < timeout) {
    try {
      const response = await fetch(url, { method: 'HEAD' });
      if (response.ok) {
        console.log('The service is up and running!');
        return; // Exit if the service is up
      }
      // If the response is not okay, throw an error to catch it below
      throw new Error('Service not ready');
    } catch (error) {
      console.log('Waiting for the service to come up...');
      // Wait for the specified interval before trying again
      await new Promise((resolve) => setTimeout(resolve, interval));
      elapsed += interval; // Update the elapsed time
    }
  }

  // On timeout
  console.error('Timeout reached, service did not become available in time.');
};