Skip to content

Commit

Permalink
Adjust reading the config into the new format
Browse files Browse the repository at this point in the history
  • Loading branch information
@Lucki
Lucki committed Aug 22, 2024
1 parent 774b907 commit bcfc355
Show file tree
Hide file tree
Showing 3 changed files with 127 additions and 20 deletions.
51 changes: 41 additions & 10 deletions packages/app/app/actions/downloads.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ const changePropertyForItem = ({downloads, uuid, propertyName='status', value}:C

export const readDownloads = createStandardAction(DownloadActionTypes.READ_DOWNLOADS).map(
() => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();
return { payload: downloads };
}
);

export const addToDownloads = createStandardAction(DownloadActionTypes.ADD_TO_DOWNLOADS).map(
(__:StreamProvider[], track: Track) => {
const clonedTrack: TrackItem = safeAddUuid(getTrackItem(track));
let downloads: Download[] = store.get('downloads');
let downloads: Download[] = getDownloadsBackwardsCompatible();

const existingTrack = downloads.find(({track}) => {
const {name, artists} = track;
Expand Down Expand Up @@ -60,7 +60,7 @@ export const addToDownloads = createStandardAction(DownloadActionTypes.ADD_TO_DO

export const onDownloadStarted = createStandardAction(DownloadActionTypes.DOWNLOAD_STARTED).map(
(uuid: string) => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();
const payload = changePropertyForItem({
downloads,
uuid,
Expand All @@ -73,7 +73,7 @@ export const onDownloadStarted = createStandardAction(DownloadActionTypes.DOWNLO

export const onDownloadPause = createStandardAction(DownloadActionTypes.DOWNLOAD_PAUSED).map(
(uuid: string) => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();
const payload = changePropertyForItem({
downloads,
uuid,
Expand All @@ -86,7 +86,7 @@ export const onDownloadPause = createStandardAction(DownloadActionTypes.DOWNLOA

export const onDownloadResume = createStandardAction(DownloadActionTypes.DOWNLOAD_RESUMED).map(
(uuid: string) => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();
const payload = changePropertyForItem({
downloads,
uuid,
Expand All @@ -101,7 +101,7 @@ export const onDownloadResume = createStandardAction(DownloadActionTypes.DOWNLOA

export const onDownloadProgress = createStandardAction(DownloadActionTypes.DOWNLOAD_PROGRESS).map(
(uuid: string, progress: number) => {
const downloads = store.get('downloads');
const downloads = getDownloadsBackwardsCompatible();
let payload = changePropertyForItem({
downloads,
uuid,
Expand All @@ -122,7 +122,7 @@ export const onDownloadProgress = createStandardAction(DownloadActionTypes.DOWNL

export const onDownloadError = createStandardAction(DownloadActionTypes.DOWNLOAD_ERROR).map(
(uuid: string) => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();
const payload = changePropertyForItem({
downloads,
uuid,
Expand All @@ -137,7 +137,7 @@ export const onDownloadError = createStandardAction(DownloadActionTypes.DOWNLOAD

export const onDownloadRemoved = createStandardAction(DownloadActionTypes.DOWNLOAD_REMOVED).map(
(uuid: string) => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();
const filteredTracks = downloads.filter(item => item.track.uuid !== uuid);
return {
payload: filteredTracks
Expand All @@ -146,7 +146,7 @@ export const onDownloadRemoved = createStandardAction(DownloadActionTypes.DOWNLO

export const onDownloadFinished = createStandardAction(DownloadActionTypes.DOWNLOAD_FINISHED).map(
(uuid: string) => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();
const payload = changePropertyForItem({
downloads,
uuid,
Expand All @@ -160,7 +160,7 @@ export const onDownloadFinished = createStandardAction(DownloadActionTypes.DOWNL

export const clearFinishedDownloads = createStandardAction(DownloadActionTypes.CLEAR_FINISHED_DOWNLOADS).map(
() => {
const downloads: Download[] = store.get('downloads');
const downloads: Download[] = getDownloadsBackwardsCompatible();

const filteredTracks = downloads.filter(( item ) =>
item.status !== DownloadStatus.FINISHED && item.status !== DownloadStatus.ERROR
Expand All @@ -170,3 +170,34 @@ export const clearFinishedDownloads = createStandardAction(DownloadActionTypes.C
payload: filteredTracks
};
});

/**
* Helper function to read the old track format into the new format.
*
* `Track.artist` and `Track.extraArtists` are written into {@link Track.artists}
*/
function getDownloadsBackwardsCompatible(): Download[] {
const downloads: Download[] = store.get('downloads');

downloads.forEach(download => {
// @ts-expect-error For backwards compatibility we're trying to parse an invalid field
if (download.track.artists || !download.track.artist) {
return;
}

// @ts-expect-error For backwards compatibility we're trying to parse an invalid field
if (download.track.artist) {
// @ts-expect-error For backwards compatibility we're trying to parse an invalid field
download.track.artists = _.isString(download.track.artist) ? [download.track.artist] : [download.track.artist.name];
}

// Assuming we have `extraArtists` on a track, we must had an `artist` which
// was already saved into `artists`, so this `track.artists` shouldn't be undefined
// @ts-expect-error For backwards compatibility we're trying to parse an invalid field
download.track.extraArtists?.forEach(artist => {
download.track.artists.push(artist);
});
});

return downloads;
}
61 changes: 53 additions & 8 deletions packages/app/app/actions/favorites.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const ADD_FAVORITE_ARTIST = 'ADD_FAVORITE_ARTIST';
export const REMOVE_FAVORITE_ARTIST = 'REMOVE_FAVORITE_ARTIST';

export function readFavorites() {
const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
return {
type: READ_FAVORITES,
payload: favorites
Expand All @@ -27,7 +27,7 @@ export function readFavorites() {
export function addFavoriteTrack(track) {
const clonedTrack = flow(safeAddUuid, getTrackItem)(track);

const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
const filteredTracks = favorites.tracks.filter(t => !areTracksEqualByName(t, track));
favorites.tracks = [...filteredTracks, omit(clonedTrack, 'streams')];

Expand All @@ -42,15 +42,15 @@ export function addFavoriteTrack(track) {
const bulkAddFavoriteTracksAction = createStandardAction(BULK_ADD_FAVORITE_TRACKS)<Track[]>();

export const bulkAddFavoriteTracks = (tracks: Track[]) => {
const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
favorites.tracks = unionWith(favorites.tracks, tracks, areTracksEqualByName);
store.set('favorites', favorites);

return bulkAddFavoriteTracksAction(favorites);
};

export function removeFavoriteTrack(track) {
const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
favorites.tracks = favorites.tracks.filter(t => !areTracksEqualByName(t, track));

store.set('favorites', favorites);
Expand All @@ -62,7 +62,7 @@ export function removeFavoriteTrack(track) {
}

export function addFavoriteAlbum(album) {
const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
favorites.albums = _.concat(favorites.albums, album);
store.set('favorites', favorites);

Expand All @@ -73,7 +73,7 @@ export function addFavoriteAlbum(album) {
}

export function removeFavoriteAlbum(album) {
const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
_.remove(favorites.albums, {
artist: album.artist,
title: album.title
Expand All @@ -88,7 +88,7 @@ export function removeFavoriteAlbum(album) {

export function addFavoriteArtist(artist) {

const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
const savedArtist = {
id: artist.id,
name: artist.name,
Expand All @@ -107,7 +107,7 @@ export function addFavoriteArtist(artist) {
}

export function removeFavoriteArtist(artist) {
const favorites = store.get('favorites');
const favorites = getFavoritesBackwardsCompatible();
_.remove(favorites.artists, {
id: artist.id,
name: artist.name
Expand All @@ -119,3 +119,48 @@ export function removeFavoriteArtist(artist) {
payload: favorites
};
}

/**
* Helper function to read the old track format into the new format.
*
* `Track.artist` and `Track.extraArtists` are written into {@link Track.artists}
*/
function getFavoritesBackwardsCompatible() {
const favorites = store.get('favorites');

favorites.tracks?.forEach(track => {
if (track.artists || !track.artist) {
return;
}

if (track.artist) {
track.artists = _.isString(track.artist) ? [track.artist] : [track.artist.name];
}

// Assuming we have `extraArtists` on a track, we must had an `artist` which
// was already saved into `artists`, so this `track.artists` shouldn't be undefined
track.extraArtists?.forEach(artist => {
track.artists.push(artist);
});
});

favorites.albums?.forEach(album => {
album.tracklist?.forEach(track => {
if (track.artists || !track.artist) {
return;
}

if (track.artist) {
track.artists = _.isString(track.artist) ? [track.artist] : [track.artist.name];
}

// Assuming we have `extraArtists` on a track, we must had an `artist` which
// was already saved into `artists`, so this `track.artists` shouldn't be undefined
track.extraArtists?.forEach(artist => {
track.artists.push(artist);
});
});
});

return favorites;
}
35 changes: 33 additions & 2 deletions packages/app/app/actions/playlists.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export const loadLocalPlaylists = () => dispatch => {
dispatch(loadLocalPlaylistsAction.request());

try {
const playlists: Playlist[] = store.get('playlists');
const playlists: Playlist[] = getPlaylistsBackwardsCompatible();
dispatch(loadLocalPlaylistsAction.success(isEmpty(playlists) ? [] : playlists));
} catch (error) {
dispatch(loadLocalPlaylistsAction.failure());
Expand Down Expand Up @@ -147,7 +147,7 @@ export function addPlaylistFromFile(filePath, t) {
throw new Error('missing tracks or name');
}

let playlists = store.get('playlists') || [];
let playlists = getPlaylistsBackwardsCompatible() || [];
const playlist = PlaylistHelper.formatPlaylistForStorage(name, tracks, v4(), source);

if (!(tracks?.length > 0)) {
Expand All @@ -167,3 +167,34 @@ export function addPlaylistFromFile(filePath, t) {
});
};
}

/**
* Helper function to read the old track format into the new format.
*
* `Track.artist` and `Track.extraArtists` are written into {@link Track.artists}
*/
function getPlaylistsBackwardsCompatible(): Playlist[] {
const playlists: Playlist[] = store.get('playlists');

playlists?.forEach(playlist => {
playlist.tracks?.forEach(track => {
// @ts-expect-error For backwards compatibility we're trying to parse an invalid field
if (track.artists || !track.artist) {
// New format already present, do nothing
return;
}

// @ts-expect-error For backwards compatibility we're trying to parse an invalid field
track.artists = _.isString(track.artist) ? [track.artist] : [track.artist.name];

// Assuming we have `extraArtists` on a track, we must had an `artist` which
// was already saved into `artists`, so this `track.artists` shouldn't be undefined
// @ts-expect-error For backwards compatibility we're trying to parse an invalid field
track.extraArtists?.forEach(artist => {
track.artists.push(artist);
});
});
});

return playlists;
}

0 comments on commit bcfc355

Please sign in to comment.