@friggframework/core 2.0.0-next.12 → 2.0.0-next.121

package/logs/logger.js

@@ -1,69 +1,157 @@
-const util = require('util');
-const aws = require('aws-sdk');
+const { LEVELS, parseLevel } = require('./levels');
+const { getLoggerScope } = require('./context');
+const runtime = require('./logger-runtime');
+const { buildRecord, DEFAULT_LOGGER_NAME } = require('./record');
+
+const LOGGER_OWN_NAME = 'frigg.logger';
+
+function copyBindings(bindings, into = {}) {
+    if (!bindings || typeof bindings !== 'object') return into;
+    for (const key of Object.keys(bindings)) {
+        try {
+            into[key] = bindings[key];
+        } catch {
+            // A throwing getter drops only that binding.
+        }
+    }
+    return into;
+}
 
-// Except in some outlier circumstances, for example steam or event error handlers, this should be the only place that calls `console.*`.  That way, this file can be modified to log everything properly on a variety of platforms because all the logging code is here in one place.
-/* eslint-disable no-console */
+// One plain object per record. Static sources were copied at child() time.
+function evaluateBindings(sources) {
+    const merged = {};
+    for (const source of sources) {
+        if (typeof source !== 'function') {
+            Object.assign(merged, source);
+            continue;
+        }
+        let value;
+        try {
+            value = source();
+        } catch {
+            continue;
+        }
+        copyBindings(value, merged);
+    }
+    return merged;
+}
 
-const logs = [];
-let flushCalled = false;
+function isFriggViolation(record) {
+    return (
+        record.logger.startsWith('frigg.') &&
+        LEVELS[record.level] >= LEVELS.WARN &&
+        !record.eventName
+    );
+}
 
-// Log AWS SDK calls
-aws.config.logger = { log: debug };
+class Logger {
+    constructor(name, bindingSources = []) {
+        this.name = name;
+        this._bindingSources = bindingSources;
+    }
 
-function debug(...messages) {
-    if (messages.length) {
-        const date = new Date();
-        const text = util.format.apply(null, messages);
+    trace(message, fields) {
+        this._log('TRACE', message, fields);
+    }
 
-        if (process.env.DEBUG_VERBOSE === '1') {
-            console.debug(date, text);
-        } else {
-            logs.push({ date, text });
-        }
+    debug(message, fields) {
+        this._log('DEBUG', message, fields);
+    }
+
+    info(message, fields) {
+        this._log('INFO', message, fields);
     }
-}
 
-function initDebugLog(...initMessages) {
-    flushCalled = false;
+    warn(message, fields) {
+        this._log('WARN', message, fields);
+    }
 
-    // Hacky but fast way to empty an array.
-    logs.length = 0;
+    error(message, fields) {
+        this._log('ERROR', message, fields);
+    }
 
-    // Log initial event
-    debug(...initMessages);
-}
+    fatal(message, fields) {
+        this._log('FATAL', message, fields);
+    }
 
-function flushDebugLog(error) {
-    if (flushCalled) {
-        console.debug(
-            'Another error was encountered while handling the same request or event!  All debug messages are included again in this output as well.'
-        );
+    child(bindings) {
+        const source = typeof bindings === 'function' ? bindings : copyBindings(bindings);
+        return new Logger(this.name, [...this._bindingSources, source]);
     }
 
-    flushCalled = true;
+    isLevelEnabled(level) {
+        try {
+            const name = parseLevel(level);
+            return name !== null && LEVELS[name] >= runtime.getConfig().threshold;
+        } catch {
+            return false;
+        }
+    }
 
-    // Output unless in verbose mode.  In verbose mode, these will already have been output so we don't want to output the messages twice.
-    if (process.env.DEBUG_VERBOSE !== '1') {
-        if (logs?.length > 0) {
-            for (const { date, text } of logs) {
-                console.debug(date, text);
+    _log(level, message, fields) {
+        const state = runtime.state();
+        if (state.inLog) return;
+        try {
+            const config = runtime.getConfig();
+            emitConfigWarnings();
+            if (LEVELS[level] < config.threshold) return;
+            // Set before fields, bindings and sinks run: any of them may log.
+            state.inLog = true;
+
+            const record = buildRecord({
+                level,
+                logger: this.name,
+                message,
+                fields,
+                bindings: evaluateBindings(this._bindingSources),
+                scope: getLoggerScope(),
+                spanContext: runtime.getSpanContext(),
+                resource: { appName: config.appName, stage: config.stage },
+            });
+            if (isFriggViolation(record)) {
+                runtime.recordViolation({
+                    logger: record.logger,
+                    level: record.level,
+                    message: record.message,
+                });
             }
+            writeToSinks(record);
+        } catch {
+            // The logger never throws.
+        } finally {
+            state.inLog = false;
         }
     }
+}
 
-    if (!error) {
-        error = new Error('flushDebugLog called with empty error');
+function writeToSinks(record) {
+    for (const sink of runtime.getSinks()) {
+        try {
+            sink.write(record);
+        } catch {
+            // One failing sink must not stop the others.
+        }
     }
+}
 
-    console.error(error);
+function emitConfigWarnings() {
+    const warnings = runtime.takeConfigWarnings();
+    if (!warnings.length) return;
+    const logger = getLogger(LOGGER_OWN_NAME);
+    for (const warning of warnings) {
+        logger.warn(warning.message, {
+            ...warning.fields,
+            eventName: warning.eventName,
+        });
+    }
+}
 
-    let { cause: parentError } = error;
+const loggers = new Map();
 
-    while (parentError) {
-        console.error('(Caused By)-------------------------');
-        console.error(parentError);
-        parentError = parentError.cause;
-    }
+function getLogger(name) {
+    const key = typeof name === 'string' && name ? name : DEFAULT_LOGGER_NAME;
+    if (!loggers.has(key)) loggers.set(key, new Logger(key));
+    return loggers.get(key);
 }
 
-module.exports = { debug, initDebugLog, flushDebugLog };
+module.exports = { Logger, getLogger };

package/logs/record.js

@@ -0,0 +1,276 @@
+const { LEVELS } = require('./levels');
+const { serializeValue, serializeError, isError } = require('./serialize');
+const { isPlainObject } = require('./context');
+const {
+    RESOURCE_KEYS,
+    DROPPED_KEYS_FIELD,
+    OWNED_KEYS,
+    RESERVED_KEYS,
+    PAYLOAD_KEYS,
+} = require('./contract-keys');
+
+const MAX_RECORD_BYTES = 16 * 1024;
+const DEFAULT_LOGGER_NAME = 'frigg.unknown';
+
+function deepFreeze(value) {
+    if (value && typeof value === 'object' && !Object.isFrozen(value)) {
+        for (const key of Object.keys(value)) deepFreeze(value[key]);
+        Object.freeze(value);
+    }
+    return value;
+}
+
+function readFields(source) {
+    const result = {};
+    if (!source || typeof source !== 'object') return result;
+    let keys;
+    try {
+        keys = Object.keys(source);
+    } catch {
+        return result;
+    }
+    for (const key of keys) {
+        try {
+            result[key] = source[key];
+        } catch {
+            result[key] = '[Getter threw]';
+        }
+    }
+    return result;
+}
+
+// Returns the message text. An Error message is serialized once; when the
+// call site has no `error`, that result becomes the record's `error`.
+function buildMessage(message, callSite) {
+    if (typeof message === 'string') {
+        return { text: serializeValue(message) };
+    }
+    if (message === undefined || message === null) return { text: '' };
+    if (isError(message)) {
+        const error = serializeError(message);
+        const text = typeof error?.message === 'string' ? error.message : '';
+        if (callSite.error !== undefined) return { text };
+        callSite.error = message;
+        return { text, error };
+    }
+    if (callSite.value === undefined) callSite.value = message;
+    return { text: '[non-string message]' };
+}
+
+const INVOCATION_KEY = 'invocation';
+
+// A boundary adds request detail to the scope's invocation; scope keys win.
+function extendInvocation(scoped, detail) {
+    const merged = { ...scoped };
+    for (const key of Object.keys(detail)) {
+        if (!(key in merged)) merged[key] = detail[key];
+    }
+    return merged;
+}
+
+function traceFields(spanContext) {
+    if (
+        !spanContext ||
+        typeof spanContext.traceId !== 'string' ||
+        typeof spanContext.spanId !== 'string'
+    ) {
+        return {};
+    }
+    const flags = Number(spanContext.traceFlags) || 0;
+    return {
+        trace_id: spanContext.traceId,
+        span_id: spanContext.spanId,
+        trace_flags: (flags & 0xff).toString(16).padStart(2, '0'),
+    };
+}
+
+function sameValue(a, b) {
+    if (a === b) return true;
+    return (
+        typeof a === 'object' &&
+        typeof b === 'object' &&
+        JSON.stringify(a) === JSON.stringify(b)
+    );
+}
+
+function byteLength(record) {
+    return Buffer.byteLength(JSON.stringify(record));
+}
+
+function isDroppedKey(key, dropPayloads) {
+    return (
+        OWNED_KEYS.has(key) ||
+        RESERVED_KEYS.has(key) ||
+        (dropPayloads && PAYLOAD_KEYS.has(key))
+    );
+}
+
+// Filters and serializes one source. `error` is serialized on its own, once
+// (or taken from `preSerializedError`), and never walked by serializeValue.
+function prepareSource(source, dropPayloads, preSerializedError) {
+    const accepted = {};
+    const keys = [];
+    const dropped = [];
+    let rawError;
+    for (const [key, value] of Object.entries(source)) {
+        if (value === undefined || value === null) continue;
+        if (isDroppedKey(key, dropPayloads)) {
+            dropped.push(key);
+            continue;
+        }
+        keys.push(key);
+        if (key === 'error') rawError = value;
+        else accepted[key] = value;
+    }
+    // One pass over the object, so key rules (denied keys, digests,
+    // headers, OAuth shapes) apply to top-level fields too.
+    const safe = serializeValue(accepted);
+    const entries = [];
+    for (const key of keys) {
+        const value =
+            key === 'error'
+                ? preSerializedError ?? serializeError(rawError)
+                : safe?.[key];
+        if (value !== undefined && value !== null) entries.push([key, value]);
+    }
+    return { entries, dropped };
+}
+
+// The scope object is frozen and shared by every record of one scope.
+const preparedScopes = new WeakMap();
+
+function prepareScope(scope, dropPayloads) {
+    if (!scope || typeof scope !== 'object') return { entries: [], dropped: [] };
+    let byLevel = preparedScopes.get(scope);
+    if (!byLevel) {
+        byLevel = {};
+        preparedScopes.set(scope, byLevel);
+    }
+    const slot = dropPayloads ? 'info' : 'debug';
+    if (!byLevel[slot]) byLevel[slot] = prepareSource(scope, dropPayloads);
+    return byLevel[slot];
+}
+
+function buildRecord({
+    level,
+    logger,
+    message,
+    fields,
+    bindings,
+    scope,
+    spanContext,
+    resource = {},
+    now = new Date(),
+} = {}) {
+    const dropPayloads = LEVELS[level] >= LEVELS.INFO;
+    // log.error('msg', err): own props of an Error (axios config, request) must not become fields.
+    const callSite = readFields(isError(fields) ? { error: fields } : fields);
+    const built = buildMessage(message, callSite);
+    const record = {
+        timestamp: now.toISOString(),
+        level,
+        message: built.text,
+        logger: typeof logger === 'string' && logger ? logger : DEFAULT_LOGGER_NAME,
+    };
+    for (const key of RESOURCE_KEYS) {
+        if (typeof resource[key] === 'string' && resource[key]) {
+            record[key] = resource[key];
+        }
+    }
+    Object.assign(record, traceFields(spanContext));
+
+    const dropped = new Set();
+    const callSiteKeys = [];
+    // Call-site keys merged into the scope invocation; the size cap must reach them too.
+    const invocationDetailKeys = [];
+    const place = ({ entries, dropped: droppedHere }, isCallSite) => {
+        for (const key of droppedHere) dropped.add(key);
+        for (const [key, value] of entries) {
+            if (Object.prototype.hasOwnProperty.call(record, key)) {
+                if (
+                    key === INVOCATION_KEY &&
+                    isPlainObject(record[key]) &&
+                    isPlainObject(value)
+                ) {
+                    const merged = extendInvocation(record[key], value);
+                    if (isCallSite) {
+                        for (const detailKey of Object.keys(value)) {
+                            if (!(detailKey in record[key])) invocationDetailKeys.push(detailKey);
+                        }
+                    }
+                    record[key] = merged;
+                } else if (!sameValue(record[key], value)) {
+                    // A repeat of the winning value is no conflict.
+                    dropped.add(key);
+                }
+                continue;
+            }
+            record[key] = value;
+            if (isCallSite) callSiteKeys.push(key);
+        }
+    };
+    place(prepareScope(scope, dropPayloads), false);
+    place(prepareSource(bindings || {}, dropPayloads), false);
+    place(prepareSource(callSite, dropPayloads, built.error), true);
+
+    const setDroppedKeys = () => {
+        delete record[DROPPED_KEYS_FIELD];
+        if (dropped.size) record[DROPPED_KEYS_FIELD] = [...dropped];
+    };
+    setDroppedKeys();
+    let size = byteLength(record);
+
+    if (size > MAX_RECORD_BYTES) {
+        const candidates = [
+            ...callSiteKeys
+                .filter((key) => key !== 'error')
+                .map((key) => ({
+                    name: key,
+                    value: record[key],
+                    remove: () => delete record[key],
+                })),
+            ...invocationDetailKeys.map((key) => ({
+                name: `${INVOCATION_KEY}.${key}`,
+                value: record[INVOCATION_KEY][key],
+                remove: () => {
+                    const rest = { ...record[INVOCATION_KEY] };
+                    delete rest[key];
+                    record[INVOCATION_KEY] = rest;
+                },
+            })),
+        ];
+        const bySize = candidates
+            .map((candidate) => [candidate, Buffer.byteLength(JSON.stringify(candidate.value))])
+            .sort((a, b) => b[1] - a[1]);
+        for (const [candidate] of bySize) {
+            candidate.remove();
+            dropped.add(candidate.name);
+            setDroppedKeys();
+            size = byteLength(record);
+            if (size <= MAX_RECORD_BYTES) break;
+        }
+    }
+    for (const part of ['stack', 'cause']) {
+        if (
+            size > MAX_RECORD_BYTES &&
+            record.error &&
+            typeof record.error === 'object' &&
+            record.error[part] !== undefined
+        ) {
+            const { [part]: _removed, ...rest } = record.error;
+            record.error = rest;
+            size = byteLength(record);
+        }
+    }
+
+    return deepFreeze(record);
+}
+
+module.exports = {
+    buildRecord,
+    deepFreeze,
+    MAX_RECORD_BYTES,
+    RESERVED_KEYS,
+    PAYLOAD_KEYS,
+    DEFAULT_LOGGER_NAME,
+};