acceptance tests!

package.json

@@ -47,7 +47,7 @@
     "puppeteer": "^10.2.0",
     "serve": "^11.3.2",
     "simple-git": "^2.24.0",
-    "testcafe": "^1.18.3",
+    "testcafe": "^1.18.4",
     "testcafe-browser-provider-browserstack": "^1.13.1",
     "underscore.string": "^3.3.5",
     "urijs": "1.18.12",

script/core.hbs

@@ -18,8 +18,10 @@
       {{#with env.JAMBO_INJECTED_DATA}}
         {{#if businessId}}businessId: "{{businessId}}",{{/if}}
       {{/with}}
-      customClientSdk: {
-        ANSWERS_THEME: '{{{ env.packageJsonVersion }}}'
+      additionalHttpHeaders: {
+        'Client-SDK': {
+          ANSWERS_THEME: '{{{ env.packageJsonVersion }}}'
+        }
       }
     };
     const userConfig = {

test-site/config/global_config.json

@@ -1,10 +1,10 @@
 {
-  "sdkVersion": "1.12", // The version of the Answers SDK to use
+  "sdkVersion": "develop", // The version of the Answers SDK to use
   // "token": "<REPLACE ME>", // The auth token to access Answers experience.
   "apiKey": "2d8c550071a64ea23e263118a2b0680b", // The answers api key found on the experiences page. This will be provided automatically by the Yext CI system
   // "experienceVersion": "<REPLACE ME>", // the Answers Experience version to use for API requests. This will be provided automatically by the Yext CI system
   // "environment": "production", // The environment to run on for this Answers Experience. (i.e. 'production' or 'sandbox')
-  // "businessId": "<REPLACE ME>", // The business ID of the account. This will be provided automatically by the Yext CI system
+  "businessId": "3350634", // The business ID of the account. This will be provided automatically by the Yext CI system
   // "initializeManually": true, // If true, the experience must be started by calling AnswersExperience.init() or AnswersExperienceFrame.init() for iframe integrations.
   // "useJWT": true, // Whether or not to enable JWT. If true, the apiKey will be hidden from the build and the token must be specified through the runtime config.
   "sessionTrackingEnabled": true, // Whether or not session tracking is enabled for all pages

tests/acceptance/constants.js

@@ -1,3 +1,5 @@
-module.exports.PORT=9999;
-module.exports.VERTICAL_SEARCH_URL_REGEX=/v2\/accounts\/me\/answers\/vertical\/query/;
-module.exports.UNIVERSAL_SEARCH_URL_REGEX=/v2\/accounts\/me\/answers\/query/;
+exports.PORT=9999;
+exports.VERTICAL_SEARCH_URL_REGEX=/v2\/accounts\/me\/answers\/vertical\/query/;
+exports.UNIVERSAL_SEARCH_URL_REGEX=/v2\/accounts\/me\/answers\/query/;
+exports.UNIVERSAL_AUTOCOMPLETE_URL_REGEX=/v2\/accounts\/me\/answers\/autocomplete/;
+exports.VERTICAL_AUTOCOMPLETE_URL_REGEX=/v2\/accounts\/me\/answers\/vertical\/autocomplete/;

tests/acceptance/searchrequestlogger.js

@@ -1,10 +1,14 @@
-import { VERTICAL_SEARCH_URL_REGEX, UNIVERSAL_SEARCH_URL_REGEX } from './constants';
+import { VERTICAL_SEARCH_URL_REGEX, UNIVERSAL_SEARCH_URL_REGEX, VERTICAL_AUTOCOMPLETE_URL_REGEX, UNIVERSAL_AUTOCOMPLETE_URL_REGEX } from './constants';
 import { RequestLogger } from 'testcafe';
 
+const LOGGER_OPTIONS = {
+  logRequestHeaders: true
+}
+
 /**
  * Handles request logger creation and request/response data received during test execution.
  */
-class SearchRequestLogger {
+export class SearchRequestLogger {
 
   /**
    * Create a RequestLogger that tracks vertical query requests to given test.
@@ -13,8 +17,9 @@ class SearchRequestLogger {
    */
   createVerticalSearchLogger() {
     this._queryRequestLogger = RequestLogger({
-      url: VERTICAL_SEARCH_URL_REGEX
-    });
+      url: VERTICAL_SEARCH_URL_REGEX,
+      method: 'get'
+    }, LOGGER_OPTIONS);
     return this._queryRequestLogger;
   }
 
@@ -25,8 +30,35 @@ class SearchRequestLogger {
    */
   createUniversalSearchLogger() {
     this._queryRequestLogger = RequestLogger({
-      url: UNIVERSAL_SEARCH_URL_REGEX
-    });
+      url: UNIVERSAL_SEARCH_URL_REGEX,
+      method: 'get'
+    }, LOGGER_OPTIONS);
+    return this._queryRequestLogger;
+  }
+
+  /**
+   * Create a RequestLogger that tracks vertical query requests to given test.
+   * 
+   * @returns {import('testcafe').RequestLogger}
+   */
+  createVerticalAutocompleteLogger() {
+    this._queryRequestLogger = RequestLogger({
+      url: VERTICAL_AUTOCOMPLETE_URL_REGEX,
+      method: 'get'
+    }, LOGGER_OPTIONS);
+    return this._queryRequestLogger;
+  }
+
+  /**
+   * Create a RequestLogger that tracks universal query requests to given test.
+   * 
+   * @returns {import('testcafe').RequestLogger}
+   */
+  createUniversalAutocompleteLogger() {
+    this._queryRequestLogger = RequestLogger({
+      url: UNIVERSAL_AUTOCOMPLETE_URL_REGEX,
+      method: 'get'
+    }, LOGGER_OPTIONS);
     return this._queryRequestLogger;
   }
 

tests/acceptance/suites/client-sdk-http-header.js

@@ -0,0 +1,51 @@
+import { PORT, UNIVERSAL_AUTOCOMPLETE_URL_REGEX, UNIVERSAL_SEARCH_URL_REGEX } from '../constants';
+import { SearchRequestLogger } from '../searchrequestlogger';
+import { VERTICAL_SEARCH_URL_REGEX, VERTICAL_AUTOCOMPLETE_URL_REGEX } from '../constants';
+import { registerIE11NoCacheHook } from '../../test-utils/testcafe';
+import packageJson from '../../../package.json';
+
+const verticalSearchLogger = (new SearchRequestLogger()).createVerticalSearchLogger();
+const verticalAutocompleteLogger = (new SearchRequestLogger()).createVerticalAutocompleteLogger();
+
+fixture`vertical page`
+  .page(`http://localhost:${PORT}/people`)
+  .requestHooks(verticalSearchLogger, verticalAutocompleteLogger)
+  .beforeEach(async t => {
+    await registerIE11NoCacheHook(t, VERTICAL_SEARCH_URL_REGEX);
+    await registerIE11NoCacheHook(t, VERTICAL_AUTOCOMPLETE_URL_REGEX);
+    await t.resizeWindow(1600, 900);
+  })
+
+test('the Client-SDK header is sent correctly on vertical search/autocomplete requests', async t => {
+  await t.expect(verticalAutocompleteLogger.requests.length).eql(1);
+  await t.expect(verticalSearchLogger.requests.length).eql(1);
+  await t
+    .expect(verticalAutocompleteLogger.requests[0].request.headers['client-sdk'])
+    .contains(`ANSWERS_THEME=${packageJson.version}`);
+  await t
+    .expect(verticalSearchLogger.requests[0].request.headers['client-sdk'])
+    .contains(`ANSWERS_THEME=${packageJson.version}`);
+});
+
+const universalSearchLogger = (new SearchRequestLogger()).createUniversalSearchLogger();
+const universalAutocompleteLogger = (new SearchRequestLogger()).createUniversalAutocompleteLogger();
+
+fixture`universal page`
+  .page(`http://localhost:${PORT}/index`)
+  .requestHooks(universalSearchLogger, universalAutocompleteLogger)
+  .beforeEach(async t => {
+    await registerIE11NoCacheHook(t, UNIVERSAL_SEARCH_URL_REGEX);
+    await registerIE11NoCacheHook(t, UNIVERSAL_AUTOCOMPLETE_URL_REGEX);
+    await t.resizeWindow(1600, 900);
+  })
+
+test('the Client-SDK header is sent correctly on universal search/autocomplete requests', async t => {
+  await t.expect(universalSearchLogger.requests.length).eql(1);
+  await t.expect(universalAutocompleteLogger.requests.length).eql(1);
+  await t
+    .expect(universalAutocompleteLogger.requests[0].request.headers['client-sdk'])
+    .contains(`ANSWERS_THEME=${packageJson.version}`);
+  await t
+    .expect(universalSearchLogger.requests[0].request.headers['client-sdk'])
+    .contains(`ANSWERS_THEME=${packageJson.version}`);
+});