@playpilot/tpi 5.28.0 → 5.29.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@playpilot/tpi",
-	"version": "5.28.0",
+	"version": "5.29.0",
 	"type": "module",
 	"scripts": {
 		"dev": "vite dev",

package/src/routes/components/Rails/ParticipantsRail.svelte

@@ -1,7 +1,9 @@
 <script lang="ts">
   import { fetchParticipantsForTitle } from '$lib/api/participants'
   import { TrackingEvent } from '$lib/enums/TrackingEvent'
+  import { getLinkInjectionElements, getLinkInjectionsParentElement, getPageText } from '$lib/injection'
   import { openModal } from '$lib/modal'
+  import { cleanPhrase, findNumberOfMatchesInString } from '$lib/text'
   import { track } from '$lib/tracking'
   import type { ParticipantData } from '$lib/types/participant'
   import type { TitleData } from '$lib/types/title'
@@ -13,6 +15,31 @@
 
   const { title }: Props = $props()
 
+  /**
+   * Order participants by how often their name appears in an the page text. This only takes into account
+   * their full name. If an actor is mentioned by first name only, which is often the case, they won't get
+   * boosted. Often times if an actor is mentioned at least once, their full name will be somewhere in the
+   * page text, so the goal is still the same; to list participants that are mentioned in the page text before
+   * other participants.
+   */
+  function orderParticipantsByPageTextOccurrence(participants: ParticipantData[]): ParticipantData[] {
+    const pageText = cleanPhrase(getPageText(getLinkInjectionElements(getLinkInjectionsParentElement())))
+
+    // Create a new object with all participants by their sid with the number of times their names appear in the page text
+    const participantsByOccurrence: Record<string, { participant: ParticipantData, count: number }> = {}
+    for(const participant of participants) {
+      const count = findNumberOfMatchesInString(pageText, cleanPhrase(participant.name))
+
+      participantsByOccurrence[participant.sid] = { participant, count }
+    }
+
+    // Sort all participants by their occurrences. If a participant did not occur their positioned will be retained
+    // relative to where it was before
+    const participantsSortedByCount = Object.values(participantsByOccurrence).sort((a, b) => b.count - a.count)
+
+    return participantsSortedByCount.map(({ participant }) => participant)
+  }
+
   function onclick(event: MouseEvent, participant: ParticipantData): void {
     openModal({ event, type: 'participant', data: participant })
     track(TrackingEvent.ParticipantClick, null, { title_source: title.original_title, participant: participant.name })
@@ -28,7 +55,7 @@
 {:then participants}
   {#if participants?.length}
     <Rail heading="Cast">
-      {#each participants.slice(0, 15) as participant}
+      {#each orderParticipantsByPageTextOccurrence(participants).slice(0, 15) as participant}
         <button class="participant" data-testid="participant" onclick={event => onclick(event, participant)}>
           <span class="truncate">{participant.name}</span>
 

package/src/tests/routes/components/Rails/ParticipantsRail.test.js

@@ -21,10 +21,13 @@ vi.mock('$lib/api/participants', () => ({
 }))
 
 describe('ParticipantsRail.svelte', () => {
+  beforeEach(() => {
+    document.body.innerHTML = ''
+  })
+
   it('Should render each given participant', async () => {
     vi.mocked(fetchParticipantsForTitle).mockResolvedValueOnce(participants)
 
-    // @ts-ignore
     const { getByText } = render(ParticipantsRail, { title })
 
     await waitFor(() => {
@@ -33,6 +36,19 @@ describe('ParticipantsRail.svelte', () => {
     })
   })
 
+  it('Should order participants by their number of occurrences on the page', async () => {
+    document.body.innerHTML = `<main>${participants[1].name}. ${participants[2].name}, ${participants[2].name}</main>`
+    vi.mocked(fetchParticipantsForTitle).mockResolvedValueOnce(participants)
+
+    const { getAllByTestId } = render(ParticipantsRail, { title })
+
+    await waitFor(() => {
+      expect(getAllByTestId('participant')[0].innerText).toContain(participants[2].name)
+      expect(getAllByTestId('participant')[1].innerText).toContain(participants[1].name)
+      expect(getAllByTestId('participant')[2].innerText).toContain(participants[0].name)
+    })
+  })
+
   it('Should not render when no participants are returned', async () => {
     vi.mocked(fetchParticipantsForTitle).mockResolvedValueOnce([])