All files / Bandstand/src/lib songs.ts

37.87% Statements 75/198
30% Branches 3/10
27.27% Functions 3/11
37.87% Lines 75/198

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 2551x   1x       1x 1x     1x   7x 7x 7x                 7x 7x   7x 7x                                                                                                                                                                                 1x 1x 1x 1x 1x 1x 1x 1x 1x                                                                                                     1x 5x         5x 5x   5x 5x 5x 5x 5x           2x 2x 2x           2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x   2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x     1x                
import {queueActivity} from './push'
import type {Prisma, PrismaClient} from '@prisma/client'
import {prisma} from './db'
 
type Tx = Prisma.TransactionClient | PrismaClient
 
export class ConflictError extends Error {
  constructor(public latest: number) {
    super(`Chart was changed by someone else (now version ${latest})`)
  }
}
 
export async function logActivity(
  tx: Tx,
  data: {
    // null = a personal change, shown in every band the person is in
    bandId: string | null
    userId: string | null
    action: string
    targetType: string
    targetId?: string | null
    summary: string
  },
) {
  const a = await tx.activity.create({data})
  // Tell the band's phones (once the change has had a moment to settle)
  queueActivity(a)
}
 
async function latestNumber(tx: Tx, songId: string) {
  const last = await tx.chartVersion.findFirst({
    where: {songId},
    orderBy: {number: 'desc'},
    select: {number: true},
  })
  return last?.number ?? 0
}
 
/**
 * Save a new chart version. `baseNumber` is the version the editor started
 * from; if someone saved in the meantime the save is refused rather than
 * silently overwriting their change.
 */
export async function saveChart(args: {
  bandId: string
  songId: string
  userId: string
  source: string
  note?: string | null
  baseNumber: number
  restoredFrom?: number | null
}) {
  return prisma.$transaction(async (tx) => {
    const owned = await tx.song.findFirst({
      where: {id: args.songId, bandId: args.bandId},
      select: {id: true},
    })
    if (!owned) return null
    const latest = await latestNumber(tx, args.songId)
    if (args.baseNumber !== latest) throw new ConflictError(latest)
    const number = latest + 1
    const version = await tx.chartVersion.create({
      data: {
        songId: args.songId,
        number,
        source: args.source,
        note: args.note?.trim() || null,
        authorId: args.userId,
        restoredFrom: args.restoredFrom ?? null,
      },
    })
    const song = await tx.song.update({
      where: {id: args.songId},
      data: {updatedById: args.userId},
      select: {title: true},
    })
    await logActivity(tx, {
      bandId: args.bandId,
      userId: args.userId,
      action: args.restoredFrom ? 'chart.restore' : 'chart.save',
      targetType: 'song',
      targetId: args.songId,
      summary: args.restoredFrom
        ? `restored ${song.title} to version ${args.restoredFrom}`
        : `edited the chart for ${song.title}${args.note?.trim() ? ` — “${args.note.trim()}”` : ''}`,
    })
    return version
  })
}
 
export async function restoreVersion(args: {
  bandId: string
  songId: string
  number: number
  userId: string
}) {
  const old = await prisma.chartVersion.findFirst({
    where: {
      songId: args.songId,
      number: args.number,
      song: {bandId: args.bandId},
    },
  })
  if (!old) return null
  const latest = await latestNumber(prisma, args.songId)
  return saveChart({
    bandId: args.bandId,
    songId: args.songId,
    userId: args.userId,
    source: old.source,
    note: `Restored version ${args.number}`,
    baseNumber: latest,
    restoredFrom: args.number,
  })
}
 
const authorSelect = {
  select: {
    id: true,
    name: true,
    displayName: true,
    email: true,
    avatarAt: true,
  },
} as const
 
/** Songs with their latest chart version's number, author and date. */
export async function listSongs(bandId: string) {
  const songs = await prisma.song.findMany({
    where: {bandId},
    orderBy: [{status: 'asc'}, {title: 'asc'}],
    include: {
      chartVersions: {
        orderBy: {number: 'desc'},
        take: 1,
        select: {
          number: true,
          createdAt: true,
          note: true,
          author: authorSelect,
          source: true,
        },
      },
    },
  })
  return songs.map(({chartVersions, ...s}) => ({
    ...s,
    latest: chartVersions[0] ?? null,
  }))
}
 
export async function getSong(id: string, bandId: string) {
  const song = await prisma.song.findFirst({
    where: {id, bandId},
    include: {
      chartVersions: {
        orderBy: {number: 'desc'},
        take: 1,
        include: {author: authorSelect},
      },
    },
  })
  if (!song) return null
  const {chartVersions, ...rest} = song
  return {...rest, latest: chartVersions[0] ?? null}
}
 
export async function listVersions(songId: string, bandId: string) {
  return prisma.chartVersion.findMany({
    where: {songId, song: {bandId}},
    orderBy: {number: 'desc'},
    include: {author: authorSelect},
  })
}
 
export function displayName(
  u: {
    name: string | null
    email: string | null
    displayName?: string | null
  } | null,
) {
  if (!u) return 'someone'
  // What the band calls them ("Ken"), else the first name, else the email
  if (u.displayName) return u.displayName
  if (u.name) return u.name.split(' ')[0]
  const local = u.email?.split('@')[0]
  return local ? local.charAt(0).toUpperCase() + local.slice(1) : 'someone'
}
 
/**
 * A proposal that wins the vote joins the book as a song to learn, with an
 * empty chart for someone to fill in. No-op if the song is already there.
 */
export async function addSongFromProposal(
  tx: Tx,
  p: {
    title: string
    artist: string
    youtubeUrl: string | null
    lyricsUrl: string | null
  },
  userId: string,
  band: {id: string; tributeTo: string | null},
) {
  const bandId = band.id
  const exists = await tx.song.findFirst({
    where: {bandId, title: {equals: p.title, mode: 'insensitive'}},
    select: {id: true},
  })
  if (exists) return null
  const song = await tx.song.create({
    data: {
      bandId,
      title: p.title,
      notes:
        p.artist && p.artist !== band.tributeTo
          ? `Originally by ${p.artist}`
          : null,
      youtubeUrl: p.youtubeUrl,
      lyricsUrl: p.lyricsUrl,
      status: 'LEARNING',
      updatedById: userId,
    },
  })
  await tx.chartVersion.create({
    data: {
      songId: song.id,
      number: 1,
      source: `{title: ${p.title}}\n`,
      authorId: userId,
      note: 'No chart yet',
    },
  })
  await logActivity(tx, {
    bandId,
    userId,
    action: 'song.create',
    targetType: 'song',
    targetId: song.id,
    summary: `voted ${p.title} in — it's on the list to learn`,
  })
  return song
}
 
/** A version written by the importer (or the empty placeholder), not by a person editing. */
export function isImportNote(note: string | null | undefined) {
  return Boolean(
    note &&
      (note.startsWith('Imported from') ||
        note === 'No chart yet' ||
        note === 'Created'),
  )
}