team preferences ui

This commit is contained in:
Marcus Efraimsson 2018-11-12 20:58:59 +01:00
parent 5f9fecd254
commit 1194ff282e
No known key found for this signature in database
GPG Key ID: EBFE0FB04612DD4A
12 changed files with 419 additions and 17 deletions

View File

@ -1,7 +1,7 @@
import React from 'react'; import React from 'react';
import { shallow } from 'enzyme'; import { shallow } from 'enzyme';
import { TeamPages, Props } from './TeamPages'; import { TeamPages, Props } from './TeamPages';
import { NavModel, Team } from '../../types'; import { NavModel, Team, OrganizationPreferences } from '../../types';
import { getMockTeam } from './__mocks__/teamMocks'; import { getMockTeam } from './__mocks__/teamMocks';
jest.mock('app/core/config', () => ({ jest.mock('app/core/config', () => ({
@ -15,6 +15,9 @@ const setup = (propOverrides?: object) => {
loadTeam: jest.fn(), loadTeam: jest.fn(),
pageName: 'members', pageName: 'members',
team: {} as Team, team: {} as Team,
loadStarredDashboards: jest.fn(),
loadTeamPreferences: jest.fn(),
preferences: {} as OrganizationPreferences,
}; };
Object.assign(props, propOverrides); Object.assign(props, propOverrides);
@ -43,10 +46,15 @@ describe('Render', () => {
expect(wrapper).toMatchSnapshot(); expect(wrapper).toMatchSnapshot();
}); });
it('should render settings page', () => { it('should render settings and preferences page', () => {
const { wrapper } = setup({ const { wrapper } = setup({
team: getMockTeam(), team: getMockTeam(),
pageName: 'settings', pageName: 'settings',
preferences: {
homeDashboardId: 1,
theme: 'Default',
timezone: 'Default',
},
}); });
expect(wrapper).toMatchSnapshot(); expect(wrapper).toMatchSnapshot();

View File

@ -7,12 +7,14 @@ import PageHeader from 'app/core/components/PageHeader/PageHeader';
import TeamMembers from './TeamMembers'; import TeamMembers from './TeamMembers';
import TeamSettings from './TeamSettings'; import TeamSettings from './TeamSettings';
import TeamGroupSync from './TeamGroupSync'; import TeamGroupSync from './TeamGroupSync';
import { NavModel, Team } from 'app/types'; import TeamPreferences from './TeamPreferences';
import { loadTeam } from './state/actions'; import { NavModel, Team, OrganizationPreferences } from 'app/types';
import { loadTeam, loadTeamPreferences } from './state/actions';
import { getTeam } from './state/selectors'; import { getTeam } from './state/selectors';
import { getTeamLoadingNav } from './state/navModel'; import { getTeamLoadingNav } from './state/navModel';
import { getNavModel } from 'app/core/selectors/navModel'; import { getNavModel } from 'app/core/selectors/navModel';
import { getRouteParamsId, getRouteParamsPage } from '../../core/selectors/location'; import { getRouteParamsId, getRouteParamsPage } from '../../core/selectors/location';
import { loadStarredDashboards } from '../../core/actions/user';
export interface Props { export interface Props {
team: Team; team: Team;
@ -20,6 +22,9 @@ export interface Props {
teamId: number; teamId: number;
pageName: string; pageName: string;
navModel: NavModel; navModel: NavModel;
preferences: OrganizationPreferences;
loadStarredDashboards: typeof loadStarredDashboards;
loadTeamPreferences: typeof loadTeamPreferences;
} }
interface State { interface State {
@ -41,14 +46,16 @@ export class TeamPages extends PureComponent<Props, State> {
}; };
} }
componentDidMount() { async componentDidMount() {
this.fetchTeam(); await this.props.loadStarredDashboards();
await this.fetchTeam();
await this.props.loadTeamPreferences();
} }
async fetchTeam() { async fetchTeam() {
const { loadTeam, teamId } = this.props; const { loadTeam, teamId } = this.props;
await loadTeam(teamId); return await loadTeam(teamId);
} }
getCurrentPage() { getCurrentPage() {
@ -66,7 +73,12 @@ export class TeamPages extends PureComponent<Props, State> {
return <TeamMembers syncEnabled={isSyncEnabled} />; return <TeamMembers syncEnabled={isSyncEnabled} />;
case PageTypes.Settings: case PageTypes.Settings:
return <TeamSettings />; return (
<div>
<TeamSettings />
<TeamPreferences />
</div>
);
case PageTypes.GroupSync: case PageTypes.GroupSync:
return isSyncEnabled && <TeamGroupSync />; return isSyncEnabled && <TeamGroupSync />;
@ -97,11 +109,14 @@ function mapStateToProps(state) {
teamId: teamId, teamId: teamId,
pageName: pageName, pageName: pageName,
team: getTeam(state.team, teamId), team: getTeam(state.team, teamId),
preferences: state.preferences,
}; };
} }
const mapDispatchToProps = { const mapDispatchToProps = {
loadTeam, loadTeam,
loadStarredDashboards,
loadTeamPreferences,
}; };
export default hot(module)(connect(mapStateToProps, mapDispatchToProps)(TeamPages)); export default hot(module)(connect(mapStateToProps, mapDispatchToProps)(TeamPages));

View File

@ -0,0 +1,28 @@
import React from 'react';
import { shallow } from 'enzyme';
import { TeamPreferences, Props } from './TeamPreferences';
const setup = () => {
const props: Props = {
preferences: {
homeDashboardId: 1,
timezone: 'UTC',
theme: 'Default',
},
starredDashboards: [{ id: 1, title: 'Standard dashboard', url: '', uri: '', uid: '', type: '', tags: [] }],
setTeamTimezone: jest.fn(),
setTeamTheme: jest.fn(),
setTeamHomeDashboard: jest.fn(),
updateTeamPreferences: jest.fn(),
};
return shallow(<TeamPreferences {...props} />);
};
describe('Render', () => {
it('should render component', () => {
const wrapper = setup();
expect(wrapper).toMatchSnapshot();
});
});

View File

@ -0,0 +1,102 @@
import React, { PureComponent } from 'react';
import { connect } from 'react-redux';
import { Label } from '../../core/components/Label/Label';
import SimplePicker from '../../core/components/Picker/SimplePicker';
import { DashboardSearchHit, OrganizationPreferences } from 'app/types';
import { setTeamHomeDashboard, setTeamTheme, setTeamTimezone, updateTeamPreferences } from './state/actions';
export interface Props {
preferences: OrganizationPreferences;
starredDashboards: DashboardSearchHit[];
setTeamHomeDashboard: typeof setTeamHomeDashboard;
setTeamTheme: typeof setTeamTheme;
setTeamTimezone: typeof setTeamTimezone;
updateTeamPreferences: typeof updateTeamPreferences;
}
const themes = [{ value: '', text: 'Default' }, { value: 'dark', text: 'Dark' }, { value: 'light', text: 'Light' }];
const timezones = [
{ value: '', text: 'Default' },
{ value: 'browser', text: 'Local browser time' },
{ value: 'utc', text: 'UTC' },
];
export class TeamPreferences extends PureComponent<Props> {
onSubmitForm = event => {
event.preventDefault();
this.props.updateTeamPreferences();
};
render() {
const { preferences, starredDashboards, setTeamHomeDashboard, setTeamTimezone, setTeamTheme } = this.props;
starredDashboards.unshift({ id: 0, title: 'Default', tags: [], type: '', uid: '', uri: '', url: '' });
return (
<form className="section gf-form-group" onSubmit={this.onSubmitForm}>
<h3 className="page-heading">Preferences</h3>
<div className="gf-form">
<span className="gf-form-label width-11">UI Theme</span>
<SimplePicker
defaultValue={themes.find(theme => theme.value === preferences.theme)}
options={themes}
getOptionValue={i => i.value}
getOptionLabel={i => i.text}
onSelected={theme => setTeamTheme(theme.value)}
width={20}
/>
</div>
<div className="gf-form">
<Label
width={11}
tooltip="Not finding dashboard you want? Star it first, then it should appear in this select box."
>
Home Dashboard
</Label>
<SimplePicker
defaultValue={starredDashboards.find(dashboard => dashboard.id === preferences.homeDashboardId)}
getOptionValue={i => i.id}
getOptionLabel={i => i.title}
onSelected={(dashboard: DashboardSearchHit) => setTeamHomeDashboard(dashboard.id)}
options={starredDashboards}
placeholder="Chose default dashboard"
width={20}
/>
</div>
<div className="gf-form">
<label className="gf-form-label width-11">Timezone</label>
<SimplePicker
defaultValue={timezones.find(timezone => timezone.value === preferences.timezone)}
getOptionValue={i => i.value}
getOptionLabel={i => i.text}
onSelected={timezone => setTeamTimezone(timezone.value)}
options={timezones}
width={20}
/>
</div>
<div className="gf-form-button-row">
<button type="submit" className="btn btn-success">
Save
</button>
</div>
</form>
);
}
}
function mapStateToProps(state) {
return {
preferences: state.team.preferences,
starredDashboards: state.user.starredDashboards,
};
}
const mapDispatchToProps = {
setTeamHomeDashboard,
setTeamTimezone,
setTeamTheme,
updateTeamPreferences,
};
export default connect(mapStateToProps, mapDispatchToProps)(TeamPreferences);

View File

@ -1,4 +1,4 @@
import { Team, TeamGroup, TeamMember } from 'app/types'; import { Team, TeamGroup, TeamMember, OrganizationPreferences } from 'app/types';
export const getMultipleMockTeams = (numberOfTeams: number): Team[] => { export const getMultipleMockTeams = (numberOfTeams: number): Team[] => {
const teams: Team[] = []; const teams: Team[] = [];
@ -65,3 +65,11 @@ export const getMockTeamGroups = (amount: number): TeamGroup[] => {
return groups; return groups;
}; };
export const getMockTeamPreferences = (): OrganizationPreferences => {
return {
theme: 'dark',
timezone: 'browser',
homeDashboardId: 1,
};
};

View File

@ -36,7 +36,7 @@ exports[`Render should render member page if team not empty 1`] = `
</div> </div>
`; `;
exports[`Render should render settings page 1`] = ` exports[`Render should render settings and preferences page 1`] = `
<div> <div>
<PageHeader <PageHeader
model={Object {}} model={Object {}}
@ -44,7 +44,10 @@ exports[`Render should render settings page 1`] = `
<div <div
className="page-container page-body" className="page-container page-body"
> >
<Connect(TeamSettings) /> <div>
<Connect(TeamSettings) />
<Connect(TeamPreferences) />
</div>
</div> </div>
</div> </div>
`; `;

View File

@ -0,0 +1,136 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`Render should render component 1`] = `
<form
className="section gf-form-group"
onSubmit={[Function]}
>
<h3
className="page-heading"
>
Preferences
</h3>
<div
className="gf-form"
>
<span
className="gf-form-label width-11"
>
UI Theme
</span>
<SimplePicker
getOptionLabel={[Function]}
getOptionValue={[Function]}
onSelected={[Function]}
options={
Array [
Object {
"text": "Default",
"value": "",
},
Object {
"text": "Dark",
"value": "dark",
},
Object {
"text": "Light",
"value": "light",
},
]
}
width={20}
/>
</div>
<div
className="gf-form"
>
<Component
tooltip="Not finding dashboard you want? Star it first, then it should appear in this select box."
width={11}
>
Home Dashboard
</Component>
<SimplePicker
defaultValue={
Object {
"id": 1,
"tags": Array [],
"title": "Standard dashboard",
"type": "",
"uid": "",
"uri": "",
"url": "",
}
}
getOptionLabel={[Function]}
getOptionValue={[Function]}
onSelected={[Function]}
options={
Array [
Object {
"id": 0,
"tags": Array [],
"title": "Default",
"type": "",
"uid": "",
"uri": "",
"url": "",
},
Object {
"id": 1,
"tags": Array [],
"title": "Standard dashboard",
"type": "",
"uid": "",
"uri": "",
"url": "",
},
]
}
placeholder="Chose default dashboard"
width={20}
/>
</div>
<div
className="gf-form"
>
<label
className="gf-form-label width-11"
>
Timezone
</label>
<SimplePicker
getOptionLabel={[Function]}
getOptionValue={[Function]}
onSelected={[Function]}
options={
Array [
Object {
"text": "Default",
"value": "",
},
Object {
"text": "Local browser time",
"value": "browser",
},
Object {
"text": "UTC",
"value": "utc",
},
]
}
width={20}
/>
</div>
<div
className="gf-form-button-row"
>
<button
className="btn btn-success"
type="submit"
>
Save
</button>
</div>
</form>
`;

View File

@ -1,16 +1,20 @@
import { ThunkAction } from 'redux-thunk'; import { ThunkAction } from 'redux-thunk';
import { getBackendSrv } from 'app/core/services/backend_srv'; import { getBackendSrv } from 'app/core/services/backend_srv';
import { StoreState, Team, TeamGroup, TeamMember } from 'app/types'; import { StoreState, Team, TeamGroup, TeamMember, OrganizationPreferences } from 'app/types';
import { updateNavIndex, UpdateNavIndexAction } from 'app/core/actions'; import { updateNavIndex, UpdateNavIndexAction } from 'app/core/actions';
import { buildNavModel } from './navModel'; import { buildNavModel } from './navModel';
export enum ActionTypes { export enum ActionTypes {
LoadTeams = 'LOAD_TEAMS', LoadTeams = 'LOAD_TEAMS',
LoadTeam = 'LOAD_TEAM', LoadTeam = 'LOAD_TEAM',
LoadTeamPreferences = 'LOAD_TEAM_PREFERENCES',
SetSearchQuery = 'SET_TEAM_SEARCH_QUERY', SetSearchQuery = 'SET_TEAM_SEARCH_QUERY',
SetSearchMemberQuery = 'SET_TEAM_MEMBER_SEARCH_QUERY', SetSearchMemberQuery = 'SET_TEAM_MEMBER_SEARCH_QUERY',
LoadTeamMembers = 'TEAM_MEMBERS_LOADED', LoadTeamMembers = 'TEAM_MEMBERS_LOADED',
LoadTeamGroups = 'TEAM_GROUPS_LOADED', LoadTeamGroups = 'TEAM_GROUPS_LOADED',
SetTeamTheme = 'SET_TEAM_THEME',
SetTeamHomeDashboard = 'SET_TEAM_HOME_DASHBOARD',
SetTeamTimezone = 'SET_TEAM_TIMEZONE',
} }
export interface LoadTeamsAction { export interface LoadTeamsAction {
@ -23,6 +27,11 @@ export interface LoadTeamAction {
payload: Team; payload: Team;
} }
export interface LoadTeamPreferencesAction {
type: ActionTypes.LoadTeamPreferences;
payload: OrganizationPreferences;
}
export interface LoadTeamMembersAction { export interface LoadTeamMembersAction {
type: ActionTypes.LoadTeamMembers; type: ActionTypes.LoadTeamMembers;
payload: TeamMember[]; payload: TeamMember[];
@ -43,13 +52,32 @@ export interface SetSearchMemberQueryAction {
payload: string; payload: string;
} }
export interface SetTeamThemeAction {
type: ActionTypes.SetTeamTheme;
payload: string;
}
export interface SetTeamHomeDashboardAction {
type: ActionTypes.SetTeamHomeDashboard;
payload: number;
}
export interface SetTeamTimezoneAction {
type: ActionTypes.SetTeamTimezone;
payload: string;
}
export type Action = export type Action =
| LoadTeamsAction | LoadTeamsAction
| SetSearchQueryAction | SetSearchQueryAction
| LoadTeamAction | LoadTeamAction
| LoadTeamPreferencesAction
| LoadTeamMembersAction | LoadTeamMembersAction
| SetSearchMemberQueryAction | SetSearchMemberQueryAction
| LoadTeamGroupsAction; | LoadTeamGroupsAction
| SetTeamThemeAction
| SetTeamHomeDashboardAction
| SetTeamTimezoneAction;
type ThunkResult<R> = ThunkAction<R, StoreState, undefined, Action | UpdateNavIndexAction>; type ThunkResult<R> = ThunkAction<R, StoreState, undefined, Action | UpdateNavIndexAction>;
@ -73,6 +101,11 @@ const teamGroupsLoaded = (teamGroups: TeamGroup[]): LoadTeamGroupsAction => ({
payload: teamGroups, payload: teamGroups,
}); });
const teamPreferencesLoaded = (preferences: OrganizationPreferences): LoadTeamPreferencesAction => ({
type: ActionTypes.LoadTeamPreferences,
payload: preferences,
});
export const setSearchMemberQuery = (searchQuery: string): SetSearchMemberQueryAction => ({ export const setSearchMemberQuery = (searchQuery: string): SetSearchMemberQueryAction => ({
type: ActionTypes.SetSearchMemberQuery, type: ActionTypes.SetSearchMemberQuery,
payload: searchQuery, payload: searchQuery,
@ -83,6 +116,21 @@ export const setSearchQuery = (searchQuery: string): SetSearchQueryAction => ({
payload: searchQuery, payload: searchQuery,
}); });
export const setTeamTheme = (theme: string) => ({
type: ActionTypes.SetTeamTheme,
payload: theme,
});
export const setTeamHomeDashboard = (id: number) => ({
type: ActionTypes.SetTeamHomeDashboard,
payload: id,
});
export const setTeamTimezone = (timezone: string) => ({
type: ActionTypes.SetTeamTimezone,
payload: timezone,
});
export function loadTeams(): ThunkResult<void> { export function loadTeams(): ThunkResult<void> {
return async dispatch => { return async dispatch => {
const response = await getBackendSrv().get('/api/teams/search', { perpage: 1000, page: 1 }); const response = await getBackendSrv().get('/api/teams/search', { perpage: 1000, page: 1 });
@ -160,3 +208,21 @@ export function deleteTeam(id: number): ThunkResult<void> {
dispatch(loadTeams()); dispatch(loadTeams());
}; };
} }
export function loadTeamPreferences(): ThunkResult<void> {
return async (dispatch, getStore) => {
const team = getStore().team.team;
const response = await getBackendSrv().get(`/api/teams/${team.id}/preferences`);
dispatch(teamPreferencesLoaded(response));
};
}
export function updateTeamPreferences() {
return async (dispatch, getStore) => {
const team = getStore().team.team;
const preferences = getStore().team.preferences;
await getBackendSrv().put(`/api/teams/${team.id}/preferences`, preferences);
window.location.reload();
};
}

View File

@ -1,6 +1,6 @@
import { Action, ActionTypes } from './actions'; import { Action, ActionTypes } from './actions';
import { initialTeamsState, initialTeamState, teamReducer, teamsReducer } from './reducers'; import { initialTeamsState, initialTeamState, teamReducer, teamsReducer } from './reducers';
import { getMockTeam, getMockTeamMember } from '../__mocks__/teamMocks'; import { getMockTeam, getMockTeamMember, getMockTeamPreferences } from '../__mocks__/teamMocks';
describe('teams reducer', () => { describe('teams reducer', () => {
it('should set teams', () => { it('should set teams', () => {
@ -69,4 +69,17 @@ describe('team reducer', () => {
expect(result.searchMemberQuery).toEqual('member'); expect(result.searchMemberQuery).toEqual('member');
}); });
it('should set team preferences', () => {
const mockTeamPrefs = getMockTeamPreferences();
const action: Action = {
type: ActionTypes.LoadTeamPreferences,
payload: mockTeamPrefs,
};
const result = teamReducer(initialTeamState, action);
expect(result.preferences).toEqual(mockTeamPrefs);
});
}); });

View File

@ -1,4 +1,4 @@
import { Team, TeamGroup, TeamMember, TeamsState, TeamState } from 'app/types'; import { Team, TeamGroup, TeamMember, TeamsState, TeamState, OrganizationPreferences } from 'app/types';
import { Action, ActionTypes } from './actions'; import { Action, ActionTypes } from './actions';
export const initialTeamsState: TeamsState = { teams: [], searchQuery: '', hasFetched: false }; export const initialTeamsState: TeamsState = { teams: [], searchQuery: '', hasFetched: false };
@ -7,6 +7,7 @@ export const initialTeamState: TeamState = {
members: [] as TeamMember[], members: [] as TeamMember[],
groups: [] as TeamGroup[], groups: [] as TeamGroup[],
searchMemberQuery: '', searchMemberQuery: '',
preferences: {} as OrganizationPreferences,
}; };
export const teamsReducer = (state = initialTeamsState, action: Action): TeamsState => { export const teamsReducer = (state = initialTeamsState, action: Action): TeamsState => {
@ -33,6 +34,18 @@ export const teamReducer = (state = initialTeamState, action: Action): TeamState
case ActionTypes.LoadTeamGroups: case ActionTypes.LoadTeamGroups:
return { ...state, groups: action.payload }; return { ...state, groups: action.payload };
case ActionTypes.LoadTeamPreferences:
return { ...state, preferences: action.payload };
case ActionTypes.SetTeamTheme:
return { ...state, preferences: { ...state.preferences, theme: action.payload } };
case ActionTypes.SetTeamHomeDashboard:
return { ...state, preferences: { ...state.preferences, homeDashboardId: action.payload } };
case ActionTypes.SetTeamTimezone:
return { ...state, preferences: { ...state.preferences, timezone: action.payload } };
} }
return state; return state;

View File

@ -1,6 +1,6 @@
import { getTeam, getTeamMembers, getTeams } from './selectors'; import { getTeam, getTeamMembers, getTeams } from './selectors';
import { getMockTeam, getMockTeamMembers, getMultipleMockTeams } from '../__mocks__/teamMocks'; import { getMockTeam, getMockTeamMembers, getMultipleMockTeams } from '../__mocks__/teamMocks';
import { Team, TeamGroup, TeamsState, TeamState } from '../../../types'; import { Team, TeamGroup, TeamsState, TeamState, OrganizationPreferences } from '../../../types';
describe('Teams selectors', () => { describe('Teams selectors', () => {
describe('Get teams', () => { describe('Get teams', () => {
@ -29,7 +29,13 @@ describe('Team selectors', () => {
const mockTeam = getMockTeam(); const mockTeam = getMockTeam();
it('should return team if matching with location team', () => { it('should return team if matching with location team', () => {
const mockState: TeamState = { team: mockTeam, searchMemberQuery: '', members: [], groups: [] }; const mockState: TeamState = {
team: mockTeam,
searchMemberQuery: '',
members: [],
groups: [],
preferences: {} as OrganizationPreferences,
};
const team = getTeam(mockState, '1'); const team = getTeam(mockState, '1');
@ -46,6 +52,7 @@ describe('Team selectors', () => {
searchMemberQuery: '', searchMemberQuery: '',
members: mockTeamMembers, members: mockTeamMembers,
groups: [] as TeamGroup[], groups: [] as TeamGroup[],
preferences: {} as OrganizationPreferences,
}; };
const members = getTeamMembers(mockState); const members = getTeamMembers(mockState);

View File

@ -1,3 +1,5 @@
import { OrganizationPreferences } from './organization';
export interface Team { export interface Team {
id: number; id: number;
name: string; name: string;
@ -31,4 +33,5 @@ export interface TeamState {
members: TeamMember[]; members: TeamMember[];
groups: TeamGroup[]; groups: TeamGroup[];
searchMemberQuery: string; searchMemberQuery: string;
preferences: OrganizationPreferences;
} }