Merge pull request #14771 from ryanml/browsing-time-fix

Dismissing browser activity notice when browsing time has met/surpassed 30 minutes

Author: NejcZdovc

app/browser/api/ledger.js

@@ -190,6 +190,7 @@ const paymentPresent = (state, tabId, present) => {
   }
   if (present) {
     appActions.onPromotionGet()
+
     if (togglePromotionTimeoutId) {
       clearTimeout(togglePromotionTimeoutId)
     }
@@ -1113,6 +1114,38 @@ const pageDataChanged = (state, viewData = {}, keepInfo = false) => {
   }
 
   state = addNewLocation(state, location, tabId, keepInfo)
+  appActions.onCheckBrowserActivityTime()
+
+  return state
+}
+
+const checkBrowserActivityTime = (state) => {
+  // Fuzzing threshold
+  const minTime = 30 * ledgerUtil.milliseconds.minute
+  const publishers = ledgerState.getPublishers(state)
+
+  if (publishers.isEmpty()) {
+    return state
+  }
+
+  const ledgerStatus = ledgerState.getAboutProp(state, 'status')
+  const curBrowsingTime = ledgerState.getAboutProp(state, 'browsingTime') || 0
+
+  // Check cached browsing time to avoid unneeded recalculation
+  if (curBrowsingTime >= minTime || ledgerStatus !== ledgerStatuses.FUZZING) {
+    return state
+  }
+
+  const browsingTime = publishers.reduce((acc, publisher) => {
+    return acc + publisher.get('duration')
+  }, 0)
+
+  // Cache browsing time
+  state = ledgerState.setAboutProp(state, 'browsingTime', browsingTime)
+
+  if (browsingTime >= minTime && ledgerStatus === ledgerStatuses.FUZZING) {
+    state = ledgerState.setAboutProp(state, 'status', '')
+  }
 
   return state
 }
@@ -3371,7 +3404,8 @@ const getMethods = () => {
     getPublisherInfo,
     checkPublisherInfoUpdate,
     updatePublishersInfo,
-    runPublishersUpdate
+    runPublishersUpdate,
+    checkBrowserActivityTime
   }
 
   let privateMethods = {}

app/browser/reducers/ledgerReducer.js

@@ -604,6 +604,11 @@ const ledgerReducer = (state, action, immutableAction) => {
         )
         break
       }
+    case appConstants.APP_ON_CHECK_BROWSER_ACTIVITY_TIME:
+      {
+        state = ledgerApi.checkBrowserActivityTime(state)
+        break
+      }
   }
   return state
 }

docs/state.md

@@ -189,6 +189,7 @@ AppStore
   },
   ledger: {
     about: {
+      browsingTime: number, // A total of publisher visit time
       synopsis: Array.Object,
       synopsisOptions: Object
     },

js/actions/appActions.js

@@ -2109,6 +2109,12 @@ const appActions = {
       tabId,
       index
     })
+  },
+
+  onCheckBrowserActivityTime: function () {
+    dispatch({
+      actionType: appConstants.APP_ON_CHECK_BROWSER_ACTIVITY_TIME
+    })
   }
 }
 

js/constants/appConstants.js

@@ -217,7 +217,8 @@ const appConstants = {
   APP_ON_NOTIFICATION_RESPONSE: _,
   APP_ON_PUBLISHERS_INFO_RECEIVED: _,
   APP_ON_PUBLISHERS_INFO_WRITE: _,
-  APP_ON_PUBLISHERS_INFO_READ: _
+  APP_ON_PUBLISHERS_INFO_READ: _,
+  APP_ON_CHECK_BROWSER_ACTIVITY_TIME: _
 }
 
 module.exports = mapValuesByKeys(appConstants)

test/unit/app/browser/api/ledgerTest.js

@@ -4211,4 +4211,155 @@ describe('ledger api unit tests', function () {
       assert.equal(true, synopsis.publishers['clifton.io'].options.verified)
     })
   })
+
+  describe('checkBrowserActivityTime', function () {
+    afterEach(function () {
+      ledgerApi.setSynopsis(undefined)
+    })
+
+    it('returns state when there are no publishers', function () {
+      const synopsis = {
+        options: {},
+        publishers: {}
+      }
+      const state = defaultAppState
+        .setIn(['ledger', 'synopsis'], Immutable.fromJS(synopsis))
+
+      ledgerApi.setSynopsis(synopsis)
+
+      const result = ledgerApi.checkBrowserActivityTime(state)
+      assert.deepEqual(result.toJS(), state.toJS())
+    })
+
+    it('returns state if browsingTime is cached at >= 30 minutes, and ledger doesn\'t have a fuzzed status', function () {
+      const synopsis = {
+        options: {},
+        publishers: {
+          'brave.com': {
+            visits: 2,
+            duration: 1080000
+          },
+          'clifton.io': {
+            visits: 3,
+            duration: 1200000
+          }
+        }
+      }
+      const state = defaultAppState
+        .setIn(['ledger', 'synopsis'], Immutable.fromJS(synopsis))
+        .setIn(['ledger', 'about', 'browsingTime'], 2280000)
+
+      ledgerApi.setSynopsis(synopsis)
+
+      const result = ledgerApi.checkBrowserActivityTime(state)
+      assert.deepEqual(result.toJS(), state.toJS())
+    })
+
+    it('return state if cached time is less than 30 minutes and status is not fuzzed', function () {
+      const synopsis = {
+        options: {},
+        publishers: {
+          'brave.com': {
+            visits: 2,
+            duration: 420000
+          },
+          'clifton.io': {
+            visits: 3,
+            duration: 425000
+          }
+        }
+      }
+      const state = defaultAppState
+        .setIn(['ledger', 'synopsis'], Immutable.fromJS(synopsis))
+        .setIn(['ledger', 'about', 'status'], ledgerStatuses.CORRUPTED_SEED)
+
+      ledgerApi.setSynopsis(synopsis)
+
+      const result = ledgerApi.checkBrowserActivityTime(state)
+      assert.deepEqual(result.toJS(), state.toJS())
+    })
+
+    it('does not unset status if browsing time is less than 30 minutes, and ledger has a fuzzed status', function () {
+      const synopsis = {
+        options: {},
+        publishers: {
+          'brave.com': {
+            visits: 2,
+            duration: 20000
+          },
+          'clifton.io': {
+            visits: 3,
+            duration: 40000
+          }
+        }
+      }
+      const state = defaultAppState
+        .setIn(['ledger', 'synopsis'], Immutable.fromJS(synopsis))
+        .setIn(['ledger', 'about', 'status'], ledgerStatuses.FUZZING)
+
+      const expectedState = state
+        .setIn(['ledger', 'about', 'browsingTime'], 60000)
+
+      ledgerApi.setSynopsis(synopsis)
+
+      const result = ledgerApi.checkBrowserActivityTime(state)
+      assert.deepEqual(result.toJS(), expectedState.toJS())
+    })
+
+    it('unsets status if browsingTime is >= 30 minutes and ledgerStatus is fuzzing', function () {
+      const synopsis = {
+        options: {},
+        publishers: {
+          'brave.com': {
+            visits: 2,
+            duration: 1080000
+          },
+          'clifton.io': {
+            visits: 3,
+            duration: 1200000
+          }
+        }
+      }
+      const state = defaultAppState
+        .setIn(['ledger', 'synopsis'], Immutable.fromJS(synopsis))
+        .setIn(['ledger', 'about', 'status'], ledgerStatuses.FUZZING)
+
+      const expectedState = state
+        .setIn(['ledger', 'about', 'browsingTime'], 2280000)
+        .setIn(['ledger', 'about', 'status'], '')
+
+      ledgerApi.setSynopsis(synopsis)
+
+      const result = ledgerApi.checkBrowserActivityTime(state)
+      assert.deepEqual(result.toJS(), expectedState.toJS())
+    })
+
+    it('caches browsing time and unsets status if browsing time is greater than 30 minutes', function () {
+      const synopsis = {
+        options: {},
+        publishers: {
+          'brave.com': {
+            visits: 2,
+            duration: 1080000
+          },
+          'clifton.io': {
+            visits: 3,
+            duration: 1200000
+          }
+        }
+      }
+      const state = defaultAppState
+        .setIn(['ledger', 'synopsis'], Immutable.fromJS(synopsis))
+        .setIn(['ledger', 'about', 'status'], ledgerStatuses.FUZZING)
+
+      const expectedState = state
+        .setIn(['ledger', 'about', 'status'], '')
+        .setIn(['ledger', 'about', 'browsingTime'], 2280000)
+
+      ledgerApi.setSynopsis(synopsis)
+
+      const result = ledgerApi.checkBrowserActivityTime(state)
+      assert.deepEqual(result.toJS(), expectedState.toJS())
+    })
+  })
 })