luisgulo/focalboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Cross team search (#2829)

Browse source 
* WIP

* Added test

* Added snapshot

* Updated server tests

* Fixed server lint

* Fixed webapp lint

* Updated server tests
This commit is contained in:
Harshil Sharma 2022-04-19 10:27:14 +05:30 committed by GitHub
parent 958fbd28bf
commit 50930a1cd3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 245 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
server/api/api.go
View file

@ -3166,7 +3166,7 @@ func (a *API) handleSearchBoards(w http.ResponseWriter, r *http.Request) {
auditRec.AddMeta("teamID", teamID)
// retrieve boards list
boards, err := a.app.SearchBoardsForUserAndTeam(term, userID, teamID)
boards, err := a.app.SearchBoardsForUser(term, userID, teamID)
if err != nil {
a.errorResponse(w, r.URL.Path, http.StatusInternalServerError, "", err)
return

4
server/app/boards.go
View file

@ -369,8 +369,8 @@ func (a *App) DeleteBoardMember(boardID, userID string) error {
return nil
}
func (a *App) SearchBoardsForUserAndTeam(term, userID, teamID string) ([]*model.Board, error) {
return a.store.SearchBoardsForUserAndTeam(term, userID, teamID)
func (a *App) SearchBoardsForUser(term, userID, teamID string) ([]*model.Board, error) {
return a.store.SearchBoardsForUser(term, userID, teamID)
}
func (a *App) UndeleteBoard(boardID string, modifiedBy string) error {

8
server/integrationtests/board_test.go
View file

@ -543,25 +543,25 @@ func TestSearchBoards(t *testing.T) {
Name: "should return all boards where user1 is member or that are public",
Client: th.Client,
Term: "board",
ExpectedIDs: []string{rBoard1.ID, rBoard2.ID, rBoard3.ID},
ExpectedIDs: []string{rBoard1.ID, rBoard2.ID, rBoard3.ID, board5.ID},
},
{
Name: "matching a full word",
Client: th.Client,
Term: "admin",
ExpectedIDs: []string{rBoard1.ID, rBoard3.ID},
ExpectedIDs: []string{rBoard1.ID, rBoard3.ID, board5.ID},
},
{
Name: "matching part of the word",
Client: th.Client,
Term: "ubli",
ExpectedIDs: []string{rBoard1.ID, rBoard2.ID},
ExpectedIDs: []string{rBoard1.ID, rBoard2.ID, board5.ID},
},
{
Name: "case insensitive",
Client: th.Client,
Term: "UBLI",
ExpectedIDs: []string{rBoard1.ID, rBoard2.ID},
ExpectedIDs: []string{rBoard1.ID, rBoard2.ID, board5.ID},
},
{
Name: "user2 can only see the public boards, as he's not a member of any",

12
server/services/store/mockstore/mockstore.go
View file

@ -1158,19 +1158,19 @@ func (mr *MockStoreMockRecorder) SaveMember(arg0 interface{}) *gomock.Call {
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SaveMember", reflect.TypeOf((*MockStore)(nil).SaveMember), arg0)
}
// SearchBoardsForUserAndTeam mocks base method.
func (m *MockStore) SearchBoardsForUserAndTeam(arg0, arg1, arg2 string) ([]*model.Board, error) {
// SearchBoardsForUser mocks base method.
func (m *MockStore) SearchBoardsForUser(arg0, arg1, arg2 string) ([]*model.Board, error) {
m.ctrl.T.Helper()
ret := m.ctrl.Call(m, "SearchBoardsForUserAndTeam", arg0, arg1, arg2)
ret := m.ctrl.Call(m, "SearchBoardsForUser", arg0, arg1, arg2)
ret0, _ := ret[0].([]*model.Board)
ret1, _ := ret[1].(error)
return ret0, ret1
}
// SearchBoardsForUserAndTeam indicates an expected call of SearchBoardsForUserAndTeam.
func (mr *MockStoreMockRecorder) SearchBoardsForUserAndTeam(arg0, arg1, arg2 interface{}) *gomock.Call {
// SearchBoardsForUser indicates an expected call of SearchBoardsForUser.
func (mr *MockStoreMockRecorder) SearchBoardsForUser(arg0, arg1, arg2 interface{}) *gomock.Call {
mr.mock.ctrl.T.Helper()
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SearchBoardsForUserAndTeam", reflect.TypeOf((*MockStore)(nil).SearchBoardsForUserAndTeam), arg0, arg1, arg2)
return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SearchBoardsForUser", reflect.TypeOf((*MockStore)(nil).SearchBoardsForUser), arg0, arg1, arg2)
}
// SearchUsersByTeam mocks base method.

7
server/services/store/sqlstore/board.go
View file

@ -597,17 +597,16 @@ func (s *SQLStore) getMembersForBoard(db sq.BaseRunner, boardID string) ([]*mode
return s.boardMembersFromRows(rows)
}
// searchBoardsForUserAndTeam returns all boards that match with the
// searchBoardsForUser returns all boards that match with the
// term that are either private and which the user is a member of, or
// they're open, regardless of the user membership.
// Search is case-insensitive.
func (s *SQLStore) searchBoardsForUserAndTeam(db sq.BaseRunner, term, userID, teamID string) ([]*model.Board, error) {
func (s *SQLStore) searchBoardsForUser(db sq.BaseRunner, term, userID string) ([]*model.Board, error) {
query := s.getQueryBuilder(db).
Select(boardFields("b.")...).
Distinct().
From(s.tablePrefix + "boards as b").
LeftJoin(s.tablePrefix + "board_members as bm on b.id=bm.board_id").
Where(sq.Eq{"b.team_id": teamID}).
Where(sq.Eq{"b.is_template": false}).
Where(sq.Or{
sq.Eq{"b.type": model.BoardTypeOpen},
@ -635,7 +634,7 @@ func (s *SQLStore) searchBoardsForUserAndTeam(db sq.BaseRunner, term, userID, te
rows, err := query.Query()
if err != nil {
s.logger.Error(`searchBoardsForUserAndTeam ERROR`, mlog.Err(err))
s.logger.Error(`searchBoardsForUser ERROR`, mlog.Err(err))
return nil, err
}
defer s.CloseRows(rows)

4
server/services/store/sqlstore/public_methods.go
View file

@ -677,8 +677,8 @@ func (s *SQLStore) SaveMember(bm *model.BoardMember) (*model.BoardMember, error)
}
func (s *SQLStore) SearchBoardsForUserAndTeam(term string, userID string, teamID string) ([]*model.Board, error) {
return s.searchBoardsForUserAndTeam(s.db, term, userID, teamID)
func (s *SQLStore) SearchBoardsForUser(term string, userID string, teamID string) ([]*model.Board, error) {
return s.searchBoardsForUser(s.db, term, userID)
}

2
server/services/store/store.go
View file

@ -99,7 +99,7 @@ type Store interface {
GetBoardMemberHistory(boardID, userID string, limit uint64) ([]*model.BoardMemberHistoryEntry, error)
GetMembersForBoard(boardID string) ([]*model.BoardMember, error)
GetMembersForUser(userID string) ([]*model.BoardMember, error)
SearchBoardsForUserAndTeam(term, userID, teamID string) ([]*model.Board, error)
SearchBoardsForUser(term, userID, teamID string) ([]*model.Board, error)
// @withTransaction
CreateBoardsAndBlocksWithAdmin(bab *model.BoardsAndBlocks, userID string) (*model.BoardsAndBlocks, []*model.BoardMember, error)

23
server/services/store/storetests/boards.go
View file

@ -68,10 +68,10 @@ func StoreTestBoardStore(t *testing.T, setup func(t *testing.T) (store.Store, fu
defer tearDown()
testDeleteMember(t, store)
})
t.Run("SearchBoardsForUserAndTeam", func(t *testing.T) {
t.Run("SearchBoardsForUser", func(t *testing.T) {
store, tearDown := setup(t)
defer tearDown()
testSearchBoardsForUserAndTeam(t, store)
testSearchBoardsForUser(t, store)
})
t.Run("GetBoardHistory", func(t *testing.T) {
store, tearDown := setup(t)
@ -683,13 +683,13 @@ func testDeleteMember(t *testing.T, store store.Store) {
})
}
func testSearchBoardsForUserAndTeam(t *testing.T, store store.Store) {
func testSearchBoardsForUser(t *testing.T, store store.Store) {
teamID1 := "team-id-1"
teamID2 := "team-id-2"
userID := "user-id-1"
t.Run("should return empty if user is not a member of any board and there are no public boards on the team", func(t *testing.T) {
boards, err := store.SearchBoardsForUserAndTeam("", userID, teamID1)
boards, err := store.SearchBoardsForUser("", userID, teamID1)
require.NoError(t, err)
require.Empty(t, boards)
})
@ -751,21 +751,21 @@ func testSearchBoardsForUserAndTeam(t *testing.T, store store.Store) {
TeamID: teamID1,
UserID: userID,
Term: "",
ExpectedBoardIDs: []string{board1.ID, board2.ID, board3.ID},
ExpectedBoardIDs: []string{board1.ID, board2.ID, board3.ID, board5.ID},
},
{
Name: "should find all with term board",
TeamID: teamID1,
UserID: userID,
Term: "board",
ExpectedBoardIDs: []string{board1.ID, board2.ID, board3.ID},
ExpectedBoardIDs: []string{board1.ID, board2.ID, board3.ID, board5.ID},
},
{
Name: "should find only public as per the term, wether user is a member or not",
TeamID: teamID1,
UserID: userID,
Term: "public",
ExpectedBoardIDs: []string{board1.ID, board2.ID},
ExpectedBoardIDs: []string{board1.ID, board2.ID, board5.ID},
},
{
Name: "should find only private as per the term, wether user is a member or not",
@ -774,13 +774,6 @@ func testSearchBoardsForUserAndTeam(t *testing.T, store store.Store) {
Term: "priv",
ExpectedBoardIDs: []string{board3.ID},
},
{
Name: "should find the only board in team 2",
TeamID: teamID2,
UserID: userID,
Term: "",
ExpectedBoardIDs: []string{board5.ID},
},
{
Name: "should find no board in team 2 with a non matching term",
TeamID: teamID2,
@ -792,7 +785,7 @@ func testSearchBoardsForUserAndTeam(t *testing.T, store store.Store) {
for _, tc := range testCases {
t.Run(tc.Name, func(t *testing.T) {
boards, err := store.SearchBoardsForUserAndTeam(tc.Term, tc.UserID, tc.TeamID)
boards, err := store.SearchBoardsForUser(tc.Term, tc.UserID, tc.TeamID)
require.NoError(t, err)
boardIDs := []string{}

95
webapp/src/components/boardsSwitcherDialog/__snapshots__/boardSwitcherDialog.test.tsx.snap Normal file
View file

@ -0,0 +1,95 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`component/BoardSwitcherDialog base case 1`] = `
<div>
<div
class="Dialog dialog-back BoardSwitcherDialog"
>
<div
class="wrapper"
>
<div
class="dialog"
role="dialog"
>
<div
class="toolbar"
>
<button
aria-label="Close dialog"
class="IconButton size--medium"
title="Close dialog"
type="button"
>
<i
class="CompassIcon icon-close CloseIcon"
/>
</button>
</div>
<div
class="BoardSwitcherDialogBody"
>
<div
class="head"
>
<h3
class="text-heading4"
>
Find Boards
</h3>
<h5>
Type to find a board. Use
<b>
UP/DOWN
</b>
to browse.
<b>
ENTER
</b>
to select,
<b>
ESC
</b>
to dismiss
</h5>
<div
class="queryWrapper"
>
<i
class="CompassIcon icon-magnify MagnifyIcon"
/>
<input
class="searchQuery"
maxlength="100"
type="text"
/>
</div>
</div>
<div
class="searchResults"
>
<div
class="noResults introScreen"
>
<div
class="iconWrapper"
>
<i
class="CompassIcon icon-magnify MagnifyIcon"
/>
</div>
<h4
class="text-heading4"
>
Search for boards
</h4>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
`;

11
webapp/src/components/boardsSwitcherDialog/boardSwitcherDialog.scss
View file

@ -3,6 +3,7 @@
gap: 12px;
overflow: hidden;
flex-direction: row;
width: 100%;
.CompassIcon {
font-size: 18px;
@ -20,4 +21,14 @@
text-overflow: ellipsis;
white-space: nowrap;
}
.resultTitle {
max-width: 60%;
}
.teamTitle {
right: auto;
margin-left: auto;
color: rgba(var(--center-channel-color-rgb), 0.56);
}
}

76
webapp/src/components/boardsSwitcherDialog/boardSwitcherDialog.test.tsx Normal file
View file

@ -0,0 +1,76 @@
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.
import React from 'react'
import {MockStoreEnhanced} from "redux-mock-store"
import {Provider as ReduxProvider} from 'react-redux'
import {render} from "@testing-library/react"
import {createMemoryHistory, History} from "history"
import {Router} from "react-router-dom"
import {Team} from "../../store/teams"
import {TestBlockFactory} from "../../test/testBlockFactory"
import {mockStateStore, wrapDNDIntl} from "../../testUtils"
import BoardSwitcherDialog from "./boardSwitcherDialog"
describe('component/BoardSwitcherDialog', () => {
const team1: Team = {
id: 'team-id-1',
title: 'Dunder Mifflin',
signupToken: '',
updateAt: 0,
modifiedBy: 'michael-scott',
}
const team2: Team = {
id: 'team-id-2',
title: 'Michael Scott Paper Company',
signupToken: '',
updateAt: 0,
modifiedBy: 'michael-scott',
}
const me = TestBlockFactory.createUser()
const state = {
users: {
me: me,
},
teams: {
allTeams: [team1, team2],
current: team1,
}
}
let store:MockStoreEnhanced<unknown, unknown>
let history: History
beforeEach(() => {
store = mockStateStore([], state)
history = createMemoryHistory()
})
test('base case', () => {
const onCloseHandler = jest.fn()
const component = wrapDNDIntl(
<Router history={history}>
<ReduxProvider store={store}>
<BoardSwitcherDialog onClose={onCloseHandler}/>
</ReduxProvider>
</Router>
)
const {container} = render(component)
expect(container).toMatchSnapshot()
})
})

22
webapp/src/components/boardsSwitcherDialog/boardSwitcherDialog.tsx
View file

@ -12,7 +12,7 @@ import SearchDialog from '../searchDialog/searchDialog'
import Globe from '../../widgets/icons/globe'
import LockOutline from '../../widgets/icons/lockOutline'
import {useAppSelector} from '../../store/hooks'
import {getCurrentTeam} from '../../store/teams'
import {getAllTeams, getCurrentTeam, Team} from '../../store/teams'
import {getMe} from '../../store/users'
import {BoardTypeOpen, BoardTypePrivate} from '../../blocks/board'
@ -38,15 +38,18 @@ const BoardSwitcherDialog = (props: Props): JSX.Element => {
const match = useRouteMatch<{boardId: string, viewId: string, cardId?: string}>()
const history = useHistory()
const selectBoard = async (boardId: string): Promise<void> => {
const selectBoard = async (teamId: string, boardId: string): Promise<void> => {
if (!me) {
return
}
const newPath = generatePath(match.path, {...match.params, boardId, viewId: undefined})
const newPath = generatePath(match.path, {...match.params, teamId, boardId, viewId: undefined})
history.push(newPath)
props.onClose()
}
const teamsById:Record<string, Team> = {}
useAppSelector(getAllTeams).forEach((t) => teamsById[t.id] = t)
const searchHandler = async (query: string): Promise<Array<ReactNode>> => {
if (query.trim().length === 0 || !team) {
return []
@ -54,17 +57,22 @@ const BoardSwitcherDialog = (props: Props): JSX.Element => {
const items = await octoClient.search(team.id, query)
const untitledBoardTitle = intl.formatMessage({id: 'ViewTitle.untitled-board', defaultMessage: 'Untitled Board'})
return items.map((item) => (
return items.map((item) => {
const resultTitle = item.title || untitledBoardTitle
const teamTitle = teamsById[item.teamId].title
return (
<div
key={item.id}
className='blockSearchResult'
onClick={() => selectBoard(item.id)}
onClick={() => selectBoard(item.teamId, item.id)}
>
{item.type === BoardTypeOpen && <Globe/>}
{item.type === BoardTypePrivate && <LockOutline/>}
<span>{item.title || untitledBoardTitle}</span>
<span className='resultTitle'>{resultTitle}</span>
<span className='teamTitle'>{teamTitle}</span>
</div>
))
)
})
}
return (

1
webapp/src/store/teams.ts
View file

@ -82,3 +82,4 @@ export const {reducer} = teamSlice
export const getCurrentTeam = (state: RootState): Team|null => state.teams.current
export const getFirstTeam = (state: RootState): Team|null => state.teams.allTeams[0]
export const getAllTeams = (state: RootState): Array<Team> => state.teams.allTeams

13
webapp/src/test/testBlockFactory.ts
View file

@ -14,6 +14,7 @@ import {Category, CategoryBoards} from '../store/sidebar'
import {Utils} from '../utils'
import {CheckboxBlock, createCheckboxBlock} from '../blocks/checkboxBlock'
import {Block} from '../blocks/block'
import {IUser} from "../user"
class TestBlockFactory {
static createBoard(): Board {
@ -181,6 +182,18 @@ class TestBlockFactory {
boardIDs: [],
}
}
static createUser(): IUser {
return {
id: 'user-id-1',
username: 'Dwight Schrute',
email: 'dwight.schrute@dundermifflin.com',
props: {},
create_at: Date.now(),
update_at: Date.now(),
is_bot: false,
}
}
}
export {TestBlockFactory}