Implement album history feature

Author: jakubito

.prettierignore

@@ -0,0 +1 @@
+CREDITS.md

CREDITS.md

@@ -821,6 +821,26 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
 
 
+-------------------------------------------------------------------------------
+
+## Project
+pretty-bytes
+
+### Source
+https://github.com/sindresorhus/pretty-bytes
+
+### License
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
 -------------------------------------------------------------------------------
 
 ## Project

package.json

@@ -19,6 +19,7 @@
     "localforage": "^1.10.0",
     "lodash": "^4.17.21",
     "moment": "^2.29.4",
+    "pretty-bytes": "^6.1.0",
     "query-string": "^8.1.0",
     "react": "^18.2.0",
     "react-colorful": "^5.6.1",

src/components/settings/GeneralSettings.js

@@ -10,6 +10,7 @@ import FirstDayOfWeekField from './FirstDayOfWeekField'
 import FetchExtraDataField from './FetchExtraDataField'
 import LabelBlocklistField from './LabelBlocklistField'
 import MinimumSavedTracksField from './MinimumSavedTracksField'
+import HistoryField from './HistoryField'
 
 /**
  * Render general settings fields
@@ -27,6 +28,7 @@ function GeneralSettings() {
       <TimePeriodField />
       <FirstDayOfWeekField />
       <UriLinksField />
+      <HistoryField />
       <LabelBlocklistField />
       {user && <DataInfo />}
       {hasAppData && <DataReset />}

src/components/settings/HistoryField.js

@@ -0,0 +1,64 @@
+import { useEffect, useState } from 'react'
+import { useSelector, useDispatch } from 'react-redux'
+import prettyBytes from 'pretty-bytes'
+import { getSettings } from 'state/selectors'
+import { setSettings } from 'state/actions'
+import { defer, sleep } from 'helpers'
+import * as history from 'history'
+import { Button, Checkbox } from 'components/common'
+import HelpText from './HelpText'
+
+function HistoryField() {
+  const { autoHistoryUpdate } = useSelector(getSettings)
+  const dispatch = useDispatch()
+  const [size, setSize] = useState(0)
+  const [cleared, setCleared] = useState(false)
+
+  useEffect(() => {
+    history.size().then(setSize)
+  }, [])
+
+  const clearHistory = () => {
+    history.clear()
+    setCleared(true)
+    setSize(0)
+    sleep(1200).then(() => setCleared(false))
+  }
+
+  return (
+    <div className="HistoryField Settings__field field">
+      <label className="label has-text-light" htmlFor="autoHistoryUpdate">
+        Album history
+      </label>
+      <div className="Settings__help">
+        <HelpText>
+          If enabled, all newly fetched albums will be automatically added to the local history
+          data. This will hide them on subsequent refreshes, making it easier to see what's new.
+        </HelpText>
+      </div>
+      <div className="control">
+        <div className="field">
+          <Checkbox
+            id="autoHistoryUpdate"
+            label="Update album history on refresh"
+            defaultChecked={autoHistoryUpdate}
+            onChange={(event) =>
+              defer(dispatch, setSettings({ autoHistoryUpdate: event.target.checked }))
+            }
+          />
+        </div>
+      </div>
+      <Button
+        title={
+          cleared ? 'Album history cleared' : `Clear album history (${prettyBytes(size)} used)`
+        }
+        icon={cleared && 'fas fa-check-circle'}
+        disabled={cleared}
+        onClick={clearHistory}
+        small
+      />
+    </div>
+  )
+}
+
+export default HistoryField

src/helpers.js

@@ -272,22 +272,19 @@ export function captureException(error) {
  *
  * @param {AlbumRaw[]} albumsRaw
  * @param {string} minDate
+ * @param {AlbumsHistory} history
  */
-export function mergeAlbumsRaw(albumsRaw, minDate) {
+export function mergeAlbumsRaw(albumsRaw, minDate, history) {
   const maxDate = moment().add(1, 'day').format(MomentFormat.ISO_DATE)
   const albumsRawMap = albumsRaw.reduce((map, album) => {
-    if (album.releaseDate < minDate || album.releaseDate > maxDate) {
-      return map
-    }
+    const { id, releaseDate, artistIds } = album
 
-    const matched = map[album.id]
+    if (history.has(id)) return map
+    if (releaseDate < minDate || releaseDate > maxDate) return map
 
-    if (!matched) {
-      map[album.id] = album
-      return map
-    }
+    if (id in map) merge(map[id].artistIds, artistIds)
+    else map[id] = album
 
-    merge(matched.artistIds, album.artistIds)
     return map
   }, /** @type {{ [id: string]: AlbumRaw }} */ ({}))
 

src/history.js

@@ -0,0 +1,44 @@
+import localForage from 'localforage'
+import { Base64 } from 'js-base64'
+
+const storageKey = 'albums-history'
+
+export async function load() {
+  /** @type {AlbumsHistory} */
+  const history = new Set()
+  /** @type {Uint8Array | null} */
+  const byteArray = await localForage.getItem(storageKey)
+  if (!byteArray) return history
+
+  for (let i = 0; i < byteArray.length; i += 17) {
+    const bytes = byteArray.slice(i, i + 17)
+    const id = Base64.fromUint8Array(bytes).slice(0, -2)
+    history.add(id)
+  }
+
+  return history
+}
+
+/** @param {AlbumsHistory} history */
+export function persist(history) {
+  const byteArray = new Uint8Array(history.size * 17)
+  let i = 0
+
+  for (const id of history) {
+    const bytes = Base64.toUint8Array(id + 'A=')
+    byteArray.set(bytes, i)
+    i += 17
+  }
+
+  return localForage.setItem(storageKey, byteArray)
+}
+
+export function clear() {
+  return localForage.removeItem(storageKey)
+}
+
+export async function size() {
+  /** @type {Uint8Array | null} */
+  const byteArray = await localForage.getItem(storageKey)
+  return byteArray?.length ?? 0
+}

src/sagas/notification.js

@@ -1,4 +1,5 @@
 import { call, delay, race, select, take } from 'redux-saga/effects'
+import isEmpty from 'lodash/isEmpty'
 import { createNotification } from 'helpers'
 import { syncFinished } from 'state/actions'
 import { getPreviousSyncMaxDate, getReleasesMaxDate, getSettings } from 'state/selectors'
@@ -26,19 +27,20 @@ function* notificationWorker() {
   yield delay(5 * 1000)
 
   while (true) {
-    yield take(syncFinished.type)
-
+    /** @type {ReturnType<typeof syncFinished>} */
+    const action = yield take(syncFinished.type)
     /** @type {ReturnType<typeof getSettings>} */
-    const { notifications } = yield select(getSettings)
+    const { notifications, autoHistoryUpdate } = yield select(getSettings)
     /** @type {ReturnType<typeof getPreviousSyncMaxDate>} */
     const previousMaxDate = yield select(getPreviousSyncMaxDate)
     /** @type {ReturnType<typeof getReleasesMaxDate>} */
     const currentMaxDate = yield select(getReleasesMaxDate)
 
     if (Notification.permission !== 'granted') continue
     if (!notifications) continue
-    if (!previousMaxDate) continue
-    if (currentMaxDate === previousMaxDate) continue
+    if (isEmpty(action.payload.albums)) continue
+    if (!autoHistoryUpdate && !previousMaxDate) continue
+    if (!autoHistoryUpdate && currentMaxDate === previousMaxDate) continue
 
     yield call(createNotification, 'New music has been released')
   }

src/sagas/root.js

@@ -1,5 +1,6 @@
 import { fork, take, takeEvery, takeLeading } from 'redux-saga/effects'
 import { REHYDRATE } from 'redux-persist'
+import * as history from 'history'
 import {
   authorize,
   authorizeError,
@@ -29,19 +30,15 @@ export function* rootSaga() {
   yield takeEvery(setSettings.type, themeUpdateSaga)
   yield takeEvery(setSettings.type, firstDayOfWeekUpdateSaga)
   yield takeEvery(reset.type, deleteAuthData)
+  yield takeEvery(reset.type, history.clear)
   yield takeEvery(authorizeError.type, authorizeErrorSaga)
   yield takeLeading(authorize.type, authorizeSaga)
   yield takeLeadingCancellable(sync.type, syncCancel.type, syncSaga)
   yield takeLeadingCancellable(createPlaylist.type, createPlaylistCancel.type, createPlaylistSaga)
   yield fork(autoSyncSaga)
 
-  if (navigator.serviceWorker) {
-    yield fork(updateSaga)
-  }
-
-  if (window.Notification) {
-    yield fork(notificationSaga)
-  }
+  if (navigator.serviceWorker) yield fork(updateSaga)
+  if (window.Notification) yield fork(notificationSaga)
 }
 
 export default rootSaga

src/sagas/sync.js

@@ -12,6 +12,8 @@ import {
   getUserSavedTracksPage,
 } from 'api'
 import { getAuthData, getSyncScopes } from 'auth'
+import { buildAlbumsMap, buildArtist, deleteLabels, mergeAlbumsRaw } from 'helpers'
+import * as history from 'history'
 import { getSettings, getReleasesMaxDate } from 'state/selectors'
 import {
   setSyncingProgress,
@@ -29,7 +31,6 @@ import {
   getAllCursorPaged,
   getAllPaged,
 } from './helpers'
-import { buildAlbumsMap, buildArtist, deleteLabels, mergeAlbumsRaw } from 'helpers'
 
 const { ISO_DATE } = MomentFormat
 const { FOLLOWED, SAVED_ALBUMS, SAVED_TRACKS } = ArtistSource
@@ -83,8 +84,10 @@ function* syncMainSaga(action) {
 
   /** @type {ReturnType<typeof getAuthData>} */
   const { token } = yield call(getAuthData)
+  /** @type {Await<ReturnType<typeof history.load>>} */
+  const albumsHistory = yield call(history.load)
   /** @type {ReturnType<typeof getSettings>} */
-  const { days, fullAlbumData, labelBlocklist } = yield select(getSettings)
+  const { days, fullAlbumData, labelBlocklist, autoHistoryUpdate } = yield select(getSettings)
   /** @type {ReturnType<typeof getReleasesMaxDate>} */
   const previousSyncMaxDate = yield select(getReleasesMaxDate)
 
@@ -120,7 +123,7 @@ function* syncMainSaga(action) {
   )
 
   /** @type {Await<ReturnType<typeof mergeAlbumsRaw>>} */
-  const mergedAlbums = yield call(mergeAlbumsRaw, albumsRaw, minDate)
+  const mergedAlbums = yield call(mergeAlbumsRaw, albumsRaw, minDate, albumsHistory)
   /** @type {Await<ReturnType<typeof buildAlbumsMap>>} */
   const albums = yield call(buildAlbumsMap, mergedAlbums, artists)
 
@@ -129,6 +132,11 @@ function* syncMainSaga(action) {
     yield call(deleteLabels, albums, labelBlocklist)
   }
 
+  if (autoHistoryUpdate) {
+    for (const album of mergedAlbums) albumsHistory.add(album.id)
+    yield call(history.persist, albumsHistory)
+  }
+
   yield cancel(tasks)
   yield call(requestChannel.close)
   yield call(responseChannel.close)