Merge pull request #616 from daffron/master

Add timeout, and clock tolerance configuration options

README.md

@@ -77,7 +77,8 @@ const xero = new XeroClient({
   redirectUris: [`http://localhost:${port}/callback`],
   scopes: 'openid profile email accounting.transactions offline_access'.split(" "),
   state: 'returnPage=my-sweet-dashboard', // custom params (optional)
-  httpTimeout: 3000 // ms (optional)
+  httpTimeout: 3000, // ms (optional)
+  clockTolerance: 10 // seconds (optional)
 });
 ```
 
@@ -234,7 +235,8 @@ const xero = new XeroClient({
   grantType: 'client_credentials', // only used for client_credentials auth flow
   scopes: 'openid profile email accounting.transactions offline_access'.split(" "), // not used for client_credentials auth flow
   state: 'returnPage=my-sweet-dashboard', // custom params (optional), not used for client_credentials auth flow
-  httpTimeout: 3000 // ms (optional)
+  httpTimeout: 3000, // ms (optional)
+  clockTolerance: 10 // seconds (optional)
 });
 
 xero.accountingApi

src/XeroClient.ts

@@ -12,7 +12,8 @@ export interface IXeroClientConfig {
   grantType?: string;
   scopes?: string[],
   state?: string,
-  httpTimeout?: number
+  httpTimeout?: number,
+  clockTolerance?: number 
 };
 
 export interface XeroIdToken {
@@ -89,8 +90,9 @@ export class XeroClient {
     if (this.config) {
       custom.setHttpOptionsDefaults({
         retry: {
-          maxRetryAfter: this.config.httpTimeout || 2500
-        }
+          maxRetryAfter: this.config.httpTimeout || 3500
+        },
+        timeout: this.config.httpTimeout || 3500
       })
 
       const issuer = await Issuer.discover('https://identity.xero.com');
@@ -100,7 +102,7 @@ export class XeroClient {
         redirect_uris: this.config.redirectUris,
       });
 
-      this.openIdClient[custom.clock_tolerance] = 5;
+      this.openIdClient[custom.clock_tolerance] = this.config.clockTolerance || 5;
     }
     return this;
   }

src/test/xeroClient.spec.ts

@@ -80,6 +80,18 @@ describe('the XeroClient', () => {
       expect(xeroClient.config.httpTimeout).toEqual(3000)
     });
 
+    it('allows for the configuration of the openid-client clock tolerance', async () => {
+      const xeroWithConfig = new XeroClient({
+        clientId: 'YOUR_CLIENT_ID',
+        clientSecret: 'YOUR_CLIENT_SECRET',
+        redirectUris: [`http://localhost:5000/callback`],
+        scopes: 'openid profile email accounting.transactions offline_access'.split(" "),
+        clockTolerance: 10
+      });
+      const xeroClient = await xeroWithConfig.initialize()
+      expect(xeroClient.config?.clockTolerance).toEqual(10)
+    });
+
     it('allows for the configuration of the Xero Client for use of client credentials grant', async () => {
       const xeroCustomConnection = new XeroClient({
         clientId: 'YOUR_CLIENT_ID',