@bifold/remote-logs 2.6.0 → 2.7.0

package/build/logger.d.ts

@@ -1,9 +1,60 @@
-import { BifoldError, BifoldLogger } from '@bifold/core';
+import { BifoldError } from '@bifold/core';
 import { RemoteLoggerOptions } from './transports';
 export declare enum RemoteLoggerEventTypes {
     ENABLE_REMOTE_LOGGING = "RemoteLogging.Enable"
 }
-export declare class RemoteLogger extends BifoldLogger {
+/**
+ * Standardized logging method interface with consistent overloads
+ * Supports all combinations of message, data, and error parameters
+ */
+interface LogMethod {
+    (message: string): void;
+    (message: string, data: Record<string, unknown>): void;
+    (message: string, error: Error): void;
+    (message: string, data: Record<string, unknown>, error: Error): void;
+}
+/**
+ * Internal logger instance interface for type safety
+ */
+interface InternalLoggerInstance {
+    test?: (props: {
+        message: string;
+        data?: Record<string, unknown>;
+        error?: Error;
+    }) => void;
+    trace?: (props: {
+        message: string;
+        data?: Record<string, unknown>;
+        error?: Error;
+    }) => void;
+    debug?: (props: {
+        message: string;
+        data?: Record<string, unknown>;
+        error?: Error;
+    }) => void;
+    info?: (props: {
+        message: string;
+        data?: Record<string, unknown>;
+        error?: Error;
+    }) => void;
+    warn?: (props: {
+        message: string;
+        data?: Record<string, unknown>;
+        error?: Error;
+    }) => void;
+    error?: (props: {
+        message: string;
+        data?: Record<string, unknown>;
+        error?: Error;
+    }) => void;
+    fatal?: (props: {
+        message: string;
+        data?: Record<string, unknown>;
+        error?: Error;
+    }) => void;
+}
+export declare class RemoteLogger {
+    private readonly baseLogger;
     private _remoteLoggingEnabled;
     private _sessionId;
     private _autoDisableRemoteLoggingIntervalInMinutes;
@@ -11,21 +62,21 @@ export declare class RemoteLogger extends BifoldLogger {
     private lokiLabels;
     private remoteLoggingAutoDisableTimer;
     private eventListener;
-    protected _log: any;
+    protected _log: InternalLoggerInstance | null;
     protected _config: {
-        levels: {
-            test: number;
-            trace: number;
-            debug: number;
-            info: number;
-            warn: number;
-            error: number;
-            fatal: number;
+        readonly levels: {
+            readonly test: 0;
+            readonly trace: 0;
+            readonly debug: 0;
+            readonly info: 1;
+            readonly warn: 2;
+            readonly error: 3;
+            readonly fatal: 4;
         };
-        severity: string;
-        async: boolean;
-        dateFormat: string;
-        printDate: boolean;
+        readonly severity: "debug";
+        readonly async: true;
+        readonly dateFormat: "time";
+        readonly printDate: false;
     };
     constructor(options: RemoteLoggerOptions);
     get sessionId(): number;
@@ -37,12 +88,20 @@ export declare class RemoteLogger extends BifoldLogger {
     startEventListeners(): void;
     stopEventListeners(): void;
     overrideCurrentAutoDisableExpiration(expirationInMinutes: number): void;
-    test(message: string, data?: Record<string, unknown> | Error): void;
-    trace(message: string, data?: Record<string, unknown> | Error): void;
-    debug(message: string, data?: Record<string, unknown> | Error): void;
-    info(message: string, data?: Record<string, unknown> | Error): void;
-    warn(message: string, data?: Record<string, unknown> | Error): void;
-    error(message: string, data?: Record<string, unknown> | Error): void;
-    fatal(message: string, data?: Record<string, unknown> | Error): void;
     report(bifoldError: BifoldError): void;
+    test: LogMethod;
+    trace: LogMethod;
+    debug: LogMethod;
+    info: LogMethod;
+    warn: LogMethod;
+    error: LogMethod;
+    fatal: LogMethod;
+    /**
+     * Helper method to parse logging arguments consistently across all log levels
+     * @param dataOrError - Either data object or Error instance
+     * @param error - Optional Error instance when first param is data
+     * @returns Parsed data and error objects
+     */
+    private parseLogArguments;
 }
+export {};

package/build/logger.js

@@ -9,27 +9,75 @@ var RemoteLoggerEventTypes;
 (function (RemoteLoggerEventTypes) {
     RemoteLoggerEventTypes["ENABLE_REMOTE_LOGGING"] = "RemoteLogging.Enable";
 })(RemoteLoggerEventTypes || (exports.RemoteLoggerEventTypes = RemoteLoggerEventTypes = {}));
-class RemoteLogger extends core_1.BifoldLogger {
+/**
+ * Default logging configuration constants
+ */
+const DEFAULT_LOG_CONFIG = {
+    levels: {
+        test: 0,
+        trace: 0,
+        debug: 0,
+        info: 1,
+        warn: 2,
+        error: 3,
+        fatal: 4,
+    },
+    severity: 'debug',
+    async: true,
+    dateFormat: 'time',
+    printDate: false,
+};
+/**
+ * Session ID generation constants
+ */
+const SESSION_ID_RANGE = {
+    MIN: 100000,
+    MAX: 999999,
+};
+class RemoteLogger {
     constructor(options) {
         var _a, _b, _c;
-        super();
         this._remoteLoggingEnabled = false;
         this._autoDisableRemoteLoggingIntervalInMinutes = 0;
-        this._config = {
-            levels: {
-                test: 0,
-                trace: 0,
-                debug: 0,
-                info: 1,
-                warn: 2,
-                error: 3,
-                fatal: 4,
-            },
-            severity: 'debug',
-            async: true,
-            dateFormat: 'time',
-            printDate: false,
+        this._log = null;
+        this._config = DEFAULT_LOG_CONFIG;
+        // Standardized logging methods with consistent overloads
+        this.test = (message, dataOrError, error) => {
+            var _a, _b;
+            const { data, actualError } = this.parseLogArguments(dataOrError, error);
+            (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.test) === null || _b === void 0 ? void 0 : _b.call(_a, { message, data, error: actualError });
+        };
+        this.trace = (message, dataOrError, error) => {
+            var _a, _b;
+            const { data, actualError } = this.parseLogArguments(dataOrError, error);
+            (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.trace) === null || _b === void 0 ? void 0 : _b.call(_a, { message, data, error: actualError });
+        };
+        this.debug = (message, dataOrError, error) => {
+            var _a, _b;
+            const { data, actualError } = this.parseLogArguments(dataOrError, error);
+            (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.debug) === null || _b === void 0 ? void 0 : _b.call(_a, { message, data, error: actualError });
+        };
+        this.info = (message, dataOrError, error) => {
+            var _a, _b;
+            const { data, actualError } = this.parseLogArguments(dataOrError, error);
+            (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.info) === null || _b === void 0 ? void 0 : _b.call(_a, { message, data, error: actualError });
+        };
+        this.warn = (message, dataOrError, error) => {
+            var _a, _b;
+            const { data, actualError } = this.parseLogArguments(dataOrError, error);
+            (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.warn) === null || _b === void 0 ? void 0 : _b.call(_a, { message, data, error: actualError });
         };
+        this.error = (message, dataOrError, error) => {
+            var _a, _b;
+            const { data, actualError } = this.parseLogArguments(dataOrError, error);
+            (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.error) === null || _b === void 0 ? void 0 : _b.call(_a, { message, data, error: actualError });
+        };
+        this.fatal = (message, dataOrError, error) => {
+            var _a, _b;
+            const { data, actualError } = this.parseLogArguments(dataOrError, error);
+            (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.fatal) === null || _b === void 0 ? void 0 : _b.call(_a, { message, data, error: actualError });
+        };
+        this.baseLogger = new core_1.BifoldLogger();
         this.lokiUrl = (_a = options.lokiUrl) !== null && _a !== void 0 ? _a : undefined;
         this.lokiLabels = (_b = options.lokiLabels) !== null && _b !== void 0 ? _b : {};
         this._autoDisableRemoteLoggingIntervalInMinutes = (_c = options.autoDisableRemoteLoggingIntervalInMinutes) !== null && _c !== void 0 ? _c : 0;
@@ -37,7 +85,7 @@ class RemoteLogger extends core_1.BifoldLogger {
     }
     get sessionId() {
         if (!this._sessionId) {
-            this._sessionId = Math.floor(100000 + Math.random() * 900000);
+            this._sessionId = Math.floor(SESSION_ID_RANGE.MIN + Math.random() * (SESSION_ID_RANGE.MAX - SESSION_ID_RANGE.MIN + 1));
         }
         return this._sessionId;
     }
@@ -96,37 +144,9 @@ class RemoteLogger extends core_1.BifoldLogger {
             this.remoteLoggingEnabled = false;
         }, expirationInMinutes * 60000);
     }
-    test(message, data) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.test({ message, data });
-    }
-    trace(message, data) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.trace({ message, data });
-    }
-    debug(message, data) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.debug({ message, data });
-    }
-    info(message, data) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.info({ message, data });
-    }
-    warn(message, data) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.warn({ message, data });
-    }
-    error(message, data) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.error({ message, data });
-    }
-    fatal(message, data) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.fatal({ message, data });
-    }
     report(bifoldError) {
-        var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.info({ message: 'Sending Loki report' });
+        var _a, _b;
+        (_b = (_a = this._log) === null || _a === void 0 ? void 0 : _a.info) === null || _b === void 0 ? void 0 : _b.call(_a, { message: 'Sending Loki report' });
         const { title, description, code, message } = bifoldError;
         (0, transports_1.lokiTransport)({
             msg: title,
@@ -139,5 +159,25 @@ class RemoteLogger extends core_1.BifoldLogger {
             },
         });
     }
+    /**
+     * Helper method to parse logging arguments consistently across all log levels
+     * @param dataOrError - Either data object or Error instance
+     * @param error - Optional Error instance when first param is data
+     * @returns Parsed data and error objects
+     */
+    parseLogArguments(dataOrError, error) {
+        let data;
+        let actualError;
+        if (dataOrError instanceof Error) {
+            // Second parameter is an Error, so no data
+            actualError = dataOrError;
+        }
+        else {
+            // Second parameter is data (or undefined)
+            data = dataOrError;
+            actualError = error;
+        }
+        return { data, actualError };
+    }
 }
 exports.RemoteLogger = RemoteLogger;

package/build/transports/console.js

@@ -43,26 +43,49 @@ const messageDataFormatter = (...msgs) => {
                 stack: (_b = (_a = msg.stack) === null || _a === void 0 ? void 0 : _a.split('\n').slice(1).map((line) => line.trim())) !== null && _b !== void 0 ? _b : [],
             }, null, 2);
         }
-        return typeof msg === 'object' ? JSON.stringify(msg, null, 2) : msg;
+        if (typeof msg === 'object' && msg !== null) {
+            try {
+                return JSON.stringify(msg, null, 2);
+            }
+            catch (error) {
+                // Handle JSON serialization errors (circular references, BigInt, etc.)
+                if (error instanceof TypeError && error.message.includes('circular')) {
+                    return '[Circular Reference]';
+                }
+                if (error instanceof TypeError && error.message.includes('BigInt')) {
+                    return '[BigInt value cannot be serialized]';
+                }
+                // Handle other JSON serialization errors
+                return `[Serialization Error: ${error instanceof Error ? error.message : 'Unknown error'}]`;
+            }
+        }
+        return msg;
     });
 };
 const consoleTransport = (props) => {
-    var _a, _b, _c;
-    if (!props) {
+    var _a, _b, _c, _d;
+    if (!((_a = props === null || props === void 0 ? void 0 : props.rawMsg) === null || _a === void 0 ? void 0 : _a.length)) {
         return;
     }
     // Get the last element without mutating the
     // original array.
     const lastMessage = props.rawMsg[props.rawMsg.length - 1];
-    let { message } = lastMessage, rest = __rest(lastMessage, ["message"]);
+    if (!lastMessage) {
+        return;
+    }
+    // Destructure the message and rest properties, allow
+    // ...rest to be `const`, message to be `let`.
+    let { message } = lastMessage;
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    const { message: _ } = lastMessage, rest = __rest(lastMessage, ["message"]);
     let color;
-    if (((_a = props.options) === null || _a === void 0 ? void 0 : _a.colors) &&
+    if (((_b = props.options) === null || _b === void 0 ? void 0 : _b.colors) &&
         props.options.colors[props.level.text] &&
         availableColors[props.options.colors[props.level.text]]) {
         color = `\x1b[${availableColors[props.options.colors[props.level.text]]}m`;
         message = `${color}${message}${resetColors}`;
     }
-    if (props.extension && ((_b = props.options) === null || _b === void 0 ? void 0 : _b.extensionColors)) {
+    if (props.extension && ((_c = props.options) === null || _c === void 0 ? void 0 : _c.extensionColors)) {
         let extensionColor = '\x1b[7m';
         const extColor = props.options.extensionColors[props.extension];
         if (extColor && availableColors[extColor]) {
@@ -77,7 +100,7 @@ const consoleTransport = (props) => {
         const formattedData = messageDataFormatter(...Object.values(rest)).join(' ');
         logMessage = `${logMessage} ${formattedData}`;
     }
-    if ((_c = props.options) === null || _c === void 0 ? void 0 : _c.consoleFunc) {
+    if ((_d = props.options) === null || _d === void 0 ? void 0 : _d.consoleFunc) {
         props.options.consoleFunc(logMessage);
     }
     else {

package/build/transports/loki.js

@@ -12,7 +12,7 @@ const lokiTransport = (props) => {
     // Loki requires a timestamp with nanosecond precision
     // however Date.now() only returns milliseconds precision.
     const timestampEndPadding = '000000';
-    if (!props.options) {
+    if (!(props === null || props === void 0 ? void 0 : props.options)) {
         throw Error('props.options is required');
     }
     if (!props.options.lokiUrl) {
@@ -25,12 +25,12 @@ const lokiTransport = (props) => {
     // Get the last element without mutating the
     // original array.
     const lastMessage = props.rawMsg[props.rawMsg.length - 1];
-    const { message, data } = lastMessage;
+    const { message, data, error } = lastMessage;
     const payload = {
         streams: [
             {
                 stream: Object.assign({ job: (_a = props.options.job) !== null && _a !== void 0 ? _a : 'react-native-logs', level: props.level.text }, lokiLabels),
-                values: [[`${Date.now()}${timestampEndPadding}`, JSON.stringify({ message, data })]],
+                values: [[`${Date.now()}${timestampEndPadding}`, JSON.stringify({ message, data, error })]],
             },
         ],
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bifold/remote-logs",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "description": "Remote logging for credo-ts agents",
   "main": "build/index.js",
   "types": "build/index.d.ts",
@@ -12,7 +12,10 @@
   "scripts": {
     "build": "echo 'building remote-logs 🏗️' && yarn run clean && yarn run compile && echo 'remote-logs built ✅'",
     "clean": "rimraf ./build",
-    "compile": "tsc"
+    "compile": "tsc",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage"
   },
   "repository": {
     "type": "git",
@@ -28,10 +31,19 @@
   },
   "homepage": "https://github.com/openwallet-foundation/bifold-wallet",
   "devDependencies": {
+    "@babel/core": "~7.25.2",
+    "@babel/plugin-transform-runtime": "~7.25.4",
+    "@babel/preset-env": "~7.25.4",
+    "@babel/preset-flow": "~7.24.7",
+    "@babel/preset-typescript": "~7.24.7",
     "@babel/runtime": "~7.23.9",
+    "@types/jest": "~29.5.12",
     "@typescript-eslint/parser": "~7.18.0",
+    "babel-jest": "~29.7.0",
     "eslint": "~8.57.1",
     "eslint-import-resolver-typescript": "~3.6.3",
+    "jest": "~29.7.0",
+    "react-test-renderer": "~18.3.1",
     "rimraf": "~5.0.10",
     "typescript": "~5.5.4"
   },
@@ -47,7 +59,7 @@
     "hoistingLimits": "workspaces"
   },
   "dependencies": {
-    "@bifold/core": "2.6.0",
+    "@bifold/core": "2.7.0",
     "@credo-ts/core": "0.5.13",
     "axios": "~1.4.0",
     "buffer": "~6.0.3",