Merge pull request #734 from kuzzleio/7-dev

fix: (ProfilePolicy.ts) restrictedTo was mistyped (#733)

Author: rolljee

.github/actions/es-lint/action.yml

@@ -4,7 +4,7 @@ runs:
   using: "composite"
   steps:
     - name: Install deps
-      run: npm i -g npm && npm install
+      run: npm ci
       shell: bash
     - name: Run lint
       run: npm run test:lint

.github/actions/functional-tests/action.yml

@@ -14,7 +14,7 @@ runs:
       shell: bash
     - name: Build Kuzzle
       run: |
-        npm install
+        npm ci
         npm run build
       shell: bash
     - name: Run functional tests

.github/actions/snippet-tests/action.yml

@@ -9,7 +9,7 @@ runs:
   steps:
     - name: Build the Stack
       run: |
-        npm install
+        npm ci
         npm run build
       shell: bash
     - run: npm run doc-testing

.github/actions/unit-tests/action.yml

@@ -5,7 +5,7 @@ runs:
   steps:
     - name: Run build
       run: |
-        npm install
+        npm ci
         npm run build
       shell: bash
     - name: Run tests

.github/workflows/push_branches.workflow.yaml

@@ -45,11 +45,12 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - uses: convictional/[email protected]
+      - name: Deploy the documentation
+        uses: convictional/[email protected]
         with:
           owner: kuzzleio
           repo: documentation
           github_token: ${{ secrets.ACCESS_TOKEN_CI }}
           workflow_file_name: child_repo.workflow.yml
           ref: ${{ github.ref_name == 'master' && 'master' || 'develop' }}
-          client_payload: '{"repo_name":"sdk-javascript","branch":"${{ github.ref_name }}","version":"1"}'
+          client_payload: '{"repo_name":"sdk-javascript","branch":"${{ github.ref_name }}","version":"7"}'

src/protocols/Http.ts

@@ -1,9 +1,9 @@
 "use strict";
 
-import staticHttpRoutes from "./routes.json";
-import { KuzzleAbstractProtocol } from "./abstract/Base";
 import { HttpRoutes, JSONObject } from "../types";
 import { RequestPayload } from "../types/RequestPayload";
+import { KuzzleAbstractProtocol } from "./abstract/Base";
+import staticHttpRoutes from "./routes.json";
 
 /**
  * Http protocol used to connect to a Kuzzle server.
@@ -405,6 +405,11 @@ export default class HttpProtocol extends KuzzleAbstractProtocol {
             );
           }
 
+          const contentType = response.headers["content-type"];
+          if (!contentType || !contentType.includes("application/json")) {
+            return response.body;
+          }
+
           return JSON.parse(response.body);
         });
     }
@@ -435,6 +440,11 @@ export default class HttpProtocol extends KuzzleAbstractProtocol {
 
       xhr.onload = () => {
         try {
+          const contentType = xhr.getResponseHeader("Content-Type");
+          if (!contentType || !contentType.includes("application/json")) {
+            resolve(xhr.responseText);
+            return;
+          }
           const json = JSON.parse(xhr.responseText);
           resolve(json);
         } catch (err) {

src/types/ProfilePolicy.ts

@@ -24,17 +24,19 @@ export type ProfilePolicy = {
   /**
    * Optional array of restrictions on which the rights are gonne be applied
    */
-  restrictedTo?: {
-    /**
-     * Index name.
-     * Rights will only be applied on this index.
-     */
-    index: string;
+  restrictedTo?: [
+    {
+      /**
+       * Index name.
+       * Rights will only be applied on this index.
+       */
+      index: string;
 
-    /**
-     * Collection names.
-     * Rights will only be applied on those collections.
-     */
-    collections?: Array<string>;
-  };
+      /**
+       * Collection names.
+       * Rights will only be applied on those collections.
+       */
+      collections?: Array<string>;
+    }
+  ];
 };

test/protocol/Http.test.js

@@ -677,9 +677,12 @@ describe("HTTP networking module", () => {
     let httpRequestStub;
 
     beforeEach(() => {
-      httpRequestStub = sinon
-        .stub()
-        .resolves({ body: JSON.stringify(mockResponseBody) });
+      httpRequestStub = sinon.stub().resolves({
+        body: JSON.stringify(mockResponseBody),
+        headers: {
+          "content-type": "application/json",
+        },
+      });
 
       const { default: MockHttp } = proxyquire("../../src/protocols/Http", {
         "min-req-promise": { request: httpRequestStub },
@@ -793,6 +796,7 @@ describe("HTTP networking module", () => {
         open: sinon.stub(),
         send: sinon.stub(),
         setRequestHeader: sinon.stub(),
+        getResponseHeader: sinon.stub().returns("application/json"),
         onreadystatechange: sinon.stub(),
         timeout: 0,
       };