Merge branch 'status_reducer_rewrite'

package.json

@@ -13,6 +13,8 @@
     "lint": "eslint --ext .js,.vue src test/unit/specs test/e2e/specs"
   },
   "dependencies": {
+    "diff": "^3.0.1",
+    "karma-mocha-reporter": "^2.2.1",
     "moment": "^2.15.2",
     "node-sass": "^3.10.1",
     "sanitize-html": "^1.13.0",

src/modules/statuses.js

@@ -1,7 +1,7 @@
-import { reduce, map, slice, last, intersectionBy, sortBy, unionBy, toInteger, groupBy, differenceBy, each, find } from 'lodash'
+import { map, slice, sortBy, toInteger, each, find, flatten, maxBy, last, merge, max } from 'lodash'
 import moment from 'moment'
 import apiService from '../services/api/api.service.js'
-import parse from '../services/status_parser/status_parser.js'
+// import parse from '../services/status_parser/status_parser.js'
 
 export const defaultState = {
   allStatuses: [],
@@ -37,66 +37,17 @@ export const defaultState = {
   }
 }
 
-const statusType = (status) => {
+export const prepareStatus = (status) => {
-  return !status.is_post_verb && status.uri.match(/fave/) ? 'fave' : 'status'
+  // Parse nsfw tags
-}
+  if (status.nsfw === undefined) {
-
-const addStatusesToTimeline = (addedStatuses, showImmediately, { statuses, visibleStatuses, newStatusCount, faves, loading }) => {
-  const statusesAndFaves = groupBy(addedStatuses, statusType)
-  const addedFaves = statusesAndFaves['fave'] || []
-  const unseenFaves = differenceBy(addedFaves, faves, 'id')
-
-  // Update fave count
-  each(unseenFaves, ({in_reply_to_status_id}) => {
-    const status = find(statuses, { id: toInteger(in_reply_to_status_id) })
-    if (status) {
-      status.fave_num += 1
-    }
-  })
-
-  addedStatuses = statusesAndFaves['status'] || []
-
-  // Add some html and nsfw to the statuses.
-  addedStatuses = map(addedStatuses, (status) => {
-    const statusoid = status.retweeted_status || status
-
-    statusoid.created_at_parsed = statusoid.created_at
-    // statusoid.statusnet_html = parse(statusoid.statusnet_html)
-
-    if (statusoid.nsfw === undefined) {
     const nsfwRegex = /#nsfw/i
-      statusoid.nsfw = statusoid.text.match(nsfwRegex)
+    status.nsfw = !!status.text.match(nsfwRegex)
   }
 
+  // Set created_at_parsed to initial value
+  status.created_at_parsed = status.created_at
+
   return status
-  })
-
-  const newStatuses = sortBy(
-    unionBy(addedStatuses, statuses, 'id'),
-    ({id}) => -id
-  )
-
-  let newNewStatusCount = newStatusCount + (newStatuses.length - statuses.length)
-
-  let newVisibleStatuses = visibleStatuses
-
-  if (showImmediately) {
-    newVisibleStatuses = unionBy(addedStatuses, newVisibleStatuses, 'id')
-    newVisibleStatuses = sortBy(newVisibleStatuses, ({id}) => -id)
-    newNewStatusCount = newStatusCount
-  };
-
-  newVisibleStatuses = intersectionBy(newStatuses, newVisibleStatuses, 'id')
-
-  return {
-    statuses: newStatuses,
-    visibleStatuses: newVisibleStatuses,
-    newStatusCount: newNewStatusCount,
-    maxId: newStatuses[0].id,
-    minVisibleId: (last(newVisibleStatuses) || { id: undefined }).id,
-    faves: unionBy(faves, addedFaves, 'id'),
-    loading
-  }
 }
 
 const updateTimestampsInStatuses = (statuses) => {
@@ -109,29 +60,109 @@ const updateTimestampsInStatuses = (statuses) => {
   })
 }
 
+const statusType = (status) => {
+  if (status.is_post_verb) {
+    return 'status'
+  }
+
+  if (status.retweeted_status) {
+    return 'retweet'
+  }
+
+  if (typeof status.uri === 'string' && status.uri.match(/fave/)) {
+    return 'favorite'
+  }
+
+  return 'unknown'
+}
+
+export const findMaxId = (...args) => {
+  return (maxBy(flatten(args), 'id') || {}).id
+}
+
+const mergeOrAdd = (arr, item) => {
+  const oldItem = find(arr, {id: item.id})
+  if (oldItem) {
+    // We already have this, so only merge the new info.
+    merge(oldItem, item)
+    return oldItem
+  } else {
+    // This is a new item, prepare it
+    prepareStatus(item)
+    arr.push(item)
+    return item
+  }
+}
+
 export const mutations = {
   addNewStatuses (state, { statuses, showImmediately = false, timeline }) {
-    state.timelines[timeline] = addStatusesToTimeline(statuses, showImmediately, state.timelines[timeline])
+    const allStatuses = state.allStatuses
-    state.allStatuses = unionBy(state.timelines[timeline].statuses, state.allStatuses, 'id')
+    const timelineObject = state.timelines[timeline]
 
-    // Set up retweets with most current status
+    // Set the maxId to the new id if it's larger.
-    const getRetweets = (result, status) => {
+    const updateMaxId = ({id}) => {
-      if (status.retweeted_status) {
+      timelineObject.maxId = max([id, timelineObject.maxId])
-        result.push(status.retweeted_status)
-      }
-      return result
     }
 
-    const retweets = reduce(statuses, getRetweets, [])
+    const addStatus = (status, showImmediately, addToTimeline = true) => {
+      // Remember the current amount of statuses
+      // We need that to calculate new status count.
+      const prevLength = timelineObject.statuses.length
 
-    state.allStatuses = unionBy(retweets, state.allStatuses, 'id')
+      updateMaxId(status)
 
-    each(state.allStatuses, (status) => {
+      status = mergeOrAdd(allStatuses, status)
-      if (status.retweeted_status) {
+
-        const retweetedStatus = find(state.allStatuses, { id: status.retweeted_status.id })
+      // Some statuses should only be added to the global status repository.
-        status.retweeted_status = retweetedStatus
+      if (addToTimeline) {
+        mergeOrAdd(timelineObject.statuses, status)
       }
+
+      if (showImmediately) {
+        // Add it directly to the visibleStatuses, don't change
+        // newStatusCount
+        mergeOrAdd(timelineObject.visibleStatuses, status)
+      } else {
+        // Just change newStatuscount
+        timelineObject.newStatusCount += (timelineObject.statuses.length - prevLength)
+      }
+
+      return status
+    }
+
+    const favoriteStatus = (favorite) => {
+      const status = find(allStatuses, { id: toInteger(favorite.in_reply_to_status_id) })
+      if (status) {
+        status.fave_num += 1
+      }
+      return status
+    }
+
+    const processors = {
+      'status': (status) => {
+        addStatus(status, showImmediately)
+      },
+      'retweet': (status) => {
+        // RetweetedStatuses are never shown immediately
+        const retweetedStatus = addStatus(status.retweeted_status, false, false)
+        const retweet = addStatus(status, showImmediately)
+        retweet.retweeted_status = retweetedStatus
+      },
+      'favorite': (status) => {
+        updateMaxId(status)
+        favoriteStatus(status)
+      }
+    }
+
+    each(statuses, (status) => {
+      const type = statusType(status)
+      processors[type](status)
     })
+
+    // Keep the visible statuses sorted
+    timelineObject.visibleStatuses = sortBy(timelineObject.visibleStatuses, ({id}) => -id)
+    timelineObject.statuses = sortBy(timelineObject.statuses, ({id}) => -id)
+    timelineObject.minVisibleId = (last(timelineObject.statuses) || {}).id
   },
   showNewStatuses (state, { timeline }) {
     const oldTimeline = (state.timelines[timeline])

test/unit/karma.conf.js

@@ -55,7 +55,7 @@ module.exports = function (config) {
     // 2. add it to the `browsers` array below.
     browsers: ['PhantomJS'],
     frameworks: ['mocha', 'sinon-chai'],
-    reporters: ['spec'],
+    reporters: ['mocha'],
     files: ['./index.js'],
     preprocessors: {
       './index.js': ['webpack', 'sourcemap']
@@ -64,6 +64,9 @@ module.exports = function (config) {
     webpackMiddleware: {
       noInfo: true
     },
+    mochaReporter: {
+      showDiff: true
+    },
     coverageReporter: {
       dir: './coverage',
       reporters: [

test/unit/specs/modules/statuses.spec.js

@@ -1,16 +1,58 @@
 import { cloneDeep } from 'lodash'
-import { defaultState, mutations } from '../../../../src/modules/statuses.js'
+import { defaultState, mutations, findMaxId, prepareStatus } from '../../../../src/modules/statuses.js'
 
-const makeMockStatus = ({id, text}) => {
+const makeMockStatus = ({id, text, is_post_verb = true}) => {
   return {
     id,
     name: 'status',
     text: text || `Text number ${id}`,
     fave_num: 0,
-    uri: ''
+    uri: '',
+    is_post_verb
   }
 }
 
+describe('Statuses.prepareStatus', () => {
+  it('sets nsfw for statuses with the #nsfw tag', () => {
+    const safe = makeMockStatus({id: 1, text: 'Hello oniichan'})
+    const nsfw = makeMockStatus({id: 1, text: 'Hello oniichan #nsfw'})
+
+    expect(prepareStatus(safe).nsfw).to.eq(false)
+    expect(prepareStatus(nsfw).nsfw).to.eq(true)
+  })
+
+  it('leaves existing nsfw settings alone', () => {
+    const nsfw = makeMockStatus({id: 1, text: 'Hello oniichan #nsfw'})
+    nsfw.nsfw = false
+
+    expect(prepareStatus(nsfw).nsfw).to.eq(false)
+  })
+
+  it('sets the created_at_parsed property', () => {
+    const status = makeMockStatus({id: 1})
+    status.created_at = ''
+    expect(status.created_at_parsed).to.eq(undefined)
+
+    const prepared = prepareStatus(status)
+    expect(prepared.created_at_parsed).to.not.eq(undefined)
+  })
+})
+
+describe('Statuses.findMaxId', () => {
+  it('returns the largest id in any of the given arrays', () => {
+    const statusesOne = [{ id: 100 }, { id: 2 }]
+    const statusesTwo = [{ id: 3 }]
+
+    const maxId = findMaxId(statusesOne, statusesTwo)
+    expect(maxId).to.eq(100)
+  })
+
+  it('returns undefined for empty arrays', () => {
+    const maxId = findMaxId([], [])
+    expect(maxId).to.eq(undefined)
+  })
+})
+
 describe('The Statuses module', () => {
   it('adds the status to allStatuses and to the given timeline', () => {
     const state = cloneDeep(defaultState)
@@ -21,6 +63,7 @@ describe('The Statuses module', () => {
     expect(state.allStatuses).to.eql([status])
     expect(state.timelines.public.statuses).to.eql([status])
     expect(state.timelines.public.visibleStatuses).to.eql([])
+    expect(state.timelines.public.newStatusCount).to.equal(1)
   })
 
   it('adds the status to allStatuses and to the given timeline, directly visible', () => {
@@ -32,12 +75,30 @@ describe('The Statuses module', () => {
     expect(state.allStatuses).to.eql([status])
     expect(state.timelines.public.statuses).to.eql([status])
     expect(state.timelines.public.visibleStatuses).to.eql([status])
+    expect(state.timelines.public.newStatusCount).to.equal(0)
+  })
+
+  it('keeps a descending by id order in timeline.visibleStatuses and timeline.statuses', () => {
+    const state = cloneDeep(defaultState)
+    const status = makeMockStatus({id: 2})
+    const statusTwo = makeMockStatus({id: 1})
+    const statusThree = makeMockStatus({id: 3})
+
+    mutations.addNewStatuses(state, { statuses: [status], showImmediately: true, timeline: 'public' })
+    mutations.addNewStatuses(state, { statuses: [statusTwo], showImmediately: true, timeline: 'public' })
+
+    expect(state.timelines.public.minVisibleId).to.equal(1)
+
+    mutations.addNewStatuses(state, { statuses: [statusThree], showImmediately: true, timeline: 'public' })
+
+    expect(state.timelines.public.statuses).to.eql([statusThree, status, statusTwo])
+    expect(state.timelines.public.visibleStatuses).to.eql([statusThree, status, statusTwo])
   })
 
   it('splits retweets from their status and links them', () => {
     const state = cloneDeep(defaultState)
     const status = makeMockStatus({id: 1})
-    const retweet = makeMockStatus({id: 2})
+    const retweet = makeMockStatus({id: 2, is_post_verb: false})
     const modStatus = makeMockStatus({id: 1, text: 'something else'})
 
     retweet.retweeted_status = status
@@ -45,12 +106,18 @@ describe('The Statuses module', () => {
     // It adds both statuses, but only the retweet to visible.
     mutations.addNewStatuses(state, { statuses: [retweet], timeline: 'public', showImmediately: true })
     expect(state.timelines.public.visibleStatuses).to.have.length(1)
-    expect(state.allStatuses).to.eql([status, retweet])
+    expect(state.timelines.public.statuses).to.have.length(1)
+    expect(state.allStatuses).to.have.length(2)
+    expect(state.allStatuses[0].id).to.equal(1)
+    expect(state.allStatuses[1].id).to.equal(2)
 
     // It refers to the modified status.
     mutations.addNewStatuses(state, { statuses: [modStatus], timeline: 'public' })
-    expect(state.allStatuses).to.eql([retweet, modStatus])
+    expect(state.allStatuses).to.have.length(2)
-    expect(retweet.retweeted_status).to.eql(modStatus)
+    expect(state.allStatuses[0].id).to.equal(1)
+    expect(state.allStatuses[0].text).to.equal(modStatus.text)
+    expect(state.allStatuses[1].id).to.equal(2)
+    expect(retweet.retweeted_status.text).to.eql(modStatus.text)
   })
 
   it('replaces existing statuses with the same id', () => {
@@ -67,7 +134,26 @@ describe('The Statuses module', () => {
     mutations.addNewStatuses(state, { statuses: [modStatus], showImmediately: true, timeline: 'public' })
     expect(state.timelines.public.visibleStatuses).to.have.length(1)
     expect(state.allStatuses).to.have.length(1)
-    expect(state.allStatuses[0]).to.equal(modStatus)
+    expect(state.allStatuses[0].text).to.eql(modStatus.text)
+  })
+
+  it('replaces existing statuses with the same id, coming from a retweet', () => {
+    const state = cloneDeep(defaultState)
+    const status = makeMockStatus({id: 1})
+    const modStatus = makeMockStatus({id: 1, text: 'something else'})
+    const retweet = makeMockStatus({id: 2, is_post_verb: false})
+    retweet.retweeted_status = modStatus
+
+    // Add original status
+    mutations.addNewStatuses(state, { statuses: [status], showImmediately: true, timeline: 'public' })
+    expect(state.timelines.public.visibleStatuses).to.have.length(1)
+    expect(state.allStatuses).to.have.length(1)
+
+    // Add new version of status
+    mutations.addNewStatuses(state, { statuses: [retweet], showImmediately: false, timeline: 'public' })
+    expect(state.timelines.public.visibleStatuses).to.have.length(1)
+    expect(state.allStatuses).to.have.length(2)
+    expect(state.allStatuses[0].text).to.eql(modStatus.text)
   })
 
   it('handles favorite actions', () => {
@@ -77,7 +163,7 @@ describe('The Statuses module', () => {
     const favorite = {
       id: 2,
       is_post_verb: false,
-      in_reply_to_status_id: 1, // The API uses strings here...
+      in_reply_to_status_id: '1', // The API uses strings here...
       uri: 'tag:shitposter.club,2016-08-21:fave:3895:note:773501:2016-08-21T16:52:15+00:00',
       text: 'a favorited something by b'
     }
@@ -87,11 +173,6 @@ describe('The Statuses module', () => {
 
     expect(state.timelines.public.visibleStatuses.length).to.eql(1)
     expect(state.timelines.public.visibleStatuses[0].fave_num).to.eql(1)
-
+    expect(state.timelines.public.maxId).to.eq(favorite.id)
-    // Adding again shouldn't change anything
-    mutations.addNewStatuses(state, { statuses: [favorite], showImmediately: true, timeline: 'public' })
-
-    expect(state.timelines.public.visibleStatuses.length).to.eql(1)
-    expect(state.timelines.public.visibleStatuses[0].fave_num).to.eql(1)
   })
 })

yarn.lock

@@ -1061,7 +1061,7 @@ chai@^3.5.0:
     deep-eql "^0.1.3"
     type-detect "^1.0.0"
 
-chalk@^1.0.0, chalk@^1.1.0, chalk@^1.1.1, chalk@^1.1.3:
+chalk@^1.0.0, chalk@^1.1.0, chalk@^1.1.1, chalk@^1.1.3, chalk@1.1.3:
   version "1.1.3"
   resolved "https://registry.yarnpkg.com/chalk/-/chalk-1.1.3.tgz#a8115c55e4a702fe4d150abd3872822a7e09fc98"
   dependencies:
@@ -1656,6 +1656,10 @@ di@^0.0.1:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/di/-/di-0.0.1.tgz#806649326ceaa7caa3306d75d985ea2748ba913c"
 
+diff:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/diff/-/diff-3.0.1.tgz#a52d90cc08956994be00877bff97110062582c35"
+
 diff@1.4.0:
   version "1.4.0"
   resolved "https://registry.yarnpkg.com/diff/-/diff-1.4.0.tgz#7f28d2eb9ee7b15a97efd89ce63dcfdaa3ccbabf"
@@ -3141,6 +3145,12 @@ karma-coverage@^1.1.1:
     minimatch "^3.0.0"
     source-map "^0.5.1"
 
+karma-mocha-reporter:
+  version "2.2.1"
+  resolved "https://registry.yarnpkg.com/karma-mocha-reporter/-/karma-mocha-reporter-2.2.1.tgz#8508b2f0925433a6417f0c528e53fcb411745758"
+  dependencies:
+    chalk "1.1.3"
+
 karma-mocha@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/karma-mocha/-/karma-mocha-1.2.0.tgz#bca6be2a66805b847417e8d2873fd0b5b27ee7cd"