@scorpionknifes/fireo/test/v001/model/model.test.js

Fork of Fireo, Google Cloud Firestore modern and simplest convenient ORM package in NodeJs. FireO is specifically designed for the Google's Firestore

const chai = require("chai");
const Model = require("../../../src/model/Model");
const Field = require("../../../src/fields/Field");
const { InstantiateError } = require("../../../errors");
const firestore = require("../../../Firestore");
const { Fireo } = require("../../../index");

const expect = chai.expect;

describe("Model", () => {
  before(() => {
    Fireo.connection.setting({ projectId: "fs-test-project" });
  });

  class User extends Model {
    name = Field.Text();
  }

  describe("Model creation", () => {
    class User extends Model {
      name = Field.Text();
      age = Field.Number();
    }

    it("create model from `fromObject` should return Model instance", () => {
      const user = User.fromObject({ name: "string", age: 1 });
      expect(user instanceof User).to.be.true;
    });
    it("create model from `fromObject`", () => {
      const user = User.fromObject({ name: "string", age: 1 });
      expect(user.name).to.equal("string");
      expect(user.age).to.equal(1);
    });
    it("create model for parent from `fromObject`", () => {
      const user = User.parent("User/custom-id").fromObject({
        name: "string",
        age: 1,
      });

      expect(user.name).to.equal("string");
      expect(user.age).to.equal(1);
      expect(user.__meta.parent).to.equal("User/custom-id");
    });
    it("Convert model into object `toObject`", async () => {
      const user = User.init();
      user.name = "string";
      user.age = 1;
      await user.save();

      const doc = await User.collection.get({ key: user.key });
      const docObject = doc.toObject();
      expect(docObject).to.deep.equal({
        name: "string",
        age: 1,
        id: user.id,
        key: user.key,
      });
    });
  });

  it("should be instantiate from `init()`", () => {
    const user = User.init();
    expect(user.__meta.isInstantiate).be.true;
  });
  it("should not be instantiate from `new` keyword", () => {
    expect(() => new User()).to.throw(InstantiateError);
  });
  it("`init()` method should return the instance of class", () => {
    expect(User.init() instanceof User).to.be.true;
  });
  it("after getting fields record every field should be undefined", () => {
    const user = User.init();
    expect(user.name).to.be.undefined;
  });

  it("able to set custom collection", async () => {
    User.config = {
      collectionName: "custom_collection",
    };

    const user = User.init();
    user.name = "string";
    await user.save();

    const snapshot = await firestore.conn
      .collection("custom_collection")
      .doc(user.id)
      .get();
    const doc = snapshot.data();
    expect(doc.name).to.equal("string");
  });

  it("able to set lowercase values", async () => {
    User.config = {
      toLowercase: true,
    };

    const user = User.init();
    user.name = "STRING-VALUE";
    await user.save();

    const doc = await User.collection.where("name", "==", "String-Value").get();
    expect(doc.name).to.equal("string-value");
  });
});