saved-questions.unit.spec.js

import {
  SAVED_QUESTIONS_VIRTUAL_DB_ID,
  getCollectionVirtualSchemaId,
  getCollectionVirtualSchemaName,
  getQuestionVirtualTableId,
  isVirtualCardId,
  getQuestionIdFromVirtualTableId,
  convertSavedQuestionToVirtualTable,
} from "./saved-questions";

describe("saved question helpers", () => {
  function getEncodedPayload(object) {
    const json = JSON.stringify(object);
    return encodeURIComponent(json);
  }

  describe("getCollectionVirtualSchemaName", () => {
    it("should return 'Everything else' for root collection", () => {
      expect(getCollectionVirtualSchemaName({ id: null })).toBe(
        "Everything else",
      );
      expect(getCollectionVirtualSchemaName({ id: "root" })).toBe(
        "Everything else",
      );
    });

    it("should return 'Everything else' if collection is not passed", () => {
      expect(getCollectionVirtualSchemaName()).toBe("Everything else");
    });

    it("should return collection name for normal collections", () => {
      expect(
        getCollectionVirtualSchemaName({ id: 23, name: "Important questions" }),
      ).toBe("Important questions");
    });

    it("should prefer collection's schema name over just name", () => {
      const collection = {
        id: 5,
        name: "Your personal collection",
        schemaName: "John Doe's Personal collection",
      };
      expect(getCollectionVirtualSchemaName(collection)).toBe(
        collection.schemaName,
      );
    });
  });

  describe("getCollectionVirtualSchemaId", () => {
    [
      {
        collection: undefined,
        expectedName: encodeURIComponent("Everything else"),
      },
      {
        collection: { id: null },
        expectedName: encodeURIComponent("Everything else"),
      },
      {
        collection: { id: "root" },
        expectedName: encodeURIComponent("Everything else"),
      },
      { collection: { id: 3, name: "Marketing" }, expectedName: "Marketing" },
    ].forEach(({ collection, expectedName }) => {
      it("returns name prefixed with virtual saved question DB ID", () => {
        expect(getCollectionVirtualSchemaId(collection)).toBe(
          `${SAVED_QUESTIONS_VIRTUAL_DB_ID}:${expectedName}`,
        );
      });
    });

    it("should return correct schema for collection models", () => {
      const collection = { id: 1, name: "Marketing" };
      const payload = getEncodedPayload({ isDatasets: true });
      const expectedId = `${SAVED_QUESTIONS_VIRTUAL_DB_ID}:Marketing:${payload}`;

      expect(
        getCollectionVirtualSchemaId(collection, { isDatasets: true }),
      ).toBe(expectedId);
    });
  });

  describe("getQuestionVirtualTableId", () => {
    it("returns question prefixed question ID", () => {
      expect(getQuestionVirtualTableId(7)).toBe("card__7");
    });
  });

  describe("isVirtualCardId", () => {
    it("should return true for virtual table ID", () => {
      expect(isVirtualCardId("card__4")).toBe(true);
    });

    it("should return false for normal table ID", () => {
      expect(isVirtualCardId(4)).toBe(false);
    });

    it("should return false for garbage", () => {
      expect(isVirtualCardId()).toBe(false);
      expect(isVirtualCardId(null)).toBe(false);
      expect(isVirtualCardId(null)).toBe(false);
      expect(isVirtualCardId(0)).toBe(false);
      expect(isVirtualCardId(-1)).toBe(false);
      expect(isVirtualCardId("1")).toBe(false);
      expect(isVirtualCardId({ foo: "bar" })).toBe(false);
    });
  });

  describe("getQuestionIdFromVirtualTableId", () => {
    [
      { tableId: "card__1", cardId: 1 },
      { tableId: "card__234", cardId: 234 },
    ].forEach(testCase => {
      const { tableId, cardId } = testCase;
      it(`should extract ID from virtual ID (${tableId})`, () => {
        expect(getQuestionIdFromVirtualTableId(tableId)).toBe(cardId);
      });
    });

    [
      { id: undefined },
      { id: null },
      { id: 123 },
      { id: true },
      { id: { foo: "bar" } },
    ].forEach(testCase => {
      const { id } = testCase;
      it(`should handle non string input (${id})`, () => {
        expect(getQuestionIdFromVirtualTableId(id)).toBe(null);
      });
    });

    ["card__", "card__test"].forEach(id => {
      it(`should handle invalid ID ${id}`, () => {
        expect(getQuestionIdFromVirtualTableId(id)).toBe(null);
      });
    });
  });

  describe("convertSavedQuestionToVirtualTable", () => {
    const COMMON_QUESTION_DATA = {
      id: 11,
      name: "Q1",
      description: "Text",
      moderated_status: "verified",
      dataset_query: {
        database: 4,
      },
    };

    it("correctly converts questions in normal collections", () => {
      const question = {
        ...COMMON_QUESTION_DATA,
        collection: {
          id: 8,
          name: "Marketing",
        },
      };

      expect(convertSavedQuestionToVirtualTable(question)).toEqual({
        id: `card__${question.id}`,
        display_name: question.name,
        description: question.description,
        moderated_status: question.moderated_status,
        db_id: question.dataset_query.database,
        schema: `${SAVED_QUESTIONS_VIRTUAL_DB_ID}:${question.collection.name}`,
        schema_name: question.collection.name,
      });
    });

    it("correctly converts questions in the root collection", () => {
      const question = {
        ...COMMON_QUESTION_DATA,
        collection: null,
      };

      expect(convertSavedQuestionToVirtualTable(question)).toEqual({
        id: `card__${question.id}`,
        display_name: question.name,
        description: question.description,
        moderated_status: question.moderated_status,
        db_id: question.dataset_query.database,
        schema: `${SAVED_QUESTIONS_VIRTUAL_DB_ID}:${encodeURIComponent(
          "Everything else",
        )}`,
        schema_name: "Everything else",
      });
    });
  });
});