fix(logging): standardize error logs to use %e token

Author: gulshanpr

packages/connection-encrypter-plaintext/src/index.ts

@@ -107,8 +107,8 @@ class Plaintext implements ConnectionEncrypter {
         throw new InvalidCryptoExchangeError('Public key did not match id')
       }
     } catch (err: any) {
-      log.error(err)
-      throw new InvalidCryptoExchangeError('Invalid public key - ' + err.message)
+      log.error('Invalid public key - %e', err)
+      throw new InvalidCryptoExchangeError(`Invalid public key - ${err.message}`)
     }
 
     if (options?.remotePeer != null && !peerId.equals(options?.remotePeer)) {

packages/interface-compliance-tests/src/mocks/connection.ts

@@ -155,11 +155,11 @@ export function mockConnection (maConn: MultiaddrConnection, opts: MockConnectio
 
             await handler({ connection, stream: muxedStream })
           }).catch(err => {
-            log.error(err)
+            log.error('%e', err)
             muxedStream.abort(err)
           })
       } catch (err: any) {
-        log.error(err)
+        log.error('%e', err)
       }
     },
     onStreamEnd: (muxedStream) => {

packages/kad-dht/src/content-fetching/index.ts

@@ -106,7 +106,7 @@ export class ContentFetching {
           this.log(`Storing corrected record for key ${dsKey.toString()}`)
           await this.components.datastore.put(dsKey, fixupRec.subarray(), options)
         } catch (err: any) {
-          this.log.error('Failed error correcting self', err)
+          this.log.error('Failed error correcting self - %e', err)
         }
 
         continue

packages/kad-dht/src/content-routing/index.ts

@@ -115,7 +115,7 @@ export class ContentRouting {
           yield addProviderEvent
         }
       } catch (err: any) {
-        self.log.error('error sending provide record to peer %p', event.peer.id, err)
+        self.log.error('error sending provide record to peer %p - %e', event.peer.id, err)
         yield queryErrorEvent({
           from: event.peer.id,
           error: err,

packages/kad-dht/src/kad-dht.ts

@@ -297,7 +297,7 @@ export class KadDHT extends TypedEventEmitter<PeerDiscoveryEvents> implements Ka
       const peerData = evt.detail
 
       this.onPeerConnect(peerData).catch(err => {
-        this.log.error('could not add %p to routing table', peerData.id, err)
+        this.log.error('could not add %p to routing table - %e', peerData.id, err)
       })
 
       this.dispatchEvent(new CustomEvent('peer', {
@@ -320,7 +320,7 @@ export class KadDHT extends TypedEventEmitter<PeerDiscoveryEvents> implements Ka
 
         await this.onPeerConnect(peerData)
       }).catch(err => {
-        this.log.error('could not add %p to routing table - %e - %e', peerId, err)
+        this.log.error('could not add %p to routing table - %e', peerId, err)
       })
     })
 
@@ -347,7 +347,7 @@ export class KadDHT extends TypedEventEmitter<PeerDiscoveryEvents> implements Ka
           }
         })
           .catch(err => {
-            this.log.error('error setting dht server mode', err)
+            this.log.error('error setting dht server mode - %e', err)
           })
       })
     }
@@ -404,7 +404,7 @@ export class KadDHT extends TypedEventEmitter<PeerDiscoveryEvents> implements Ka
         signal
       })
     } catch (err: any) {
-      this.log.error('could not add %p to routing table', peerData.id, err)
+      this.log.error('could not add %p to routing table - %e', peerData.id, err)
     }
   }
 

packages/kad-dht/src/network.ts

@@ -188,7 +188,7 @@ export class Network extends TypedEventEmitter<NetworkEvents> implements Startab
 
       stream.close(options)
         .catch(err => {
-          this.log.error('error closing stream to %p', to, err)
+          this.log.error('error closing stream to %p - %e', to, err)
           stream?.abort(err)
         })
 
@@ -255,7 +255,7 @@ export class Network extends TypedEventEmitter<NetworkEvents> implements Startab
 
       stream.close(options)
         .catch(err => {
-          this.log.error('error closing stream to %p', to, err)
+          this.log.error('error closing stream to %p - %e', to, err)
           stream?.abort(err)
         })
 

packages/kad-dht/src/query-self.ts

@@ -76,7 +76,7 @@ export class QuerySelf implements Startable {
     this.timeoutId = setTimeout(() => {
       this.querySelf()
         .catch(err => {
-          this.log.error('error running self-query', err)
+          this.log.error('error running self-query - %e', err)
         })
     }, this.initialInterval)
   }
@@ -146,7 +146,7 @@ export class QuerySelf implements Startable {
           }
         }))
       } catch (err: any) {
-        this.log.error('self-query error', err)
+        this.log.error('self-query error - %e', err)
       } finally {
         signal.clear()
 
@@ -167,7 +167,7 @@ export class QuerySelf implements Startable {
     this.timeoutId = setTimeout(() => {
       this.querySelf()
         .catch(err => {
-          this.log.error('error running self-query', err)
+          this.log.error('error running self-query - %e', err)
         })
     }, this.interval)
   }

packages/kad-dht/src/query/manager.ts

@@ -217,7 +217,7 @@ export class QueryManager implements Startable {
       // Execute the query along each disjoint path and yield their results as they become available
       for await (const event of merge(...paths)) {
         if (event.name === 'QUERY_ERROR') {
-          log.error('query error', event.error)
+          log.error('query error - %e', event.error)
         }
 
         if (event.name === 'PEER_RESPONSE') {

packages/kad-dht/src/reprovider.ts

@@ -153,7 +153,7 @@ export class Reprovider extends TypedEventEmitter<ReprovideEvents> {
               })
           }
         } catch (err: any) {
-          this.log.error('error processing datastore key %s - %e', entry.key, err.message)
+          this.log.error('error processing datastore key %s - %s', entry.key, err.message)
         }
       }
 

packages/kad-dht/src/routing-table/refresh.ts

@@ -107,24 +107,24 @@ export class RoutingTableRefresh {
               try {
                 await this._refreshCommonPrefixLength(n, lastRefresh, force, options)
               } catch (err: any) {
-                this.log.error(err)
+                this.log.error('%e', err)
               }
             }
           }
         } catch (err: any) {
-          this.log.error(err)
+          this.log.error('%e', err)
         }
       })
     ).catch(err => {
-      this.log.error(err)
+      this.log.error('%e', err)
     }).then(() => {
       this.refreshTimeoutId = setTimeout(this.refreshTable, this.refreshInterval)
 
       if (this.refreshTimeoutId.unref != null) {
         this.refreshTimeoutId.unref()
       }
     }).catch(err => {
-      this.log.error(err)
+      this.log.error('%e', err)
     })
   }