collectionController.test.js

"use strict";

const should = require("should");

const {
  Request,
  BadRequestError,
  NotFoundError,
  SizeLimitError,
} = require("../../../index");
const KuzzleMock = require("../../mocks/kuzzle.mock");

const CollectionController = require("../../../lib/api/controllers/collectionController");
const {
  NativeController,
} = require("../../../lib/api/controllers/baseController");

describe("Test: collection controller", () => {
  let collectionController;
  let kuzzle;
  let index = "%text";
  let collection = "unit-test-collectionController";
  let request;

  beforeEach(() => {
    const data = {
      controller: "collection",
      index,
      collection,
    };

    kuzzle = new KuzzleMock();
    collectionController = new CollectionController();

    request = new Request(data);
  });

  describe("#constructor", () => {
    it("should inherit the base constructor", () => {
      should(collectionController).instanceOf(NativeController);
    });
  });

  describe("#updateMapping", () => {
    it("should throw a BadRequestError if the body is missing", () => {
      return should(collectionController.updateMapping(request)).rejectedWith(
        BadRequestError,
        { id: "api.assert.body_required" },
      );
    });

    it("should forward to the store module", async () => {
      const mappings = {
        dynamic: "false",
        _meta: "data",
        properties: "properties",
      };
      request.input.body = mappings;

      kuzzle.ask
        .withArgs("core:storage:public:mappings:update")
        .resolves(mappings);

      const response = await collectionController.updateMapping(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:public:mappings:update",
        index,
        collection,
        mappings,
      );

      should(response).match({
        dynamic: "false",
        _meta: "data",
        properties: "properties",
      });
    });
  });

  describe("#getMapping", () => {
    it("should forward to the store module", async () => {
      const mappings = {
        dynamic: "false",
        _meta: "data",
        properties: "properties",
      };

      kuzzle.ask
        .withArgs("core:storage:public:mappings:get")
        .resolves(mappings);

      const response = await collectionController.getMapping(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:public:mappings:get",
        index,
        collection,
        { includeKuzzleMeta: false },
      );

      should(response).match(mappings);
    });

    it("should include kuzzleMeta if specified", async () => {
      const mappings = {
        dynamic: "false",
        _meta: "data",
        properties: "properties",
      };
      request.input.args.includeKuzzleMeta = true;

      kuzzle.ask
        .withArgs("core:storage:public:mappings:get")
        .resolves(mappings);

      await collectionController.getMapping(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:public:mappings:get",
        index,
        collection,
        { includeKuzzleMeta: true },
      );
    });
  });

  describe("#truncate", () => {
    it("should trigger the proper methods and return a valid response", async () => {
      const response = await collectionController.truncate(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:public:collection:truncate",
        index,
        collection,
      );

      should(response).match({
        acknowledged: true,
      });
    });
  });

  describe("#getSpecifications", () => {
    it("should trigger the proper methods and return a valid response", async () => {
      kuzzle.ask.withArgs("core:storage:private:document:get").resolves({
        _source: {
          some: "validation",
        },
      });

      const response = await collectionController.getSpecifications(request);

      should(kuzzle.ask).be.calledWithMatch(
        "core:storage:private:document:get",
        kuzzle.internalIndex.index,
        "validations",
        `${index}#${collection}`,
      );

      should(response).match({
        some: "validation",
      });
    });

    it("should give a meaningful message if there is no specifications", () => {
      kuzzle.ask
        .withArgs("core:storage:private:document:get")
        .rejects(new NotFoundError("not found"));

      return should(
        collectionController.getSpecifications(request),
      ).be.rejectedWith(NotFoundError, { id: "validation.assert.not_found" });
    });
  });

  describe("#searchSpecifications", () => {
    it("should throw if the page size exceeds server limitations", () => {
      kuzzle.config.limits.documentsFetchCount = 1;
      request.input.args.from = 0;
      request.input.args.size = 20;

      return should(
        collectionController.searchSpecifications(request),
      ).rejectedWith(SizeLimitError, {
        id: "services.storage.get_limit_exceeded",
      });
    });

    it("should call internalIndex with the right data", async () => {
      kuzzle.ask.withArgs("core:storage:private:document:search").resolves({
        hits: [{ _id: "bar" }],
        scrollId: "foobar",
        total: 123,
      });

      request = new Request({
        body: {
          query: {
            match_all: {},
          },
        },
        from: 0,
        size: 20,
        scroll: "15s",
      });

      const response = await collectionController.searchSpecifications(request);

      should(kuzzle.ask).be.calledWithMatch(
        "core:storage:private:document:search",
        kuzzle.internalIndex.index,
        "validations",
        request.input.body,
        {
          from: request.input.args.from,
          size: request.input.args.size,
          scroll: request.input.args.scroll,
        },
      );

      should(response).match({
        total: 123,
        scrollId: "foobar",
        hits: [{ _id: "bar" }],
      });
    });
  });

  describe("#scrollSpecifications", () => {
    it("should throw if no scrollId is provided", () => {
      request = new Request({
        controller: "collection",
        action: "scrollSpecifications",
      });

      return should(
        collectionController.scrollSpecifications(request),
      ).rejectedWith(BadRequestError, { id: "api.assert.missing_argument" });
    });

    it("should call internalIndex with the right data", async () => {
      kuzzle.ask.withArgs("core:storage:private:document:scroll").resolves({
        hits: [{ _id: "bar" }],
        scrollId: "foobar",
        total: 123,
      });

      request = new Request({ scrollId: "foobar" });

      const response = await collectionController.scrollSpecifications(request);

      should(kuzzle.ask).be.calledWithMatch(
        "core:storage:private:document:scroll",
        "foobar",
        collectionController.defaultScrollTTL,
      );

      should(response).match({
        total: 123,
        scrollId: "foobar",
        hits: [{ _id: "bar" }],
      });
    });

    it("should handle the optional scroll argument", async () => {
      kuzzle.ask.withArgs("core:storage:private:document:scroll").resolves({
        hits: [{ _id: "bar" }],
        scrollId: "foobar",
        total: 123,
      });

      request = new Request({ scrollId: "foobar", scroll: "qux" });

      const response = await collectionController.scrollSpecifications(request);

      should(kuzzle.ask).be.calledWithMatch(
        "core:storage:private:document:scroll",
        "foobar",
        "qux",
      );

      should(response).match({
        total: 123,
        scrollId: "foobar",
        hits: [{ _id: "bar" }],
      });
    });
  });

  describe("#updateSpecifications", () => {
    it("should create or replace specifications", async () => {
      request.input.body = {
        strict: true,
        fields: {
          myField: {
            mandatory: true,
            type: "integer",
            defaultValue: 42,
          },
        },
      };
      kuzzle.validation.validateFormat.resolves({ isValid: true });
      kuzzle.validation.curateSpecification.resolves();

      const response = await collectionController.updateSpecifications(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:private:collection:refresh",
        kuzzle.internalIndex.index,
        "validations",
      );

      should(kuzzle.validation.curateSpecification).be.called();

      should(kuzzle.ask).be.calledWithMatch(
        "core:storage:private:document:createOrReplace",
        kuzzle.internalIndex.index,
        "validations",
        `${index}#${collection}`,
        {
          index,
          collection,
          validation: request.input.body,
        },
      );

      should(response).match(request.input.body);
    });

    it("should rejects and do not create or replace specifications if the specs are wrong", async () => {
      request.input.body = {
        strict: true,
        fields: {
          myField: {
            mandatory: true,
            type: "zorglub",
            defaultValue: 42,
          },
        },
      };
      kuzzle.validation.validateFormat.resolves({
        isValid: false,
        errors: ["zorglub is a bad type !"],
      });

      await should(
        collectionController.updateSpecifications(request),
      ).be.rejectedWith(BadRequestError, {
        id: "validation.assert.invalid_specifications",
      });

      should(kuzzle.validation.curateSpecification).not.be.called();
      should(kuzzle.internalIndex.createOrReplace).not.be.called();
    });
  });

  describe("#validateSpecifications", () => {
    beforeEach(() => {
      request.input.body = {
        strict: true,
        fields: {
          myField: {
            mandatory: true,
            type: "integer",
            defaultValue: 42,
          },
        },
      };
    });

    it("should call the right functions and respond with the right response", async () => {
      kuzzle.validation.validateFormat.resolves({ isValid: true });

      const response =
        await collectionController.validateSpecifications(request);

      should(kuzzle.validation.validateFormat).be.calledWith(
        index,
        collection,
        request.input.body,
        true,
      );
      should(response).match({
        valid: true,
      });
    });

    it("should return an error if specifications are invalid", async () => {
      kuzzle.validation.validateFormat.resolves({
        isValid: false,
        errors: "errors",
      });

      const response =
        await collectionController.validateSpecifications(request);

      should(response).match({
        valid: false,
        details: "errors",
        description: "Some errors with provided specifications.",
      });
    });
  });

  describe("#deleteSpecifications", () => {
    it("should call the right functions and respond with the right response if the validation specification exists", async () => {
      const response = await collectionController.deleteSpecifications(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:private:document:delete",
        kuzzle.internalIndex.index,
        "validations",
        `${index}#${collection}`,
      );

      should(kuzzle.ask).be.calledWith(
        "core:storage:private:collection:refresh",
        kuzzle.internalIndex.index,
        "validations",
      );

      should(kuzzle.validation.curateSpecification).be.calledOnce();

      should(response).match({
        acknowledged: true,
      });
    });
  });

  describe("#list", () => {
    let realtimeListCollectionsStub;

    beforeEach(() => {
      kuzzle.ask
        .withArgs("core:storage:public:collection:list")
        .resolves(["col", "loc"]);

      realtimeListCollectionsStub = kuzzle.ask
        .withArgs("core:realtime:collections:get")
        .resolves(["foo", "bar"]);
    });

    it("should resolve to a full collections list", async () => {
      const response = await collectionController.list(request);

      should(kuzzle.ask).calledWith(
        "core:realtime:collections:get",
        request.input.args.index,
      );

      should(kuzzle.ask).calledWith(
        "core:storage:public:collection:list",
        index,
      );

      should(response.type).be.exactly("all");
      should(response.collections).be.an.Array();
      should(response.collections).deepEqual([
        { name: "bar", type: "realtime" },
        { name: "col", type: "stored" },
        { name: "foo", type: "realtime" },
        { name: "loc", type: "stored" },
      ]);
    });

    it('should reject the request if an invalid "type" argument is provided', () => {
      request = new Request({ index: "index", type: "foo" });

      return should(collectionController.list(request)).rejectedWith(
        BadRequestError,
        { id: "api.assert.invalid_argument" },
      );
    });

    it("should only return stored collections with type = stored", async () => {
      request = new Request({ index: "index", type: "stored" });

      const response = await collectionController.list(request);

      should(response).be.instanceof(Object);
      should(response.type).be.exactly("stored");
      should(realtimeListCollectionsStub).not.be.called();
      should(kuzzle.ask).be.calledWith("core:storage:public:collection:list");
    });

    it("should only return realtime collections with type = realtime", async () => {
      request = new Request({ index: "index", type: "realtime" });

      const response = await collectionController.list(request);

      should(response).be.instanceof(Object);
      should(response.type).be.exactly("realtime");

      should(realtimeListCollectionsStub).calledWith(
        "core:realtime:collections:get",
        "index",
      );

      should(
        kuzzle.ask.withArgs("core:storage:public:collection:list"),
      ).not.be.called();
    });

    it("should return a portion of the collection list if from and size are specified", async () => {
      request = new Request({ index: "index", type: "all", from: 2, size: 3 });

      kuzzle.ask
        .withArgs("core:storage:public:collection:list")
        .resolves(["astored", "bstored", "cstored", "dstored", "estored"]);

      realtimeListCollectionsStub.resolves([
        "arealtime",
        "brealtime",
        "crealtime",
        "drealtime",
        "erealtime",
      ]);

      const response = await collectionController.list(request);

      should(response).be.instanceof(Object);
      should(response.collections).be.deepEqual([
        { name: "brealtime", type: "realtime" },
        { name: "bstored", type: "stored" },
        { name: "crealtime", type: "realtime" },
      ]);
      should(response.type).be.exactly("all");
      should(realtimeListCollectionsStub).calledWith(
        "core:realtime:collections:get",
        "index",
      );
      should(kuzzle.ask).calledWith("core:storage:public:collection:list");
    });

    it("should return a portion of the collection list if from is specified", async () => {
      request = new Request({ index: "index", type: "all", from: 8 });

      kuzzle.ask
        .withArgs("core:storage:public:collection:list")
        .resolves(["astored", "bstored", "cstored", "dstored", "estored"]);

      realtimeListCollectionsStub.resolves([
        "arealtime",
        "brealtime",
        "crealtime",
        "drealtime",
        "erealtime",
      ]);

      const response = await collectionController.list(request);

      should(response.type).be.exactly("all");
      should(response.collections).be.deepEqual([
        { name: "erealtime", type: "realtime" },
        { name: "estored", type: "stored" },
      ]);
      should(response).be.instanceof(Object);
      should(realtimeListCollectionsStub).calledWith(
        "core:realtime:collections:get",
        "index",
      );
      should(kuzzle.ask).be.calledWith("core:storage:public:collection:list");
    });

    it("should return a portion of the collection list if size is specified", async () => {
      request = new Request({ index: "index", type: "all", size: 2 });

      kuzzle.ask
        .withArgs("core:storage:public:collection:list")
        .resolves(["astored", "bstored", "cstored", "dstored", "estored"]);

      realtimeListCollectionsStub.resolves([
        "arealtime",
        "brealtime",
        "crealtime",
        "drealtime",
        "erealtime",
      ]);

      const response = await collectionController.list(request);

      should(response).be.instanceof(Object);
      should(response.collections).be.deepEqual([
        { name: "arealtime", type: "realtime" },
        { name: "astored", type: "stored" },
      ]);
      should(response.type).be.exactly("all");
      should(realtimeListCollectionsStub).calledWithMatch(
        "core:realtime:collections:get",
        "index",
      );
      should(kuzzle.ask).be.calledWith("core:storage:public:collection:list");
    });

    it("should reject if getting stored collections fails", () => {
      kuzzle.ask
        .withArgs("core:storage:public:collection:list")
        .rejects(new Error("foobar"));

      request = new Request({ index: "index", type: "stored" });
      return should(collectionController.list(request)).be.rejected();
    });

    it("should reject if getting all collections fails", () => {
      kuzzle.ask
        .withArgs("core:storage:public:collection:list")
        .rejects(new Error("foobar"));

      request = new Request({ index: "index", type: "all" });
      return should(collectionController.list(request)).be.rejected();
    });
  });

  describe("#exists", () => {
    it("should forward to the store module", async () => {
      kuzzle.ask
        .withArgs("core:storage:public:collection:exist")
        .resolves(true);

      const response = await collectionController.exists(request);

      should(response).match(true);
      should(kuzzle.ask).calledWith(
        "core:storage:public:collection:exist",
        request.input.args.index,
        request.input.args.collection,
      );
    });
  });

  describe("#refresh", () => {
    it("should forward to the store module", async () => {
      const response = await collectionController.refresh(request);

      should(response).be.null();
      should(kuzzle.ask).be.calledWith(
        "core:storage:public:collection:refresh",
        index,
        collection,
      );
    });
  });

  describe("#create", () => {
    it("should resolve to a valid response", async () => {
      const response = await collectionController.create(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:public:collection:create",
        index,
        collection,
      );
      should(response).be.instanceof(Object);
      should(response).match({
        acknowledged: true,
      });
    });
  });

  describe("#delete", () => {
    it("should call deleteCollection", async () => {
      const response = await collectionController.delete(request);

      should(kuzzle.ask).be.calledWith(
        "core:storage:public:collection:delete",
        index,
        collection,
      );

      should(response).be.null();
    });
  });
});