@wireio/shared 1.0.0

package/src/logging/context/LogContextProvider.ts

@@ -0,0 +1,43 @@
+// noinspection JSValidateJSDoc
+
+import type { LogContext } from "./LogContext"
+
+
+
+export interface LogContextProvider {
+  
+  /**
+   * Get current context stack
+   *
+   * @returns {any[]}
+   */
+  currentContext(): Array<LogContext>
+  
+  /**
+   * Run in context
+   *
+   * @param {LogContext} context
+   * @param {() => Promise<T>} fn
+   * @returns {Promise<T>}
+   */
+  runInContext<T = unknown>(context: LogContext, fn: () => Promise<T>): Promise<T>
+}
+
+
+/**
+ * Dummy/Noop context provider
+ *
+ * @type {{currentContext(): Array<LogContext>, runInContext<T=unknown>(context: LogContext, fn: () => Promise<T>): Promise<T>}}
+ */
+export const DefaultLogContextProvider:LogContextProvider = {
+  currentContext(): Array<LogContext> {
+    return []
+  },
+  runInContext<T = unknown>(context: LogContext, fn: () => Promise<T>): Promise<T> {
+    if (process.env.NODE_ENV === "development") {
+      console.warn(`Attempting to use LogContext without any installed provider`)
+    }
+  
+    return fn()
+  }
+}

package/src/logging/context/index.ts

@@ -0,0 +1,3 @@
+export * from "./LogContext.js"
+export * from "./LogContextProvider.js"
+export * from "./LogContextContainer.js"

package/src/logging/context/providers/node/NodeContextProvider.ts

@@ -0,0 +1,45 @@
+import { AsyncLocalStorage } from "async_hooks"
+import { uniq } from "lodash"
+import type { LogContext } from "../../LogContext"
+import type { LogContextProvider } from "../../LogContextProvider"
+import { LogContextContainer } from "../../LogContextContainer.js"
+
+const contextStorage = new AsyncLocalStorage<Array<LogContext>>()
+
+function currentContextStore(): Array<LogContext> {
+  return contextStorage.getStore() ?? []
+}
+
+class NodeContextProvider implements LogContextProvider {
+  
+  
+  /**
+   * Get current context stack
+   *
+   * @returns {any[]}
+   */
+  currentContext(): Array<LogContext> {
+    return currentContextStore() ?? []
+  }
+  
+  /**
+   * Run in context
+   *
+   * @param {LogContext} context
+   * @param {() => Promise<T>} fn
+   * @returns {Promise<T>}
+   */
+  runInContext<T = unknown>(
+    context: LogContext,
+    fn: () => Promise<T>
+  ): Promise<T> {
+    const contexts = currentContextStore()
+    return contextStorage.run<Promise<T>, []>(uniq([...contexts, context]), fn)
+  }
+}
+
+const instance = new NodeContextProvider()
+
+LogContextContainer.setProvider(instance)
+
+export {}

package/src/logging/context/providers/node/index.ts

@@ -0,0 +1,3 @@
+import "./NodeContextProvider.js"
+
+export {}

package/src/logging/examples/example-debug-appender.ts

@@ -0,0 +1,19 @@
+import { getLogger } from "../getLogger.js"
+import { LevelNames } from "../Level.js"
+import { getLoggingManager } from "../LoggingManager.js"
+
+
+getLoggingManager().configure({
+  // Default appenders list is [ConsoleAppender],
+  // so the following is not needed and only
+  // remains as an example:
+  //
+  // appenders: [new ConsoleAppender()],
+  rootLevel: "trace"
+})
+
+const log = getLogger(__filename)
+
+LevelNames.forEach((name) =>
+  log[name].call(log, `example %s`, name)
+)

package/src/logging/examples/example-file-appender.ts

@@ -0,0 +1,19 @@
+import { FileAppender } from "../appenders/FileAppender.js"
+import { getLogger } from "../getLogger.js"
+import { LevelNames } from "../Level.js"
+import { getLoggingManager } from "../LoggingManager.js"
+
+async function run() {
+  const manager = getLoggingManager()
+  const fileAppender = new FileAppender({
+    enableRolling: true,
+    maxFiles: 4,
+    maxSize: 20480
+  })
+  manager.setAppenders(fileAppender).setRootLevel("trace")
+
+  const log = getLogger(__filename)
+  await fileAppender.close()
+}
+
+run().catch((err) => console.error(`failed`, err))

package/src/logging/getLogger.ts

@@ -0,0 +1,9 @@
+import type { Logger, LoggerOptions } from "./Logger"
+import { getLoggingManager } from "./LoggingManager.js"
+
+export function getLogger(
+  category: string,
+  options: Partial<LoggerOptions> = {}
+): Logger {
+  return getLoggingManager().getLogger(category, options)
+}

package/src/logging/index-node.ts

@@ -0,0 +1,2 @@
+export * from "./index.js"
+export * from "./appenders/FileAppender.js"

package/src/logging/index.ts

@@ -0,0 +1,11 @@
+export * from "./Appender.js"
+export * from "./Formatter.js"
+export * from "./Level.js"
+export * from "./LogRecord.js"
+export * from "./Logger.js"
+export * from "./LoggingManager.js"
+export * from "./appenders/index.js"
+export * from "./getLogger.js"
+export * from "./util.js"
+export * from "./context/index.js"
+

package/src/logging/util.ts

@@ -0,0 +1,6 @@
+import { isString } from "../guards/primitive.js"
+import { LevelKind, LevelNames } from "./Level.js"
+
+export function isLogLevelKind(o: any): o is LevelKind {
+  return isString(o) && LevelNames.includes(o?.toLowerCase?.() as any)
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../etc/tsconfig/tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "lib"
+  },
+  "include": ["src"],
+
+}