const helpers = require('./support/helpers.js'); beforeAll(() => { require('../../app/assets/javascripts/liveSearch.js'); }); afterAll(() => { require('./support/teardown.js'); }); describe('Live search', () => { let searchLabelText; let searchTextbox; let liveRegion let list; function liveRegionResults (num) { if (num === 1) { return "1 result"; } else if (num === 0) { return "no results"; } else { return `${num} results`; } }; describe("With a list of content items", () => { searchLabelText = "Search by name or email address"; function getContentItems (users) { function getPermissionsHTML (permissions) { const PERMISSIONS = ["Send messages", "Add and edit templates", "Manage settings, team and usage", "API integration"]; let permissionsHTML = ''; PERMISSIONS.forEach(permission => { let can = permissions.includes(permission); permissionsHTML += `
  • ${can ? "Can" : "Can't"} ${permission}
  • `; }); return ``; }; let result = ''; users.forEach(user => result += `

    ${user.label} (${user.email}) (invited)

    `); return result; }; beforeEach(() => { const users = [ { "label": "Template editor", "email": "template-editor@nhs.uk", "permissions" : ["Add and edit templates"] }, { "label": "Software Developer", "email": "software-developer@nhs.uk", "permissions" : ["Send messages", "Add and edit templates", "team and usage", "API integration"] }, { "label": "Team member", "email": "team-member@nhs.uk", "permissions" : ["Send messages", "Add and edit templates"] }, { "label": "Administrator", "email": "admin@nhs.uk", "permissions" : ["Send messages", "Add and edit templates", "Manage settings, team and usage", "API integration"] } ]; // set up DOM document.body.innerHTML = `
    ${getContentItems(users)}
    `; searchTextbox = document.getElementById('search'); liveRegion = document.querySelector('.live-search__status'); list = document.querySelector('form'); }); describe("When the page loads", () => { test("If there is no search term, the results should be unchanged", () => { // start the module window.NotifyModules.start(); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); expect(listItemsShowing.length).toEqual(listItems.length); expect(searchTextbox.hasAttribute('aria-label')).toBe(false); }); test("If there is a single word search term, only the results that match should show", () => { searchTextbox.value = 'admin'; // start the module window.NotifyModules.start(); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); expect(listItemsShowing.length).toEqual(1); expect(searchTextbox.hasAttribute('aria-label')).toBe(true); expect(searchTextbox.getAttribute('aria-label')).toEqual(`${searchLabelText}, ${liveRegionResults(1)}`); }); test("If there is a search term made of several words, only the results that match should show", () => { searchTextbox.value = 'Administrator (admin@nhs.uk)'; // start the module window.NotifyModules.start(); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); expect(listItemsShowing.length).toEqual(1); expect(searchTextbox.hasAttribute('aria-label')).toBe(true); expect(searchTextbox.getAttribute('aria-label')).toEqual(`${searchLabelText}, ${liveRegionResults(1)}`); }); test("If the items have a block of text to match against, only results that match it should show", () => { searchTextbox.value = "Add and edit templates"; // start the module window.NotifyModules.start(); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); // all items contain the "Add and edit templates" permission so would match if all text was matched against the search term // only the text containing the label and email address is matched against expect(listItemsShowing.length).toEqual(0); expect(searchTextbox.getAttribute('aria-label')).toEqual(`${searchLabelText}, ${liveRegionResults(0)}`); }); }); describe("When the search text changes", () => { test("If there is no search term, the results should be unchanged", () => { searchTextbox.value = 'Admin'; // start the module window.NotifyModules.start(); // simulate input of new search text searchTextbox.value = ''; helpers.triggerEvent(searchTextbox, 'input'); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); expect(listItemsShowing.length).toEqual(listItems.length); }); test("If there is a single word search term, only the results that match should show", () => { searchTextbox.value = 'Admin'; // start the module window.NotifyModules.start(); // simulate input of new search text searchTextbox.value = 'Administrator'; helpers.triggerEvent(searchTextbox, 'input'); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); expect(listItemsShowing.length).toEqual(1); expect(liveRegion.textContent.trim()).toEqual(liveRegionResults(1)); }); test("If there is a search term made of several words, only the results that match should show", () => { searchTextbox.value = 'Admin'; // start the module window.NotifyModules.start(); // simulate input of new search text searchTextbox.value = 'Administrator (admin@nhs.uk)'; helpers.triggerEvent(searchTextbox, 'input'); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); expect(listItemsShowing.length).toEqual(1); expect(liveRegion.textContent.trim()).toEqual(liveRegionResults(1)); }); test("If the items have a block of text to match against, only results that match it should show", () => { searchTextbox.value = "Admin"; // start the module window.NotifyModules.start(); // simulate input of new search text searchTextbox.value = 'Add and edit templates'; helpers.triggerEvent(searchTextbox, 'input'); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); // all items contain the "Add and edit templates" permission so would match if all text was matched against the search term // only the text containing the label and email address is matched against expect(listItemsShowing.length).toEqual(0); expect(liveRegion.textContent.trim()).toEqual(liveRegionResults(0)); }); }); }); describe("When items have checked checkboxes", () => { beforeEach(() => { const users = [ { "label": "Template editor", "email": "template-editor@example.gov", "permissions" : ["Add and edit templates"], "checked": true }, { "label": "Administrator", "email": "admin@example.gov", "permissions" : ["Send messages", "Add and edit templates", "Manage settings, team and usage", "API integration"], "checked": false } ]; document.body.innerHTML = `
    ${users[0].label} (${users[0].email})
    ${users[1].label} (${users[1].email})
    `; searchTextbox = document.getElementById('search'); liveRegion = document.querySelector('.live-search__status'); list = document.querySelector('form'); }); test("Items with checked checkboxes should always be visible", () => { searchTextbox.value = 'Administrator'; window.NotifyModules.start(); const listItems = list.querySelectorAll('.user-list-item'); const listItemsShowing = Array.from(listItems).filter(item => !item.classList.contains('js-hidden')); expect(listItemsShowing.length).toEqual(2); }); }); describe("When no results message element exists", () => { beforeEach(() => { document.body.innerHTML = `
    Test User (test@example.com)
    `; searchTextbox = document.getElementById('search'); liveRegion = document.querySelector('.live-search__status'); list = document.querySelector('form'); }); test("No results message should show when search yields no results", () => { searchTextbox.value = 'nomatch'; window.NotifyModules.start(); const noResultsMessage = document.querySelector('.js-live-search-no-results'); expect(noResultsMessage.classList.contains('js-hidden')).toBe(false); }); test("No results message should hide when search yields results", () => { searchTextbox.value = 'nomatch'; window.NotifyModules.start(); let noResultsMessage = document.querySelector('.js-live-search-no-results'); expect(noResultsMessage.classList.contains('js-hidden')).toBe(false); searchTextbox.value = 'Test'; helpers.triggerEvent(searchTextbox, 'input'); expect(noResultsMessage.classList.contains('js-hidden')).toBe(true); }); test("No results message should hide when search is empty", () => { searchTextbox.value = 'nomatch'; window.NotifyModules.start(); searchTextbox.value = ''; helpers.triggerEvent(searchTextbox, 'input'); const noResultsMessage = document.querySelector('.js-live-search-no-results'); expect(noResultsMessage.classList.contains('js-hidden')).toBe(true); }); }); });