@cypress/github-action 0.0.0-dev.5013

package/dist/thread.js

@@ -0,0 +1,57 @@
+'use strict';
+const fs = require('fs');
+const crypto = require('crypto');
+const {parentPort} = require('worker_threads');
+
+const handlers = {
+	hashFile: (algorithm, filePath) => new Promise((resolve, reject) => {
+		const hasher = crypto.createHash(algorithm);
+		fs.createReadStream(filePath)
+			// TODO: Use `Stream.pipeline` when targeting Node.js 12.
+			.on('error', reject)
+			.pipe(hasher)
+			.on('error', reject)
+			.on('finish', () => {
+				const {buffer} = new Uint8Array(hasher.read());
+				resolve({value: buffer, transferList: [buffer]});
+			});
+	}),
+	hash: async (algorithm, input) => {
+		const hasher = crypto.createHash(algorithm);
+
+		if (Array.isArray(input)) {
+			for (const part of input) {
+				hasher.update(part);
+			}
+		} else {
+			hasher.update(input);
+		}
+
+		const {buffer} = new Uint8Array(hasher.digest());
+		return {value: buffer, transferList: [buffer]};
+	}
+};
+
+parentPort.on('message', async message => {
+	try {
+		const {method, args} = message;
+		const handler = handlers[method];
+
+		if (handler === undefined) {
+			throw new Error(`Unknown method '${method}'`);
+		}
+
+		const {value, transferList} = await handler(...args);
+		parentPort.postMessage({id: message.id, value}, transferList);
+	} catch (error) {
+		const newError = {message: error.message, stack: error.stack};
+
+		for (const [key, value] of Object.entries(error)) {
+			if (typeof value !== 'object') {
+				newError[key] = value;
+			}
+		}
+
+		parentPort.postMessage({id: message.id, error: newError});
+	}
+});

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@cypress/github-action",
+  "version": "0.0.0-dev.5013",
+  "description": "GitHub Action for running Cypress end-to-end and component tests",
+  "private": false,
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "src",
+    "action.yml"
+  ],
+  "scripts": {
+    "test": "echo \"There are no tests :(\"",
+    "build": "rimraf dist && ncc build -o dist index.js",
+    "format": "prettier --write index.js src/ping.js action.yml",
+    "format:markdown": "prettier --write \"**/*.md\"",
+    "format:markdown:check": "prettier --check \"**/*.md\"",
+    "format:all": "prettier --write .",
+    "format:all:check": "prettier --check .",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "check:markdown-links": "find *.md docs/*.md -print0 | xargs -0 -n1 markdown-link-check -c markdownLinkConfig.json",
+    "update:cypress": "./scripts/update-cypress-latest.sh",
+    "prepare": "husky"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cypress-io/github-action.git"
+  },
+  "keywords": [
+    "actions",
+    "cypress-io"
+  ],
+  "author": "Cypress-io",
+  "license": "MIT",
+  "type": "commonjs",
+  "bugs": {
+    "url": "https://github.com/cypress-io/github-action/issues"
+  },
+  "homepage": "https://github.com/cypress-io/github-action#readme",
+  "dependencies": {
+    "@actions/cache": "5.0.5",
+    "@actions/core": "2.0.3",
+    "@actions/exec": "2.0.0",
+    "@actions/io": "2.0.0",
+    "@octokit/core": "7.0.6",
+    "argument-vector": "1.0.2",
+    "debug": "4.4.3",
+    "find-yarn-workspace-root": "2.0.0",
+    "got": "16.0.0",
+    "hasha": "5.2.2",
+    "quote": "0.4.0",
+    "supports-color": "9.3.1"
+  },
+  "devDependencies": {
+    "@eslint/js": "10.0.1",
+    "@stylistic/eslint-plugin": "5.10.0",
+    "@types/node": "26.6.5",
+    "@vercel/ncc": "0.45.0",
+    "eslint": "10.13.0",
+    "eslint-plugin-cypress": "7.0.2",
+    "globals": "17.13.0",
+    "husky": "9.1.7",
+    "markdown-link-check": "3.15.0",
+    "prettier": "3.9.10",
+    "rimraf": "6.1.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/ping-cli.js

@@ -0,0 +1,19 @@
+// a little CLI utility for testing pinging websites
+// node ./src/ping-cli <url>
+
+const { ping } = require('./ping')
+const timeoutSeconds = 30
+const url = process.argv[2]
+console.log('pinging url %s for %d seconds', url, timeoutSeconds)
+if (!url) {
+  console.error('Missing url to ping')
+  process.exit(1)
+}
+ping(url, timeoutSeconds * 1000)
+  .then(() => {
+    console.log('%s is responding', url)
+  })
+  .catch((err) => {
+    console.error('Could not connect to %s: %s', url, err.message)
+    process.exit(1)
+  })

package/src/ping.js

@@ -0,0 +1,85 @@
+const debug = require('debug')('@cypress/github-action')
+
+/**
+ * A small utility for checking when an URL responds, kind of
+ * a poor man's https://www.npmjs.com/package/wait-on. This version
+ * is implemented using https://github.com/sindresorhus/got
+ */
+const ping = async (url, timeout) => {
+  if (!timeout) {
+    throw new Error('Expected timeout in ms')
+  }
+
+  // got@16 is ESM-only; dynamic import works from CommonJS
+  const { default: got } = await import('got')
+
+  // make copy of the error codes that "got" retries on
+  const errorCodes = [...got.defaults.options.retry.errorCodes]
+  errorCodes.push('ESOCKETTIMEDOUT')
+
+  // we expect the server to respond within a time limit
+  // and if it does not - retry up to total "timeout" duration
+  const individualPingTimeout = Math.min(timeout, 30000)
+
+  // add to the timeout max individual ping timeout
+  // to avoid long-waiting ping from "rolling" over the end
+  // and preventing pinging the last time
+  timeout += individualPingTimeout
+  const limit = Math.ceil(timeout / individualPingTimeout)
+
+  debug(`total ping timeout ${timeout}`)
+  debug(`individual ping timeout ${individualPingTimeout}ms`)
+  debug(`retries limit ${limit}`)
+
+  const start = +new Date()
+  return got(url, {
+    headers: {
+      Accept: 'text/html, application/json, text/plain, */*'
+    },
+    timeout: {
+      request: individualPingTimeout
+    },
+    retry: {
+      errorCodes,
+      // enforceRetryRules:false lets calculateDelay be the sole stop condition,
+      // matching got@11 behaviour. limit is a generous failsafe only.
+      enforceRetryRules: false,
+      limit,
+      calculateDelay({ error, attemptCount }) {
+        if (error) {
+          debug(`got error ${JSON.stringify(error)}`)
+        }
+        const now = +new Date()
+        const elapsed = now - start
+        debug(
+          `${elapsed}ms ${error.method} ${error.host} ${error.code} attempt ${attemptCount}`
+        )
+        if (elapsed > timeout) {
+          console.error(
+            '%s timed out after %d retries, elapsed %dms, limit %dms',
+            url,
+            attemptCount,
+            elapsed,
+            timeout
+          )
+          return 0
+        }
+
+        // if the error code is ECONNREFUSED use shorter timeout
+        // because the server is probably starting
+        if (error.code === 'ECONNREFUSED') {
+          return 1000
+        }
+
+        // default "long" timeout
+        return individualPingTimeout
+      }
+    }
+  }).then(() => {
+    const now = +new Date()
+    const elapsed = now - start
+    debug(`pinging ${url} has finished ok after ${elapsed}ms`)
+  })
+}
+
+module.exports = { ping }