fix: retry transient write failures after receiving goaway

Author: ionutmanolache-okta

lib/client.js

@@ -138,8 +138,27 @@ module.exports = function (dependencies) {
     return subDirectoryObject;
   };
 
+  /**
+   * Determines if a request should be retried based on the error. This includes certain status codes, expired provider token, and transient write failures.
+   * @param {Object} error - An object representing the error which may include the following properties:
+   * @param {number} [error.status] - The HTTP status code returned from the APNs server.
+   * @param {VError} error.error - The error details which may include a message describing the error.
+   * @param {string} [error.error.message] - The error message which may indicate specific conditions such as 'ExpiredProviderToken' or transient write failures.
+   * @returns {boolean} - Returns true if the request is considered retryable based on the error, otherwise false.
+   */
+  function isRequestRetryable(error) {
+    const isStatusCodeRetryable = [408, 429, 500, 502, 503, 504].includes(error.status);
+
+    const isProviderTokenExpired =
+      error.status === 403 && error.error?.message === 'ExpiredProviderToken';
+
+    // This can happen after the server initiates a goaway, and the client did not finish closing and destroying the session yet, so the client tries to send a request on a closing session.
+    const isTransientWriteFailure = !!error.error?.message?.startsWith('apn write failed');
+
+    return isStatusCodeRetryable || isProviderTokenExpired || isTransientWriteFailure;
+  }
+
   Client.prototype.write = async function write(notification, subDirectory, type, method, count) {
-    const retryStatusCodes = [408, 429, 500, 502, 503, 504];
     const retryCount = count || 0;
     const subDirectoryLabel = this.subDirectoryLabel(type) ?? type;
     const subDirectoryInformation = this.makeSubDirectoryTypeObject(
@@ -198,13 +217,7 @@ module.exports = function (dependencies) {
         );
         return { ...subDirectoryInformation, ...sentRequest };
       } catch (error) {
-        // Determine if this is a retryable request.
-        if (
-          retryStatusCodes.includes(error.status) ||
-          (typeof error.error !== 'undefined' &&
-            error.status == 403 &&
-            error.error.message === 'ExpiredProviderToken')
-        ) {
+        if (isRequestRetryable(error)) {
           try {
             const resentRequest = await this.retryRequest(
               error,
@@ -255,13 +268,7 @@ module.exports = function (dependencies) {
         );
         return { ...subDirectoryInformation, ...sentRequest };
       } catch (error) {
-        // Determine if this is a retryable request.
-        if (
-          retryStatusCodes.includes(error.status) ||
-          (typeof error.error !== 'undefined' &&
-            error.status == 403 &&
-            error.error.message === 'ExpiredProviderToken')
-        ) {
+        if (isRequestRetryable(error)) {
           try {
             const resentRequest = await this.retryRequest(
               error,

test/.jshintrc

@@ -1,4 +1,5 @@
 {
+  "esversion": 11,
   "expr": true,
   "strict": false,
   "mocha": true,