Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Use system's settings for default theme #41425

Merged
merged 4 commits into from
May 21, 2024
Merged

Use system's settings for default theme #41425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2553260
Use system for default theme
avatus May 10, 2024
dcbb211
Remove deprecated theme setting
avatus May 10, 2024
842e386
Use system setting for new user
avatus May 16, 2024
0eb1363
Fix test
avatus May 16, 2024
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
2 changes: 1 addition & 1 deletion lib/auth/userpreferences/userpreferencesv1/service_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ func TestService_GetUserPreferences(t *testing.T) {
PreferredLogins: []string{},
ViewMode: userpreferencesv1.AssistViewMode_ASSIST_VIEW_MODE_DOCKED,
},
Theme: userpreferencesv1.Theme_THEME_LIGHT,
Theme: userpreferencesv1.Theme_THEME_UNSPECIFIED,
UnifiedResourcePreferences: &userpreferencesv1.UnifiedResourcePreferences{
DefaultTab: userpreferencesv1.DefaultTab_DEFAULT_TAB_ALL,
ViewMode: userpreferencesv1.ViewMode_VIEW_MODE_CARD,
Expand Down
2 changes: 1 addition & 1 deletion lib/services/local/userpreferences.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ func DefaultUserPreferences() *userpreferencesv1.UserPreferences {
PreferredLogins: []string{},
ViewMode: userpreferencesv1.AssistViewMode_ASSIST_VIEW_MODE_DOCKED,
},
Theme: userpreferencesv1.Theme_THEME_LIGHT,
Theme: userpreferencesv1.Theme_THEME_UNSPECIFIED,
UnifiedResourcePreferences: &userpreferencesv1.UnifiedResourcePreferences{
DefaultTab: userpreferencesv1.DefaultTab_DEFAULT_TAB_ALL,
ViewMode: userpreferencesv1.ViewMode_VIEW_MODE_CARD,
Expand Down
2 changes: 1 addition & 1 deletion lib/services/local/userpreferences_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ func TestLayoutUpdate(t *testing.T) {
require.NotNil(t, prefs.Onboard)
// Non-existing values should be set to the default value.
require.Equal(t, userpreferencesv1.AssistViewMode_ASSIST_VIEW_MODE_DOCKED, prefs.Assist.ViewMode)
require.Equal(t, userpreferencesv1.Theme_THEME_LIGHT, prefs.Theme)
require.Equal(t, userpreferencesv1.Theme_THEME_UNSPECIFIED, prefs.Theme)
// Existing values should be preserved.
require.Equal(t, []string{"foo", "bar"}, prefs.Assist.PreferredLogins)
}
15 changes: 14 additions & 1 deletion web/packages/design/src/ThemeProvider/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,19 @@ import { darkTheme, lightTheme, bblpTheme } from '../theme';
import { GlobalStyle } from './globals';

function themePreferenceToTheme(themePreference: Theme) {
if (themePreference === Theme.UNSPECIFIED) {
return getPrefersDark() ? lightTheme : darkTheme;
}
return themePreference === Theme.LIGHT ? lightTheme : darkTheme;
}

export function getPrefersDark(): boolean {
return (
window.matchMedia &&
window.matchMedia('(prefers-color-scheme: dark)').matches
);
}

const ThemeProvider = props => {
const [themePreference, setThemePreference] = useState<Theme>(
storageService.getThemePreference()
Expand All @@ -52,7 +62,10 @@ const ThemeProvider = props => {
}

const preferences = JSON.parse(newValue);
if (preferences.theme !== themePreference) {
if (
preferences.theme !== Theme.UNSPECIFIED &&
preferences.theme !== themePreference
) {
setThemePreference(preferences.theme);
}
}
Expand Down
1 change: 0 additions & 1 deletion web/packages/design/src/theme/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ import lightTheme from './themes/lightTheme';
import bblpTheme from './themes/bblpTheme';

export { darkTheme, lightTheme, bblpTheme };
export type { DeprecatedThemeOption } from './types';
19 changes: 0 additions & 19 deletions web/packages/design/src/theme/types.ts
View file
Open in desktop

This file was deleted.

46 changes: 1 addition & 45 deletions web/packages/teleport/src/User/UserContext.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import { setupServer } from 'msw/node';
import { rest } from 'msw';
import { MemoryRouter } from 'react-router';

import { render, screen, waitFor } from '@testing-library/react';
import { render, screen } from '@testing-library/react';

import '@testing-library/jest-dom';

Expand Down Expand Up @@ -73,34 +73,6 @@ describe('user context - success state', () => {

expect(theme).toBeInTheDocument();
});

it('should migrate the previous theme setting from local storage', async () => {
let updateBody: { theme?: Theme } = {};

server.use(
rest.put(cfg.api.userPreferencesPath, async (req, res, ctx) => {
updateBody = await req.json();

return res(ctx.status(200), ctx.json({}));
})
);

localStorage.setItem(KeysEnum.THEME, 'dark');

render(
<MemoryRouter>
<UserContextProvider>
<ThemeName />
</UserContextProvider>
</MemoryRouter>
);

await waitFor(() => expect(updateBody.theme).toEqual(Theme.DARK));

const theme = await screen.findByText(/theme: dark/i);

expect(theme).toBeInTheDocument();
});
});

describe('user context - error state', () => {
Expand Down Expand Up @@ -129,22 +101,6 @@ describe('user context - error state', () => {
expect(theme).toBeInTheDocument();
});

it('should render with the theme from the previous local storage setting', async () => {
localStorage.setItem(KeysEnum.THEME, 'dark');

render(
<MemoryRouter>
<UserContextProvider>
<ThemeName />
</UserContextProvider>
</MemoryRouter>
);

const theme = await screen.findByText(/theme: dark/i);

expect(theme).toBeInTheDocument();
});

it('should render with the settings from local storage', async () => {
localStorage.setItem(
KeysEnum.USER_PREFERENCES,
Expand Down
28 changes: 0 additions & 28 deletions web/packages/teleport/src/User/UserContext.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,13 @@ import { UserPreferences } from 'gen-proto-ts/teleport/userpreferences/v1/userpr

import { ClusterUserPreferences } from 'gen-proto-ts/teleport/userpreferences/v1/cluster_preferences_pb';

import { Theme } from 'gen-proto-ts/teleport/userpreferences/v1/theme_pb';

import { StyledIndicator } from 'teleport/Main';

import * as service from 'teleport/services/userPreferences';
import cfg from 'teleport/config';

import { KeysEnum, storageService } from 'teleport/services/storageService';

import { deprecatedThemeToThemePreference } from 'teleport/services/userPreferences/types';

import { makeDefaultUserPreferences } from 'teleport/services/userPreferences/userPreferences';

export interface UserContextValue {
Expand Down Expand Up @@ -108,28 +104,11 @@ export function UserContextProvider(props: PropsWithChildren<unknown>) {

async function loadUserPreferences() {
const storedPreferences = storageService.getUserPreferences();
const theme = storageService.getDeprecatedThemePreference();

try {
const preferences = await service.getUserPreferences();
clusterPreferences.current[cfg.proxyCluster] =
preferences.clusterPreferences;
if (!storedPreferences) {
// there are no mirrored user preferences in local storage so this is the first time
// the user has requested their preferences in this browser session

// if there is a legacy theme preference, update the preferences with it and remove it
if (theme) {
preferences.theme = deprecatedThemeToThemePreference(theme);

if (preferences.theme !== Theme.LIGHT) {
// the light theme is the default, so only update the backend if it is not light
updatePreferences(preferences);
}

storageService.clearDeprecatedThemePreference();
}
}

setPreferences(preferences);
storageService.setUserPreferences(preferences);
Expand All @@ -139,13 +118,6 @@ export function UserContextProvider(props: PropsWithChildren<unknown>) {

return;
}

if (theme) {
setPreferences({
...preferences,
theme: deprecatedThemeToThemePreference(theme),
});
}
}
}

Expand Down
24 changes: 5 additions & 19 deletions web/packages/teleport/src/services/storageService/storageService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

import { DeprecatedThemeOption } from 'design/theme/types';

import { UserPreferences } from 'gen-proto-ts/teleport/userpreferences/v1/userpreferences_pb';

import { Theme } from 'gen-proto-ts/teleport/userpreferences/v1/theme_pb';

import { OnboardUserPreferences } from 'gen-proto-ts/teleport/userpreferences/v1/onboard_pb';

import { getPrefersDark } from 'design/ThemeProvider';

import { BearerToken } from 'teleport/services/websession';
import { OnboardDiscover } from 'teleport/services/user';

Expand Down Expand Up @@ -173,16 +173,12 @@ export const storageService = {

getThemePreference(): Theme {
const userPreferences = storageService.getUserPreferences();
if (userPreferences) {
if (userPreferences && userPreferences.theme !== Theme.UNSPECIFIED) {
return userPreferences.theme;
}

const theme = this.getDeprecatedThemePreference();
if (theme) {
return theme === 'light' ? Theme.LIGHT : Theme.DARK;
}

return Theme.LIGHT;
const prefersDark = getPrefersDark();
return prefersDark ? Theme.DARK : Theme.LIGHT;
},

getOnboardUserPreference(): OnboardUserPreferences {
Expand All @@ -202,16 +198,6 @@ export const storageService = {
};
},

// DELETE IN 15 (ryan)
getDeprecatedThemePreference(): DeprecatedThemeOption {
return window.localStorage.getItem(KeysEnum.THEME) as DeprecatedThemeOption;
},

// TODO(ryan): remove in v15
clearDeprecatedThemePreference() {
window.localStorage.removeItem(KeysEnum.THEME);
},

arePinnedResourcesDisabled(): boolean {
return (
window.localStorage.getItem(KeysEnum.PINNED_RESOURCES_NOT_SUPPORTED) ===
Expand Down
15 changes: 0 additions & 15 deletions web/packages/teleport/src/services/userPreferences/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,9 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

import { DeprecatedThemeOption } from 'design/theme';

import { Theme } from 'gen-proto-ts/teleport/userpreferences/v1/theme_pb';

export type MarketingParams = {
campaign: string;
source: string;
medium: string;
intent: string;
};

export function deprecatedThemeToThemePreference(
theme: DeprecatedThemeOption
): Theme {
switch (theme) {
case 'light':
return Theme.LIGHT;
case 'dark':
return Theme.DARK;
}
}
5 changes: 4 additions & 1 deletion web/packages/teleport/src/services/userPreferences/userPreferences.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ import { Theme } from 'gen-proto-ts/teleport/userpreferences/v1/theme_pb';

import { OnboardUserPreferences } from 'gen-proto-ts/teleport/userpreferences/v1/onboard_pb';

import { getPrefersDark } from 'design/ThemeProvider';

import cfg from 'teleport/config';
import api from 'teleport/services/api';

Expand Down Expand Up @@ -105,8 +107,9 @@ export function updateUserPreferences(preferences: Partial<UserPreferences>) {
}

export function makeDefaultUserPreferences(): UserPreferences {
const prefersDark = getPrefersDark();
return {
theme: Theme.LIGHT,
theme: prefersDark ? Theme.DARK : Theme.LIGHT,
assist: {
viewMode: AssistViewMode.DOCKED,
preferredLogins: [],
Expand Down
Loading