Merge pull request #203 from nhsuk/feature/add-result-numbers-to-meta…

…data

More visibility/flexibility of the number of results returned from search

app/lib/esGeoQueryBuilder.js

@@ -1,8 +1,8 @@
 const getShouldClause = require('./utils/getTextSearchShouldClause');
 const getBaseQuery = require('./utils/getBaseQuery');
 
-function build(location, searchTerm) {
-  const query = getBaseQuery();
+function build(location, searchTerm, size) {
+  const query = getBaseQuery(size);
 
   query.body.query.bool.filter = {
     geo_distance: {

app/lib/esQueryBuilder.js

@@ -1,8 +1,8 @@
 const getShouldClause = require('./utils/getTextSearchShouldClause');
 const getBaseQuery = require('./utils/getBaseQuery');
 
-function build(searchTerm) {
-  const query = getBaseQuery();
+function build(searchTerm, size) {
+  const query = getBaseQuery(size);
   query.body.query.bool.should = getShouldClause(searchTerm);
   return query;
 }

app/lib/utils/getBaseQuery.js

@@ -1,9 +1,9 @@
-function getBaseQuery() {
+function getBaseQuery(size) {
   return {
     index: 'profiles',
     type: 'gps',
     body: {
-      size: 30,
+      size,
       query: {
         bool: {}
       }

app/middleware/getGps.js

@@ -34,17 +34,18 @@ function mapResults(results, res, searchTerm) {
   res.locals.resultsSubHeader = resultsFormat.pluraliseSurgery(res.locals.gps.length, searchTerm);
 }
 
-function getEsQuery(postcodeLocationDetails, searchTerm) {
+function getEsQuery(postcodeLocationDetails, searchTerm, size) {
   return (postcodeLocationDetails) ?
-    esGeoQueryBuilder.build(postcodeLocationDetails.location, searchTerm) :
-    esQueryBuilder.build(searchTerm);
+    esGeoQueryBuilder.build(postcodeLocationDetails.location, searchTerm, size) :
+    esQueryBuilder.build(searchTerm, size);
 }
 
 function getGps(req, res, next) {
   const searchTerm = res.locals.search;
   const postcode = res.locals.postcodeSearch;
+  const resultsLimit = res.locals.RESULTS_LIMIT;
   const postcodeLocationDetails = res.locals.postcodeLocationDetails;
-  const esQuery = getEsQuery(postcodeLocationDetails, searchTerm);
+  const esQuery = getEsQuery(postcodeLocationDetails, searchTerm, resultsLimit);
 
   elasticsearchClient
     .search(esQuery)
@@ -56,6 +57,8 @@ function getGps(req, res, next) {
         esQuery,
         resultCount: results.hits.total
       }, 'getGps');
+      // eslint-disable-next-line no-param-reassign
+      res.locals.resultsCount = results.hits.total;
       mapResults(results, res, searchTerm);
     })
     .then(next)

app/middleware/locals.js

@@ -5,6 +5,7 @@ module.exports = config =>
     res.locals.WEBTRENDS_ANALYTICS_TRACKING_ID = config.webtrendsId;
     res.locals.HOTJAR_ANALYTICS_TRACKING_ID = config.hotjarId;
     res.locals.SITE_ROOT = req.app.locals.SITE_ROOT;
+    res.locals.RESULTS_LIMIT = config.resultsLimit;
     /* eslint-enable no-param-reassign */
 
     next();

app/middleware/setLocals.js

@@ -3,6 +3,7 @@ const backLinkUtils = require('../lib/utils/backLink');
 function fromRequest(req, res, next) {
   res.locals.search = req.query.search;
   res.locals.postcodeSearch = req.query.postcode;
+  res.locals.resultsCount = 0;
   res.locals.isOutcode = false;
   res.locals.searchLabel = 'Surgery or GP name';
   res.locals.searchButton = 'Search';

app/views/results.nunjucks

@@ -5,6 +5,8 @@
 {% block meta %}
 <meta name="WT.gposs" content="{{ search }}"></meta>
 <meta name="WT.gposs_r" content="1"></meta>
+<meta name="DCSext.GPResultsLimit" content="{{ RESULTS_LIMIT }}"></meta>
+<meta name="DCSext.GPTotalResults" content="{{ resultsCount }}"></meta>
 {% endblock %}
 
 {% block content %}

config/config.js

@@ -14,6 +14,7 @@ module.exports = {
     host: process.env.ES_HOST || 'es',
     port: process.env.ES_PORT || '9200',
   },
+  resultsLimit: process.env.RESULTS_LIMIT || 30,
   googleAnalyticsId: process.env.GOOGLE_ANALYTICS_TRACKING_ID,
   webtrendsId: process.env.WEBTRENDS_ANALYTICS_TRACKING_ID,
   hotjarId: process.env.HOTJAR_ANALYTICS_TRACKING_ID,

test/integration/resultsPage.js

@@ -25,7 +25,7 @@ function assertSearchResponse(search, postcode, done, assertions) {
 describe('Results page', () => {
   const noOnlineBookingLinkMessage = 'This surgery doesn't have an online booking system.';
 
-  describe('page layout', () => {
+  describe('layout', () => {
     it('should contain HTML', (done) => {
       const search = 'Surgery';
       const postcode = '';
@@ -47,6 +47,20 @@ describe('Results page', () => {
       });
     });
 
+    it('should contain meta data with results information', (done) => {
+      const search = 'Surgery';
+      const postcode = '';
+
+      assertSearchResponse(search, postcode, done, (err, res) => {
+        const $ = cheerio.load(res.text);
+        const resultsLimit = $('meta[name="DCSext.GPResultsLimit"]').attr('content');
+        const totalResults = $('meta[name="DCSext.GPTotalResults"]').attr('content');
+
+        expect(resultsLimit).to.eq('30');
+        expect(totalResults).to.eq('3687');
+      });
+    });
+
     describe('matching surgeries found', () => {
       describe('multiple matches', () => {
         it('should have more than one result', (done) => {

test/unit/lib/esGeoQueryBuilder.js

@@ -50,8 +50,9 @@ describe('esGeoQueryBuilder', () => {
     );
   });
 
-  it('should return the size as 30', () => {
-    const query = esGeoQueryBuilder.build(location, searchTerm);
+  it('should return the size as per the setting in the locale', () => {
+    const res = { locals: { resultsReturnedCount: 30 } };
+    const query = esGeoQueryBuilder.build(location, searchTerm, res.locals.resultsReturnedCount);
     expect(query.body.size).to.be.equal(30);
   });
 });

test/unit/lib/esQueryBuilder.js

@@ -40,8 +40,10 @@ describe('esQueryBuilder', () => {
       );
   });
 
-  it('should return the size as 30', () => {
-    const query = esQueryBuilder.build();
+  it('should return the size as set in the locale', () => {
+    const searchTerm = 'search for this';
+    const res = { locals: { resultsReturnedCount: 30 } };
+    const query = esQueryBuilder.build(searchTerm, res.locals.resultsReturnedCount);
 
     expect(query.body.size).to.be.equal(30);
   });