mirror of
https://github.com/jquery/jquery.git
synced 2024-12-25 13:14:21 +00:00
dfc693ea25
This is a complete rework of our testing infrastructure. The main goal is to modernize and drop deprecated or undermaintained dependencies (specifically, grunt, karma, and testswarm). We've achieved that by limiting our dependency list to ones that are unlikely to drop support any time soon. The new dependency list includes: - `qunit` (our trusty unit testing library) - `selenium-webdriver` (for spinning up local browsers) - `express` (for starting a test server and adding middleware) - express middleware includes uses of `body-parser` and `raw-body` - `yargs` (for constructing a CLI with pretty help text) - BrowserStack (for running each of our QUnit modules separately in all of our supported browsers) - `browserstack-local` (for opening a local tunnel. This is the same package still currently used in the new Browserstack SDK) - We are not using any other BrowserStack library. The newest BrowserStack SDK does not fit our needs (and isn't open source). Existing libraries, such as `node-browserstack` or `browserstack-runner`, either do not quite fit our needs, are under-maintained and out-of-date, or are not robust enough to meet all of our requirements. We instead call the [BrowserStack REST API](https://github.com/browserstack/api) directly. ## BrowserStack Runner - automatically retries individual modules in case of test failure(s) - automatically attempts to re-establish broken tunnels - automatically refreshes the page in case a test run has stalled - runs all browsers concurrently and uses as many sessions as are available under the BrowserStack plan. It will wait for available sessions if there are none. - supports filtering the available list of browsers by browser name, browser version, device, OS, and OS version (see `npm run test:unit -- --list-browsers` for more info). It will retrieve the latest matching browser available if any of those parameters are not specified. - cleans up after itself (closes the local tunnel, stops the test server, etc.) - Requires `BROWSERSTACK_USERNAME` and `BROWSERSTACK_ACCESS_KEY` environment variables. ## Selenium Runner - supports running any local browser as long as the driver is installed, including support for headless mode in Chrome, FF, and Edge - supports running `basic` tests on the latest [jsdom](https://github.com/jsdom/jsdom#readme), which can be seen in action in this PR (see `test:browserless`) - Node tests will run as before in PRs and all non-dependabot branches, but now includes tests on real Safari in a GH actions macos image instead of playwright-webkit. - can run multiple browsers and multiple modules concurrently Other notes: - Stale dependencies have been removed and all remaining dependencies have been upgraded with a few exceptions: - `sinon`: stopped supporting IE in version 10. But, `sinon` has been updated to 9.x. - `husky`: latest does not support Node 10 and runs on `npm install`. Needed for now until git builds are migrated to GitHub Actions. - `rollup`: latest does not support Node 10. Needed for now until git builds are migrated to GitHub Actions. - BrowserStack tests are set to run on each `main` branch commit - `debug` mode leaves Selenium browsers open whether they pass or fail and leaves browsers with test failures open on BrowserStack. The latter is to avoid leaving open too many sessions. - This PR includes a workflow to dispatch BrowserStack runs on-demand - The Node version used for most workflow tests has been upgraded to 20.x - updated supportjQuery to 3.7.1 Run `npm run test:unit -- --help` for CLI documentation Close gh-5418
277 lines
6.3 KiB
JavaScript
277 lines
6.3 KiB
JavaScript
import chalk from "chalk";
|
|
import { getBrowserString } from "../lib/getBrowserString.js";
|
|
import { changeUrl, createWorker, deleteWorker, getWorker } from "./api.js";
|
|
|
|
const workers = Object.create( null );
|
|
|
|
// Acknowledge the worker within the time limit.
|
|
// BrowserStack can take much longer spinning up
|
|
// some browsers, such as iOS 15 Safari.
|
|
const ACKNOWLEDGE_WORKER_TIMEOUT = 60 * 1000 * 8;
|
|
const ACKNOWLEDGE_WORKER_INTERVAL = 1000;
|
|
|
|
// No report after the time limit
|
|
// should refresh the worker
|
|
const RUN_WORKER_TIMEOUT = 60 * 1000 * 2;
|
|
const MAX_WORKER_RESTARTS = 5;
|
|
const MAX_WORKER_REFRESHES = 1;
|
|
const POLL_WORKER_TIMEOUT = 1000;
|
|
|
|
export async function cleanupWorker( reportId, verbose ) {
|
|
const worker = workers[ reportId ];
|
|
if ( worker ) {
|
|
try {
|
|
delete workers[ reportId ];
|
|
await deleteWorker( worker.id, verbose );
|
|
} catch ( error ) {
|
|
console.error( error );
|
|
}
|
|
}
|
|
}
|
|
|
|
export function debugWorker( reportId ) {
|
|
const worker = workers[ reportId ];
|
|
if ( worker ) {
|
|
worker.debug = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Set the last time a request was
|
|
* received related to the worker.
|
|
*/
|
|
export function touchWorker( reportId ) {
|
|
const worker = workers[ reportId ];
|
|
if ( worker ) {
|
|
worker.lastTouch = Date.now();
|
|
}
|
|
}
|
|
|
|
export function retryTest( reportId, retries ) {
|
|
const worker = workers[ reportId ];
|
|
if ( worker ) {
|
|
worker.retries ||= 0;
|
|
worker.retries++;
|
|
if ( worker.retries <= retries ) {
|
|
worker.retry = true;
|
|
console.log( `\nRetrying test ${ reportId }...${ worker.retries }` );
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
export async function cleanupAllWorkers( verbose ) {
|
|
const workersRemaining = Object.keys( workers ).length;
|
|
if ( workersRemaining ) {
|
|
if ( verbose ) {
|
|
console.log(
|
|
`Stopping ${ workersRemaining } stray worker${
|
|
workersRemaining > 1 ? "s" : ""
|
|
}...`
|
|
);
|
|
}
|
|
await Promise.all(
|
|
Object.values( workers ).map( ( worker ) => deleteWorker( worker.id, verbose ) )
|
|
);
|
|
}
|
|
}
|
|
|
|
async function waitForAck( id, verbose ) {
|
|
return new Promise( ( resolve, reject ) => {
|
|
const interval = setInterval( () => {
|
|
const worker = workers[ id ];
|
|
if ( !worker ) {
|
|
clearTimeout( timeout );
|
|
clearInterval( interval );
|
|
return reject( new Error( `Worker ${ id } not found.` ) );
|
|
}
|
|
if ( worker.lastTouch ) {
|
|
if ( verbose ) {
|
|
console.log( `\nWorker ${ id } acknowledged.` );
|
|
}
|
|
clearTimeout( timeout );
|
|
clearInterval( interval );
|
|
resolve();
|
|
}
|
|
}, ACKNOWLEDGE_WORKER_INTERVAL );
|
|
const timeout = setTimeout( () => {
|
|
clearInterval( interval );
|
|
const worker = workers[ id ];
|
|
reject(
|
|
new Error(
|
|
`Worker ${
|
|
worker ? worker.id : ""
|
|
} for test ${ id } not acknowledged after ${
|
|
ACKNOWLEDGE_WORKER_TIMEOUT / 1000
|
|
}s.`
|
|
)
|
|
);
|
|
}, ACKNOWLEDGE_WORKER_TIMEOUT );
|
|
} );
|
|
}
|
|
|
|
export async function runWorker(
|
|
url,
|
|
browser,
|
|
options,
|
|
restarts = 0
|
|
) {
|
|
const { modules, reportId, runId, verbose } = options;
|
|
const worker = await createWorker( {
|
|
...browser,
|
|
url: encodeURI( url ),
|
|
project: "jquery",
|
|
build: `Run ${ runId }`,
|
|
name: `${ modules.join( "," ) } (${ reportId })`,
|
|
|
|
// Set the max here, so that we can
|
|
// control the timeout
|
|
timeout: 1800,
|
|
|
|
// Not documented in the API docs,
|
|
// but required to make local testing work.
|
|
// See https://www.browserstack.com/docs/automate/selenium/manage-multiple-connections#nodejs
|
|
"browserstack.local": true,
|
|
"browserstack.localIdentifier": runId
|
|
} );
|
|
|
|
workers[ reportId ] = worker;
|
|
|
|
const timeMessage = `\nWorker ${
|
|
worker.id
|
|
} created for test ${ reportId } (${ chalk.yellow( getBrowserString( browser ) ) })`;
|
|
|
|
if ( verbose ) {
|
|
console.time( timeMessage );
|
|
}
|
|
|
|
async function retryWorker() {
|
|
await cleanupWorker( reportId, verbose );
|
|
if ( verbose ) {
|
|
console.log( `Retrying worker for test ${ reportId }...${ restarts + 1 }` );
|
|
}
|
|
return runWorker( url, browser, options, restarts + 1 );
|
|
}
|
|
|
|
// Wait for the worker to be acknowledged
|
|
try {
|
|
await waitForAck( reportId );
|
|
} catch ( error ) {
|
|
if ( !workers[ reportId ] ) {
|
|
|
|
// The worker has already been cleaned up
|
|
return;
|
|
}
|
|
|
|
if ( restarts < MAX_WORKER_RESTARTS ) {
|
|
return retryWorker();
|
|
}
|
|
|
|
throw error;
|
|
}
|
|
|
|
if ( verbose ) {
|
|
console.timeEnd( timeMessage );
|
|
}
|
|
|
|
let refreshes = 0;
|
|
let loggedStarted = false;
|
|
return new Promise( ( resolve, reject ) => {
|
|
async function refreshWorker() {
|
|
try {
|
|
await changeUrl( worker.id, url );
|
|
touchWorker( reportId );
|
|
return tick();
|
|
} catch ( error ) {
|
|
if ( !workers[ reportId ] ) {
|
|
|
|
// The worker has already been cleaned up
|
|
return resolve();
|
|
}
|
|
console.error( error );
|
|
return retryWorker().then( resolve, reject );
|
|
}
|
|
}
|
|
|
|
async function checkWorker() {
|
|
const worker = workers[ reportId ];
|
|
|
|
if ( !worker || worker.debug ) {
|
|
return resolve();
|
|
}
|
|
|
|
let fetchedWorker;
|
|
try {
|
|
fetchedWorker = await getWorker( worker.id );
|
|
} catch ( error ) {
|
|
return reject( error );
|
|
}
|
|
if (
|
|
!fetchedWorker ||
|
|
( fetchedWorker.status !== "running" && fetchedWorker.status !== "queue" )
|
|
) {
|
|
return resolve();
|
|
}
|
|
|
|
if ( verbose && !loggedStarted ) {
|
|
loggedStarted = true;
|
|
console.log(
|
|
`\nTest ${ chalk.bold( reportId ) } is ${
|
|
worker.status === "running" ? "running" : "in the queue"
|
|
}.`
|
|
);
|
|
console.log( ` View at ${ fetchedWorker.browser_url }.` );
|
|
}
|
|
|
|
// Refresh the worker if a retry is triggered
|
|
if ( worker.retry ) {
|
|
worker.retry = false;
|
|
|
|
// Reset recovery refreshes
|
|
refreshes = 0;
|
|
return refreshWorker();
|
|
}
|
|
|
|
if ( worker.lastTouch > Date.now() - RUN_WORKER_TIMEOUT ) {
|
|
return tick();
|
|
}
|
|
|
|
refreshes++;
|
|
|
|
if ( refreshes >= MAX_WORKER_REFRESHES ) {
|
|
if ( restarts < MAX_WORKER_RESTARTS ) {
|
|
if ( verbose ) {
|
|
console.log(
|
|
`Worker ${ worker.id } not acknowledged after ${
|
|
ACKNOWLEDGE_WORKER_TIMEOUT / 1000
|
|
}s.`
|
|
);
|
|
}
|
|
return retryWorker().then( resolve, reject );
|
|
}
|
|
await cleanupWorker( reportId, verbose );
|
|
return reject(
|
|
new Error(
|
|
`Worker ${ worker.id } for test ${ reportId } timed out after ${ MAX_WORKER_RESTARTS } restarts.`
|
|
)
|
|
);
|
|
}
|
|
|
|
if ( verbose ) {
|
|
console.log(
|
|
`\nRefreshing worker ${ worker.id } for test ${ reportId }...${ refreshes }`
|
|
);
|
|
}
|
|
|
|
return refreshWorker();
|
|
}
|
|
|
|
function tick() {
|
|
setTimeout( checkWorker, POLL_WORKER_TIMEOUT );
|
|
}
|
|
|
|
checkWorker();
|
|
} );
|
|
}
|