@wireio/shared 1.0.2 → 1.0.3

package/src/logging/appenders/aws-firehose/AWSFirehoseCredentialManager.ts

@@ -1,132 +0,0 @@
-import { FirehoseClient, PutRecordBatchCommand } from "@aws-sdk/client-firehose"
-import { Deferred } from "../../../helpers/index.js"
-import { getInternalLogger } from "../../InternalLogger.js"
-import EventEmitter3 from "eventemitter3"
-
-const API_BASE = "https://log-ingest.shared.wire-dev.com"
-const CRED_BUFFER_PADDING_MS = 3 * 60 * 1000 // 3 minutes
-
-const log = getInternalLogger(import.meta.filename)
-
-export interface AWSCredentials {
-  accessKeyId: string
-  secretAccessKey: string
-  sessionToken: string
-  streamName: string
-  region: string
-  expiration: string
-}
-
-export interface AWSFirehoseCredentialManagerEventMap {
-  received: (creds: AWSCredentials) => void
-  expired: () => void
-}
-
-export class AWSFirehoseCredentialManager extends EventEmitter3<AWSFirehoseCredentialManagerEventMap> {
-
-  private refreshTimer: ReturnType<typeof setTimeout> = null;
-  private loadDeferred: Deferred<AWSCredentials> = null;
-
-  forceUpdateCredentials(): void {
-    if (this.loadDeferred && !this.loadDeferred.isSettled()) {
-      this.loadDeferred.reject(new Error("force update"))
-    }
-
-    this.loadDeferred = null
-    this.scheduleRefresh(1)
-  }
-
-  getCredentials(): AWSCredentials {
-    if (this.loadDeferred && this.loadDeferred.isFulfilled()) {
-      const creds = this.loadDeferred.getResult(),
-        expMs = Date.parse(creds.expiration)
-
-      if (expMs <= Date.now()) {
-        log.info("Credentials expired")
-        this.loadDeferred = null
-        this.scheduleRefresh(1)
-        this.emit("expired")
-        return null
-      }
-      return creds
-    }
-
-    this.scheduleRefresh(1)
-    return null
-  }
-
-  hasCredentials(): boolean {
-    return this.getCredentials() != null
-  }
-
-  private async load(): Promise<AWSCredentials> {
-    if (this.loadDeferred && !this.loadDeferred.isRejected())
-      return this.loadDeferred.promise
-
-    const deferred = this.loadDeferred = new Deferred<AWSCredentials>()
-    try {
-      const r = await fetch(API_BASE + "/creds", {
-        method: "GET",
-        credentials: "include",
-      })
-      if (!r.ok) throw new Error(`creds http ${r.status}`)
-      const creds: AWSCredentials = await r.json()
-
-
-      this.scheduleRefresh(creds)
-      log.info(`Got creds, expire=${creds.expiration}, stream=${creds.streamName}, region=${creds.region}`)
-      deferred.resolve(creds)
-      this.emit("received", creds)
-      return deferred.promise
-    } catch (e) {
-      deferred.reject(e)
-      this.loadDeferred = null
-      throw e
-    }
-  }
-  scheduleRefresh(credsOrMillis: AWSCredentials | number): void {
-    if (this.refreshTimer) {
-      clearTimeout(this.refreshTimer)
-      this.refreshTimer = null
-    }
-    if (!credsOrMillis)
-      return
-
-    let refreshInMs: number
-    if (typeof credsOrMillis === "number") {
-      refreshInMs = credsOrMillis
-    } else {
-      const
-        creds = credsOrMillis,
-        expMs = Date.parse(creds.expiration)
-
-      refreshInMs = expMs - Date.now() - CRED_BUFFER_PADDING_MS
-
-    }
-
-    refreshInMs = Math.max(100, refreshInMs)
-
-    this.refreshTimer = setTimeout(() => {
-      this.loadDeferred = null
-      this.load().catch((e: Error) => log.error(`refresh failed: ${e.message}`, e))
-    }, refreshInMs)
-  }
-
-  getStreamName(): string {
-    return this.getCredentials()?.streamName
-  }
-
-  getRegion(): string {
-    return this.getCredentials()?.region
-  }
-
-  destroy(): void {
-    this.scheduleRefresh(null)
-    if (!this.loadDeferred.isSettled())
-      this.loadDeferred.reject(new Error("destroyed"))
-    this.loadDeferred = null
-  }
-}
-
-
-export default AWSFirehoseCredentialManager

package/src/logging/appenders/index.ts

@@ -1,3 +0,0 @@
-export * from "./aws-firehose/AWSFirehoseAppender.js"
-export * from "./ConsoleAppender.js"
-export * from "./DebugAppender.js"

package/src/logging/context/LogContext.ts

@@ -1,74 +0,0 @@
-import { Appender } from "../Appender.js"
-import { Level } from "../Level.js"
-import { LogContextProvider } from "./LogContextProvider.js"
-import { LogContextContainer } from "./LogContextContainer.js"
-
-
-
-
-
-
-export class LogContext {
-  /**
-   * Threshold override level
-   *
-   * @type {Level}
-   */
-  readonly thresholdLevel: Level
-
-  /**
-   * If specified, only categories that match will
-   * use this context
-   *
-   * @type {RegExp}
-   */
-  readonly pattern: RegExp
-
-  /**
-   * Exclusive, only use this config in context.  Defaults to `false`
-   *
-   * @type {boolean}
-   */
-  readonly exclusive: RegExp
-  
-  /**
-   * Use a logger context within
-   *
-   * @param {() => Promise<T>} fn
-   * @returns {Promise<T>}
-   */
-  use<T = unknown>(fn: () => Promise<T>) {
-    return LogContextContainer.runInContext(this, fn)
-  }
-  
-  /**
-   * Creates a new logger context
-   *
-   * @param {Appender[]} appenders - additional appenders for the context
-   * @param {LoggerContextOptions} options -
-   */
-  protected constructor(
-    readonly appenders: Appender[],
-    options: LoggerContextOptions
-  ) {
-    Object.assign(this, {
-      exclusive: false,
-      thresholdLevel: null,
-      pattern: null,
-      ...options
-    })
-  }
-
-  /**
-   * Create a new logger context
-   *
-   * @param {Appender[]} appenders
-   * @param {LoggerContextOptions} options
-   * @returns {LogContext}
-   */
-  static with(appenders: Appender[], options: LoggerContextOptions = {}) {
-    return new LogContext(appenders, options)
-  }
-}
-
-export type LoggerContextOptions = Partial<Pick<LogContext, "pattern" | "exclusive">>

package/src/logging/context/LogContextContainer.ts

@@ -1,28 +0,0 @@
-import { LogContext } from "./LogContext.js"
-import { DefaultLogContextProvider, LogContextProvider } from "./LogContextProvider.js"
-
-const state = {
-  provider: DefaultLogContextProvider as LogContextProvider
-}
-
-
-export namespace LogContextContainer  {
-  
-  export function setProvider(provider: LogContextProvider) {
-    state.provider = provider ?? DefaultLogContextProvider
-  }
-  
-  export function getProvider():LogContextProvider {
-    return state.provider ?? DefaultLogContextProvider
-  }
-  
-  export function currentContext(): Array<LogContext> {
-    return getProvider().currentContext?.() ?? []
-  }
-  
-  export function runInContext<T = unknown>(context: LogContext, fn: () => Promise<T>): Promise<T> {
-    const provider = getProvider()
-    return provider.runInContext(context,fn)
-  }
-  
-}

package/src/logging/context/LogContextProvider.ts

@@ -1,43 +0,0 @@
-// 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

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

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

@@ -1,45 +0,0 @@
-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

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

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

@@ -1,19 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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

package/src/logging/index.ts

@@ -1,11 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

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