Made search key optional (#30)

Author: JasonStoltz

README.md

@@ -105,14 +105,14 @@ var client = ElasticAppSearch.createClient({
 
 ### List of configuration options:
 
-| Option            | Required | Description                                                                                                                                                                                                  |
-| ----------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| hostIdentifier    | No       | Your **Host Identifier**, should start with `host-`. Required unless explicitly setting `endpointBase`                                                                                                       |
-| searchKey         | Yes      | Your **Public Search Key**. It should start with `search-`.                                                                                                                                                  |
-| engineName        | Yes      |                                                                                                                                                                                                              |
-| endpointBase      | No       | Overrides the base of the App Search API endpoint completely. Useful when proxying the App Search API, developing against a local server, or a Self-Managed or Cloud Deployment. Ex. "http://localhost:3002" |
-| cacheResponses    | No       | Whether or not API responses should be cached. Default: `true`.                                                                                                                                              |
-| additionalHeaders | No       | An Object with keys and values that will be converted to header names and values on all API requests                                                                                                         |
+| Option            | Required | Description                                                                                                                                                                                                                                                                                                                                         |
+| ----------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| hostIdentifier    | No       | Your **Host Identifier**, should start with `host-`. Required unless explicitly setting `endpointBase`                                                                                                                                                                                                                                              |
+| searchKey         | No       | Your **Public Search Key**. It should start with `search-`.<br/><br/>NOTE: This is not _technically_ required, but in 99% of cases it should be provided. There is a small edge case for not providing this, mainly useful for internal App Search usage, where this can be ommited in order to leverage App Search's session based authentication. |
+| engineName        | Yes      |                                                                                                                                                                                                                                                                                                                                                     |
+| endpointBase      | No       | Overrides the base of the App Search API endpoint completely. Useful when proxying the App Search API, developing against a local server, or a Self-Managed or Cloud Deployment. Ex. "http://localhost:3002"                                                                                                                                        |
+| cacheResponses    | No       | Whether or not API responses should be cached. Default: `true`.                                                                                                                                                                                                                                                                                     |
+| additionalHeaders | No       | An Object with keys and values that will be converted to header names and values on all API requests                                                                                                                                                                                                                                                |
 
 ### API Methods
 

src/request.js

@@ -44,7 +44,7 @@ function _request(
   { additionalHeaders } = {}
 ) {
   const headers = new Headers({
-    Authorization: `Bearer ${searchKey}`,
+    ...(searchKey && { Authorization: `Bearer ${searchKey}` }),
     "Content-Type": "application/json",
     "X-Swiftype-Client": "elastic-app-search-javascript",
     "X-Swiftype-Client-Version": version,

tests/request.spec.js

@@ -19,25 +19,34 @@ describe("request", () => {
 
   beforeEach(() => {
     global.Headers = Headers;
+    jest.resetAllMocks();
     global.fetch = jest
       .fn()
       .mockImplementation(() => Promise.resolve(response));
   });
 
-  beforeEach(() => {
-    global.fetch.mockClear();
+  it("can send a fetch request, authenticated by the provided search key", async () => {
+    const res = await request(searchKey, endpoint, path, params, false);
+    expect(res.response).toBe(response);
+    expect(global.fetch.mock.calls.length).toBe(1);
+    var [_, options] = global.fetch.mock.calls[0];
+    expect(options.headers.get("Authorization")).toEqual("Bearer api-12345");
   });
 
-  it("can fetch", async () => {
-    const res = await request(searchKey, endpoint, path, params, true);
-    expect(res.response).toBe(response);
+  // The use case for this is mostly internal to Elastic, where we rely on the logged in user session (via cookies) to authenticate
+  it("can send an authenticated fetch request, when no search key is provided", async () => {
+    const res = await request(undefined, endpoint, path, params, false);
     expect(global.fetch.mock.calls.length).toBe(1);
+    var [_, options] = global.fetch.mock.calls[0];
+    expect(options.headers.has("Authorization")).toBe(false);
   });
 
   it("will return a cached response if already called once", async () => {
     const res = await request(searchKey, endpoint, path, params, true);
+    await request(searchKey, endpoint, path, params, true);
+    await request(searchKey, endpoint, path, params, true);
     expect(res.response).toBe(response);
-    expect(global.fetch.mock.calls.length).toBe(0);
+    expect(global.fetch.mock.calls.length).toBe(1);
   });
 
   it("will not return the cached response if endpoint changes", async () => {