Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

fix timeline search with empty text box should do nothing #8262

Merged
merged 6 commits into from
May 2, 2022
Merged
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
1 change: 1 addition & 0 deletions src/components/views/rooms/SearchBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ export default class SearchBar extends React.Component<IProps, IState> {
}

private onSearch = (): void => {
if (!this.searchTerm.current.value.trim()) return;
this.props.onSearch(this.searchTerm.current.value, this.state.scope);
};

Expand Down
134 changes: 134 additions & 0 deletions test/components/views/rooms/SearchBar-test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
/*
Copyright 2022 Emmanuel Ezeka <[email protected]>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

import React from 'react';
import { mount } from "enzyme";

import DesktopBuildsNotice from "../../../../src/components/views/elements/DesktopBuildsNotice";
import { PosthogScreenTracker } from "../../../../src/PosthogTrackers";
import SearchBar, { SearchScope } from "../../../../src/components/views/rooms/SearchBar";
import { KeyBindingAction } from "../../../../src/accessibility/KeyboardShortcuts";

let mockCurrentEvent = KeyBindingAction.Enter;
const mockWarningKind = true;
let wrapper: any = null;

const searchProps = {
onCancelClick: jest.fn(),
onSearch: jest.fn(),
searchInProgress: false,
isRoomEncrypted: false,
};

jest.mock("../../../../src/KeyBindingsManager", () => ({
__esModule: true,
getKeyBindingsManager: jest.fn(() => (
{ getAccessibilityAction: jest.fn(() => mockCurrentEvent) })),
}));

/** mock out DesktopBuildsNotice component so it doesn't affect the result of our test */
jest.mock('../../../../src/components/views/elements/DesktopBuildsNotice', () => ({
__esModule: true,
WarningKind: {
get Search() { // eslint-disable-line @typescript-eslint/naming-convention
return mockWarningKind;
},
},
default: jest.fn(({ children }) => (
<div>{ children }</div>
)),
}));

/** mock out PosthogTrackers component so it doesn't affect the result of our test */
jest.mock('../../../../src/PosthogTrackers', () => ({
__esModule: true,
PosthogScreenTracker: jest.fn(({ children }) => (
<div>{ children }</div>
)),
}));

describe("SearchBar", () => {
beforeEach(() => {
wrapper = mount(<SearchBar {...searchProps} />);
});

afterEach(() => {
wrapper.unmount();
searchProps.onCancelClick.mockClear();
searchProps.onSearch.mockClear();
});

it("must render child components and pass necessary props", () => {
const postHogScreenTracker = wrapper.find(PosthogScreenTracker);
const desktopBuildNotice = wrapper.find(DesktopBuildsNotice);

expect(postHogScreenTracker.length).toBe(1);
expect(desktopBuildNotice.length).toBe(1);
expect(postHogScreenTracker.props().screenName).toEqual("RoomSearch");
expect(desktopBuildNotice.props().isRoomEncrypted).toEqual(searchProps.isRoomEncrypted);
expect(desktopBuildNotice.props().kind).toEqual(mockWarningKind);
});

it("must not search when input value is empty", () => {
const roomButtons = wrapper.find(".mx_SearchBar_button");
const searchButton = wrapper.find(".mx_SearchBar_searchButton");

expect(roomButtons.length).toEqual(4);

searchButton.at(0).simulate("click");
roomButtons.at(0).simulate("click");
roomButtons.at(2).simulate("click");

expect(searchProps.onSearch).not.toHaveBeenCalled();
});

it("must trigger onSearch when value is not empty", () => {
const searchValue = "abcd";

const roomButtons = wrapper.find(".mx_SearchBar_button");
const searchButton = wrapper.find(".mx_SearchBar_searchButton");
const input = wrapper.find(".mx_SearchBar_input input");
input.instance().value = searchValue;

expect(roomButtons.length).toEqual(4);

searchButton.at(0).simulate("click");

expect(searchProps.onSearch).toHaveBeenCalledTimes(1);
expect(searchProps.onSearch).toHaveBeenNthCalledWith(1, searchValue, SearchScope.Room);

roomButtons.at(0).simulate("click");

expect(searchProps.onSearch).toHaveBeenCalledTimes(2);
expect(searchProps.onSearch).toHaveBeenNthCalledWith(2, searchValue, SearchScope.Room);

roomButtons.at(2).simulate("click");

expect(searchProps.onSearch).toHaveBeenCalledTimes(3);
expect(searchProps.onSearch).toHaveBeenNthCalledWith(3, searchValue, SearchScope.All);
});

it("cancel button and esc key should trigger onCancelClick", () => {
mockCurrentEvent = KeyBindingAction.Escape;
const cancelButton = wrapper.find(".mx_SearchBar_cancel");
const input = wrapper.find(".mx_SearchBar_input input");
input.simulate("focus");
input.simulate("keydown", { key: "ESC" });
cancelButton.at(0).simulate("click");

expect(searchProps.onCancelClick).toHaveBeenCalledTimes(2);
});
});