@featurevisor/sdk/src/datafileReader.spec.ts

Featurevisor SDK for Node.js and the browser

import { Attribute, DatafileContent } from "@featurevisor/types";
import { DatafileReader } from "./datafileReader";

describe("sdk: DatafileReader", function () {
  it("should be a function", function () {
    expect(typeof DatafileReader).toEqual("function");
  });

  it("v1 datafile schema: should return requested entities", function () {
    const datafileJson: DatafileContent = {
      schemaVersion: "1",
      revision: "1",
      attributes: [
        {
          key: "userId",
          type: "string",
          capture: true,
        },
        {
          key: "country",
          type: "string",
        },
      ],
      segments: [
        {
          key: "netherlands",
          conditions: [
            {
              attribute: "country",
              operator: "equals",
              value: "nl",
            },
          ],
        },
        {
          key: "germany",
          conditions: JSON.stringify([
            {
              attribute: "country",
              operator: "equals",
              value: "de",
            },
          ]),
        },
      ],
      features: [
        {
          key: "test",
          bucketBy: "userId",
          variations: [
            { value: "control" },
            {
              value: "treatment",
              variables: [
                {
                  key: "showSidebar",
                  value: true,
                },
              ],
            },
          ],
          traffic: [
            {
              key: "1",
              segments: "*",
              percentage: 100000,
              allocation: [
                { variation: "control", range: [0, 0] },
                { variation: "treatment", range: [0, 100000] },
              ],
            },
          ],
        },
      ],
    };

    const reader = new DatafileReader(datafileJson);

    expect(reader.getRevision()).toEqual("1");
    expect(reader.getSchemaVersion()).toEqual("1");
    expect(reader.getAllAttributes()).toEqual(datafileJson.attributes);
    expect(reader.getAttribute("userId")).toEqual(datafileJson.attributes[0]);
    expect(reader.getSegment("netherlands")).toEqual(datafileJson.segments[0]);
    expect((reader.getSegment("germany") as any).conditions[0].value).toEqual("de");
    expect(reader.getSegment("belgium")).toEqual(undefined);
    expect(reader.getFeature("test")).toEqual(datafileJson.features[0]);
    expect(reader.getFeature("test2")).toEqual(undefined);
  });

  it("v2 datafile schema: should return requested entities", function () {
    const datafileJson: DatafileContent = {
      schemaVersion: "2",
      revision: "1",
      attributes: {
        userId: {
          key: "userId",
          type: "string",
          capture: true,
        },
        country: {
          key: "country",
          type: "string",
        },
      },
      segments: {
        netherlands: {
          key: "netherlands",
          conditions: [
            {
              attribute: "country",
              operator: "equals",
              value: "nl",
            },
          ],
        },
        germany: {
          key: "germany",
          conditions: JSON.stringify([
            {
              attribute: "country",
              operator: "equals",
              value: "de",
            },
          ]),
        },
      },
      features: {
        test: {
          key: "test",
          bucketBy: "userId",
          variations: [
            { value: "control" },
            {
              value: "treatment",
              variables: [
                {
                  key: "showSidebar",
                  value: true,
                },
              ],
            },
          ],
          traffic: [
            {
              key: "1",
              segments: "*",
              percentage: 100000,
              allocation: [
                { variation: "control", range: [0, 0] },
                { variation: "treatment", range: [0, 100000] },
              ],
            },
          ],
        },
      },
    };

    const reader = new DatafileReader(datafileJson);

    expect(reader.getRevision()).toEqual("1");
    expect(reader.getSchemaVersion()).toEqual("2");
    expect(reader.getAllAttributes()).toEqual(
      Object.keys(datafileJson.attributes).reduce((acc, key) => {
        acc.push(datafileJson.attributes[key]);
        return acc;
      }, [] as Attribute[]),
    );
    expect(reader.getAttribute("userId")).toEqual(datafileJson.attributes.userId);
    expect(reader.getSegment("netherlands")).toEqual(datafileJson.segments.netherlands);
    expect((reader.getSegment("germany") as any).conditions[0].value).toEqual("de");
    expect(reader.getSegment("belgium")).toEqual(undefined);
    expect(reader.getFeature("test")).toEqual(datafileJson.features.test);
    expect(reader.getFeature("test2")).toEqual(undefined);
  });
});