fix: expose isRequestRetryable as a static method on Client and add unit tests

Author: ionutmanolache-okta

lib/client.js

@@ -146,7 +146,7 @@ module.exports = function (dependencies) {
    * @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) {
+  Client.isRequestRetryable = function isRequestRetryable(error) {
     const isStatusCodeRetryable = [408, 429, 500, 502, 503, 504].includes(error.status);
 
     const isProviderTokenExpired =
@@ -156,7 +156,7 @@ module.exports = function (dependencies) {
     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 retryCount = count || 0;
@@ -217,7 +217,7 @@ module.exports = function (dependencies) {
         );
         return { ...subDirectoryInformation, ...sentRequest };
       } catch (error) {
-        if (isRequestRetryable(error)) {
+        if (Client.isRequestRetryable(error)) {
           try {
             const resentRequest = await this.retryRequest(
               error,
@@ -268,7 +268,7 @@ module.exports = function (dependencies) {
         );
         return { ...subDirectoryInformation, ...sentRequest };
       } catch (error) {
-        if (isRequestRetryable(error)) {
+        if (Client.isRequestRetryable(error)) {
           try {
             const resentRequest = await this.retryRequest(
               error,

test/isRequestRetryable.unit.js

@@ -0,0 +1,61 @@
+const { expect } = require('chai');
+const Client = require('../lib/client')({
+  logger: { enabled: false, log: () => {} },
+  errorLogger: { enabled: false, log: () => {} },
+  config: () => ({}),
+  http2: { constants: {} },
+});
+
+describe('Client.isRequestRetryable', () => {
+  it('returns true for error.message starting with "apn write failed"', () => {
+    const error = { error: { message: 'apn write failed: socket hang up' } };
+    expect(Client.isRequestRetryable(error)).to.be.true;
+  });
+
+  it('returns false for error.message starting with "apn write timeout" (not retryable)', () => {
+    const error = { error: { message: 'apn write timeout: timed out' } };
+    expect(Client.isRequestRetryable(error)).to.be.false;
+  });
+
+  it('returns false for error.message starting with "apn write aborted" (not retryable)', () => {
+    const error = { error: { message: 'apn write aborted: aborted' } };
+    expect(Client.isRequestRetryable(error)).to.be.false;
+  });
+
+  it('returns false for error.message with other apn messages', () => {
+    const error = { error: { message: 'apn connection closed' } };
+    expect(Client.isRequestRetryable(error)).to.be.false;
+  });
+
+  it('returns false for null error.error', () => {
+    const error = { error: null };
+    expect(Client.isRequestRetryable(error)).to.be.false;
+  });
+
+  it('returns false for undefined error.error', () => {
+    const error = {};
+    expect(Client.isRequestRetryable(error)).to.be.false;
+  });
+
+  it('returns false for error.error.message not matching', () => {
+    const error = { error: { message: 'some other error' } };
+    expect(Client.isRequestRetryable(error)).to.be.false;
+  });
+
+  it('returns true for retryable status codes', () => {
+    [408, 429, 500, 502, 503, 504].forEach(status => {
+      expect(Client.isRequestRetryable({ status })).to.be.true;
+    });
+  });
+
+  it('returns true for ExpiredProviderToken', () => {
+    const error = { status: 403, error: { message: 'ExpiredProviderToken' } };
+    expect(Client.isRequestRetryable(error)).to.be.true;
+  });
+
+  it('returns false for non-retryable status codes', () => {
+    [200, 201, 400, 404, 401, 403].forEach(status => {
+      expect(Client.isRequestRetryable({ status })).to.be.false;
+    });
+  });
+});