Adds record_analytics boolean flag when search is for disjunctive facet search calls (#40)

* add verbose mode to show skipped tests

* adds record_analytics flag for disjunctive facets + update network snapshots

Author: joemcelroy

.vscode/launch.json

@@ -10,7 +10,7 @@
       "request": "launch",
       "program": "${workspaceRoot}/node_modules/jest/bin/jest.js",
       "stopOnEntry": false,
-      "args": ["--runInBand", "--forceExit", "--watch"],
+      "args": ["--runInBand", "--forceExit", "--watch", "--verbose"],
       "cwd": "${workspaceRoot}",
       "preLaunchTask": null,
       "runtimeExecutable": null,

fixtures/host-2376rb.api.swiftype.com-443/disjunctive_deps_also_license

@@ -5,7 +5,7 @@ x-swiftype-client: elastic-app-search-javascript
 x-swiftype-client-version: 8.1.1
 accept: */*
 accept-encoding: gzip,deflate
-body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"license\":\"BSD\"}]},\"facets\":{\"dependencies\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"Facet-Only\"]}}
+body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"license\":\"BSD\"}]},\"facets\":{\"dependencies\":[{\"type\":\"value\",\"size\":3}]},\"record_analytics\":false,\"analytics\":{\"tags\":[\"Facet-Only\"]}}
 
 HTTP/1.1 200 OK
 date: Thu, 27 Sep 2018 21:19:12 GMT

fixtures/host-2376rb.api.swiftype.com-443/disjunctive_deps_also_license_no_array_syntax

@@ -5,7 +5,7 @@ x-swiftype-client: elastic-app-search-javascript
 x-swiftype-client-version: 8.1.1
 accept: */*
 accept-encoding: gzip,deflate
-body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":{\"type\":\"value\",\"size\":3}},\"analytics\":{\"tags\":[\"Facet-Only\"]}}
+body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":{\"type\":\"value\",\"size\":3}},\"record_analytics\":false,\"analytics\":{\"tags\":[\"Facet-Only\"]}}
 
 HTTP/1.1 200 OK
 date: Fri, 28 Sep 2018 20:07:24 GMT

fixtures/host-2376rb.api.swiftype.com-443/disjunctive_licence_override_tags

@@ -0,0 +1,35 @@
+POST /api/as/v1/engines/node-modules/search.json
+authorization: Bearer api-hean6g8dmxnm2shqqiag757a
+content-type: application/json
+x-swiftype-client: elastic-app-search-javascript
+x-swiftype-client-version: 8.1.1
+x-elastic-client-meta: ent=8.1.1-legacy,js=browser,t=8.1.1-legacy,ft=universal
+accept: */*
+accept-encoding: gzip,deflate
+body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"FromSERP\",\"Disjunctive\"]},\"record_analytics\":false}
+
+HTTP/1.1 200 OK
+date: Fri, 06 May 2022 19:35:53 GMT
+content-type: application/json; charset=utf-8
+transfer-encoding: chunked
+connection: close
+vary: Accept-Encoding, Origin
+status: 200 OK
+x-frame-options: SAMEORIGIN
+x-xss-protection: 1; mode=block
+x-content-type-options: nosniff
+x-swiftype-backend-region: dal
+x-swiftype-backend-datacenter: dal10
+x-swiftype-backend-node: app-api03a.dal10
+x-ratelimit-limit: 12000
+x-ratelimit-remaining: 11999
+etag: W/"10be0071db0ead6986f2ddf45b896207"
+cache-control: max-age=0, private, must-revalidate
+x-request-id: 78e10ad9edfafd32ff71faddaaaa6292
+x-runtime: 0.244323
+x-swiftype-frontend-datacenter: dal10
+x-swiftype-frontend-node: web02b.dal10
+x-swiftype-edge-datacenter: dal10
+x-swiftype-edge-node: web02b.dal10
+
+{"meta":{"alerts":[],"warnings":[],"page":{"current":1,"total_pages":1,"total_results":642,"size":0},"request_id":"78e10ad9edfafd32ff71faddaaaa6292"},"results":[],"facets":{"license":[{"type":"value","data":[{"value":"MIT","count":101},{"value":"BSD","count":33},{"value":"MIT/X11","count":3}]}]}}

fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license

@@ -5,7 +5,7 @@ x-swiftype-client: elastic-app-search-javascript
 x-swiftype-client-version: 8.1.1
 accept: */*
 accept-encoding: gzip,deflate
-body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"Facet-Only\"]}}
+body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"record_analytics\":false,\"analytics\":{\"tags\":[\"Facet-Only\"]}}
 
 HTTP/1.1 200 OK
 date: Thu, 27 Sep 2018 20:36:08 GMT

fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license_also_deps

@@ -5,7 +5,7 @@ x-swiftype-client: elastic-app-search-javascript
 x-swiftype-client-version: 8.1.1
 accept: */*
 accept-encoding: gzip,deflate
-body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"Facet-Only\"]}}
+body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{\"all\":[{\"dependencies\":\"socket.io\"}]},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"record_analytics\":false,\"analytics\":{\"tags\":[\"Facet-Only\"]}}
 
 HTTP/1.1 200 OK
 date: Thu, 27 Sep 2018 21:04:37 GMT

fixtures/host-2376rb.api.swiftype.com-443/disjunctive_license_with_override_tags

@@ -3,12 +3,13 @@ authorization: Bearer api-hean6g8dmxnm2shqqiag757a
 content-type: application/json
 x-swiftype-client: elastic-app-search-javascript
 x-swiftype-client-version: 8.1.1
+x-elastic-client-meta: ent=8.1.1-legacy,js=browser,t=8.1.1-legacy,ft=universal
 accept: */*
 accept-encoding: gzip,deflate
-body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"FromSERP\",\"Disjunctive\"]}}
+body: {\"query\":\"cat\",\"page\":{\"size\":0},\"filters\":{},\"facets\":{\"license\":[{\"type\":\"value\",\"size\":3}]},\"analytics\":{\"tags\":[\"Facet-Only\"]},\"record_analytics\":false}
 
 HTTP/1.1 200 OK
-date: Thu, 27 Sep 2018 20:36:08 GMT
+date: Fri, 06 May 2022 15:25:51 GMT
 content-type: application/json; charset=utf-8
 transfer-encoding: chunked
 connection: close
@@ -17,13 +18,18 @@ status: 200 OK
 x-frame-options: SAMEORIGIN
 x-xss-protection: 1; mode=block
 x-content-type-options: nosniff
-etag: W/"d31aa222a68122cb8392577cf4a1a7f1"
+x-swiftype-backend-region: dal
+x-swiftype-backend-datacenter: dal10
+x-swiftype-backend-node: app-api03a.dal10
+x-ratelimit-limit: 12000
+x-ratelimit-remaining: 11998
+etag: W/"680394011bb0efcb7a53ebd964a1127f"
 cache-control: max-age=0, private, must-revalidate
-x-request-id: 91197d45d104a3e2281a60eecec630ff
-x-runtime: 0.270027
-x-swiftype-frontend-datacenter: dal05
-x-swiftype-frontend-node: web01.dal05
-x-swiftype-edge-datacenter: dal05
-x-swiftype-edge-node: web01.dal05
+x-request-id: 73ed894a358f45bc79fb829d2427d9d9
+x-runtime: 0.086157
+x-swiftype-frontend-datacenter: dal10
+x-swiftype-frontend-node: web02b.dal10
+x-swiftype-edge-datacenter: dal10
+x-swiftype-edge-node: web02b.dal10
 
-{"meta":{"warnings":[],"page":{"current":1,"total_pages":642,"total_results":642,"size":1},"request_id":"91197d45d104a3e2281a60eecec630ff"},"results":[{"license":{"raw":["BSD"]},"name":{"raw":"source-map-cat"},"repository":{"raw":null},"created":{"raw":"2013-01-23T04:51:39.995Z"},"dependencies":{"raw":["coffee-script","argparse","source-map"]},"keywords":{"raw":null},"description":{"raw":"WIP cat for JS source maps."},"modified":{"raw":"2013-01-23T04:51:42.782Z"},"id":{"raw":"source-map-cat"},"version":{"raw":"0.0.0"},"owners":{"raw":["gregg@aweber.com"]},"_meta":{"score":19.12111}}],"facets":{"license":[{"type":"value","data":[{"value":"MIT","count":101},{"value":"BSD","count":33},{"value":"MIT/X11","count":3}]}]}}
+{"meta":{"alerts":[],"warnings":[],"page":{"current":1,"total_pages":1,"total_results":642,"size":0},"request_id":"73ed894a358f45bc79fb829d2427d9d9"},"results":[],"facets":{"license":[{"type":"value","data":[{"value":"MIT","count":101},{"value":"BSD","count":33},{"value":"MIT/X11","count":3}]}]}}

src/client.js

@@ -172,6 +172,7 @@ export default class Client {
         return this._performSearch({
           ...params,
           filters: filters.removeFilter(appliedDisjunctiveFilter).filtersJSON,
+          record_analytics: false,
           page: {
             ...page,
             // Set this to 0 for performance, since disjunctive queries

tests/client.spec.js

@@ -225,7 +225,7 @@ describe("Client", () => {
         );
       });
 
-      // Fixture: disjunctive_license
+      // Fixture: disjunctive_license_override_tags
       // Fixture: search_filter_and_multi_facet_with_tags
       it("will not pass tags through on disjunctive queries", async () => {
         // Note, this is tested implicitly by using the same disjunctive fixture as the previous test. This
@@ -401,7 +401,7 @@ describe("Client", () => {
     });
 
     // Fixture: additional_headers
-    it.only("should pass along additional headers", async () => {
+    it("should pass along additional headers", async () => {
       const headerClient = new Client(hostIdentifier, searchKey, engineName, {
         additionalHeaders: { "Content-Type": "bogus/format" }
       });