Merge pull request #444 from actions/yoannchaudet-deployment-polling-backoff

Add backoff and jitter to deployment polling

.github/workflows/publish-immutable-actions.yml

@@ -0,0 +1,20 @@
+name: 'Publish Immutable Action Version'
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+      packages: write
+
+    steps:
+      - name: Checking out
+        uses: actions/checkout@v4
+      - name: Publish
+        id: publish
+        uses: actions/publish-immutable-action@0.0.3

.node-version

@@ -1 +1 @@
-20.10.0
+24.4.0

README.md

@@ -51,7 +51,7 @@ jobs:
 | `token` | `true` | `${{ github.token }}` | The GitHub token used to create an authenticated client - Provided for you by default! |
 | `timeout` | `false` | `"600000"` | Time in milliseconds after which to timeout and cancel the deployment (default: 10 minutes) |
 | `error_count` | `false` | `"10"` | Maximum number of status report errors before cancelling a deployment (default: 10) |
-| `reporting_interval` | `false` | `"5000"` | Time in milliseconds between two deployment status reports (default: 5 seconds) |
+| `reporting_interval` | `false` | `"5000"` | Initial time in milliseconds between deployment status reports. Successful non-terminal polls use exponential backoff up to 30 seconds, or the configured interval when higher, with ±20% jitter. Error backoff is added separately (default: 5 seconds). |
 | `artifact_name` | `false` | `"github-pages"` | The name of the artifact to deploy |
 | `preview` | `false` | `"false"` | Is this attempting to deploy a pull request as a GitHub Pages preview site? (NOTE: This feature is only in alpha currently and is not available to the public!) |
 

action.yml

@@ -2,7 +2,7 @@ name: 'Deploy GitHub Pages site'
 description: 'A GitHub Action to deploy an artifact as a GitHub Pages site'
 author: 'GitHub'
 runs:
-  using: 'node20'
+  using: 'node24'
   main: 'dist/index.js'
 inputs:
   token:
@@ -18,7 +18,7 @@ inputs:
     required: false
     default: '10'
   reporting_interval:
-    description: 'Time in milliseconds between two deployment status report (default: 5 seconds)'
+    description: 'Initial time between deployment status reports; successful polls use capped backoff and jitter, with error backoff added separately (default: 5 seconds)'
     required: false
     default: '5000'
   artifact_name:

dist/index.js

@@ -67028,6 +67028,104 @@ exports.retry = retry;
 //# sourceMappingURL=index.js.map
 
 
+/***/ }),
+
+/***/ 10537:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+"use strict";
+
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// pkg/dist-src/index.js
+var dist_src_exports = {};
+__export(dist_src_exports, {
+  RequestError: () => RequestError
+});
+module.exports = __toCommonJS(dist_src_exports);
+var import_deprecation = __nccwpck_require__(58932);
+var import_once = __toESM(__nccwpck_require__(1223));
+var logOnceCode = (0, import_once.default)((deprecation) => console.warn(deprecation));
+var logOnceHeaders = (0, import_once.default)((deprecation) => console.warn(deprecation));
+var RequestError = class extends Error {
+  constructor(message, statusCode, options) {
+    super(message);
+    if (Error.captureStackTrace) {
+      Error.captureStackTrace(this, this.constructor);
+    }
+    this.name = "HttpError";
+    this.status = statusCode;
+    let headers;
+    if ("headers" in options && typeof options.headers !== "undefined") {
+      headers = options.headers;
+    }
+    if ("response" in options) {
+      this.response = options.response;
+      headers = options.response.headers;
+    }
+    const requestCopy = Object.assign({}, options.request);
+    if (options.request.headers.authorization) {
+      requestCopy.headers = Object.assign({}, options.request.headers, {
+        authorization: options.request.headers.authorization.replace(
+          / .*$/,
+          " [REDACTED]"
+        )
+      });
+    }
+    requestCopy.url = requestCopy.url.replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]").replace(/\baccess_token=\w+/g, "access_token=[REDACTED]");
+    this.request = requestCopy;
+    Object.defineProperty(this, "code", {
+      get() {
+        logOnceCode(
+          new import_deprecation.Deprecation(
+            "[@octokit/request-error] `error.code` is deprecated, use `error.status`."
+          )
+        );
+        return statusCode;
+      }
+    });
+    Object.defineProperty(this, "headers", {
+      get() {
+        logOnceHeaders(
+          new import_deprecation.Deprecation(
+            "[@octokit/request-error] `error.headers` is deprecated, use `error.response.headers`."
+          )
+        );
+        return headers || {};
+      }
+    });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (0);
+
+
 /***/ }),
 
 /***/ 36234:
@@ -67079,7 +67177,7 @@ function isPlainObject(value) {
 }
 
 // pkg/dist-src/fetch-wrapper.js
-var import_request_error = __nccwpck_require__(30013);
+var import_request_error = __nccwpck_require__(10537);
 
 // pkg/dist-src/get-buffer-response.js
 function getBufferResponse(response) {
@@ -67251,104 +67349,6 @@ var request = withDefaults(import_endpoint.endpoint, {
 0 && (0);
 
 
-/***/ }),
-
-/***/ 30013:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-"use strict";
-
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// pkg/dist-src/index.js
-var dist_src_exports = {};
-__export(dist_src_exports, {
-  RequestError: () => RequestError
-});
-module.exports = __toCommonJS(dist_src_exports);
-var import_deprecation = __nccwpck_require__(58932);
-var import_once = __toESM(__nccwpck_require__(1223));
-var logOnceCode = (0, import_once.default)((deprecation) => console.warn(deprecation));
-var logOnceHeaders = (0, import_once.default)((deprecation) => console.warn(deprecation));
-var RequestError = class extends Error {
-  constructor(message, statusCode, options) {
-    super(message);
-    if (Error.captureStackTrace) {
-      Error.captureStackTrace(this, this.constructor);
-    }
-    this.name = "HttpError";
-    this.status = statusCode;
-    let headers;
-    if ("headers" in options && typeof options.headers !== "undefined") {
-      headers = options.headers;
-    }
-    if ("response" in options) {
-      this.response = options.response;
-      headers = options.response.headers;
-    }
-    const requestCopy = Object.assign({}, options.request);
-    if (options.request.headers.authorization) {
-      requestCopy.headers = Object.assign({}, options.request.headers, {
-        authorization: options.request.headers.authorization.replace(
-          / .*$/,
-          " [REDACTED]"
-        )
-      });
-    }
-    requestCopy.url = requestCopy.url.replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]").replace(/\baccess_token=\w+/g, "access_token=[REDACTED]");
-    this.request = requestCopy;
-    Object.defineProperty(this, "code", {
-      get() {
-        logOnceCode(
-          new import_deprecation.Deprecation(
-            "[@octokit/request-error] `error.code` is deprecated, use `error.status`."
-          )
-        );
-        return statusCode;
-      }
-    });
-    Object.defineProperty(this, "headers", {
-      get() {
-        logOnceHeaders(
-          new import_deprecation.Deprecation(
-            "[@octokit/request-error] `error.headers` is deprecated, use `error.response.headers`."
-          )
-        );
-        return headers || {};
-      }
-    });
-  }
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (0);
-
-
 /***/ }),
 
 /***/ 57171:
@@ -149676,7 +149676,7 @@ ZipStream.prototype.finalize = function() {
 const core = __nccwpck_require__(42186)
 const github = __nccwpck_require__(95438)
 const { DefaultArtifactClient } = __nccwpck_require__(79450)
-const { RequestError } = __nccwpck_require__(26999)
+const { RequestError } = __nccwpck_require__(10537)
 const HttpStatusMessages = __nccwpck_require__(73703)
 
 function wrapTwirpResponseLikeOctokit(twirpResponse, requestOptions) {
@@ -149920,9 +149920,18 @@ const finalErrorStatus = {
 }
 
 const MAX_TIMEOUT = 600000
+const DEFAULT_REPORTING_INTERVAL = 5000
+const MAX_REPORTING_INTERVAL = 30000
+const REPORTING_BACKOFF_MULTIPLIER = 1.5
+const REPORTING_JITTER_FACTOR = 0.2
 const ONE_GIGABYTE = 1073741824
 const SIZE_LIMIT_DESCRIPTION = '1 GB'
 
+function getJitteredInterval(interval) {
+  const jitter = interval * REPORTING_JITTER_FACTOR
+  return Math.round(interval - jitter + Math.random() * jitter * 2)
+}
+
 class Deployment {
   constructor() {
     const context = getContext()
@@ -150034,9 +150043,19 @@ class Deployment {
     }
 
     const deploymentId = this.deploymentInfo.id || this.buildVersion
-    const reportingInterval = Number(core.getInput('reporting_interval'))
+    const reportingIntervalInput = Number(core.getInput('reporting_interval'))
+    const initialReportingInterval =
+      Number.isFinite(reportingIntervalInput) && reportingIntervalInput > 0
+        ? reportingIntervalInput
+        : DEFAULT_REPORTING_INTERVAL
+    const maxReportingInterval = Math.max(MAX_REPORTING_INTERVAL, initialReportingInterval)
     const maxErrorCount = Number(core.getInput('error_count'))
 
+    if (initialReportingInterval !== reportingIntervalInput) {
+      core.warning(`Invalid reporting_interval value; using the default of ${DEFAULT_REPORTING_INTERVAL} milliseconds.`)
+    }
+
+    let reportingInterval = initialReportingInterval
     let errorCount = 0
 
     // Time in milliseconds between two deployment status report when status errored, default 0.
@@ -150047,7 +150066,7 @@ class Deployment {
     /*eslint no-constant-condition: ["error", { "checkLoops": false }]*/
     while (true) {
       // Handle reporting interval
-      await new Promise(resolve => setTimeout(resolve, reportingInterval + errorReportingInterval))
+      await new Promise(resolve => setTimeout(resolve, getJitteredInterval(reportingInterval + errorReportingInterval)))
 
       // Check status
       try {
@@ -150075,6 +150094,7 @@ class Deployment {
 
         // reset the error reporting interval once get the proper status back.
         errorReportingInterval = 0
+        reportingInterval = Math.min(Math.round(reportingInterval * REPORTING_BACKOFF_MULTIPLIER), maxReportingInterval)
       } catch (error) {
         core.error(error.stack)
 
@@ -150138,7 +150158,14 @@ class Deployment {
   }
 }
 
-module.exports = { Deployment, MAX_TIMEOUT, ONE_GIGABYTE, SIZE_LIMIT_DESCRIPTION }
+module.exports = {
+  Deployment,
+  MAX_TIMEOUT,
+  DEFAULT_REPORTING_INTERVAL,
+  MAX_REPORTING_INTERVAL,
+  ONE_GIGABYTE,
+  SIZE_LIMIT_DESCRIPTION
+}
 
 
 /***/ }),
@@ -160243,56 +160270,6 @@ const index = /*@__PURE__*/getDefaultExportFromCjs(bufferCrc32);
 module.exports = index;
 
 
-/***/ }),
-
-/***/ 26999:
-/***/ ((__unused_webpack___webpack_module__, __webpack_exports__, __nccwpck_require__) => {
-
-"use strict";
-__nccwpck_require__.r(__webpack_exports__);
-/* harmony export */ __nccwpck_require__.d(__webpack_exports__, {
-/* harmony export */   "RequestError": () => (/* binding */ RequestError)
-/* harmony export */ });
-class RequestError extends Error {
-  name;
-  /**
-   * http status code
-   */
-  status;
-  /**
-   * Request options that lead to the error.
-   */
-  request;
-  /**
-   * Response object if a response was received
-   */
-  response;
-  constructor(message, statusCode, options) {
-    super(message);
-    this.name = "HttpError";
-    this.status = Number.parseInt(statusCode);
-    if (Number.isNaN(this.status)) {
-      this.status = 0;
-    }
-    if ("response" in options) {
-      this.response = options.response;
-    }
-    const requestCopy = Object.assign({}, options.request);
-    if (options.request.headers.authorization) {
-      requestCopy.headers = Object.assign({}, options.request.headers, {
-        authorization: options.request.headers.authorization.replace(
-          / .*$/,
-          " [REDACTED]"
-        )
-      });
-    }
-    requestCopy.url = requestCopy.url.replace(/\bclient_secret=\w+/g, "client_secret=[REDACTED]").replace(/\baccess_token=\w+/g, "access_token=[REDACTED]");
-    this.request = requestCopy;
-  }
-}
-
-
-
 /***/ }),
 
 /***/ 39839:
@@ -160355,34 +160332,6 @@ module.exports = JSON.parse('[[[0,44],"disallowed_STD3_valid"],[[45,46],"valid"]
 /******/ 	}
 /******/ 	
 /************************************************************************/
-/******/ 	/* webpack/runtime/define property getters */
-/******/ 	(() => {
-/******/ 		// define getter functions for harmony exports
-/******/ 		__nccwpck_require__.d = (exports, definition) => {
-/******/ 			for(var key in definition) {
-/******/ 				if(__nccwpck_require__.o(definition, key) && !__nccwpck_require__.o(exports, key)) {
-/******/ 					Object.defineProperty(exports, key, { enumerable: true, get: definition[key] });
-/******/ 				}
-/******/ 			}
-/******/ 		};
-/******/ 	})();
-/******/ 	
-/******/ 	/* webpack/runtime/hasOwnProperty shorthand */
-/******/ 	(() => {
-/******/ 		__nccwpck_require__.o = (obj, prop) => (Object.prototype.hasOwnProperty.call(obj, prop))
-/******/ 	})();
-/******/ 	
-/******/ 	/* webpack/runtime/make namespace object */
-/******/ 	(() => {
-/******/ 		// define __esModule on exports
-/******/ 		__nccwpck_require__.r = (exports) => {
-/******/ 			if(typeof Symbol !== 'undefined' && Symbol.toStringTag) {
-/******/ 				Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-/******/ 			}
-/******/ 			Object.defineProperty(exports, '__esModule', { value: true });
-/******/ 		};
-/******/ 	})();
-/******/ 	
 /******/ 	/* webpack/runtime/node module decorator */
 /******/ 	(() => {
 /******/ 		__nccwpck_require__.nmd = (module) => {

package-lock.json

@@ -12,7 +12,7 @@
         "@actions/artifact": "^2.1.8",
         "@actions/core": "^1.10.1",
         "@actions/github": "^6.0.0",
-        "@octokit/request-error": "^6.1.4",
+        "@octokit/request-error": "^5.0.1",
         "http-status-messages": "^1.1.0"
       },
       "devDependencies": {
@@ -161,32 +161,6 @@
         "universal-user-agent": "^6.0.0"
       }
     },
-    "node_modules/@actions/artifact/node_modules/@octokit/request-error": {
-      "version": "5.1.0",
-      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-5.1.0.tgz",
-      "integrity": "sha512-GETXfE05J0+7H2STzekpKObFe765O5dlAKUTLNGeH+x47z7JjXHfsHKo5z21D/o/IOZTUEI6nyWyR+bZVP/n5Q==",
-      "dependencies": {
-        "@octokit/types": "^13.1.0",
-        "deprecation": "^2.0.0",
-        "once": "^1.4.0"
-      },
-      "engines": {
-        "node": ">= 18"
-      }
-    },
-    "node_modules/@actions/artifact/node_modules/@octokit/request-error/node_modules/@octokit/openapi-types": {
-      "version": "22.2.0",
-      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz",
-      "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg=="
-    },
-    "node_modules/@actions/artifact/node_modules/@octokit/request-error/node_modules/@octokit/types": {
-      "version": "13.5.0",
-      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.5.0.tgz",
-      "integrity": "sha512-HdqWTf5Z3qwDVlzCrP8UJquMwunpDiMPt5er+QjGzL4hqr/vBVY/MauQgS1xWxCDT1oMx1EULyqxncdCY/NVSQ==",
-      "dependencies": {
-        "@octokit/openapi-types": "^22.2.0"
-      }
-    },
     "node_modules/@actions/artifact/node_modules/@octokit/request/node_modules/@octokit/request-error": {
       "version": "2.1.0",
       "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.1.0.tgz",
@@ -1761,32 +1735,6 @@
         "node": ">= 18"
       }
     },
-    "node_modules/@octokit/core/node_modules/@octokit/openapi-types": {
-      "version": "22.2.0",
-      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz",
-      "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg=="
-    },
-    "node_modules/@octokit/core/node_modules/@octokit/request-error": {
-      "version": "5.1.0",
-      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-5.1.0.tgz",
-      "integrity": "sha512-GETXfE05J0+7H2STzekpKObFe765O5dlAKUTLNGeH+x47z7JjXHfsHKo5z21D/o/IOZTUEI6nyWyR+bZVP/n5Q==",
-      "dependencies": {
-        "@octokit/types": "^13.1.0",
-        "deprecation": "^2.0.0",
-        "once": "^1.4.0"
-      },
-      "engines": {
-        "node": ">= 18"
-      }
-    },
-    "node_modules/@octokit/core/node_modules/@octokit/request-error/node_modules/@octokit/types": {
-      "version": "13.5.0",
-      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.5.0.tgz",
-      "integrity": "sha512-HdqWTf5Z3qwDVlzCrP8UJquMwunpDiMPt5er+QjGzL4hqr/vBVY/MauQgS1xWxCDT1oMx1EULyqxncdCY/NVSQ==",
-      "dependencies": {
-        "@octokit/openapi-types": "^22.2.0"
-      }
-    },
     "node_modules/@octokit/endpoint": {
       "version": "9.0.4",
       "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-9.0.4.tgz",
@@ -1890,40 +1838,11 @@
       }
     },
     "node_modules/@octokit/request-error": {
-      "version": "6.1.4",
-      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-6.1.4.tgz",
-      "integrity": "sha512-VpAhIUxwhWZQImo/dWAN/NpPqqojR6PSLgLYAituLM6U+ddx9hCioFGwBr5Mi+oi5CLeJkcAs3gJ0PYYzU6wUg==",
+      "version": "5.0.1",
+      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-5.0.1.tgz",
+      "integrity": "sha512-X7pnyTMV7MgtGmiXBwmO6M5kIPrntOXdyKZLigNfQWSEQzVxR4a4vo49vJjTWX70mPndj8KhfT4Dx+2Ng3vnBQ==",
       "dependencies": {
-        "@octokit/types": "^13.0.0"
-      },
-      "engines": {
-        "node": ">= 18"
-      }
-    },
-    "node_modules/@octokit/request-error/node_modules/@octokit/openapi-types": {
-      "version": "22.2.0",
-      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz",
-      "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg=="
-    },
-    "node_modules/@octokit/request-error/node_modules/@octokit/types": {
-      "version": "13.5.0",
-      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.5.0.tgz",
-      "integrity": "sha512-HdqWTf5Z3qwDVlzCrP8UJquMwunpDiMPt5er+QjGzL4hqr/vBVY/MauQgS1xWxCDT1oMx1EULyqxncdCY/NVSQ==",
-      "dependencies": {
-        "@octokit/openapi-types": "^22.2.0"
-      }
-    },
-    "node_modules/@octokit/request/node_modules/@octokit/openapi-types": {
-      "version": "22.2.0",
-      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-22.2.0.tgz",
-      "integrity": "sha512-QBhVjcUa9W7Wwhm6DBFu6ZZ+1/t/oYxqc2tp81Pi41YNuJinbFRx8B133qVOrAaBbF7D/m0Et6f9/pZt9Rc+tg=="
-    },
-    "node_modules/@octokit/request/node_modules/@octokit/request-error": {
-      "version": "5.1.0",
-      "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-5.1.0.tgz",
-      "integrity": "sha512-GETXfE05J0+7H2STzekpKObFe765O5dlAKUTLNGeH+x47z7JjXHfsHKo5z21D/o/IOZTUEI6nyWyR+bZVP/n5Q==",
-      "dependencies": {
-        "@octokit/types": "^13.1.0",
+        "@octokit/types": "^12.0.0",
         "deprecation": "^2.0.0",
         "once": "^1.4.0"
       },
@@ -1931,14 +1850,6 @@
         "node": ">= 18"
       }
     },
-    "node_modules/@octokit/request/node_modules/@octokit/request-error/node_modules/@octokit/types": {
-      "version": "13.5.0",
-      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-13.5.0.tgz",
-      "integrity": "sha512-HdqWTf5Z3qwDVlzCrP8UJquMwunpDiMPt5er+QjGzL4hqr/vBVY/MauQgS1xWxCDT1oMx1EULyqxncdCY/NVSQ==",
-      "dependencies": {
-        "@octokit/openapi-types": "^22.2.0"
-      }
-    },
     "node_modules/@octokit/types": {
       "version": "12.4.0",
       "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.4.0.tgz",

package.json

@@ -7,7 +7,7 @@
     "@actions/artifact": "^2.1.8",
     "@actions/core": "^1.10.1",
     "@actions/github": "^6.0.0",
-    "@octokit/request-error": "^6.1.4",
+    "@octokit/request-error": "^5.0.1",
     "http-status-messages": "^1.1.0"
   },
   "devDependencies": {

src/__tests__/internal/deployment.test.js

@@ -4,7 +4,14 @@ const nock = require('nock')
 // For mocking network calls with native Fetch (octokit)
 const { MockAgent, setGlobalDispatcher } = require('undici')
 
-const { Deployment, MAX_TIMEOUT, ONE_GIGABYTE, SIZE_LIMIT_DESCRIPTION } = require('../../internal/deployment')
+const {
+  Deployment,
+  MAX_TIMEOUT,
+  DEFAULT_REPORTING_INTERVAL,
+  MAX_REPORTING_INTERVAL,
+  ONE_GIGABYTE,
+  SIZE_LIMIT_DESCRIPTION
+} = require('../../internal/deployment')
 
 const fakeJwt =
   'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJqdGkiOiJiNjllMWIxOC1jOGFiLTRhZGQtOGYxOC03MzVlMzVjZGJhZjAiLCJzdWIiOiJyZXBvOnBhcGVyLXNwYS9taW55aTplbnZpcm9ubWVudDpQcm9kdWN0aW9uIiwiYXVkIjoiaHR0cHM6Ly9naXRodWIuY29tL3BhcGVyLXNwYSIsInJlZiI6InJlZnMvaGVhZHMvbWFpbiIsInNoYSI6ImEyODU1MWJmODdiZDk3NTFiMzdiMmM0YjM3M2MxZjU3NjFmYWM2MjYiLCJyZXBvc2l0b3J5IjoicGFwZXItc3BhL21pbnlpIiwicmVwb3NpdG9yeV9vd25lciI6InBhcGVyLXNwYSIsInJ1bl9pZCI6IjE1NDY0NTkzNjQiLCJydW5fbnVtYmVyIjoiMzQiLCJydW5fYXR0ZW1wdCI6IjIiLCJhY3RvciI6IllpTXlzdHkiLCJ3b3JrZmxvdyI6IkNJIiwiaGVhZF9yZWYiOiIiLCJiYXNlX3JlZiI6IiIsImV2ZW50X25hbWUiOiJwdXNoIiwicmVmX3R5cGUiOiJicmFuY2giLCJlbnZpcm9ubWVudCI6IlByb2R1Y3Rpb24iLCJqb2Jfd29ya2Zsb3dfcmVmIjoicGFwZXItc3BhL21pbnlpLy5naXRodWIvd29ya2Zsb3dzL2JsYW5rLnltbEByZWZzL2hlYWRzL21haW4iLCJpc3MiOiJodHRwczovL3Rva2VuLmFjdGlvbnMuZ2l0aHVidXNlcmNvbnRlbnQuY29tIiwibmJmIjoxNjM4ODI4MDI4LCJleHAiOjE2Mzg4Mjg5MjgsImlhdCI6MTYzODgyODYyOH0.1wyupfxu1HGoTyIqatYg0hIxy2-0bMO-yVlmLSMuu2w'
@@ -35,7 +42,7 @@ describe('Deployment', () => {
         case 'token':
           return process.env.GITHUB_TOKEN
         case 'reporting_interval':
-          return 50 // Lower reporting interval to speed up test
+          return process.env.INPUT_REPORTING_INTERVAL || 50 // Lower reporting interval to speed up test
         default:
           return process.env[`INPUT_${param.toUpperCase()}`] || ''
       }
@@ -121,6 +128,58 @@ describe('Deployment', () => {
       twirpScope.done()
     })
 
+    it('can successfully create a deployment with a 64-character build version', async () => {
+      process.env.GITHUB_SHA = 'a'.repeat(64)
+
+      const twirpScope = nock(process.env.ACTIONS_RESULTS_URL)
+        .post(LIST_ARTIFACTS_TWIRP_PATH)
+        .reply(
+          200,
+          {
+            artifacts: [{ databaseId: 11, name: 'github-pages', size: 221 }]
+          },
+          { headers: { 'content-type': 'application/json' } }
+        )
+
+      mockPool
+        .intercept({
+          path: `/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments`,
+          method: 'POST',
+          body: bodyString => {
+            const body = JSON.parse(bodyString)
+            const keys = Object.keys(body).sort()
+            return (
+              keys.length === 3 &&
+              keys[0] === 'artifact_id' &&
+              keys[1] === 'oidc_token' &&
+              keys[2] === 'pages_build_version' &&
+              body.artifact_id === 11 &&
+              body.pages_build_version === process.env.GITHUB_SHA &&
+              body.oidc_token === fakeJwt
+            )
+          }
+        })
+        .reply(
+          200,
+          {
+            status_url: `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`,
+            page_url: 'https://actions.github.io/is-awesome'
+          },
+          { headers: { 'content-type': 'application/json' } }
+        )
+
+      const deployment = new Deployment()
+      await deployment.create(fakeJwt)
+
+      expect(process.env.GITHUB_SHA).toHaveLength(64)
+      expect(core.setFailed).not.toHaveBeenCalled()
+      expect(core.info).toHaveBeenLastCalledWith(
+        expect.stringMatching(new RegExp(`^Created deployment for ${process.env.GITHUB_SHA}`))
+      )
+
+      twirpScope.done()
+    })
+
     it('can successfully create a preview deployment', async () => {
       process.env.GITHUB_SHA = 'valid-build-version'
 
@@ -556,6 +615,42 @@ describe('Deployment', () => {
   })
 
   describe('#check', () => {
+    afterEach(() => {
+      jest.restoreAllMocks()
+      delete process.env.INPUT_ERROR_COUNT
+      delete process.env.INPUT_REPORTING_INTERVAL
+    })
+
+    const mockDeploymentStatus = (status, times = 1) => {
+      mockPool
+        .intercept({
+          path: `/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`,
+          method: 'GET'
+        })
+        .reply(200, { status }, { headers: { 'content-type': 'application/json' } })
+        .times(times)
+    }
+
+    const createPendingDeployment = () => {
+      const deployment = new Deployment()
+      deployment.deploymentInfo = {
+        id: process.env.GITHUB_SHA,
+        pending: true
+      }
+      deployment.startTime = Date.now()
+      return deployment
+    }
+
+    const runWithoutWaiting = async deployment => {
+      const timeoutSpy = jest.spyOn(global, 'setTimeout').mockImplementation(resolve => {
+        resolve()
+        return 0
+      })
+
+      await deployment.check()
+      return timeoutSpy
+    }
+
     it('sets output to success when deployment is successful', async () => {
       process.env.GITHUB_SHA = 'valid-build-version'
 
@@ -912,7 +1007,7 @@ describe('Deployment', () => {
           case 'error_count':
             return 10
           case 'reporting_interval':
-            return 0 // The default of 5000 is too long for the test
+            return 1 // The default of 5000 is too long for the test
           case 'timeout':
             return 42
           default:
@@ -938,6 +1033,108 @@ describe('Deployment', () => {
       expect(core.info).toHaveBeenLastCalledWith('Reported success!')
       twirpScope.done()
     })
+
+    it('backs off successful non-terminal status checks', async () => {
+      process.env.GITHUB_SHA = 'valid-build-version'
+      process.env.INPUT_ERROR_COUNT = '10'
+      mockDeploymentStatus('deployment_in_progress', 2)
+      mockDeploymentStatus('succeed')
+      const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5)
+
+      const timeoutSpy = await runWithoutWaiting(createPendingDeployment())
+
+      expect(timeoutSpy).toHaveBeenNthCalledWith(1, expect.any(Function), 50)
+      expect(timeoutSpy).toHaveBeenNthCalledWith(2, expect.any(Function), 75)
+      expect(timeoutSpy).toHaveBeenNthCalledWith(3, expect.any(Function), 113)
+
+      timeoutSpy.mockRestore()
+      randomSpy.mockRestore()
+      delete process.env.INPUT_ERROR_COUNT
+    })
+
+    it('caps the successful status check backoff', async () => {
+      process.env.GITHUB_SHA = 'valid-build-version'
+      process.env.INPUT_ERROR_COUNT = '10'
+      process.env.INPUT_REPORTING_INTERVAL = '20000'
+      mockDeploymentStatus('deployment_in_progress')
+      mockDeploymentStatus('succeed')
+      const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5)
+
+      const timeoutSpy = await runWithoutWaiting(createPendingDeployment())
+
+      expect(timeoutSpy.mock.calls.map(([, interval]) => interval)).toEqual([20000, MAX_REPORTING_INTERVAL])
+
+      timeoutSpy.mockRestore()
+      randomSpy.mockRestore()
+    })
+
+    it('does not reduce a configured interval above the backoff cap', async () => {
+      process.env.GITHUB_SHA = 'valid-build-version'
+      process.env.INPUT_ERROR_COUNT = '10'
+      process.env.INPUT_REPORTING_INTERVAL = '45000'
+      mockDeploymentStatus('deployment_in_progress')
+      mockDeploymentStatus('succeed')
+      jest.spyOn(Math, 'random').mockReturnValue(0.5)
+
+      const timeoutSpy = await runWithoutWaiting(createPendingDeployment())
+
+      expect(timeoutSpy.mock.calls.map(([, interval]) => interval)).toEqual([45000, 45000])
+    })
+
+    it.each(['not-a-number', '0', '-1'])(
+      'uses the default reporting interval for invalid input %s',
+      async reportingInterval => {
+        process.env.GITHUB_SHA = 'valid-build-version'
+        process.env.INPUT_ERROR_COUNT = '10'
+        process.env.INPUT_REPORTING_INTERVAL = reportingInterval
+        mockDeploymentStatus('succeed')
+        jest.spyOn(Math, 'random').mockReturnValue(0.5)
+
+        const timeoutSpy = await runWithoutWaiting(createPendingDeployment())
+
+        expect(timeoutSpy).toHaveBeenCalledWith(expect.any(Function), DEFAULT_REPORTING_INTERVAL)
+        expect(core.warning).toHaveBeenCalledWith(
+          `Invalid reporting_interval value; using the default of ${DEFAULT_REPORTING_INTERVAL} milliseconds.`
+        )
+      }
+    )
+
+    it('jitters status check intervals by up to twenty percent', async () => {
+      process.env.GITHUB_SHA = 'valid-build-version'
+      process.env.INPUT_ERROR_COUNT = '10'
+      mockDeploymentStatus('deployment_in_progress')
+      mockDeploymentStatus('succeed')
+      const randomSpy = jest.spyOn(Math, 'random').mockReturnValueOnce(0).mockReturnValueOnce(1)
+
+      const timeoutSpy = await runWithoutWaiting(createPendingDeployment())
+
+      expect(timeoutSpy).toHaveBeenNthCalledWith(1, expect.any(Function), 40)
+      expect(timeoutSpy).toHaveBeenNthCalledWith(2, expect.any(Function), 90)
+
+      timeoutSpy.mockRestore()
+      randomSpy.mockRestore()
+    })
+
+    it('keeps success backoff separate from error backoff', async () => {
+      process.env.GITHUB_SHA = 'valid-build-version'
+      process.env.INPUT_ERROR_COUNT = '10'
+      mockPool
+        .intercept({
+          path: `/repos/${process.env.GITHUB_REPOSITORY}/pages/deployments/${process.env.GITHUB_SHA}`,
+          method: 'GET'
+        })
+        .reply(500, {}, { headers: { 'content-type': 'application/json' } })
+      mockDeploymentStatus('deployment_in_progress')
+      mockDeploymentStatus('succeed')
+      const randomSpy = jest.spyOn(Math, 'random').mockReturnValue(0.5)
+
+      const timeoutSpy = await runWithoutWaiting(createPendingDeployment())
+
+      expect(timeoutSpy.mock.calls.map(([, interval]) => interval)).toEqual([50, 51, 75])
+
+      timeoutSpy.mockRestore()
+      randomSpy.mockRestore()
+    })
   })
 
   describe('#cancel', () => {

src/internal/deployment.js

@@ -24,9 +24,18 @@ const finalErrorStatus = {
 }
 
 const MAX_TIMEOUT = 600000
+const DEFAULT_REPORTING_INTERVAL = 5000
+const MAX_REPORTING_INTERVAL = 30000
+const REPORTING_BACKOFF_MULTIPLIER = 1.5
+const REPORTING_JITTER_FACTOR = 0.2
 const ONE_GIGABYTE = 1073741824
 const SIZE_LIMIT_DESCRIPTION = '1 GB'
 
+function getJitteredInterval(interval) {
+  const jitter = interval * REPORTING_JITTER_FACTOR
+  return Math.round(interval - jitter + Math.random() * jitter * 2)
+}
+
 class Deployment {
   constructor() {
     const context = getContext()
@@ -138,9 +147,19 @@ class Deployment {
     }
 
     const deploymentId = this.deploymentInfo.id || this.buildVersion
-    const reportingInterval = Number(core.getInput('reporting_interval'))
+    const reportingIntervalInput = Number(core.getInput('reporting_interval'))
+    const initialReportingInterval =
+      Number.isFinite(reportingIntervalInput) && reportingIntervalInput > 0
+        ? reportingIntervalInput
+        : DEFAULT_REPORTING_INTERVAL
+    const maxReportingInterval = Math.max(MAX_REPORTING_INTERVAL, initialReportingInterval)
     const maxErrorCount = Number(core.getInput('error_count'))
 
+    if (initialReportingInterval !== reportingIntervalInput) {
+      core.warning(`Invalid reporting_interval value; using the default of ${DEFAULT_REPORTING_INTERVAL} milliseconds.`)
+    }
+
+    let reportingInterval = initialReportingInterval
     let errorCount = 0
 
     // Time in milliseconds between two deployment status report when status errored, default 0.
@@ -151,7 +170,7 @@ class Deployment {
     /*eslint no-constant-condition: ["error", { "checkLoops": false }]*/
     while (true) {
       // Handle reporting interval
-      await new Promise(resolve => setTimeout(resolve, reportingInterval + errorReportingInterval))
+      await new Promise(resolve => setTimeout(resolve, getJitteredInterval(reportingInterval + errorReportingInterval)))
 
       // Check status
       try {
@@ -179,6 +198,7 @@ class Deployment {
 
         // reset the error reporting interval once get the proper status back.
         errorReportingInterval = 0
+        reportingInterval = Math.min(Math.round(reportingInterval * REPORTING_BACKOFF_MULTIPLIER), maxReportingInterval)
       } catch (error) {
         core.error(error.stack)
 
@@ -242,4 +262,11 @@ class Deployment {
   }
 }
 
-module.exports = { Deployment, MAX_TIMEOUT, ONE_GIGABYTE, SIZE_LIMIT_DESCRIPTION }
+module.exports = {
+  Deployment,
+  MAX_TIMEOUT,
+  DEFAULT_REPORTING_INTERVAL,
+  MAX_REPORTING_INTERVAL,
+  ONE_GIGABYTE,
+  SIZE_LIMIT_DESCRIPTION
+}