@featurevisor/sdk 1.35.3 → 2.0.0

package/src/segments.spec.ts

@@ -1,468 +0,0 @@
-import { DatafileContent, GroupSegment } from "@featurevisor/types";
-
-import { DatafileReader } from "./datafileReader";
-import { allGroupSegmentsAreMatched } from "./segments";
-import { createLogger } from "./logger";
-
-interface Group {
-  key: string;
-  segments: GroupSegment | GroupSegment[] | "*";
-}
-
-describe("sdk: Segments", function () {
-  const logger = createLogger();
-
-  it("should be a function", function () {
-    expect(typeof allGroupSegmentsAreMatched).toEqual("function");
-  });
-
-  describe("datafile #1", function () {
-    const groups = [
-      // everyone
-      {
-        key: "*",
-        segments: "*",
-      },
-
-      // dutch
-      {
-        key: "dutchMobileUsers",
-        segments: ["mobileUsers", "netherlands"],
-      },
-      {
-        key: "dutchMobileUsers2",
-        segments: {
-          and: ["mobileUsers", "netherlands"],
-        },
-      },
-      {
-        key: "dutchMobileOrDesktopUsers",
-        segments: ["netherlands", { or: ["mobileUsers", "desktopUsers"] }],
-      },
-      {
-        key: "dutchMobileOrDesktopUsers2",
-        segments: {
-          and: ["netherlands", { or: ["mobileUsers", "desktopUsers"] }],
-        },
-      },
-
-      // german
-      {
-        key: "germanMobileUsers",
-        segments: [
-          {
-            and: ["mobileUsers", "germany"],
-          },
-        ],
-      },
-      {
-        key: "germanNonMobileUsers",
-        segments: [
-          {
-            and: [
-              "germany",
-              {
-                not: ["mobileUsers"],
-              },
-            ],
-          },
-        ],
-      },
-
-      // version
-      {
-        key: "notVersion5.5",
-        segments: [
-          {
-            not: ["version_5.5"],
-          },
-        ],
-      },
-    ];
-
-    const datafileContent: DatafileContent = {
-      schemaVersion: "1.0",
-      revision: "1",
-      features: [],
-      attributes: [],
-
-      segments: [
-        // deviceType
-        {
-          key: "mobileUsers",
-          conditions: [
-            {
-              attribute: "deviceType",
-              operator: "equals",
-              value: "mobile",
-            },
-          ],
-        },
-        {
-          key: "desktopUsers",
-          conditions: [
-            {
-              attribute: "deviceType",
-              operator: "equals",
-              value: "desktop",
-            },
-          ],
-        },
-
-        // browser
-        {
-          key: "chromeBrowser",
-          conditions: [
-            {
-              attribute: "browser",
-              operator: "equals",
-              value: "chrome",
-            },
-          ],
-        },
-        {
-          key: "firefoxBrowser",
-          conditions: [
-            {
-              attribute: "browser",
-              operator: "equals",
-              value: "firefox",
-            },
-          ],
-        },
-
-        // country
-        {
-          key: "netherlands",
-          conditions: [
-            {
-              attribute: "country",
-              operator: "equals",
-              value: "nl",
-            },
-          ],
-        },
-        {
-          key: "germany",
-          conditions: [
-            {
-              attribute: "country",
-              operator: "equals",
-              value: "de",
-            },
-          ],
-        },
-
-        // version
-        {
-          key: "version_5.5",
-          conditions: [
-            {
-              or: [
-                {
-                  attribute: "version",
-                  operator: "equals",
-                  value: "5.5",
-                },
-                {
-                  attribute: "version",
-                  operator: "equals",
-                  value: 5.5,
-                },
-              ],
-            },
-          ],
-        },
-      ],
-    };
-
-    const datafileReader = new DatafileReader(datafileContent);
-
-    it("should match everyone", function () {
-      const group = groups.find((g) => g.key === "*") as Group;
-
-      // match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { foo: "foo" }, datafileReader, logger),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { bar: "bar" }, datafileReader, logger),
-      ).toEqual(true);
-    });
-
-    it("should match dutchMobileUsers", function () {
-      const group = groups.find((g) => g.key === "dutchMobileUsers") as Group;
-
-      // match
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-
-      // not match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-    });
-
-    it("should match dutchMobileUsers2", function () {
-      const group = groups.find((g) => g.key === "dutchMobileUsers") as Group;
-
-      // match
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-
-      // not match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-    });
-
-    it("should match dutchMobileOrDesktopUsers", function () {
-      const group = groups.find((g) => g.key === "dutchMobileOrDesktopUsers") as Group;
-
-      // match
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "desktop" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "desktop", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-
-      // not match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "desktop" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-    });
-
-    it("should match dutchMobileOrDesktopUsers2", function () {
-      const group = groups.find((g) => g.key === "dutchMobileOrDesktopUsers2") as Group;
-
-      // match
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "desktop" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "desktop", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-
-      // not match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "desktop" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-    });
-
-    it("should match germanMobileUsers", function () {
-      const group = groups.find((g) => g.key === "germanMobileUsers") as Group;
-
-      // match
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "mobile", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-
-      // not match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "mobile" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-    });
-
-    it("should match germanNonMobileUsers", function () {
-      const group = groups.find((g) => g.key === "germanNonMobileUsers") as Group;
-
-      // match
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "desktop" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "de", deviceType: "desktop", browser: "chrome" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(true);
-
-      // not match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(
-          group.segments,
-          { country: "nl", deviceType: "desktop" },
-          datafileReader,
-          logger,
-        ),
-      ).toEqual(false);
-    });
-
-    it("should match notVersion5.5", function () {
-      const group = groups.find((g) => g.key === "notVersion5.5") as Group;
-
-      // match
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(true);
-      expect(allGroupSegmentsAreMatched(group.segments, {}, datafileReader, logger)).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { version: "5.6" }, datafileReader, logger),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { version: 5.6 }, datafileReader, logger),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { version: "5.7" }, datafileReader, logger),
-      ).toEqual(true);
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { version: 5.7 }, datafileReader, logger),
-      ).toEqual(true);
-
-      // not match
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { version: "5.5" }, datafileReader, logger),
-      ).toEqual(false);
-      expect(
-        allGroupSegmentsAreMatched(group.segments, { version: 5.5 }, datafileReader, logger),
-      ).toEqual(false);
-    });
-  });
-});

package/src/segments.ts

@@ -1,58 +0,0 @@
-import { Context, GroupSegment, Segment, Condition } from "@featurevisor/types";
-import { allConditionsAreMatched } from "./conditions";
-import { DatafileReader } from "./datafileReader";
-import { Logger } from "./logger";
-
-export function segmentIsMatched(segment: Segment, context: Context, logger: Logger): boolean {
-  return allConditionsAreMatched(segment.conditions as Condition | Condition[], context, logger);
-}
-
-export function allGroupSegmentsAreMatched(
-  groupSegments: GroupSegment | GroupSegment[] | "*",
-  context: Context,
-  datafileReader: DatafileReader,
-  logger: Logger,
-): boolean {
-  if (groupSegments === "*") {
-    return true;
-  }
-
-  if (typeof groupSegments === "string") {
-    const segment = datafileReader.getSegment(groupSegments);
-
-    if (segment) {
-      return segmentIsMatched(segment, context, logger);
-    }
-
-    return false;
-  }
-
-  if (typeof groupSegments === "object") {
-    if ("and" in groupSegments && Array.isArray(groupSegments.and)) {
-      return groupSegments.and.every((groupSegment) =>
-        allGroupSegmentsAreMatched(groupSegment, context, datafileReader, logger),
-      );
-    }
-
-    if ("or" in groupSegments && Array.isArray(groupSegments.or)) {
-      return groupSegments.or.some((groupSegment) =>
-        allGroupSegmentsAreMatched(groupSegment, context, datafileReader, logger),
-      );
-    }
-
-    if ("not" in groupSegments && Array.isArray(groupSegments.not)) {
-      return groupSegments.not.every(
-        (groupSegment) =>
-          allGroupSegmentsAreMatched(groupSegment, context, datafileReader, logger) === false,
-      );
-    }
-  }
-
-  if (Array.isArray(groupSegments)) {
-    return groupSegments.every((groupSegment) =>
-      allGroupSegmentsAreMatched(groupSegment, context, datafileReader, logger),
-    );
-  }
-
-  return false;
-}