Fix callback-return issues (#8996)

See [`callback-return`](https://eslint.org/docs/rules/callback-return) for more information.

This change enables `callback-return` and fixes the resulting issues.

.eslintrc.js

@@ -43,6 +43,7 @@ module.exports = {
   rules: {
     /* TODO: Remove these when upgrading to `@metamask/eslint-config@2` */
     'array-callback-return': 'error',
+    'callback-return': 'error',
     /* End v2 rules */
     'arrow-parens': 'error',
     'no-tabs': 'error',

app/scripts/controllers/permissions/methodMiddleware.js

@@ -107,6 +107,7 @@ export default function createMethodMiddleware ({
     }
 
     // when this promise resolves, the response is on its way back
+    // eslint-disable-next-line callback-return
     await next()
 
     if (responseHandler) {

app/scripts/controllers/preferences.js

@@ -206,13 +206,15 @@ export default class PreferencesController {
             res.result = result
             end()
           }
-          break
+          return
         default:
           end(new Error(`Asset of type ${type} not supported`))
+          return
       }
-    } else {
-      next()
     }
+
+    next()
+    return
   }
 
   /**

app/scripts/metamask-controller.js

@@ -1119,6 +1119,7 @@ export default class MetamaskController extends EventEmitter {
     messageManager.rejectMsg(msgId)
     if (cb && typeof cb === 'function') {
       cb(null, this.getState())
+      return
     }
   }
 
@@ -1177,6 +1178,7 @@ export default class MetamaskController extends EventEmitter {
     messageManager.rejectMsg(msgId)
     if (cb && typeof cb === 'function') {
       cb(null, this.getState())
+      return
     }
   }
 
@@ -1261,6 +1263,7 @@ export default class MetamaskController extends EventEmitter {
     messageManager.rejectMsg(msgId)
     if (cb && typeof cb === 'function') {
       cb(null, this.getState())
+      return
     }
   }
 
@@ -1318,6 +1321,7 @@ export default class MetamaskController extends EventEmitter {
     messageManager.rejectMsg(msgId)
     if (cb && typeof cb === 'function') {
       cb(null, this.getState())
+      return
     }
   }
 
@@ -1377,6 +1381,7 @@ export default class MetamaskController extends EventEmitter {
     messageManager.rejectMsg(msgId)
     if (cb && typeof cb === 'function') {
       cb(null, this.getState())
+      return
     }
   }
 
@@ -1843,8 +1848,10 @@ export default class MetamaskController extends EventEmitter {
       this.currencyRateController.update(currencyState)
       this.currencyRateController.configure(currencyState)
       cb(null, this.currencyRateController.state)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
@@ -1925,8 +1932,10 @@ export default class MetamaskController extends EventEmitter {
     try {
       this.preferencesController.setUseBlockie(val)
       cb(null)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
@@ -1939,8 +1948,10 @@ export default class MetamaskController extends EventEmitter {
     try {
       this.preferencesController.setUseNonceField(val)
       cb(null)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
@@ -1953,8 +1964,10 @@ export default class MetamaskController extends EventEmitter {
     try {
       this.preferencesController.setUsePhishDetect(val)
       cb(null)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
@@ -1967,8 +1980,10 @@ export default class MetamaskController extends EventEmitter {
     try {
       this.preferencesController.setIpfsGateway(val)
       cb(null)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
@@ -1981,17 +1996,21 @@ export default class MetamaskController extends EventEmitter {
     try {
       const metaMetricsId = this.preferencesController.setParticipateInMetaMetrics(bool)
       cb(null, metaMetricsId)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
   setMetaMetricsSendCount (val, cb) {
     try {
       this.preferencesController.setMetaMetricsSendCount(val)
       cb(null)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
@@ -2004,8 +2023,10 @@ export default class MetamaskController extends EventEmitter {
     try {
       this.preferencesController.setFirstTimeFlowType(type)
       cb(null)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 
@@ -2019,8 +2040,10 @@ export default class MetamaskController extends EventEmitter {
     try {
       const direction = this.preferencesController.setCurrentLocale(key)
       cb(null, direction)
+      return
     } catch (err) {
       cb(err)
+      return
     }
   }
 

app/scripts/platforms/extension.js

@@ -105,6 +105,7 @@ export default class ExtensionPlatform {
       })
     } catch (e) {
       cb(e)
+      return
     }
   }
 

test/e2e/helpers.js

@@ -33,6 +33,7 @@ async function withFixtures (options, callback) {
     const { driver } = await buildWebDriver(driverOptions)
     webDriver = driver
 
+    // eslint-disable-next-line callback-return
     await callback({
       driver,
     })

test/unit/app/controllers/metamask-controller-test.js

@@ -53,9 +53,9 @@ const createLoggerMiddlewareMock = () => (req, res, next) => {
       loggerMiddlewareMock.responses.push(res)
       cb()
     })
-  } else {
-    next()
+    return
   }
+  next()
 }
 
 const MetaMaskController = proxyquire('../../../../app/scripts/metamask-controller', {
@@ -839,9 +839,9 @@ describe('MetaMaskController', function () {
       const streamTest = createThoughStream((chunk, _, cb) => {
         if (chunk.data && chunk.data.method) {
           cb(null, chunk)
-        } else {
-          cb()
+          return
         }
+        cb()
       })
 
       metamaskController.setupUntrustedCommunication(streamTest, messageSender)
@@ -877,9 +877,9 @@ describe('MetaMaskController', function () {
       const streamTest = createThoughStream((chunk, _, cb) => {
         if (chunk.data && chunk.data.method) {
           cb(null, chunk)
-        } else {
-          cb()
+          return
         }
+        cb()
       })
 
       metamaskController.setupUntrustedCommunication(streamTest, messageSender)