Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions react/src/shared/models/comment.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
export interface Comment {
id: number;
level: number;
user: string;
time: number;
time_ago: string;
content: string;
deleted?: boolean;
comments: Comment[];
}
7 changes: 7 additions & 0 deletions react/src/shared/models/feed-type.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { FEED_NAMES } from '.';

describe('FEED_NAMES', () => {
it('lists every HN feed in nav order', () => {
expect(FEED_NAMES).toEqual(['news', 'newest', 'show', 'ask', 'jobs']);
});
});
6 changes: 6 additions & 0 deletions react/src/shared/models/feed-type.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/** Angular's `FeedType`: the item kinds a story can be. Renamed to avoid clashing with route feed names. */
export type ItemType = 'poll' | 'story' | 'job';

export type FeedName = 'news' | 'newest' | 'show' | 'ask' | 'jobs';

export const FEED_NAMES: readonly FeedName[] = ['news', 'newest', 'show', 'ask', 'jobs'];
7 changes: 7 additions & 0 deletions react/src/shared/models/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export type { Comment } from './comment';
export type { FeedName, ItemType } from './feed-type';
export { FEED_NAMES } from './feed-type';
export type { PollResult } from './poll-result';
export type { Settings } from './settings';
export type { Story } from './story';
export type { User } from './user';
4 changes: 4 additions & 0 deletions react/src/shared/models/poll-result.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export interface PollResult {
points: number;
content: string;
}
9 changes: 9 additions & 0 deletions react/src/shared/models/settings.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import type { Theme } from '../services/settings';

export interface Settings {
showSettings: boolean;
openLinkInNewTab: boolean;
theme: Theme;
titleFontSize: string;
listSpacing: string;
}
23 changes: 23 additions & 0 deletions react/src/shared/models/story.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import type { Comment } from './comment';
import type { ItemType } from './feed-type';
import type { PollResult } from './poll-result';

export interface Story {
id: number;
title: string;
points: number;
user: string;
time: number;
time_ago: string;
/** node-hnapi also returns 'link' (stories with a URL), 'ask' and 'comment'. */
type: ItemType | 'link' | 'ask' | 'comment';
url?: string;
domain?: string;
content?: string;
comments?: Comment[];
comments_count?: number;
poll?: PollResult[];
poll_votes_count?: number;
deleted?: boolean;
dead?: boolean;
}
9 changes: 9 additions & 0 deletions react/src/shared/models/user.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
export interface User {
id: string;
/** Typo kept from the Angular model for parity. */
crated_time?: number;
created: string;
karma: number;
avg?: number;
about?: string;
}
137 changes: 137 additions & 0 deletions react/src/shared/services/SettingsProvider.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
import { act, render, renderHook, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';

import { mockMatchMedia, type MatchMediaMock } from '../../test/matchMedia';
import { SettingsProvider } from './SettingsProvider';
import { useSettings } from './useSettings';

function Consumer() {
const { settings, toggleSettings, toggleOpenLinksInNewTab, setTheme, setFont, setSpacing } = useSettings();
return (
<div>
<output data-testid="settings">{JSON.stringify(settings)}</output>
<button onClick={toggleSettings}>toggle settings</button>
<button onClick={toggleOpenLinksInNewTab}>toggle new tab</button>
<button onClick={() => setTheme('amoledblack')}>black theme</button>
<button onClick={() => setFont('20')}>font 20</button>
<button onClick={() => setSpacing('10')}>spacing 10</button>
</div>
);
}

function renderConsumer() {
return render(
<SettingsProvider>
<Consumer />
</SettingsProvider>
);
}

function currentSettings() {
return JSON.parse(screen.getByTestId('settings').textContent ?? '{}');
}

describe('SettingsProvider / useSettings', () => {
let media: MatchMediaMock;

beforeEach(() => {
media = mockMatchMedia(false);
});

afterEach(() => {
media.restore();
});

it('initialises from defaults and persists the system theme on first load', () => {
renderConsumer();
expect(currentSettings()).toEqual({
showSettings: false,
openLinkInNewTab: false,
theme: 'default',
titleFontSize: '16',
listSpacing: '0',
});
expect(localStorage.getItem('theme')).toBe('default');
expect(localStorage.getItem('openLinkInNewTab')).toBeNull();
expect(localStorage.getItem('titleFontSize')).toBeNull();
expect(localStorage.getItem('listSpacing')).toBeNull();
});

it('persists the dark system theme on first load', () => {
media.setMatches(true);
renderConsumer();
expect(currentSettings().theme).toBe('night');
expect(localStorage.getItem('theme')).toBe('night');
});

it('keeps a previously saved theme', () => {
media.setMatches(true);
localStorage.setItem('theme', 'amoledblack');
localStorage.setItem('titleFontSize', '24');
renderConsumer();
expect(currentSettings()).toMatchObject({ theme: 'amoledblack', titleFontSize: '24' });
expect(localStorage.getItem('theme')).toBe('amoledblack');
});

it('toggleSettings flips showSettings without persisting', async () => {
const user = userEvent.setup();
renderConsumer();
await user.click(screen.getByRole('button', { name: 'toggle settings' }));
expect(currentSettings().showSettings).toBe(true);
await user.click(screen.getByRole('button', { name: 'toggle settings' }));
expect(currentSettings().showSettings).toBe(false);
expect(Object.keys(localStorage)).toEqual(['theme']);
});

it('toggleOpenLinksInNewTab flips and persists the value as JSON', async () => {
const user = userEvent.setup();
renderConsumer();
await user.click(screen.getByRole('button', { name: 'toggle new tab' }));
expect(currentSettings().openLinkInNewTab).toBe(true);
expect(localStorage.getItem('openLinkInNewTab')).toBe('true');
await user.click(screen.getByRole('button', { name: 'toggle new tab' }));
expect(currentSettings().openLinkInNewTab).toBe(false);
expect(localStorage.getItem('openLinkInNewTab')).toBe('false');
});

it('setTheme, setFont and setSpacing update state and persist', async () => {
const user = userEvent.setup();
renderConsumer();
await user.click(screen.getByRole('button', { name: 'black theme' }));
await user.click(screen.getByRole('button', { name: 'font 20' }));
await user.click(screen.getByRole('button', { name: 'spacing 10' }));
expect(currentSettings()).toMatchObject({ theme: 'amoledblack', titleFontSize: '20', listSpacing: '10' });
expect(localStorage.getItem('theme')).toBe('amoledblack');
expect(localStorage.getItem('titleFontSize')).toBe('20');
expect(localStorage.getItem('listSpacing')).toBe('10');
});

it('follows system colour scheme changes and unsubscribes on unmount', () => {
localStorage.setItem('theme', 'amoledblack');
const { unmount } = renderConsumer();
expect(media.listenerCount()).toBe(1);

act(() => media.setMatches(true));
expect(currentSettings().theme).toBe('night');
expect(localStorage.getItem('theme')).toBe('night');

act(() => media.setMatches(false));
expect(currentSettings().theme).toBe('default');
expect(localStorage.getItem('theme')).toBe('default');

unmount();
expect(media.listenerCount()).toBe(0);
});

it('works without matchMedia support', () => {
media.restore();
renderConsumer();
expect(currentSettings().theme).toBe('default');
expect(localStorage.getItem('theme')).toBe('default');
});

it('useSettings throws a descriptive error outside SettingsProvider', () => {
vi.spyOn(console, 'error').mockImplementation(() => {});
expect(() => renderHook(() => useSettings())).toThrow('useSettings must be used within a <SettingsProvider>.');
});
});
67 changes: 67 additions & 0 deletions react/src/shared/services/SettingsProvider.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
import { useCallback, useEffect, useMemo, useState, type ReactNode } from 'react';

import type { Settings } from '../models';
import {
DARK_SCHEME_QUERY,
getSavedTheme,
getSystemTheme,
loadSettings,
saveListSpacing,
saveOpenLinkInNewTab,
saveTheme,
saveTitleFontSize,
type Theme,
} from './settings';
import { SettingsContext, type SettingsContextValue } from './settingsContext';

export function SettingsProvider({ children }: { children: ReactNode }) {
const [settings, setSettings] = useState<Settings>(loadSettings);

const setTheme = useCallback((theme: Theme) => {
saveTheme(theme);
setSettings((current) => ({ ...current, theme }));
}, []);

const toggleSettings = useCallback(() => {
setSettings((current) => ({ ...current, showSettings: !current.showSettings }));
}, []);

const { openLinkInNewTab } = settings;
const toggleOpenLinksInNewTab = useCallback(() => {
saveOpenLinkInNewTab(!openLinkInNewTab);
setSettings((current) => ({ ...current, openLinkInNewTab: !openLinkInNewTab }));
}, [openLinkInNewTab]);

const setFont = useCallback((titleFontSize: string) => {
saveTitleFontSize(titleFontSize);
setSettings((current) => ({ ...current, titleFontSize }));
}, []);

const setSpacing = useCallback((listSpacing: string) => {
saveListSpacing(listSpacing);
setSettings((current) => ({ ...current, listSpacing }));
}, []);

useEffect(() => {
if (getSavedTheme() === null) {
setTheme(getSystemTheme());
}
}, [setTheme]);

useEffect(() => {
if (typeof window.matchMedia !== 'function') {
return;
}
const darkScheme = window.matchMedia(DARK_SCHEME_QUERY);
const handleChange = (event: MediaQueryListEvent) => setTheme(event.matches ? 'night' : 'default');
darkScheme.addEventListener('change', handleChange);
return () => darkScheme.removeEventListener('change', handleChange);
}, [setTheme]);

const value = useMemo<SettingsContextValue>(
() => ({ settings, toggleSettings, toggleOpenLinksInNewTab, setTheme, setFont, setSpacing }),
[settings, toggleSettings, toggleOpenLinksInNewTab, setTheme, setFont, setSpacing]
);

return <SettingsContext.Provider value={value}>{children}</SettingsContext.Provider>;
}
Loading
Loading