Reduce logging in production builds

Our logger middleware can be quite noisy in production, logging all RPC requests. It has been updated to have more condensed logs in production builds, but preserving the existing logging for development builds.
MetaMask · Sep 4, 2023 · e046338 · e046338
1 parent 52f4936
commit e046338
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 5 deletions.
diff --git a/app/scripts/lib/createLoggerMiddleware.js b/app/scripts/lib/createLoggerMiddleware.js
@@ -1,7 +1,8 @@
 import log from 'loglevel';
 
 /**
- * Returns a middleware that logs RPC activity
+ * Returns a middleware that logs RPC activity. Logging is detailed in
+ * development builds, but more limited in production builds.
  *
  * @param {{ origin: string }} opts - The middleware options
  * @returns {Function}
@@ -14,12 +15,20 @@ export default function createLoggerMiddleware(opts) {
   ) {
     next((/** @type {Function} */ cb) => {
       if (res.error) {
-        log.error('Error in RPC response:\n', res);
+        log.debug('Error in RPC response:\n', res);
       }
       if (req.isMetamaskInternal) {
         return;
       }
-      log.info(`RPC (${opts.origin}):`, req, '->', res);
+      if (process.env.METAMASK_DEBUG) {
+        log.info(`RPC (${opts.origin}):`, req, '->', res);
+      } else {
+        log.info(
+          `RPC (${opts.origin}): ${req.method} -> ${
+            res.error ? 'error' : 'success'
+          }`,
+        );
+      }
       cb();
     });
   };

diff --git a/app/scripts/lib/rpc-method-middleware/createMethodMiddleware.js b/app/scripts/lib/rpc-method-middleware/createMethodMiddleware.js
@@ -65,7 +65,9 @@ export function createMethodMiddleware(hooks) {
           selectHooks(hooks, hookNames),
         );
       } catch (error) {
-        console.error(error);
+        if (process.env.METAMASK_DEBUG) {
+          console.error(error);
+        }
         return end(error);
       }
     }
@@ -101,7 +103,9 @@ export function createSnapMethodMiddleware(isSnap, hooks) {
           selectHooks(hooks, hookNames),
         );
       } catch (error) {
-        console.error(error);
+        if (process.env.METAMASK_DEBUG) {
+          console.error(error);
+        }
         return end(error);
       }
     }