feat: better logs during timeout (#1208)

Co-authored-by: Nicolas Moreau <[email protected]>

packages/forestadmin-client/src/utils/server.ts

@@ -15,9 +15,10 @@ export default class ServerUtils {
     body?: string | object,
     maxTimeAllowed = 10000, // Set a default value if not provided
   ): Promise<T> {
-    try {
-      const url = new URL(path, options.forestServerUrl).toString();
+    let url;
 
+    try {
+      url = new URL(path, options.forestServerUrl).toString();
       const request = superagent[method](url).timeout(maxTimeAllowed);
 
       request.set('forest-secret-key', options.envSecret);
@@ -28,7 +29,11 @@ export default class ServerUtils {
       return response.body;
     } catch (error) {
       if (error.timeout) {
-        throw new Error('The request to Forest Admin server has timeout');
+        throw new Error(
+          `The request to Forest Admin server has timed out while trying to reach ${url} at ${new Date().toISOString()}. Message: ${
+            error.message
+          }`,
+        );
       }
 
       this.handleResponseError(error);

packages/forestadmin-client/test/utils/server.test.ts

@@ -104,6 +104,8 @@ describe('ServerUtils', () => {
   });
 
   it('should timeout if the server take more than maxTimeAllowed to respond', async () => {
+    const mockDate = new Date(1466424490000);
+    const spy = jest.spyOn(global, 'Date').mockImplementation(() => mockDate);
     nock(options.forestServerUrl, {
       reqheaders: { 'x-foo': 'bar', 'forest-secret-key': options.envSecret },
     })
@@ -123,7 +125,10 @@ describe('ServerUtils', () => {
         '',
         100, // maxTimeAllowed to respond
       ),
-    ).rejects.toThrow('The request to Forest Admin server has timeout');
+    ).rejects.toThrow(
+      'The request to Forest Admin server has timed out while trying to reach http://forestadmin-server.com/endpoint at 2016-06-20T12:08:10.000Z. Message: Timeout of 100ms exceeded',
+    );
+    spy.mockRestore();
   });
 
   describe('when the server send back a message', () => {