-
Notifications
You must be signed in to change notification settings - Fork 0
feat(workspace): guide tonight's first pre-chorus on map and player #955
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Changes from all commits
95e74ee
711bfd4
7159431
5609a7a
78d916f
40130a1
cb7ce76
d1975e1
4c0cf96
1e9fcc8
4058e50
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import { render, screen } from "@testing-library/react"; | ||
| import { createDemoRehearsalSong } from "@bandscope/shared-types"; | ||
| import { afterEach, describe, expect, it, vi } from "vitest"; | ||
| import { PlayerFeature } from "./index"; | ||
|
|
||
| afterEach(() => { | ||
| vi.unstubAllGlobals(); | ||
| }); | ||
|
|
||
| function songWithPreChorus() { | ||
| const song = createDemoRehearsalSong(); | ||
| const seed = song.sections[0]!; | ||
| const preChorus = structuredClone(seed); | ||
| preChorus.id = "pre-chorus-localization"; | ||
| preChorus.label = "pre-chorus"; | ||
| preChorus.timeRange = { start: 20, end: 28 }; | ||
| song.sections = [preChorus]; | ||
| return song; | ||
| } | ||
|
|
||
| describe("PlayerFeature localization", () => { | ||
| it("keeps the Korean player summary and playback notice locale-consistent", () => { | ||
| vi.stubGlobal("navigator", { language: "ko-KR" }); | ||
|
|
||
| render(<PlayerFeature title="Player" song={songWithPreChorus()} />); | ||
|
|
||
| expect(screen.getByText("1개 섹션")).toBeTruthy(); | ||
| expect(screen.queryByText("1 section")).toBeNull(); | ||
| expect(screen.getByText("프리코러스")).toBeTruthy(); | ||
| expect(screen.queryByText("pre-chorus")).toBeNull(); | ||
| expect( | ||
| screen.getByText("오디오 재생은 로컬 오디오 소스가 있는 데스크톱 앱에서 사용할 수 있습니다.") | ||
| ).toBeTruthy(); | ||
| expect( | ||
| screen.queryByText("Audio playback requires the desktop app with a local audio source.") | ||
| ).toBeNull(); | ||
| }); | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| import { fireEvent, render, screen } from "@testing-library/react"; | ||
| import { createDemoRehearsalSong } from "@bandscope/shared-types"; | ||
| import { describe, expect, it, vi } from "vitest"; | ||
| import { PlayerFeature } from "./index"; | ||
|
|
||
| function songWithPreChorus() { | ||
| const song = createDemoRehearsalSong(); | ||
| const seed = song.sections[0]!; | ||
| const preChorus = structuredClone(seed); | ||
| preChorus.id = "pre-chorus-1"; | ||
| preChorus.label = "pre-chorus"; | ||
| preChorus.timeRange = { start: 20, end: 28 }; | ||
| preChorus.roles = [ | ||
| { | ||
| ...seed.roles[2]!, | ||
| id: "lead-vocal", | ||
| name: "Lead Vocal", | ||
| rehearsalPriority: "high" | ||
| } | ||
| ]; | ||
| preChorus.partGraph = [ | ||
| { | ||
| role_id: "lead-vocal", | ||
| is_active: true, | ||
| handoff_to: [], | ||
| handoff_from: [] | ||
| } | ||
| ]; | ||
| song.sections = [preChorus]; | ||
| return song; | ||
| } | ||
|
|
||
| describe("PlayerFeature", () => { | ||
| it("asks the room to analyze first when no song is loaded", () => { | ||
| render(<PlayerFeature title="Player" />); | ||
| expect( | ||
| screen.getByText("Analyze tonight's song first, then hear the first pre-chorus from this player.") | ||
| ).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("keeps the pre-chorus hear action unavailable without a player playback callback", () => { | ||
| render(<PlayerFeature title="Player" song={songWithPreChorus()} />); | ||
|
|
||
| expect(screen.queryByRole("button", { name: "Hear Lead Vocal pre-chorus at 0:20" })).toBeNull(); | ||
| expect(screen.getByText("Lead Vocal carries the pre-chorus at 0:20.")).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("delegates the pre-chorus hear action to the owning player callback", () => { | ||
| const onPlayFromSeconds = vi.fn(); | ||
| render( | ||
| <PlayerFeature title="Player" song={songWithPreChorus()} onPlayFromSeconds={onPlayFromSeconds} /> | ||
| ); | ||
|
|
||
| fireEvent.click(screen.getByRole("button", { name: "Hear Lead Vocal pre-chorus at 0:20" })); | ||
|
|
||
| expect(onPlayFromSeconds).toHaveBeenCalledTimes(1); | ||
| expect(onPlayFromSeconds).toHaveBeenCalledWith(20); | ||
| }); | ||
|
|
||
| it("renders a safe empty summary when the runtime section collection is not an array", () => { | ||
| const song = songWithPreChorus(); | ||
| (song as unknown as { sections: unknown }).sections = null; | ||
|
|
||
| render(<PlayerFeature title="Player" song={song} />); | ||
|
|
||
| expect( | ||
| screen.getByText("No pre-chorus yet. Stay on tonight's map until the first lift is labeled.") | ||
| ).toBeTruthy(); | ||
| expect(screen.getByText("0 sections")).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("renders a safe empty summary when the runtime section collection is sparse", () => { | ||
| const song = songWithPreChorus(); | ||
| const sparseSections: typeof song.sections = new Array(2); | ||
| sparseSections[1] = song.sections[0]!; | ||
| song.sections = sparseSections; | ||
|
|
||
| render(<PlayerFeature title="Player" song={song} />); | ||
|
|
||
| expect( | ||
| screen.getByText("No pre-chorus yet. Stay on tonight's map until the first lift is labeled.") | ||
| ).toBeTruthy(); | ||
| expect(screen.getByText("0 sections")).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("omits malformed runtime section elements without crashing the player summary", () => { | ||
| const song = songWithPreChorus(); | ||
| song.sections = [null, song.sections[0]!] as unknown as typeof song.sections; | ||
|
|
||
| render(<PlayerFeature title="Player" song={song} />); | ||
|
|
||
| expect(screen.getByText("1 section")).toBeTruthy(); | ||
| expect(screen.getByText("pre-chorus")).toBeTruthy(); | ||
| }); | ||
|
|
||
| it("does not pass an object-valued runtime song title into React copy", () => { | ||
| const song = songWithPreChorus(); | ||
| (song as unknown as { title: unknown }).title = { unsafe: "not-copy" }; | ||
|
|
||
| expect(() => render(<PlayerFeature title="Player" song={song} />)).not.toThrow(); | ||
| expect(screen.queryByText("not-copy")).toBeNull(); | ||
| }); | ||
| }); |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,54 +1,110 @@ | ||
| import type { RehearsalSong } from "@bandscope/shared-types"; | ||
| import { | ||
| SECTION_FORM_LABELS, | ||
| type RehearsalSection, | ||
| type RehearsalSong, | ||
| type SectionFormLabel | ||
| } from "@bandscope/shared-types"; | ||
| import { FirstPreChorusCallout } from "../workspace/FirstPreChorusCallout"; | ||
| import { createTranslator, detectPreferredLocale, translateSectionFormLabel } from "../../i18n"; | ||
|
|
||
| /** Documented. */ | ||
| export function PlayerFeature(props: { title: string; song?: RehearsalSong | null }) { | ||
| const { title, song } = props; | ||
| type PlayerFeatureProps = { | ||
| title: string; | ||
| song?: RehearsalSong | null; | ||
| onPlayFromSeconds?: (startSeconds: number) => void; | ||
| }; | ||
|
|
||
| /** Return whether one runtime section is safe to summarize in the player. */ | ||
| function isPlayerSummarySection(value: unknown): value is RehearsalSection { | ||
| if (value === null || typeof value !== "object") { | ||
| return false; | ||
| } | ||
| const section = value as Partial<RehearsalSection>; | ||
| return ( | ||
| typeof section.id === "string" && | ||
| section.id.trim().length > 0 && | ||
| typeof section.label === "string" && | ||
| SECTION_FORM_LABELS.includes(section.label as SectionFormLabel) | ||
| ); | ||
| } | ||
|
|
||
| /** Return dense, individually valid sections without trusting runtime collection metadata. */ | ||
| function playerSummarySections(song: RehearsalSong): RehearsalSection[] { | ||
| const sections = song.sections as unknown; | ||
| if (!Array.isArray(sections)) { | ||
| return []; | ||
| } | ||
| const length = Number(sections.length); | ||
| if (!Number.isSafeInteger(length) || length < 0 || length > 0xffffffff) { | ||
| return []; | ||
| } | ||
| for (let index = 0; index < length; index += 1) { | ||
| if (!(index in sections)) { | ||
| return []; | ||
| } | ||
| } | ||
| return sections.filter(isPlayerSummarySection); | ||
| } | ||
|
|
||
| /** Player surface that names tonight's first labeled pre-chorus and delegates playback to the owning player. */ | ||
| export function PlayerFeature({ title, song, onPlayFromSeconds }: PlayerFeatureProps) { | ||
| const locale = detectPreferredLocale(); | ||
| const t = createTranslator(locale); | ||
|
|
||
| if (!song) { | ||
| return ( | ||
| <section style={{ padding: "24px" }}> | ||
| <h2>{title}</h2> | ||
| <p style={{ color: "#999" }}>No song loaded. Start an analysis to use the player.</p> | ||
| <p style={{ color: "#999" }}>{t("firstPreChorusNeedsSong")}</p> | ||
| </section> | ||
| ); | ||
| } | ||
|
|
||
| const sections = playerSummarySections(song); | ||
| const songTitle = typeof song.title === "string" ? song.title : ""; | ||
| const sectionCountLabel = t( | ||
| sections.length === 1 | ||
| ? "metricConfidenceSectionCountSingular" | ||
| : "metricConfidenceSectionCountPlural" | ||
| ).replace("{count}", String(sections.length)); | ||
|
|
||
| return ( | ||
| <section style={{ padding: "24px" }}> | ||
| <h2>{title}</h2> | ||
| <FirstPreChorusCallout song={song} actionMode="callback-only" onHearPreChorus={onPlayFromSeconds} /> | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔍 Player Hear action has no production wiring
Was this helpful? React with 👍 or 👎 to provide feedback. |
||
| <div | ||
| style={{ | ||
| padding: "16px", | ||
| backgroundColor: "#fafafa", | ||
| borderRadius: "8px", | ||
| border: "1px solid #e8e8e8", | ||
| marginTop: "16px" | ||
| }} | ||
| > | ||
| <div style={{ marginBottom: "12px" }}> | ||
| <strong>{song.title}</strong> | ||
| <strong>{songTitle}</strong> | ||
| <span style={{ color: "#666", marginLeft: "8px" }}> | ||
| {song.sections.length} {song.sections.length === 1 ? "section" : "sections"} | ||
| {sectionCountLabel} | ||
| </span> | ||
| </div> | ||
| <div style={{ display: "flex", gap: "8px", flexWrap: "wrap" }}> | ||
| {song.sections.map((section) => ( | ||
| {sections.map((section, sectionIndex) => ( | ||
| <span | ||
| key={section.id} | ||
| key={`${section.id}-${sectionIndex}`} | ||
| style={{ | ||
| padding: "4px 12px", | ||
| borderRadius: "16px", | ||
| backgroundColor: "#fff", | ||
| border: "1px solid #d9d9d9", | ||
| fontSize: "0.85em", | ||
| textTransform: "capitalize", | ||
| textTransform: "capitalize" | ||
| }} | ||
| > | ||
| {section.label} | ||
| {translateSectionFormLabel(locale, section.label)} | ||
| </span> | ||
| ))} | ||
| </div> | ||
| <div style={{ marginTop: "16px", color: "#999", fontSize: "0.85em" }}> | ||
| Audio playback requires the desktop app with a local audio source. | ||
| {t("playerAudioPlaybackRequiresDesktop")} | ||
| </div> | ||
| </div> | ||
| </section> | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| import { fireEvent, render, screen } from "@testing-library/react"; | ||
| import { createDemoRehearsalSong } from "@bandscope/shared-types"; | ||
| import { afterEach, describe, expect, it, vi } from "vitest"; | ||
| import { FirstPreChorusCallout } from "./FirstPreChorusCallout"; | ||
|
|
||
| function songWithPreChorus() { | ||
| const song = createDemoRehearsalSong(); | ||
| const seed = song.sections[0]!; | ||
| const preChorus = structuredClone(seed); | ||
| preChorus.id = "pre-chorus-1"; | ||
| preChorus.label = "pre-chorus"; | ||
| preChorus.timeRange = { start: 20, end: 28 }; | ||
| preChorus.roles = [ | ||
| { | ||
| ...seed.roles[2]!, | ||
| id: "lead-vocal", | ||
| name: "Lead Vocal", | ||
| rehearsalPriority: "high" | ||
| } | ||
| ]; | ||
| preChorus.partGraph = [ | ||
| { | ||
| role_id: "lead-vocal", | ||
| is_active: true, | ||
| handoff_to: [], | ||
| handoff_from: [] | ||
| } | ||
| ]; | ||
| song.sections = [preChorus]; | ||
| return song; | ||
| } | ||
|
|
||
| describe("FirstPreChorusCallout reduced motion", () => { | ||
| afterEach(() => { | ||
| vi.unstubAllGlobals(); | ||
| }); | ||
|
|
||
| it("scrolls immediately when the operating system requests reduced motion", () => { | ||
| vi.stubGlobal("matchMedia", (query: string) => ({ | ||
| matches: query === "(prefers-reduced-motion: reduce)", | ||
| media: query, | ||
| onchange: null, | ||
| addListener: vi.fn(), | ||
| removeListener: vi.fn(), | ||
| addEventListener: vi.fn(), | ||
| removeEventListener: vi.fn(), | ||
| dispatchEvent: vi.fn() | ||
| })); | ||
|
|
||
| const grid = document.createElement("div"); | ||
| grid.dataset.testid = "song-structure-grid"; | ||
| const target = document.createElement("div"); | ||
| const scrollIntoView = vi.fn(); | ||
| Object.defineProperty(target, "scrollIntoView", { | ||
| configurable: true, | ||
| value: scrollIntoView | ||
| }); | ||
| grid.appendChild(target); | ||
| document.body.appendChild(grid); | ||
|
|
||
| render(<FirstPreChorusCallout song={songWithPreChorus()} />); | ||
| fireEvent.click(screen.getByRole("button", { name: "Open Lead Vocal pre-chorus at 0:20" })); | ||
| expect(scrollIntoView).toHaveBeenCalledWith({ block: "nearest", behavior: "auto" }); | ||
|
|
||
| grid.remove(); | ||
| }); | ||
| }); |
Uh oh!
There was an error while loading. Please reload this page.