@valkey/valkey-glide 1.3.4 → 1.3.5-rc2

package/build-ts/Logger.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * Copyright Valkey GLIDE Project Contributors - SPDX Identifier: Apache-2.0
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Logger = void 0;
+const native_1 = require("./native");
+const LEVEL = new Map([
+    ["error", 0 /* Level.Error */],
+    ["warn", 1 /* Level.Warn */],
+    ["info", 2 /* Level.Info */],
+    ["debug", 3 /* Level.Debug */],
+    ["trace", 4 /* Level.Trace */],
+    ["off", 5 /* Level.Off */],
+    [undefined, undefined],
+]);
+/*
+ * A singleton class that allows logging which is consistent with logs from the internal rust core.
+ * The logger can be set up in 2 ways -
+ *    1. By calling init, which configures the logger only if it wasn't previously configured.
+ *     2. By calling Logger.setLoggerConfig, which replaces the existing configuration, and means that new logs will not be saved with the logs that were sent before the call. The previous logs will remain unchanged.
+ * If no call to any of these function is received, the first log attempt will configure the logger with default configuration decided by rust core.
+ */
+class Logger {
+    constructor(level, fileName) {
+        Logger.logger_level = (0, native_1.InitInternalLogger)(LEVEL.get(level), fileName);
+    }
+    /**
+     * take the arguments from the user and provide to the core-logger (see ../logger-core)
+     * if the level is higher then the logger level (error is 0, warn 1, etc.) simply return without operation
+     * if a logger instance doesn't exist, create new one with default mode (decided by rust core, normally - level: error, target: console)
+     * logIdentifier arg is a string contain data that suppose to give the log a context and make it easier to find certain type of logs.
+     * when the log is connect to certain task the identifier should be the task id, when the log is not part of specific task the identifier should give a context to the log - for example, "socket connection".
+     * External users shouldn't use this function.
+     */
+    static log(logLevel, logIdentifier, message) {
+        if (!Logger._instance) {
+            new Logger();
+        }
+        const level = LEVEL.get(logLevel) || 0;
+        if (!(level <= Logger.logger_level))
+            return;
+        (0, native_1.log)(level, logIdentifier, message);
+    }
+    /**
+     * Initialize a logger if it wasn't initialized before - this method is meant to be used when there is no intention to replace an existing logger.
+     * The logger will filter all logs with a level lower than the given level,
+     * If given a fileName argument, will write the logs to files postfixed with fileName. If fileName isn't provided, the logs will be written to the console.
+     * To turn off the logger, provide the level "off".
+     */
+    static init(level, fileName) {
+        if (!this._instance) {
+            this._instance = new this(level, fileName);
+        }
+    }
+    /**
+     * configure the logger.
+     * the level argument is the level of the logs you want the system to provide (error logs, warn logs, etc.)
+     * the filename argument is optional - if provided the target of the logs will be the file mentioned, else will be the console
+     * To turn off the logger, provide the level "off".
+     */
+    static setLoggerConfig(level, fileName) {
+        this._instance = new this(level, fileName);
+    }
+}
+exports.Logger = Logger;
+Logger.logger_level = 0;