Merge pull request #719 from kuzzleio/7.10.4-proposal

Release 7.10.4

Author: Shiranuit

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "kuzzle-sdk",
-  "version": "7.10.3",
+  "version": "7.10.4",
   "description": "Official Javascript SDK for Kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
   "repository": {

package.json

@@ -840,7 +840,7 @@ export interface ArgsDocumentControllerDelete extends ArgsDefault {
 }
 
 export interface ArgsDocumentControllerDeleteByQuery extends ArgsDefault {
-  refresh?: string;
+  refresh?: "wait_for" | "false";
   silent?: boolean;
   lang?: string;
 }
@@ -933,7 +933,7 @@ export interface ArgsDocumentControllerUpdateByQuery extends ArgsDefault {
 export interface ArgsDocumentControllerUpsert<TKDocumentContent>
   extends ArgsDefault {
   default?: Partial<TKDocumentContent>;
-  refresh?: string;
+  refresh?: "wait_for" | "false";
   silent?: boolean;
   retryOnConflict?: boolean;
   source?: boolean;

src/controllers/Document.ts

@@ -164,14 +164,11 @@ export class SearchResultBase<T> implements SearchResult<T> {
       }
 
       return this._kuzzle
-        .query(
-          {
-            ...this._request,
-            action: this._searchAction,
-            from: this.fetched,
-          },
-          this._options
-        )
+        .query({
+          ...this._request,
+          action: this._searchAction,
+          from: this.fetched,
+        })
         .then(({ result }) => this._buildNextSearchResult(result));
     }
 

src/core/searchResult/SearchResultBase.ts

@@ -274,6 +274,14 @@ export default class HttpProtocol extends KuzzleAbstractProtocol {
         payload.headers.authorization = "Bearer " + value;
       } else if (key === "volatile") {
         payload.headers["x-kuzzle-volatile"] = JSON.stringify(value);
+      } else if (key === "index" || key === "collection") {
+        // If we're calling a non-native route that answer to a GET request
+        // we need to add the index and collection (if provided) to the query string
+        if (!staticHttpRoutes[request.controller] && method === "GET") {
+          queryArgs[key] = value;
+        } else {
+          payload[key] = value;
+        }
       } else if (Object.prototype.hasOwnProperty.call(payload, key)) {
         payload[key] = value;
       } else if (value !== undefined && value !== null) {

src/protocols/Http.ts

@@ -83,11 +83,12 @@ export abstract class BaseProtocolRealtime extends KuzzleAbstractProtocol {
       this.retrying = true;
 
       if (
+        window !== null &&
         typeof window === "object" &&
-        typeof window.navigator === "object" &&
-        window.navigator.onLine === false
+        typeof window!.navigator === "object" &&
+        window!.navigator.onLine === false
       ) {
-        window.addEventListener(
+        window!.addEventListener(
           "online",
           () => {
             this.retrying = false;

src/protocols/abstract/Realtime.ts

@@ -3,19 +3,33 @@ let NODE_DEBUG;
 /* eslint no-undef: 0 */
 
 function shouldDebug() {
-  if (typeof window === "undefined") {
-    // Avoid multiple calls to process.env
-    if (!NODE_DEBUG) {
-      NODE_DEBUG = (process.env.DEBUG || "").includes("kuzzle-sdk");
+  /**
+   * Some framework like react-native or other might emulate the window object
+   * but when on plateforms like iOS / Android, the window.location is undefined.
+   *
+   * So we need to check if window.location is defined before using it otherwise
+   * we will get an error.
+   *
+   * If something went wrong, be sure to return false to avoid any error.
+   */
+  try {
+    if (typeof window === "undefined") {
+      // Avoid multiple calls to process.env
+      if (!NODE_DEBUG) {
+        NODE_DEBUG = (process.env.DEBUG || "").includes("kuzzle-sdk");
+      }
+
+      return NODE_DEBUG;
     }
 
-    return NODE_DEBUG;
+    return (
+      window.debugKuzzleSdk ||
+      (window.location &&
+        new URL(window.location).searchParams.get("debugKuzzleSdk") !== null)
+    );
+  } catch (e) {
+    return false;
   }
-
-  return (
-    window.debugKuzzleSdk ||
-    new URL(window.location).searchParams.get("debugKuzzleSdk") !== null
-  );
 }
 
 /**

src/utils/debug.js

@@ -332,18 +332,15 @@ describe("DocumentSearchResult", () => {
         return searchResult.next().then((nextSearchResult) => {
           should(kuzzle.query)
             .be.calledOnce()
-            .be.calledWith(
-              {
-                index: "index",
-                collection: "collection",
-                body: { query: { foo: "bar" } },
-                controller: "document",
-                action: "search",
-                size: 2,
-                from: 2,
-              },
-              options
-            );
+            .be.calledWith({
+              index: "index",
+              collection: "collection",
+              body: { query: { foo: "bar" } },
+              controller: "document",
+              action: "search",
+              size: 2,
+              from: 2,
+            });
           should(nextSearchResult).not.be.equal(searchResult);
           should(nextSearchResult).be.instanceOf(DocumentSearchResult);
         });

test/core/searchResult/document.test.js

@@ -352,16 +352,13 @@ describe("ProfileSearchResult", () => {
         return searchResult.next().then((nextSearchResult) => {
           should(kuzzle.query)
             .be.calledOnce()
-            .be.calledWith(
-              {
-                body: { query: { foo: "bar" } },
-                controller: "security",
-                action: "searchProfiles",
-                size: 2,
-                from: 2,
-              },
-              options
-            );
+            .be.calledWith({
+              body: { query: { foo: "bar" } },
+              controller: "security",
+              action: "searchProfiles",
+              size: 2,
+              from: 2,
+            });
           should(nextSearchResult).not.be.equal(searchResult);
           should(nextSearchResult).be.instanceOf(ProfileSearchResult);
         });

test/core/searchResult/profile.test.js

@@ -160,16 +160,13 @@ describe("RoleSearchResult", () => {
         return searchResult.next().then((nextSearchResult) => {
           should(kuzzle.query)
             .be.calledOnce()
-            .be.calledWith(
-              {
-                body: { foo: "bar" },
-                controller: "security",
-                action: "searchRoles",
-                size: 2,
-                from: 2,
-              },
-              options
-            );
+            .be.calledWith({
+              body: { foo: "bar" },
+              controller: "security",
+              action: "searchRoles",
+              size: 2,
+              from: 2,
+            });
           should(nextSearchResult).not.be.equal(searchResult);
           should(nextSearchResult).be.instanceOf(RoleSearchResult);
         });