@bifold/remote-logs 2.4.6 → 2.6.0

package/build/index.d.ts

@@ -1,2 +1,2 @@
 export * from './logger';
-export { RemoteLoggerOptions } from './transports';
+export * from './transports';

package/build/index.js

@@ -15,3 +15,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./logger"), exports);
+__exportStar(require("./transports"), exports);

package/build/logger.d.ts

@@ -37,12 +37,12 @@ export declare class RemoteLogger extends BifoldLogger {
     startEventListeners(): void;
     stopEventListeners(): void;
     overrideCurrentAutoDisableExpiration(expirationInMinutes: number): void;
-    test(...msgs: unknown[]): void;
-    trace(...msgs: unknown[]): void;
-    debug(...msgs: unknown[]): void;
-    info(...msgs: unknown[]): void;
-    warn(...msgs: unknown[]): void;
-    error(...msgs: unknown[]): void;
-    fatal(...msgs: unknown[]): 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;
 }

package/build/logger.js

@@ -60,7 +60,7 @@ class RemoteLogger extends core_1.BifoldLogger {
     }
     configureLogger() {
         const transportOptions = {};
-        const transport = [react_native_logs_1.consoleTransport];
+        const transport = [transports_1.consoleTransport];
         const config = Object.assign(Object.assign({}, this._config), { transport,
             transportOptions });
         if (this.remoteLoggingEnabled && this.lokiUrl) {
@@ -96,33 +96,33 @@ class RemoteLogger extends core_1.BifoldLogger {
             this.remoteLoggingEnabled = false;
         }, expirationInMinutes * 60000);
     }
-    test(...msgs) {
+    test(message, data) {
         var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.test(...this.messageFormatter(...msgs));
+        (_a = this._log) === null || _a === void 0 ? void 0 : _a.test({ message, data });
     }
-    trace(...msgs) {
+    trace(message, data) {
         var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.trace(...this.messageFormatter(...msgs));
+        (_a = this._log) === null || _a === void 0 ? void 0 : _a.trace({ message, data });
     }
-    debug(...msgs) {
+    debug(message, data) {
         var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.debug(...this.messageFormatter(...msgs));
+        (_a = this._log) === null || _a === void 0 ? void 0 : _a.debug({ message, data });
     }
-    info(...msgs) {
+    info(message, data) {
         var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.info(...this.messageFormatter(...msgs));
+        (_a = this._log) === null || _a === void 0 ? void 0 : _a.info({ message, data });
     }
-    warn(...msgs) {
+    warn(message, data) {
         var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.warn(...this.messageFormatter(...msgs));
+        (_a = this._log) === null || _a === void 0 ? void 0 : _a.warn({ message, data });
     }
-    error(...msgs) {
+    error(message, data) {
         var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.error(...this.messageFormatter(...msgs));
+        (_a = this._log) === null || _a === void 0 ? void 0 : _a.error({ message, data });
     }
-    fatal(...msgs) {
+    fatal(message, data) {
         var _a;
-        (_a = this._log) === null || _a === void 0 ? void 0 : _a.fatal(...this.messageFormatter(...msgs));
+        (_a = this._log) === null || _a === void 0 ? void 0 : _a.fatal({ message, data });
     }
     report(bifoldError) {
         var _a;

package/build/transports/console.d.ts

@@ -0,0 +1,38 @@
+import { transportFunctionType } from 'react-native-logs';
+declare const availableColors: {
+    readonly default: null;
+    readonly black: 30;
+    readonly red: 31;
+    readonly green: 32;
+    readonly yellow: 33;
+    readonly blue: 34;
+    readonly magenta: 35;
+    readonly cyan: 36;
+    readonly white: 37;
+    readonly grey: 90;
+    readonly redBright: 91;
+    readonly greenBright: 92;
+    readonly yellowBright: 93;
+    readonly blueBright: 94;
+    readonly magentaBright: 95;
+    readonly cyanBright: 96;
+    readonly whiteBright: 97;
+};
+type Color = keyof typeof availableColors;
+export interface ConsoleLoggerOptions {
+    colors?: Record<string, Color>;
+    extensionColors?: Record<string, Color>;
+    consoleFunc?: (msg: string) => void;
+}
+export type ConsoleTransportProps = {
+    msg: any;
+    rawMsg: any;
+    level: {
+        severity: number;
+        text: string;
+    };
+    extension?: string | null | undefined;
+    options?: ConsoleLoggerOptions;
+};
+export declare const consoleTransport: transportFunctionType;
+export {};

package/build/transports/console.js

@@ -0,0 +1,87 @@
+"use strict";
+/* eslint-disable no-console */
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.consoleTransport = void 0;
+const availableColors = {
+    default: null,
+    black: 30,
+    red: 31,
+    green: 32,
+    yellow: 33,
+    blue: 34,
+    magenta: 35,
+    cyan: 36,
+    white: 37,
+    grey: 90,
+    redBright: 91,
+    greenBright: 92,
+    yellowBright: 93,
+    blueBright: 94,
+    magentaBright: 95,
+    cyanBright: 96,
+    whiteBright: 97,
+};
+const resetColors = '\x1b[0m';
+const messageDataFormatter = (...msgs) => {
+    return msgs.map((msg) => {
+        var _a, _b;
+        if (msg instanceof Error) {
+            return JSON.stringify({
+                name: msg.name,
+                message: msg.message,
+                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;
+    });
+};
+const consoleTransport = (props) => {
+    var _a, _b, _c;
+    if (!props) {
+        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"]);
+    let color;
+    if (((_a = props.options) === null || _a === void 0 ? void 0 : _a.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)) {
+        let extensionColor = '\x1b[7m';
+        const extColor = props.options.extensionColors[props.extension];
+        if (extColor && availableColors[extColor]) {
+            extensionColor = `\x1b[${availableColors[extColor] + 10}m`;
+        }
+        const extStart = color ? resetColors + extensionColor : extensionColor;
+        const extEnd = color ? resetColors + color : resetColors;
+        message = message.replace(props.extension, `${extStart} ${props.extension} ${extEnd}`);
+    }
+    let logMessage = message.trim();
+    if (Object.keys(rest).length > 0) {
+        const formattedData = messageDataFormatter(...Object.values(rest)).join(' ');
+        logMessage = `${logMessage} ${formattedData}`;
+    }
+    if ((_c = props.options) === null || _c === void 0 ? void 0 : _c.consoleFunc) {
+        props.options.consoleFunc(logMessage);
+    }
+    else {
+        console.log(logMessage);
+    }
+};
+exports.consoleTransport = consoleTransport;

package/build/transports/index.d.ts

@@ -0,0 +1,2 @@
+export * from './console';
+export * from './loki';

package/build/transports/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./console"), exports);
+__exportStar(require("./loki"), exports);

package/build/{transports.js → transports/loki.js}

@@ -22,7 +22,10 @@ const lokiTransport = (props) => {
         throw Error('props.options.labels is required');
     }
     const { lokiUrl, lokiLabels } = props.options;
-    const { message, data } = props.rawMsg.pop();
+    // Get the last element without mutating the
+    // original array.
+    const lastMessage = props.rawMsg[props.rawMsg.length - 1];
+    const { message, data } = lastMessage;
     const payload = {
         streams: [
             {

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "@bifold/remote-logs",
-  "version": "2.4.6",
+  "version": "2.6.0",
   "description": "Remote logging for credo-ts agents",
   "main": "build/index.js",
   "types": "build/index.d.ts",
-  "source": "src/index.ts",
+  "source": "build/index.js",
   "files": [
-    "src",
     "build"
   ],
   "license": "Apache-2.0",
@@ -48,7 +47,7 @@
     "hoistingLimits": "workspaces"
   },
   "dependencies": {
-    "@bifold/core": "2.4.6",
+    "@bifold/core": "2.6.0",
     "@credo-ts/core": "0.5.13",
     "axios": "~1.4.0",
     "buffer": "~6.0.3",

package/src/index.ts

@@ -1,2 +0,0 @@
-export * from './logger'
-export { RemoteLoggerOptions } from './transports'

package/src/logger.ts

@@ -1,174 +0,0 @@
-import { BifoldError, BifoldLogger } from '@bifold/core'
-import { DeviceEventEmitter, EmitterSubscription } from 'react-native'
-import { consoleTransport, logger } from 'react-native-logs'
-
-import { RemoteLoggerOptions, lokiTransport } from './transports'
-
-export enum RemoteLoggerEventTypes {
-  ENABLE_REMOTE_LOGGING = 'RemoteLogging.Enable',
-}
-
-export class RemoteLogger extends BifoldLogger {
-  private _remoteLoggingEnabled = false
-  private _sessionId: number | undefined
-  private _autoDisableRemoteLoggingIntervalInMinutes = 0
-  private lokiUrl: string | undefined
-  private lokiLabels: Record<string, string>
-  private remoteLoggingAutoDisableTimer: ReturnType<typeof setTimeout> | undefined
-  private eventListener: EmitterSubscription | undefined
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  protected _log: any
-  protected _config = {
-    levels: {
-      test: 0,
-      trace: 0,
-      debug: 0,
-      info: 1,
-      warn: 2,
-      error: 3,
-      fatal: 4,
-    },
-    severity: 'debug',
-    async: true,
-    dateFormat: 'time',
-    printDate: false,
-  }
-
-  constructor(options: RemoteLoggerOptions) {
-    super()
-
-    this.lokiUrl = options.lokiUrl ?? undefined
-    this.lokiLabels = options.lokiLabels ?? {}
-    this._autoDisableRemoteLoggingIntervalInMinutes = options.autoDisableRemoteLoggingIntervalInMinutes ?? 0
-
-    this.configureLogger()
-  }
-
-  get sessionId(): number {
-    if (!this._sessionId) {
-      this._sessionId = Math.floor(100000 + Math.random() * 900000)
-    }
-
-    return this._sessionId
-  }
-
-  set sessionId(value: number) {
-    this._sessionId = value
-
-    this.configureLogger()
-  }
-
-  get autoDisableRemoteLoggingIntervalInMinutes(): number {
-    return this._autoDisableRemoteLoggingIntervalInMinutes
-  }
-
-  get remoteLoggingEnabled(): boolean {
-    return this._remoteLoggingEnabled
-  }
-
-  set remoteLoggingEnabled(value: boolean) {
-    this._remoteLoggingEnabled = value
-
-    if (value === false) {
-      this._sessionId = undefined
-    }
-
-    this.configureLogger()
-  }
-
-  private configureLogger() {
-    const transportOptions = {}
-    const transport = [consoleTransport]
-    const config = {
-      ...this._config,
-      transport,
-      transportOptions,
-    }
-
-    if (this.remoteLoggingEnabled && this.lokiUrl) {
-      transport.push(lokiTransport)
-      config['transportOptions'] = {
-        lokiUrl: this.lokiUrl,
-        lokiLabels: {
-          ...this.lokiLabels,
-          session_id: `${this.sessionId}`,
-        },
-      }
-
-      if (this.autoDisableRemoteLoggingIntervalInMinutes && this.autoDisableRemoteLoggingIntervalInMinutes > 0) {
-        this.remoteLoggingAutoDisableTimer = setTimeout(() => {
-          this.remoteLoggingEnabled = false
-        }, this.autoDisableRemoteLoggingIntervalInMinutes * 60000)
-      }
-    }
-
-    this._log = logger.createLogger<'test' | 'trace' | 'debug' | 'info' | 'warn' | 'error' | 'fatal'>(config)
-  }
-
-  public startEventListeners() {
-    this.eventListener = DeviceEventEmitter.addListener(RemoteLoggerEventTypes.ENABLE_REMOTE_LOGGING, (value) => {
-      this.remoteLoggingEnabled = value
-    })
-  }
-
-  public stopEventListeners() {
-    this.eventListener = undefined
-  }
-
-  public overrideCurrentAutoDisableExpiration(expirationInMinutes: number) {
-    if (expirationInMinutes <= 0) {
-      return
-    }
-
-    if (this.remoteLoggingAutoDisableTimer) {
-      clearTimeout(this.remoteLoggingAutoDisableTimer)
-    }
-
-    this.remoteLoggingAutoDisableTimer = setTimeout(() => {
-      this.remoteLoggingEnabled = false
-    }, expirationInMinutes * 60000)
-  }
-
-  public test(...msgs: unknown[]): void {
-    this._log?.test(...this.messageFormatter(...msgs))
-  }
-
-  public trace(...msgs: unknown[]): void {
-    this._log?.trace(...this.messageFormatter(...msgs))
-  }
-
-  public debug(...msgs: unknown[]): void {
-    this._log?.debug(...this.messageFormatter(...msgs))
-  }
-
-  public info(...msgs: unknown[]): void {
-    this._log?.info(...this.messageFormatter(...msgs))
-  }
-
-  public warn(...msgs: unknown[]): void {
-    this._log?.warn(...this.messageFormatter(...msgs))
-  }
-
-  public error(...msgs: unknown[]): void {
-    this._log?.error(...this.messageFormatter(...msgs))
-  }
-
-  public fatal(...msgs: unknown[]): void {
-    this._log?.fatal(...this.messageFormatter(...msgs))
-  }
-
-  public report(bifoldError: BifoldError): void {
-    this._log?.info({ message: 'Sending Loki report' })
-    const { title, description, code, message } = bifoldError
-    lokiTransport({
-      msg: title,
-      rawMsg: [{ message: title, data: { title, description, code, message } }],
-      level: { severity: 3, text: 'error' },
-      options: {
-        lokiUrl: this.lokiUrl,
-        lokiLabels: this.lokiLabels,
-        job: 'incident-report',
-      },
-    })
-  }
-}

package/src/transports.ts

@@ -1,78 +0,0 @@
-/* eslint-disable no-console */
-import axios from 'axios'
-import { Buffer } from 'buffer'
-import { transportFunctionType } from 'react-native-logs'
-
-export interface RemoteLoggerOptions {
-  lokiUrl?: string
-  lokiLabels?: Record<string, string>
-  autoDisableRemoteLoggingIntervalInMinutes?: number
-  job?: string
-}
-
-export type LokiTransportProps = {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  msg: any
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  rawMsg: any
-  level: {
-    severity: number
-    text: string
-  }
-  options?: RemoteLoggerOptions
-}
-
-export const lokiTransport: transportFunctionType = (props: LokiTransportProps) => {
-  // Loki requires a timestamp with nanosecond precision
-  // however Date.now() only returns milliseconds precision.
-  const timestampEndPadding = '000000'
-
-  if (!props.options) {
-    throw Error('props.options is required')
-  }
-
-  if (!props.options.lokiUrl) {
-    throw Error('props.options.lokiUrl is required')
-  }
-
-  if (!props.options.lokiLabels) {
-    throw Error('props.options.labels is required')
-  }
-
-  const { lokiUrl, lokiLabels } = props.options
-  const { message, data } = props.rawMsg.pop()
-  const payload = {
-    streams: [
-      {
-        stream: {
-          job: props.options.job ?? 'react-native-logs',
-          level: props.level.text,
-          ...lokiLabels,
-        },
-        values: [[`${Date.now()}${timestampEndPadding}`, JSON.stringify({ message, data })]],
-      },
-    ],
-  }
-
-  const [credentials, href] = lokiUrl.split('@')
-  const [username, password] = credentials.split('//')[1].split(':')
-  const protocol = credentials.split('//')[0]
-  const authHeader = `Basic ${Buffer.from(`${username}:${password}`).toString('base64')}`
-  const config = {
-    headers: {
-      'Content-Type': 'application/json',
-      Authorization: authHeader,
-    },
-  }
-
-  axios
-    .post(`${protocol}//${href}`, payload, config)
-    .then((res) => {
-      if (res.status !== 204) {
-        console.warn(`Expected Loki to return 204, received ${res.status}`)
-      }
-    })
-    .catch((error) => {
-      console.error(`Error while sending to Loki, ${error}`)
-    })
-}