@featurevisor/sdk 1.35.3 → 2.0.1

package/src/logger.spec.ts

@@ -1,152 +1,230 @@
-import { createLogger } from "./logger";
+import { createLogger, Logger, LogLevel, defaultLogHandler } from "./logger";
 
 describe("logger", () => {
-  it("should log", () => {
-    const logger = createLogger({
-      levels: ["debug", "info", "warn", "error"],
-      handler: jest.fn(),
-    });
+  let consoleSpy: jest.SpyInstance; // eslint-disable-line
+
+  beforeEach(() => {
+    consoleSpy = jest.spyOn(console, "log").mockImplementation();
+    jest.spyOn(console, "info").mockImplementation();
+    jest.spyOn(console, "warn").mockImplementation();
+    jest.spyOn(console, "error").mockImplementation();
+  });
 
-    logger.debug("debug");
-    logger.info("info");
-    logger.warn("warn");
-    logger.error("error");
-
-    expect(logger).toBeDefined();
-    expect(logger.debug).toBeDefined();
-    expect(logger.info).toBeDefined();
-    expect(logger.warn).toBeDefined();
-    expect(logger.error).toBeDefined();
-    expect(logger.setLevels).toBeDefined();
-    expect(logger.log).toBeDefined();
-    expect(logger.log).toBeInstanceOf(Function);
-    expect(logger.debug).toBeInstanceOf(Function);
-    expect(logger.info).toBeInstanceOf(Function);
-    expect(logger.warn).toBeInstanceOf(Function);
-    expect(logger.error).toBeInstanceOf(Function);
-    expect(logger.setLevels).toBeInstanceOf(Function);
+  afterEach(() => {
+    jest.restoreAllMocks();
   });
 
-  it("should log with custom levels", () => {
-    const logger = createLogger({
-      levels: ["debug", "info"],
-      handler: jest.fn(),
+  describe("createLogger", () => {
+    it("should create a logger with default options", () => {
+      const logger = createLogger();
+      expect(logger).toBeInstanceOf(Logger);
     });
 
-    logger.debug("debug");
-    logger.info("info");
-    logger.warn("warn");
-    logger.error("error");
-
-    expect(logger).toBeDefined();
-    expect(logger.debug).toBeDefined();
-    expect(logger.info).toBeDefined();
-    expect(logger.warn).toBeDefined();
-    expect(logger.error).toBeDefined();
-    expect(logger.setLevels).toBeDefined();
-    expect(logger.log).toBeDefined();
-    expect(logger.log).toBeInstanceOf(Function);
-    expect(logger.debug).toBeInstanceOf(Function);
-    expect(logger.info).toBeInstanceOf(Function);
-    expect(logger.warn).toBeInstanceOf(Function);
-    expect(logger.error).toBeInstanceOf(Function);
-    expect(logger.setLevels).toBeInstanceOf(Function);
-  });
+    it("should create a logger with custom level", () => {
+      const logger = createLogger({ level: "debug" });
+      expect(logger).toBeInstanceOf(Logger);
+    });
+
+    it("should create a logger with custom handler", () => {
+      const customHandler = jest.fn();
+      const logger = createLogger({ handler: customHandler });
 
-  it("should log with default handler", () => {
-    const logs: any[] = [];
-
-    const realConsole = console;
-    const customConsole = {
-      log: (...args) => logs.push(args),
-      info: (...args) => logs.push(args),
-      warn: (...args) => logs.push(args),
-      error: (...args) => logs.push(args),
-    };
-
-    console = customConsole as unknown as Console;
-
-    const logger = createLogger({});
-
-    logger.setLevels(["debug", "info", "warn", "error"]);
-
-    logger.debug("debug");
-    logger.info("info");
-    logger.warn("warn");
-    logger.error("error");
-
-    expect(logger).toBeDefined();
-    expect(logger.debug).toBeDefined();
-    expect(logger.info).toBeDefined();
-    expect(logger.warn).toBeDefined();
-    expect(logger.error).toBeDefined();
-    expect(logger.setLevels).toBeDefined();
-    expect(logger.log).toBeDefined();
-    expect(logger.log).toBeInstanceOf(Function);
-    expect(logger.debug).toBeInstanceOf(Function);
-    expect(logger.info).toBeInstanceOf(Function);
-    expect(logger.warn).toBeInstanceOf(Function);
-    expect(logger.error).toBeInstanceOf(Function);
-    expect(logger.setLevels).toBeInstanceOf(Function);
-
-    expect(logs.length).toBe(4);
-
-    console = realConsole; // eslint-ignore-line
+      logger.info("test message");
+      expect(customHandler).toHaveBeenCalledWith("info", "test message", undefined);
+    });
   });
 
-  it("should log with custom handler", () => {
-    const handler = jest.fn();
-    const logger = createLogger({
-      levels: ["debug", "info", "warn", "error"],
-      handler,
+  describe("Logger", () => {
+    describe("constructor", () => {
+      it("should use default log level when none provided", () => {
+        const logger = new Logger({});
+        logger.debug("debug message");
+
+        // Debug should not be logged with default level (info)
+        expect(console.log).not.toHaveBeenCalled();
+      });
+
+      it("should use provided log level", () => {
+        const logger = new Logger({ level: "debug" });
+        logger.debug("debug message");
+
+        // Debug should be logged with debug level
+        expect(console.log).toHaveBeenCalledWith("[Featurevisor]", "debug message", {});
+      });
+
+      it("should use default handler when none provided", () => {
+        const logger = new Logger({});
+        logger.info("test message");
+
+        expect(console.info).toHaveBeenCalledWith("[Featurevisor]", "test message", {});
+      });
+
+      it("should use provided handler", () => {
+        const customHandler = jest.fn();
+        const logger = new Logger({ handler: customHandler });
+
+        logger.info("test message");
+        expect(customHandler).toHaveBeenCalledWith("info", "test message", undefined);
+      });
+    });
+
+    describe("setLevel", () => {
+      it("should update the log level", () => {
+        const logger = new Logger({ level: "info" });
+
+        // Debug should not be logged initially
+        logger.debug("debug message");
+        expect(console.log).not.toHaveBeenCalled();
+
+        // Set to debug level
+        logger.setLevel("debug");
+        logger.debug("debug message");
+        expect(console.log).toHaveBeenCalledWith("[Featurevisor]", "debug message", {});
+      });
+    });
+
+    describe("log level filtering", () => {
+      it("should log error messages at all levels", () => {
+        const levels: LogLevel[] = ["debug", "info", "warn", "error"];
+
+        levels.forEach((level) => {
+          const logger = new Logger({ level });
+          logger.error("error message");
+          expect(console.error).toHaveBeenCalledWith("[Featurevisor]", "error message", {});
+          jest.clearAllMocks();
+        });
+      });
+
+      it("should log warn messages at warn level and above", () => {
+        const logger = new Logger({ level: "warn" });
+
+        logger.warn("warn message");
+        expect(console.warn).toHaveBeenCalledWith("[Featurevisor]", "warn message", {});
+
+        logger.error("error message");
+        expect(console.error).toHaveBeenCalledWith("[Featurevisor]", "error message", {});
+      });
+
+      it("should not log info messages at warn level", () => {
+        const logger = new Logger({ level: "warn" });
+
+        logger.info("info message");
+        expect(console.info).not.toHaveBeenCalled();
+      });
+
+      it("should not log debug messages at info level", () => {
+        const logger = new Logger({ level: "info" });
+
+        logger.debug("debug message");
+        expect(console.log).not.toHaveBeenCalled();
+      });
+
+      it("should log all messages at debug level", () => {
+        const logger = new Logger({ level: "debug" });
+
+        logger.debug("debug message");
+        expect(console.log).toHaveBeenCalledWith("[Featurevisor]", "debug message", {});
+
+        logger.info("info message");
+        expect(console.info).toHaveBeenCalledWith("[Featurevisor]", "info message", {});
+
+        logger.warn("warn message");
+        expect(console.warn).toHaveBeenCalledWith("[Featurevisor]", "warn message", {});
+
+        logger.error("error message");
+        expect(console.error).toHaveBeenCalledWith("[Featurevisor]", "error message", {});
+      });
     });
 
-    logger.debug("debug");
-    logger.info("info");
-    logger.warn("warn");
-    logger.error("error");
-
-    expect(logger).toBeDefined();
-    expect(logger.debug).toBeDefined();
-    expect(logger.info).toBeDefined();
-    expect(logger.warn).toBeDefined();
-    expect(logger.error).toBeDefined();
-    expect(logger.setLevels).toBeDefined();
-    expect(logger.log).toBeDefined();
-    expect(logger.log).toBeInstanceOf(Function);
-    expect(logger.debug).toBeInstanceOf(Function);
-    expect(logger.info).toBeInstanceOf(Function);
-    expect(logger.warn).toBeInstanceOf(Function);
-    expect(logger.error).toBeInstanceOf(Function);
-    expect(logger.setLevels).toBeInstanceOf(Function);
-    expect(handler).toHaveBeenCalledTimes(4);
+    describe("convenience methods", () => {
+      let logger: Logger;
+
+      beforeEach(() => {
+        logger = new Logger({ level: "debug" });
+      });
+
+      it("should call debug method correctly", () => {
+        logger.debug("debug message");
+        expect(console.log).toHaveBeenCalledWith("[Featurevisor]", "debug message", {});
+      });
+
+      it("should call info method correctly", () => {
+        logger.info("info message");
+        expect(console.info).toHaveBeenCalledWith("[Featurevisor]", "info message", {});
+      });
+
+      it("should call warn method correctly", () => {
+        logger.warn("warn message");
+        expect(console.warn).toHaveBeenCalledWith("[Featurevisor]", "warn message", {});
+      });
+
+      it("should call error method correctly", () => {
+        logger.error("error message");
+        expect(console.error).toHaveBeenCalledWith("[Featurevisor]", "error message", {});
+      });
+
+      it("should handle details parameter", () => {
+        const details = { key: "value", number: 42 };
+
+        logger.info("message with details", details);
+        expect(console.info).toHaveBeenCalledWith(
+          "[Featurevisor]",
+          "message with details",
+          details,
+        );
+      });
+    });
+
+    describe("log method", () => {
+      it("should call handler with correct parameters", () => {
+        const customHandler = jest.fn();
+        const logger = new Logger({ handler: customHandler, level: "debug" });
+        const details = { test: true };
+
+        logger.log("info", "test message", details);
+        expect(customHandler).toHaveBeenCalledWith("info", "test message", details);
+      });
+
+      it("should not call handler when level is filtered out", () => {
+        const customHandler = jest.fn();
+        const logger = new Logger({ handler: customHandler, level: "warn" });
+
+        logger.log("debug", "debug message");
+        expect(customHandler).not.toHaveBeenCalled();
+      });
+    });
   });
 
-  it("should log with custom levels and handler", () => {
-    const handler = jest.fn();
-    const logger = createLogger({
-      levels: ["debug", "info"],
-      handler,
+  describe("defaultLogHandler", () => {
+    it("should use console.log for debug level", () => {
+      defaultLogHandler("debug", "debug message");
+      expect(console.log).toHaveBeenCalledWith("[Featurevisor]", "debug message", {});
+    });
+
+    it("should use console.info for info level", () => {
+      defaultLogHandler("info", "info message");
+      expect(console.info).toHaveBeenCalledWith("[Featurevisor]", "info message", {});
+    });
+
+    it("should use console.warn for warn level", () => {
+      defaultLogHandler("warn", "warn message");
+      expect(console.warn).toHaveBeenCalledWith("[Featurevisor]", "warn message", {});
+    });
+
+    it("should use console.error for error level", () => {
+      defaultLogHandler("error", "error message");
+      expect(console.error).toHaveBeenCalledWith("[Featurevisor]", "error message", {});
     });
 
-    logger.debug("debug");
-    logger.info("info");
-    logger.warn("warn");
-    logger.error("error");
-
-    expect(logger).toBeDefined();
-    expect(logger.debug).toBeDefined();
-    expect(logger.info).toBeDefined();
-    expect(logger.warn).toBeDefined();
-    expect(logger.error).toBeDefined();
-    expect(logger.setLevels).toBeDefined();
-    expect(logger.log).toBeDefined();
-    expect(logger.log).toBeInstanceOf(Function);
-    expect(logger.debug).toBeInstanceOf(Function);
-    expect(logger.info).toBeInstanceOf(Function);
-    expect(logger.warn).toBeInstanceOf(Function);
-    expect(logger.error).toBeInstanceOf(Function);
-    expect(logger.setLevels).toBeInstanceOf(Function);
-    expect(handler).toHaveBeenCalledTimes(2);
+    it("should handle undefined details", () => {
+      defaultLogHandler("info", "message without details");
+      expect(console.info).toHaveBeenCalledWith("[Featurevisor]", "message without details", {});
+    });
+
+    it("should handle provided details", () => {
+      const details = { key: "value" };
+      defaultLogHandler("info", "message with details", details);
+      expect(console.info).toHaveBeenCalledWith("[Featurevisor]", "message with details", details);
+    });
   });
 });

package/src/logger.ts

@@ -1,4 +1,4 @@
-export type LogLevel = "debug" | "info" | "warn" | "error";
+export type LogLevel = "fatal" | "error" | "warn" | "info" | "debug";
 
 export type LogMessage = string;
 
@@ -9,60 +9,63 @@ export interface LogDetails {
 export type LogHandler = (level: LogLevel, message: LogMessage, details?: LogDetails) => void;
 
 export interface CreateLoggerOptions {
-  levels?: LogLevel[];
+  level?: LogLevel;
   handler?: LogHandler;
 }
 
 export const loggerPrefix = "[Featurevisor]";
 
-export const defaultLogLevels: LogLevel[] = [
-  // supported, but not enabled by default
-  // "debug",
-  // "info",
-
-  // enabled by default
-  "warn",
-  "error",
-];
-
 export const defaultLogHandler: LogHandler = function defaultLogHandler(
   level,
   message,
   details = {},
 ) {
-  switch (level) {
-    case "debug":
-      console.log(loggerPrefix, message, details);
-      break;
-    case "info":
-      console.info(loggerPrefix, message, details);
-      break;
-    case "warn":
-      console.warn(loggerPrefix, message, details);
-      break;
-    case "error":
-      console.error(loggerPrefix, message, details);
-      break;
+  let method = "log";
+
+  if (level === "info") {
+    method = "info";
+  } else if (level === "warn") {
+    method = "warn";
+  } else if (level === "error") {
+    method = "error";
   }
+
+  console[method](loggerPrefix, message, details);
 };
 
 export class Logger {
-  private levels: LogLevel[];
+  static allLevels: LogLevel[] = [
+    "fatal",
+    "error",
+    "warn",
+    "info",
+
+    // not enabled by default
+    "debug",
+  ];
+
+  static defaultLevel: LogLevel = "info";
+
+  private level: LogLevel;
   private handle: LogHandler;
 
   constructor(options: CreateLoggerOptions) {
-    this.levels = options.levels as LogLevel[];
-    this.handle = options.handler as LogHandler;
+    this.level = options.level || Logger.defaultLevel;
+    this.handle = options.handler || defaultLogHandler;
   }
 
-  setLevels(levels: LogLevel[]) {
-    this.levels = levels;
+  setLevel(level: LogLevel) {
+    this.level = level;
   }
 
   log(level: LogLevel, message: LogMessage, details?: LogDetails) {
-    if (this.levels.indexOf(level) !== -1) {
-      this.handle(level, message, details);
+    const shouldHandle = Logger.allLevels.indexOf(this.level) >= Logger.allLevels.indexOf(level);
+
+    if (!shouldHandle) {
+      return;
     }
+
+    this.handle(level, message, details);
   }
 
   debug(message: LogMessage, details?: LogDetails) {
@@ -83,8 +86,5 @@ export class Logger {
 }
 
 export function createLogger(options: CreateLoggerOptions = {}): Logger {
-  const levels = options.levels || defaultLogLevels;
-  const logHandler = options.handler || defaultLogHandler;
-
-  return new Logger({ levels, handler: logHandler });
+  return new Logger(options);
 }

package/src/murmurhash.ts

@@ -0,0 +1,71 @@
+// v3 function taken from: https://github.com/perezd/node-murmurhash
+// this has been done to avoid loading v2 function which is not used in the SDK
+
+/**
+ * Copyright (c) 2020 Gary Court, Derek Perez
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+const createBuffer = (val) => new TextEncoder().encode(val);
+
+export function MurmurHashV3(key, seed) {
+  if (typeof key === "string") key = createBuffer(key);
+
+  let remainder, bytes, h1, h1b, c1, c2, k1, i;
+
+  remainder = key.length & 3; // key.length % 4
+  bytes = key.length - remainder;
+  h1 = seed;
+  c1 = 0xcc9e2d51;
+  c2 = 0x1b873593;
+  i = 0;
+
+  while (i < bytes) {
+    k1 =
+      (key[i] & 0xff) |
+      ((key[++i] & 0xff) << 8) |
+      ((key[++i] & 0xff) << 16) |
+      ((key[++i] & 0xff) << 24);
+    ++i;
+
+    k1 = ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff;
+    k1 = (k1 << 15) | (k1 >>> 17);
+    k1 = ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) & 0xffffffff;
+
+    h1 ^= k1;
+    h1 = (h1 << 13) | (h1 >>> 19);
+    h1b = ((h1 & 0xffff) * 5 + ((((h1 >>> 16) * 5) & 0xffff) << 16)) & 0xffffffff;
+    h1 = (h1b & 0xffff) + 0x6b64 + ((((h1b >>> 16) + 0xe654) & 0xffff) << 16);
+  }
+
+  k1 = 0;
+
+  switch (remainder) {
+    case 3:
+      k1 ^= (key[i + 2] & 0xff) << 16;
+    case 2:
+      k1 ^= (key[i + 1] & 0xff) << 8;
+    case 1:
+      k1 ^= key[i] & 0xff;
+
+      k1 = ((k1 & 0xffff) * c1 + ((((k1 >>> 16) * c1) & 0xffff) << 16)) & 0xffffffff;
+      k1 = (k1 << 15) | (k1 >>> 17);
+      k1 = ((k1 & 0xffff) * c2 + ((((k1 >>> 16) * c2) & 0xffff) << 16)) & 0xffffffff;
+      h1 ^= k1;
+  }
+
+  h1 ^= key.length;
+
+  h1 ^= h1 >>> 16;
+  h1 = ((h1 & 0xffff) * 0x85ebca6b + ((((h1 >>> 16) * 0x85ebca6b) & 0xffff) << 16)) & 0xffffffff;
+  h1 ^= h1 >>> 13;
+  h1 = ((h1 & 0xffff) * 0xc2b2ae35 + ((((h1 >>> 16) * 0xc2b2ae35) & 0xffff) << 16)) & 0xffffffff;
+  h1 ^= h1 >>> 16;
+
+  return h1 >>> 0;
+}