-
Notifications
You must be signed in to change notification settings - Fork 10.4k
feat: Show snowfall animation for holiday theme #15494
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
99b99fc
Holiday logo
sehoon38 343b9d8
integrate with holiday theme
sehoon38 239139f
integrate with holiday theme. do not show snowfall in short width. st…
sehoon38 d52c704
stops snow animation after 15 sec
sehoon38 ffca0de
add useSnowfall test
sehoon38 cd6983b
fix test
sehoon38 dd468df
when checking history, do not check for /theme
sehoon38 202dc3a
Merge branch 'main' into sehoon/holiday
jackwotherspoon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest'; | ||
| import { useSnowfall } from './useSnowfall.js'; | ||
| import { themeManager } from '../themes/theme-manager.js'; | ||
| import { renderHookWithProviders } from '../../test-utils/render.js'; | ||
| import { act } from 'react'; | ||
| import { debugState } from '../debug.js'; | ||
| import type { Theme } from '../themes/theme.js'; | ||
| import type { UIState } from '../contexts/UIStateContext.js'; | ||
|
|
||
| vi.mock('../themes/theme-manager.js', () => ({ | ||
| themeManager: { | ||
| getActiveTheme: vi.fn(), | ||
| }, | ||
| })); | ||
|
|
||
| vi.mock('../themes/holiday.js', () => ({ | ||
| Holiday: { name: 'Holiday' }, | ||
| })); | ||
|
|
||
| vi.mock('./useTerminalSize.js', () => ({ | ||
| useTerminalSize: vi.fn(() => ({ columns: 120, rows: 20 })), | ||
| })); | ||
|
|
||
| describe('useSnowfall', () => { | ||
| const mockArt = 'LOGO'; | ||
|
|
||
| beforeEach(() => { | ||
| vi.clearAllMocks(); | ||
| vi.useFakeTimers(); | ||
| vi.mocked(themeManager.getActiveTheme).mockReturnValue({ | ||
| name: 'Holiday', | ||
| } as Theme); | ||
| vi.setSystemTime(new Date('2025-12-25')); | ||
| debugState.debugNumAnimatedComponents = 0; | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| vi.useRealTimers(); | ||
| }); | ||
|
|
||
| it('initially enables animation during holiday season with Holiday theme', () => { | ||
| const { result } = renderHookWithProviders(() => useSnowfall(mockArt), { | ||
| uiState: { history: [], historyRemountKey: 0 } as Partial<UIState>, | ||
| }); | ||
|
|
||
| // Should contain holiday trees | ||
| expect(result.current).toContain('|_|'); | ||
| // Should have started animation | ||
| expect(debugState.debugNumAnimatedComponents).toBeGreaterThan(0); | ||
| }); | ||
|
|
||
| it('stops animation after 15 seconds', () => { | ||
| const { result } = renderHookWithProviders(() => useSnowfall(mockArt), { | ||
| uiState: { history: [], historyRemountKey: 0 } as Partial<UIState>, | ||
| }); | ||
|
|
||
| expect(debugState.debugNumAnimatedComponents).toBeGreaterThan(0); | ||
|
|
||
| act(() => { | ||
| vi.advanceTimersByTime(15001); | ||
| }); | ||
|
|
||
| // Animation should be stopped | ||
| expect(debugState.debugNumAnimatedComponents).toBe(0); | ||
| // Should no longer contain trees | ||
| expect(result.current).toBe(mockArt); | ||
| }); | ||
|
|
||
| it('does not enable animation if not holiday season', () => { | ||
| vi.setSystemTime(new Date('2025-06-15')); | ||
| const { result } = renderHookWithProviders(() => useSnowfall(mockArt), { | ||
| uiState: { history: [], historyRemountKey: 0 } as Partial<UIState>, | ||
| }); | ||
|
|
||
| expect(result.current).toBe(mockArt); | ||
| expect(debugState.debugNumAnimatedComponents).toBe(0); | ||
| }); | ||
|
|
||
| it('does not enable animation if theme is not Holiday', () => { | ||
| vi.mocked(themeManager.getActiveTheme).mockReturnValue({ | ||
| name: 'Default', | ||
| } as Theme); | ||
| const { result } = renderHookWithProviders(() => useSnowfall(mockArt), { | ||
| uiState: { history: [], historyRemountKey: 0 } as Partial<UIState>, | ||
| }); | ||
|
|
||
| expect(result.current).toBe(mockArt); | ||
| expect(debugState.debugNumAnimatedComponents).toBe(0); | ||
| }); | ||
|
|
||
| it('does not enable animation if chat has started', () => { | ||
| const { result } = renderHookWithProviders(() => useSnowfall(mockArt), { | ||
| uiState: { | ||
| history: [{ type: 'user', text: 'hello' }], | ||
| historyRemountKey: 0, | ||
| } as Partial<UIState>, | ||
| }); | ||
|
|
||
| expect(result.current).toBe(mockArt); | ||
| expect(debugState.debugNumAnimatedComponents).toBe(0); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,162 @@ | ||
| /** | ||
| * @license | ||
| * Copyright 2025 Google LLC | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { useState, useEffect, useMemo } from 'react'; | ||
| import { getAsciiArtWidth } from '../utils/textUtils.js'; | ||
| import { debugState } from '../debug.js'; | ||
| import { themeManager } from '../themes/theme-manager.js'; | ||
| import { Holiday } from '../themes/holiday.js'; | ||
| import { useUIState } from '../contexts/UIStateContext.js'; | ||
| import { useTerminalSize } from './useTerminalSize.js'; | ||
| import { shortAsciiLogo } from '../components/AsciiArt.js'; | ||
|
|
||
| interface Snowflake { | ||
| x: number; | ||
| y: number; | ||
| char: string; | ||
| } | ||
|
|
||
| const SNOW_CHARS = ['*', '.', '·', '+']; | ||
| const FRAME_RATE = 150; // ms | ||
|
|
||
| const addHolidayTrees = (art: string): string => { | ||
| const holidayTree = ` | ||
| * | ||
| *** | ||
| ***** | ||
| ******* | ||
| ********* | ||
| |_|`; | ||
|
|
||
| const treeLines = holidayTree.split('\n').filter((l) => l.length > 0); | ||
| const treeWidth = getAsciiArtWidth(holidayTree); | ||
| const logoWidth = getAsciiArtWidth(art); | ||
|
|
||
| // Create three trees side by side | ||
| const treeSpacing = ' '; | ||
| const tripleTreeLines = treeLines.map((line) => { | ||
| const paddedLine = line.padEnd(treeWidth, ' '); | ||
| return `${paddedLine}${treeSpacing}${paddedLine}${treeSpacing}${paddedLine}`; | ||
| }); | ||
|
|
||
| const tripleTreeWidth = treeWidth * 3 + treeSpacing.length * 2; | ||
| const paddingCount = Math.max( | ||
| 0, | ||
| Math.floor((logoWidth - tripleTreeWidth) / 2), | ||
| ); | ||
| const treePadding = ' '.repeat(paddingCount); | ||
|
|
||
| const centeredTripleTrees = tripleTreeLines | ||
| .map((line) => treePadding + line) | ||
| .join('\n'); | ||
|
|
||
| // Add vertical padding and the trees below the logo | ||
| return `\n\n${art}\n${centeredTripleTrees}\n\n`; | ||
| }; | ||
|
|
||
| export const useSnowfall = (displayTitle: string): string => { | ||
| const isHolidaySeason = | ||
| new Date().getMonth() === 11 || new Date().getMonth() === 0; | ||
|
|
||
| const currentTheme = themeManager.getActiveTheme(); | ||
| const { columns: terminalWidth } = useTerminalSize(); | ||
| const { history, historyRemountKey } = useUIState(); | ||
|
|
||
| const hasStartedChat = history.some( | ||
| (item) => item.type === 'user' && item.text !== '/theme', | ||
| ); | ||
| const widthOfShortLogo = getAsciiArtWidth(shortAsciiLogo); | ||
|
|
||
| const [showSnow, setShowSnow] = useState(true); | ||
|
|
||
| useEffect(() => { | ||
| setShowSnow(true); | ||
| const timer = setTimeout(() => { | ||
| setShowSnow(false); | ||
| }, 15000); | ||
| return () => clearTimeout(timer); | ||
| }, [historyRemountKey]); | ||
|
|
||
| const showAnimation = | ||
| isHolidaySeason && | ||
| currentTheme.name === Holiday.name && | ||
| terminalWidth >= widthOfShortLogo && | ||
| !hasStartedChat && | ||
| showSnow; | ||
|
|
||
| const displayArt = useMemo(() => { | ||
| if (showAnimation) { | ||
| return addHolidayTrees(displayTitle); | ||
| } | ||
| return displayTitle; | ||
| }, [displayTitle, showAnimation]); | ||
|
|
||
| const [snowflakes, setSnowflakes] = useState<Snowflake[]>([]); | ||
| // We don't need 'frame' state if we just use functional updates for snowflakes, | ||
| // but we need a trigger. A simple interval is fine. | ||
|
|
||
| const lines = displayArt.split('\n'); | ||
| const height = lines.length; | ||
| const width = getAsciiArtWidth(displayArt); | ||
|
|
||
| useEffect(() => { | ||
| if (!showAnimation) { | ||
| setSnowflakes([]); | ||
| return; | ||
| } | ||
| debugState.debugNumAnimatedComponents++; | ||
|
|
||
| const timer = setInterval(() => { | ||
| setSnowflakes((prev) => { | ||
| // Move existing flakes | ||
| const moved = prev | ||
| .map((flake) => ({ ...flake, y: flake.y + 1 })) | ||
| .filter((flake) => flake.y < height); | ||
|
|
||
| // Spawn new flakes | ||
| // Adjust spawn rate based on width to keep density consistent | ||
| const spawnChance = 0.3; | ||
| const newFlakes: Snowflake[] = []; | ||
|
|
||
| if (Math.random() < spawnChance) { | ||
| // Spawn 1 to 2 flakes | ||
| const count = Math.floor(Math.random() * 2) + 1; | ||
| for (let i = 0; i < count; i++) { | ||
| newFlakes.push({ | ||
| x: Math.floor(Math.random() * width), | ||
| y: 0, | ||
| char: SNOW_CHARS[Math.floor(Math.random() * SNOW_CHARS.length)], | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| return [...moved, ...newFlakes]; | ||
| }); | ||
| }, FRAME_RATE); | ||
| return () => { | ||
| debugState.debugNumAnimatedComponents--; | ||
| clearInterval(timer); | ||
| }; | ||
| }, [height, width, showAnimation]); | ||
|
|
||
| if (!showAnimation) return displayTitle; | ||
|
|
||
| // Render current frame | ||
| if (snowflakes.length === 0) return displayArt; | ||
| const grid = lines.map((line) => line.padEnd(width, ' ').split('')); | ||
|
|
||
| snowflakes.forEach((flake) => { | ||
| if (flake.y >= 0 && flake.y < height && flake.x >= 0 && flake.x < width) { | ||
| // Overwrite with snow character | ||
| // We check if the row exists just in case | ||
| if (grid[flake.y]) { | ||
| grid[flake.y][flake.x] = flake.char; | ||
| } | ||
| } | ||
| }); | ||
|
|
||
| return grid.map((row) => row.join('')).join('\n'); | ||
| }; | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.