@featurevisor/sdk 1.35.3 → 2.0.1

package/src/datafileReader.spec.ts

@@ -1,28 +1,26 @@
-import { Attribute, DatafileContent } from "@featurevisor/types";
+import type { DatafileContent, GroupSegment } from "@featurevisor/types";
+
 import { DatafileReader } from "./datafileReader";
+import { createLogger } from "./logger";
+
+interface Group {
+  key: string;
+  segments: GroupSegment | GroupSegment[] | "*";
+}
 
 describe("sdk: DatafileReader", function () {
+  const logger = createLogger();
+
   it("should be a function", function () {
     expect(typeof DatafileReader).toEqual("function");
   });
 
-  it("v1 datafile schema: should return requested entities", function () {
+  it("v2 datafile schema: should return requested entities", function () {
     const datafileJson: DatafileContent = {
-      schemaVersion: "1",
+      schemaVersion: "2",
       revision: "1",
-      attributes: [
-        {
-          key: "userId",
-          type: "string",
-          capture: true,
-        },
-        {
-          key: "country",
-          type: "string",
-        },
-      ],
-      segments: [
-        {
+      segments: {
+        netherlands: {
           key: "netherlands",
           conditions: [
             {
@@ -32,7 +30,7 @@ describe("sdk: DatafileReader", function () {
             },
           ],
         },
-        {
+        germany: {
           key: "germany",
           conditions: JSON.stringify([
             {
@@ -42,21 +40,18 @@ describe("sdk: DatafileReader", function () {
             },
           ]),
         },
-      ],
-      features: [
-        {
+      },
+      features: {
+        test: {
           key: "test",
           bucketBy: "userId",
           variations: [
             { value: "control" },
             {
               value: "treatment",
-              variables: [
-                {
-                  key: "showSidebar",
-                  value: true,
-                },
-              ],
+              variables: {
+                showSidebar: true,
+              },
             },
           ],
           traffic: [
@@ -71,38 +66,138 @@ describe("sdk: DatafileReader", function () {
             },
           ],
         },
-      ],
+      },
     };
 
-    const reader = new DatafileReader(datafileJson);
+    const reader = new DatafileReader({
+      datafile: datafileJson,
+      logger,
+    });
 
     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.getSchemaVersion()).toEqual("2");
+    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[0]);
+    expect(reader.getFeature("test")).toEqual(datafileJson.features.test);
     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,
+  describe("segments", function () {
+    const groups = [
+      // everyone
+      {
+        key: "*",
+        segments: "*",
+      },
+
+      // dutch
+      {
+        key: "dutchMobileUsers",
+        segments: ["mobileUsers", "netherlands"],
+      },
+      {
+        key: "dutchMobileUsers2",
+        segments: {
+          and: ["mobileUsers", "netherlands"],
         },
-        country: {
-          key: "country",
-          type: "string",
+      },
+      {
+        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: "2",
+      revision: "1",
+      features: {},
+
       segments: {
+        // deviceType
+        mobileUsers: {
+          key: "mobileUsers",
+          conditions: [
+            {
+              attribute: "deviceType",
+              operator: "equals",
+              value: "mobile",
+            },
+          ],
+        },
+        desktopUsers: {
+          key: "desktopUsers",
+          conditions: [
+            {
+              attribute: "deviceType",
+              operator: "equals",
+              value: "desktop",
+            },
+          ],
+        },
+
+        // browser
+        chromeBrowser: {
+          key: "chromeBrowser",
+          conditions: [
+            {
+              attribute: "browser",
+              operator: "equals",
+              value: "chrome",
+            },
+          ],
+        },
+        firefoxBrowser: {
+          key: "firefoxBrowser",
+          conditions: [
+            {
+              attribute: "browser",
+              operator: "equals",
+              value: "firefox",
+            },
+          ],
+        },
+
+        // country
         netherlands: {
           key: "netherlands",
           conditions: [
@@ -115,39 +210,31 @@ describe("sdk: DatafileReader", function () {
         },
         germany: {
           key: "germany",
-          conditions: JSON.stringify([
+          conditions: [
             {
               attribute: "country",
               operator: "equals",
               value: "de",
             },
-          ]),
+          ],
         },
-      },
-      features: {
-        test: {
-          key: "test",
-          bucketBy: "userId",
-          variations: [
-            { value: "control" },
+
+        // version
+        "version_5.5": {
+          key: "version_5.5",
+          conditions: [
             {
-              value: "treatment",
-              variables: [
+              or: [
                 {
-                  key: "showSidebar",
-                  value: true,
+                  attribute: "version",
+                  operator: "equals",
+                  value: "5.5",
+                },
+                {
+                  attribute: "version",
+                  operator: "equals",
+                  value: 5.5,
                 },
-              ],
-            },
-          ],
-          traffic: [
-            {
-              key: "1",
-              segments: "*",
-              percentage: 100000,
-              allocation: [
-                { variation: "control", range: [0, 0] },
-                { variation: "treatment", range: [0, 100000] },
               ],
             },
           ],
@@ -155,21 +242,246 @@ describe("sdk: DatafileReader", function () {
       },
     };
 
-    const reader = new DatafileReader(datafileJson);
+    const datafileReader = new DatafileReader({
+      datafile: datafileContent,
+      logger,
+    });
 
-    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);
+    it("should match everyone", function () {
+      const group = groups.find((g) => g.key === "*") as Group;
+
+      // match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(true);
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { foo: "foo" })).toEqual(true);
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { bar: "bar" })).toEqual(true);
+    });
+
+    it("should match dutchMobileUsers", function () {
+      const group = groups.find((g) => g.key === "dutchMobileUsers") as Group;
+
+      // match
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+
+      // not match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "mobile",
+        }),
+      ).toEqual(false);
+    });
+
+    it("should match dutchMobileUsers2", function () {
+      const group = groups.find((g) => g.key === "dutchMobileUsers") as Group;
+
+      // match
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+
+      // not match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "mobile",
+        }),
+      ).toEqual(false);
+    });
+
+    it("should match dutchMobileOrDesktopUsers", function () {
+      const group = groups.find((g) => g.key === "dutchMobileOrDesktopUsers") as Group;
+
+      // match
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "desktop",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "desktop",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+
+      // not match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "mobile",
+        }),
+      ).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "desktop",
+        }),
+      ).toEqual(false);
+    });
+
+    it("should match dutchMobileOrDesktopUsers2", function () {
+      const group = groups.find((g) => g.key === "dutchMobileOrDesktopUsers2") as Group;
+
+      // match
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "desktop",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "desktop",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+
+      // not match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "mobile",
+        }),
+      ).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "desktop",
+        }),
+      ).toEqual(false);
+    });
+
+    it("should match germanMobileUsers", function () {
+      const group = groups.find((g) => g.key === "germanMobileUsers") as Group;
+
+      // match
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "mobile",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "mobile",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+
+      // not match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "mobile",
+        }),
+      ).toEqual(false);
+    });
+
+    it("should match germanNonMobileUsers", function () {
+      const group = groups.find((g) => g.key === "germanNonMobileUsers") as Group;
+
+      // match
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "desktop",
+        }),
+      ).toEqual(true);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "de",
+          deviceType: "desktop",
+          browser: "chrome",
+        }),
+      ).toEqual(true);
+
+      // not match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(false);
+      expect(
+        datafileReader.allSegmentsAreMatched(group.segments, {
+          country: "nl",
+          deviceType: "desktop",
+        }),
+      ).toEqual(false);
+    });
+
+    it("should match notVersion5.5", function () {
+      const group = groups.find((g) => g.key === "notVersion5.5") as Group;
+
+      // match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(true);
+      expect(datafileReader.allSegmentsAreMatched(group.segments, {})).toEqual(true);
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { version: "5.6" })).toEqual(
+        true,
+      );
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { version: 5.6 })).toEqual(true);
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { version: "5.7" })).toEqual(
+        true,
+      );
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { version: 5.7 })).toEqual(true);
+
+      // not match
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { version: "5.5" })).toEqual(
+        false,
+      );
+      expect(datafileReader.allSegmentsAreMatched(group.segments, { version: 5.5 })).toEqual(false);
+    });
   });
 });