We did a lot of work in laying a foundation for the app in the previous steps, so now we'll do something simple; we will add full-text search (yes, it will be simple!). We will also write an end-to-end (E2E) test, because a good E2E test is a good friend. It stays with your app, keeps an eye on it, and quickly detects regressions.
We made no changes to the component's controller.
app/phone-list/phone-list.template.html
:
<div class="container-fluid">
<div class="row">
<div class="col-md-2">
<!--Sidebar content-->
Search: <input ng-model="$ctrl.query" />
</div>
<div class="col-md-10">
<!--Body content-->
<ul class="phones">
<li ng-repeat="phone in $ctrl.phones | filter:$ctrl.query">
<span>{{phone.name}}</span>
<p>{{phone.snippet}}</p>
</li>
</ul>
</div>
</div>
</div>
We added a standard HTML <input>
tag and used AngularJS's filter function
to process the input for the ngRepeat directive.
By virtue of the ngModel directive, this lets a user enter search criteria and immediately see the effects of their search on the phone list. This new code demonstrates the following:
Data-binding: This is one of the core features in AngularJS. When the page loads, AngularJS binds the
value of the input box to the data model variable specified with ngModel
and keeps the two in
sync.
In this code, the data that a user types into the input box (bound to $ctrl.query
) is
immediately available as a filter input in the list repeater
(phone in $ctrl.phones | filter:
$ctrl.query
). When changes to the data model cause the
repeater's input to change, the repeater efficiently updates the DOM to reflect the current state
of the model.
Use of the filter
filter: The filter function uses the $ctrl.query
value to create a new array that contains only those records that match the query.
ngRepeat
automatically updates the view in response to the changing number of phones returned
by the filter
filter. The process is completely transparent to the developer.
In previous steps, we learned how to write and run unit tests. Unit tests are perfect for testing controllers and other parts of our application written in JavaScript, but they can't easily test templates, DOM manipulation or interoperability of components and services. For these, an end-to-end (E2E) test is a much better choice.
The search feature was fully implemented via templates and data-binding, so we'll write our first E2E test, to verify that the feature works.
e2e-tests/scenarios.js
:
describe('PhoneCat Application', function() {
describe('phoneList', function() {
beforeEach(function() {
browser.get('index.html');
});
it('should filter the phone list as a user types into the search box', function() {
var phoneList = element.all(by.repeater('phone in $ctrl.phones'));
var query = element(by.model('$ctrl.query'));
expect(phoneList.count()).toBe(3);
query.sendKeys('nexus');
expect(phoneList.count()).toBe(1);
query.clear();
query.sendKeys('motorola');
expect(phoneList.count()).toBe(2);
});
});
});
This test verifies that the search box and the repeater are correctly wired together. Notice how easy it is to write E2E tests in AngularJS. Although this example is for a simple test, it really is that easy to set up any functional, readable, E2E test.
Even though the syntax of this test looks very much like our controller unit test written with Jasmine, the E2E test uses APIs of Protractor. Read about the Protractor APIs in the Protractor API Docs.
Much like Karma is the test runner for unit tests, we use Protractor to run E2E tests. Try it with
npm run protractor
. E2E tests take time, so unlike with unit tests, Protractor will exit after the
tests run and will not automatically rerun the test suite on every file change.
To rerun the test suite, execute npm run protractor
again.
npm start
to fire up
the web server.
Display the current value of the query
model by adding a {{$ctrl.query}}
binding into the
phone-list.template.html
template and see how it changes, when you type in the input box.
You might also try to add the {{$ctrl.query}}
binding to index.html
. However, when you reload
the page, you won't see the expected result. This is because the query
model lives in the scope
defined by the <phone-list>
component.
Component isolation at work!
We have now added full-text search and included a test to verify that it works! Now let's go on to step 6 to learn how to add sorting capabilities to the PhoneCat application.