11085094286

Committed 28 Sep 2024 03:39PM UTC coverage: 79.715% (-0.4%) from 80.131%

Build # 11085094286

Build Type

Pull #637

github

Committed by

web-flow

Commit Message

Merge 11ccf3b06 into 14c162f19

Pull Request Pull Request #637: Switch to a relational database, closes #549

Run Details

751 of 918 branches covered (81.81%)

Branch coverage included in aggregate %.

1891 of 2530 new or added lines in 50 files covered. (74.74%)

13 existing lines in 7 files now uncovered.

9191 of 11554 relevant lines covered (79.55%)

68.11 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

86.55

/src/plugins/playlists.js

import ObjectGroupBy from 'object.groupby';
import {
  PlaylistNotFoundError,
  ItemNotInPlaylistError,
  MediaNotFoundError,
  UserNotFoundError,
} from '../errors/index.js';
import Page from '../Page.js';
import routes from '../routes/playlists.js';
import { randomUUID } from 'node:crypto';
import { sql } from 'kysely';
import {
  arrayCycle, jsonb, jsonEach, jsonLength, arrayShuffle as arrayShuffle,
} from '../utils/sqlite.js';
import Multimap from '../utils/Multimap.js';

/**
 * @typedef {import('../schema.js').UserID} UserID
 * @typedef {import('../schema.js').MediaID} MediaID
 * @typedef {import('../schema.js').PlaylistID} PlaylistID
 * @typedef {import('../schema.js').PlaylistItemID} PlaylistItemID
 * @typedef {import('../schema.js').User} User
 * @typedef {import('../schema.js').Playlist} Playlist
 * @typedef {import('../schema.js').PlaylistItem} PlaylistItem
 * @typedef {import('../schema.js').Media} Media
 */

/**
 * @typedef {object} PlaylistItemDesc
 * @prop {string} sourceType
 * @prop {string} sourceID
 * @prop {string} [artist]
 * @prop {string} [title]
 * @prop {number} [start]
 * @prop {number} [end]
 */

/**
 * Calculate valid start/end times for a playlist item.
 *
 * @param {PlaylistItemDesc} item
 * @param {Media} media
 */
function getStartEnd(item, media) {
  let { start, end } = item;
  if (!start || start < 0) {
    start = 0;
  } else if (start > media.duration) {
    start = media.duration;
  }
  if (!end || end > media.duration) {
    end = media.duration;
  } else if (end < start) {
    end = start;
  }
  return { start, end };
}

const playlistItemSelection = /** @type {const} */ ([
  'playlistItems.id as id',
  'media.id as media.id',
  'media.sourceID as media.sourceID',
  'media.sourceType as media.sourceType',
  'media.sourceData as media.sourceData',
  'media.artist as media.artist',
  'media.title as media.title',
  'media.duration as media.duration',
  'media.thumbnail as media.thumbnail',
  'playlistItems.artist',
  'playlistItems.title',
  'playlistItems.start',
  'playlistItems.end',
  'playlistItems.createdAt',
  'playlistItems.updatedAt',
]);

/**
 * @param {{
 *   id: PlaylistItemID,
 *   'media.id': MediaID,
 *   'media.sourceID': string,
 *   'media.sourceType': string,
 *   'media.sourceData': import('type-fest').JsonObject | null,
 *   'media.artist': string,
 *   'media.title': string,
 *   'media.duration': number,
 *   'media.thumbnail': string,
 *   artist: string,
 *   title: string,
 *   start: number,
 *   end: number,
 * }} raw
 */
function playlistItemFromSelection(raw) {
  return {
    _id: raw.id,
    artist: raw.artist,
    title: raw.title,
    start: raw.start,
    end: raw.end,
    media: {
      _id: raw['media.id'],
      artist: raw['media.artist'],
      title: raw['media.title'],
      duration: raw['media.duration'],
      thumbnail: raw['media.thumbnail'],
      sourceID: raw['media.sourceID'],
      sourceType: raw['media.sourceType'],
      sourceData: raw['media.sourceData'],
    },
  };
}

/**
 * @param {{
 *   id: PlaylistItemID,
 *   'media.id': MediaID,
 *   'media.sourceID': string,
 *   'media.sourceType': string,
 *   'media.sourceData': import('type-fest').JsonObject | null,
 *   'media.artist': string,
 *   'media.title': string,
 *   'media.duration': number,
 *   'media.thumbnail': string,
 *   artist: string,
 *   title: string,
 *   start: number,
 *   end: number,
 *   createdAt: Date,
 *   updatedAt: Date,
 * }} raw
 */
function playlistItemFromSelectionNew(raw) {
  return {
    playlistItem: {
      id: raw.id,
      mediaID: raw['media.id'],
      artist: raw.artist,
      title: raw.title,
      start: raw.start,
      end: raw.end,
      createdAt: raw.createdAt,
      updatedAt: raw.updatedAt,
    },
    media: {
      id: raw['media.id'],
      artist: raw['media.artist'],
      title: raw['media.title'],
      duration: raw['media.duration'],
      thumbnail: raw['media.thumbnail'],
      sourceID: raw['media.sourceID'],
      sourceType: raw['media.sourceType'],
      sourceData: raw['media.sourceData'],
    },
  };
}

class PlaylistsRepository {
  #uw;

  #logger;

  /**
   * @param {import('../Uwave.js').default} uw
   */
  constructor(uw) {
    this.#uw = uw;
    this.#logger = uw.logger.child({ ns: 'uwave:playlists' });
  }

  /**
   * @param {User} user
   * @param {PlaylistID} id
   */
  async getUserPlaylist(user, id) {
    const { db } = this.#uw;

    const playlist = await db.selectFrom('playlists')
      .where('userID', '=', user.id)
      .where('id', '=', id)
      .select([
        'id',
        'userID',
        'name',
        'createdAt',
        'updatedAt',
        (eb) => jsonLength(eb.ref('items')).as('size'),
      ])
      .executeTakeFirst();

    if (!playlist) {
      throw new PlaylistNotFoundError({ id });
    }
    return {
      ...playlist,
      size: Number(playlist.size),
    };
  }

  /**
   * @param {User} user
   * @param {{ name: string }} options
   */
  async createPlaylist(user, { name }) {
    const { db } = this.#uw;
    const id = /** @type {PlaylistID} */ (randomUUID());

    const playlist = await db.insertInto('playlists')
      .values({
        id,
        name,
        userID: user.id,
        items: jsonb([]),
      })
      .returning([
        'id',
        'userID',
        'name',
        (eb) => jsonLength(eb.ref('items')).as('size'),
        'createdAt',
        'updatedAt',
      ])
      .executeTakeFirstOrThrow();

    let active = false;
    // If this is the user's first playlist, immediately activate it.
    if (user.activePlaylistID == null) {
      this.#logger.info({ userId: user.id, playlistId: playlist.id }, 'activating first playlist');
      await db.updateTable('users')
        .where('users.id', '=', user.id)
        .set({ activePlaylistID: playlist.id })
        .execute();
      active = true;
    }

    return { playlist, active };
  }

  /**
   * @param {User} user
   */
  async getUserPlaylists(user) {
    const { db } = this.#uw;

    const playlists = await db.selectFrom('playlists')
      .where('userID', '=', user.id)
      .select([
        'id',
        'userID',
        'name',
        (eb) => jsonLength(eb.ref('items')).as('size'),
        'createdAt',
        'updatedAt',
      ])
      .execute();

    return playlists.map((playlist) => {
      return { ...playlist, size: Number(playlist.size) };
    });
  }

  /**
   * @param {Playlist} playlist
   * @param {Partial<Pick<Playlist, 'name'>>} patch
   */
  async updatePlaylist(playlist, patch = {}) {
    const { db } = this.#uw;

    const updatedPlaylist = await db.updateTable('playlists')
      .where('id', '=', playlist.id)
      .set(patch)
      .returning([
        'id',
        'userID',
        'name',
        (eb) => jsonLength(eb.ref('items')).as('size'),
        'createdAt',
        'updatedAt',
      ])
      .executeTakeFirstOrThrow();

    return updatedPlaylist;
  }

  /**
   * "Cycle" the playlist, moving its first item to last.
   *
   * @param {Playlist} playlist
   */
  async cyclePlaylist(playlist, tx = this.#uw.db) {
    await tx.updateTable('playlists')
      .where('id', '=', playlist.id)
      .set('items', (eb) => arrayCycle(eb.ref('items')))
      .execute();
  }

  /**
   * @param {Playlist} playlist
   */
  async shufflePlaylist(playlist) {
    const { db } = this.#uw;

    await db.updateTable('playlists')
      .where('id', '=', playlist.id)
      .set('items', (eb) => arrayShuffle(eb.ref('items')))
      .execute();
  }

  /**
   * @param {Playlist} playlist
   */
  async deletePlaylist(playlist) {
    const { db } = this.#uw;

    await db.deleteFrom('playlists')
      .where('id', '=', playlist.id)
      .execute();
  }

  /**
   * @param {Playlist} playlist
   * @param {PlaylistItemID} itemID
   */
  async getPlaylistItem(playlist, itemID) {
    const { db } = this.#uw;

    const raw = await db.selectFrom('playlistItems')
      .where('playlistItems.id', '=', itemID)
      .where('playlistItems.playlistID', '=', playlist.id)
      .innerJoin('media', 'media.id', 'playlistItems.mediaID')
      .select(playlistItemSelection)
      .executeTakeFirst();

    if (raw == null) {
      throw new ItemNotInPlaylistError({ playlistID: playlist.id, itemID });
    }

    return playlistItemFromSelectionNew(raw);
  }

  /**
   * @param {Playlist} playlist
   * @param {number} order
   */
  async getPlaylistItemAt(playlist, order) {
    const { db } = this.#uw;

    const raw = await db.selectFrom('playlistItems')
      .where('playlistItems.playlistID', '=', playlist.id)
      .where('playlistItems.id', '=', (eb) => {
        /** @type {import('kysely').RawBuilder<PlaylistItemID>} */
        // items->>order doesn't work for some reason, not sure why
        const item =  sql`json_extract(items, ${`$[${order}]`})`;
        return eb.selectFrom('playlists')
          .select(item.as('playlistItemID'))
          .where('id', '=', playlist.id);
      })
      .innerJoin('media', 'media.id', 'playlistItems.mediaID')
      .select(playlistItemSelection)
      .executeTakeFirst();

    if (raw == null) {
      throw new ItemNotInPlaylistError({ playlistID: playlist.id });
    }

    return playlistItemFromSelectionNew(raw);
  }

  /**
   * @param {{ id: PlaylistID }} playlist
   * @param {string|undefined} filter
   * @param {{ offset: number, limit: number }} pagination
   */
  async getPlaylistItems(playlist, filter, pagination) {
    const { db } = this.#uw;

    let query = db.selectFrom('playlists')
      .innerJoin(
        (eb) => jsonEach(eb.ref('playlists.items')).as('playlistItemIDs'),
        (join) => join,
      )
      .innerJoin('playlistItems', (join) => join.on((eb) => eb(
        eb.ref('playlistItemIDs.value'),
        '=',
        eb.ref('playlistItems.id'),
      )))
      .innerJoin('media', 'playlistItems.mediaID', 'media.id')
      .where('playlists.id', '=', playlist.id)
      .select(playlistItemSelection);
    if (filter != null) {
      query = query.where((eb) => eb.or([
        eb('playlistItems.artist', 'like', `%${filter}%`),
        eb('playlistItems.title', 'like', `%${filter}%`),
      ]));
    }

    query = query
      .offset(pagination.offset)
      .limit(pagination.limit);

    const totalQuery = db.selectFrom('playlists')
      .select((eb) => jsonLength(eb.ref('items')).as('count'))
      .where('id', '=', playlist.id)
      .executeTakeFirstOrThrow();

    const filteredQuery = filter == null ? totalQuery : db.selectFrom('playlistItems')
      .select((eb) => eb.fn.countAll().as('count'))
      .where('playlistID', '=', playlist.id)
      .where((eb) => eb.or([
        eb('playlistItems.artist', 'like', `%${filter}%`),
        eb('playlistItems.title', 'like', `%${filter}%`),
      ]))
      .executeTakeFirstOrThrow();

    const [
      playlistItemsRaw,
      filtered,
      total,
    ] = await Promise.all([
      query.execute(),
      filteredQuery,
      totalQuery,
    ]);

    const playlistItems = playlistItemsRaw.map(playlistItemFromSelection);

    return new Page(playlistItems, {
      pageSize: pagination.limit,
      filtered: Number(filtered.count),
      total: Number(total.count),

      current: pagination,
      next: {
        offset: pagination.offset + pagination.limit,
        limit: pagination.limit,
      },
      previous: {
        offset: Math.max(pagination.offset - pagination.limit, 0),
        limit: pagination.limit,
      },
    });
  }

  /**
   * Get playlists containing a particular Media.
   *
   * @typedef {object} GetPlaylistsContainingMediaOptions
   * @prop {UserID} [author]
   * @prop {string[]} [fields]
   * @param {MediaID} mediaID
   * @param {GetPlaylistsContainingMediaOptions} options
   */
  async getPlaylistsContainingMedia(mediaID, options = {}) {
    const { db } = this.#uw;

    let query = db.selectFrom('playlists')
      .select([
        'playlists.id',
        'playlists.userID',
        'playlists.name',
        (eb) => jsonLength(eb.ref('playlists.items')).as('size'),
        'playlists.createdAt',
        'playlists.updatedAt',
      ])
      .innerJoin('playlistItems', 'playlists.id', 'playlistItems.playlistID')
      .where('playlistItems.mediaID', '=', mediaID)
      .groupBy('playlistItems.playlistID');
    if (options.author) {
      query = query.where('playlists.userID', '=', options.author);
    }

    const playlists = await query.execute();
    return playlists;
  }

  /**
   * Get playlists that contain any of the given medias. If multiple medias are in a single
   * playlist, that playlist will be returned multiple times, keyed on the media's unique ObjectId.
   *
   * @param {MediaID[]} mediaIDs
   * @param {{ author?: UserID }} options
   * @returns A map of media IDs to the Playlist objects that contain them.
   */
  async getPlaylistsContainingAnyMedia(mediaIDs, options = {}) {
    const { db } = this.#uw;

    /** @type {Multimap<MediaID, Playlist>} */
    const playlistsByMediaID = new Multimap();
    if (mediaIDs.length === 0) {
      return playlistsByMediaID;
    }

    let query = db.selectFrom('playlists')
      .innerJoin('playlistItems', 'playlists.id', 'playlistItems.playlistID')
      .select([
        'playlists.id',
        'playlists.userID',
        'playlists.name',
        (eb) => jsonLength(eb.ref('playlists.items')).as('size'),
        'playlists.createdAt',
        'playlists.updatedAt',
        'playlistItems.mediaID',
      ])
      .where('playlistItems.mediaID', 'in', mediaIDs);
    if (options.author) {
      query = query.where('playlists.userID', '=', options.author);
    }

    const playlists = await query.execute();
    for (const { mediaID, ...playlist } of playlists) {
      playlistsByMediaID.set(mediaID, playlist);
    }

    return playlistsByMediaID;
  }

  /**
   * Load media for all the given source type/source IDs.
   *
   * @param {User} user
   * @param {{ sourceType: string, sourceID: string }[]} items
   */
  async resolveMedia(user, items) {
    const { db } = this.#uw;

    // Group by source so we can retrieve all unknown medias from the source in
    // one call.
    const itemsBySourceType = ObjectGroupBy(items, (item) => item.sourceType);
    /** @type {Map<string, Media>} */
    const allMedias = new Map();
    const promises = Object.entries(itemsBySourceType).map(async ([sourceType, sourceItems]) => {
      const knownMedias = await db.selectFrom('media')
        .where('sourceType', '=', sourceType)
        .where('sourceID', 'in', sourceItems.map((item) => String(item.sourceID)))
        .selectAll()
        .execute();

      /** @type {Set<string>} */
      const knownMediaIDs = new Set();
      knownMedias.forEach((knownMedia) => {
        allMedias.set(`${knownMedia.sourceType}:${knownMedia.sourceID}`, knownMedia);
        knownMediaIDs.add(knownMedia.sourceID);
      });

      /** @type {string[]} */
      const unknownMediaIDs = [];
      sourceItems.forEach((item) => {
        if (!knownMediaIDs.has(String(item.sourceID))) {
          unknownMediaIDs.push(String(item.sourceID));
        }
      });

      if (unknownMediaIDs.length > 0) {
        // @ts-expect-error TS2322
        const unknownMedias = await this.#uw.source(sourceType).get(user, unknownMediaIDs);
        for (const media of unknownMedias) {
          const newMedia = await db.insertInto('media')
            .values({
              id: /** @type {MediaID} */ (randomUUID()),
              sourceType: media.sourceType,
              sourceID: media.sourceID,
              sourceData: jsonb(media.sourceData),
              artist: media.artist,
              title: media.title,
              duration: media.duration,
              thumbnail: media.thumbnail,
            })
            .returningAll()
            .executeTakeFirstOrThrow();

          allMedias.set(`${media.sourceType}:${media.sourceID}`, newMedia);
        }
      }
    });

    await Promise.all(promises);

    for (const item of items) {
      if (!allMedias.has(`${item.sourceType}:${item.sourceID}`)) {
        throw new MediaNotFoundError({ sourceType: item.sourceType, sourceID: item.sourceID });
      }
    }

    return allMedias;
  }

  /**
   * Add items to a playlist.
   *
   * @param {Playlist} playlist
   * @param {PlaylistItemDesc[]} items
   * @param {{ after: PlaylistItemID } | { at: 'start' | 'end' }} [options]
   */
  async addPlaylistItems(playlist, items, options = { at: 'end' }) {
    const { users } = this.#uw;
    const user = await users.getUser(playlist.userID);
    if (!user) {
      throw new UserNotFoundError({ id: playlist.userID });
    }

    const medias = await this.resolveMedia(user, items);
    const playlistItems = items.map((item) => {
      const media = medias.get(`${item.sourceType}:${item.sourceID}`);
      if (media == null) {
        throw new Error('resolveMedia() should have errored');
      }
      const { start, end } = getStartEnd(item, media);
      return {
        id: /** @type {PlaylistItemID} */ (randomUUID()),
        media: media,
        artist: item.artist ?? media.artist,
        title: item.title ?? media.title,
        start,
        end,
      };
    });

    const result = await this.#uw.db.transaction().execute(async (tx) => {
      for (const item of playlistItems) {
        // TODO: use a prepared statement
        await tx.insertInto('playlistItems')
          .values({
            id: item.id,
            playlistID: playlist.id,
            mediaID: item.media.id,
            artist: item.artist,
            title: item.title,
            start: item.start,
            end: item.end,
          })
          .execute();
      }

      const result = await tx.selectFrom('playlists')
        .select(sql`json(items)`.as('items'))
        .where('id', '=', playlist.id)
        .executeTakeFirstOrThrow();

      /** @type {PlaylistItemID[]} */
      const oldItems = result?.items ? JSON.parse(/** @type {string} */ (result.items)) : [];

      /** @type {PlaylistItemID | null} */
      let after;
      let newItems;
      if ('after' in options) {
        after = options.after;
        const insertIndex = oldItems.indexOf(options.after);
        newItems = [
          ...oldItems.slice(0, insertIndex + 1),
          ...playlistItems.map((item) => item.id),
          ...oldItems.slice(insertIndex + 1),
        ];
      } else if (options.at === 'start') {
        after = null;
        newItems = playlistItems.map((item) => item.id).concat(oldItems);
      } else {
        newItems = oldItems.concat(playlistItems.map((item) => item.id));
        after = oldItems.at(-1) ?? null;
      }

      await tx.updateTable('playlists')
        .where('id', '=', playlist.id)
        .set({ items: jsonb(newItems) })
        .executeTakeFirstOrThrow();

      return {
        added: playlistItems,
        afterID: after,
        playlistSize: newItems.length,
      };
    });

    return result;
  }

  /**
   * @param {Omit<PlaylistItem, 'playlistID'>} item
   * @param {Partial<Pick<PlaylistItem, 'artist' | 'title' | 'start' | 'end'>>} patch
   * @returns {Promise<PlaylistItem>}
   */
  async updatePlaylistItem(item, patch = {}) {
    const { db } = this.#uw;

    const updatedItem = await db.updateTable('playlistItems')
      .where('id', '=', item.id)
      .set(patch)
      .returningAll()
      .executeTakeFirstOrThrow();

    return updatedItem;
  }

  /**
   * @param {Playlist} playlist
   * @param {PlaylistItemID[]} itemIDs
   * @param {{ after: PlaylistItemID } | { at: 'start' | 'end' }} options
   */
  async movePlaylistItems(playlist, itemIDs, options) {
    const { db } = this.#uw;

    await db.transaction().execute(async (tx) => {
      const result = await tx.selectFrom('playlists')
        .select(sql`json(items)`.as('items'))
        .where('id', '=', playlist.id)
        .executeTakeFirst();

      const items = result?.items ? JSON.parse(/** @type {string} */ (result.items)) : [];
      const itemIDsInPlaylist = new Set(items);
      const itemIDsToMove = new Set(itemIDs.filter((itemID) => itemIDsInPlaylist.has(itemID)));

      /** @type {PlaylistItemID[]} */
      let newItemIDs = [];
      /** Index in the new item array to move the item IDs to. */
      let insertIndex = 0;
      let index = 0;
      for (const itemID of itemIDsInPlaylist) {
        if (!itemIDsToMove.has(itemID)) {
          index += 1;
          newItemIDs.push(itemID);
        }
        if ('after' in options && itemID === options.after) {
          insertIndex = index;
        }
      }

      let after;
      if ('after' in options) {
        after = options.after;
        newItemIDs = [
          ...newItemIDs.slice(0, insertIndex + 1),
          ...itemIDsToMove,
          ...newItemIDs.slice(insertIndex + 1),
        ];
      } else if (options.at === 'start') {
        after = null;
        newItemIDs = [...itemIDsToMove, ...newItemIDs];
      } else {
        newItemIDs = [...newItemIDs, ...itemIDsToMove];
        after = newItemIDs.at(-1) ?? null;
      }

      await tx.updateTable('playlists')
        .where('id', '=', playlist.id)
        .set('items', jsonb(newItemIDs))
        .execute();
    });

    return {};
  }

  /**
   * @param {Playlist} playlist
   * @param {PlaylistItemID[]} itemIDs
   */
  async removePlaylistItems(playlist, itemIDs) {
    const { db } = this.#uw;

    const rows = await db.selectFrom('playlists')
      .innerJoin((eb) => jsonEach(eb.ref('playlists.items')).as('playlistItemIDs'), (join) => join)
      .select('playlistItemIDs.value as itemID')
      .where('playlists.id', '=', playlist.id)
      .execute();

    // Only remove items that are actually in this playlist.
    const set = new Set(itemIDs);
    /** @type {PlaylistItemID[]} */
    const toRemove = [];
    /** @type {PlaylistItemID[]} */
    const toKeep = [];
    rows.forEach(({ itemID }) => {
      if (set.has(itemID)) {
        toRemove.push(itemID);
      } else {
        toKeep.push(itemID);
      }
    });

    await db.transaction().execute(async (tx) => {
      await tx.updateTable('playlists')
        .where('id', '=', playlist.id)
        .set({ items: jsonb(toKeep) })
        .execute();
      await tx.deleteFrom('playlistItems')
        .where('id', 'in', toRemove)
        .execute();
    });
  }
}

/**
 * @param {import('../Uwave.js').default} uw
 */
async function playlistsPlugin(uw) {
  uw.playlists = new PlaylistsRepository(uw);
  uw.httpApi.use('/playlists', routes());
}

export default playlistsPlugin;
export { PlaylistsRepository };

u-wave / core / 11085094286

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous