Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions deno.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions flow-core/src/deps.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export { normalize } from 'https://deno.land/std@0.224.0/path/mod.ts';
export { describe, it } from "https://deno.land/std@0.224.0/testing/bdd.ts";
export {
assertEquals,
assertNotStrictEquals,
Expand Down Expand Up @@ -38,3 +39,4 @@ export type * as RDF from 'npm:@rdfjs/types';

// Sentry for error reporting and logging
export * as Sentry from 'npm:@sentry/deno';

4 changes: 1 addition & 3 deletions flow-core/src/platform-constants.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
export const validLogLevels = ['debug', 'info', 'warn', 'error'] as const;

export type LogLevel = typeof validLogLevels[number];
import { LogLevel, validLogLevels } from './utils/logger/logger-types.ts';

/**
* Validates that the provided log level is one of the allowed values.
Expand Down
55 changes: 55 additions & 0 deletions flow-core/src/utils/logger/component-logger.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
import {
EnhancedStructuredLogger,
LoggingConfig,
createEnhancedLogger,
} from "./index.ts";

let injectedLoggingConfig: LoggingConfig | undefined;
let globalLogger: EnhancedStructuredLogger | undefined;

/**
* Inject a LoggingConfig to be used globally by flow-core.
* Should be called once by flow-service at startup.
*/
export function setGlobalLoggingConfig(config: LoggingConfig): void {
injectedLoggingConfig = config;
globalLogger = undefined; // force re-creation with new config
}

/**
* Resets logger for testing or reconfiguration
*/
export function resetGlobalLogger(): void {
injectedLoggingConfig = undefined;
globalLogger = undefined;
}

/**
* Get the global enhanced logger, initializing if necessary.
*/
function getGlobalLogger(): EnhancedStructuredLogger {
if (!globalLogger) {
globalLogger = createEnhancedLogger(injectedLoggingConfig ?? {
consoleChannel: {
logChannelEnabled: true,
logLevel: 'info',
logFormat: 'pretty',
}
});
}
return globalLogger;
}

/**
* Get a logger scoped to the current file/module.
* Auto-fills the `component` field from import.meta.
*/
export function getComponentLogger(meta: ImportMeta): EnhancedStructuredLogger {
const component = deriveComponentName(meta);
return getGlobalLogger().forComponent(component) as EnhancedStructuredLogger;
}

function deriveComponentName(meta: ImportMeta): string {
const url = new URL(meta.url);
return url.pathname.split("/").pop()?.replace(".ts", "") ?? "unknown";
}
10 changes: 6 additions & 4 deletions flow-core/src/utils/logger/error-handlers.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* better error tracking and debugging across the platform.
*/

import type { LogContext, ErrorHandlingOptions } from './types.ts';
import type { LogContext, ErrorHandlingOptions } from './logger-types.ts';
import { createEnhancedLogger } from './structured-logger.ts';
import { mergeLogContext } from './formatters.ts';

Expand Down Expand Up @@ -36,6 +36,7 @@ export async function handleError(
// Extract error information for structured context
const errorContext = error instanceof Error ? {
errorType: error.constructor.name,
// deno-lint-ignore no-explicit-any
errorCode: (error as any).code,
stackTrace: error.stack,
originalError: error
Expand Down Expand Up @@ -123,6 +124,7 @@ export async function handleCaughtError(
const logDetailedError = async (error: Error, type = 'Error') => {
const errorContext = {
errorType: error.constructor.name,
// deno-lint-ignore no-explicit-any
errorCode: (error as any).code,
stackTrace: error.stack,
originalError: error
Expand Down Expand Up @@ -432,7 +434,7 @@ export async function withErrorHandling<T>(
*/
export function createContextualErrorHandler(baseContext: LogContext) {
return {
handleError: async (
handleError: (
error: unknown,
context?: string,
additionalContext?: LogContext,
Expand All @@ -443,7 +445,7 @@ export function createContextualErrorHandler(baseContext: LogContext) {
return handleError(error, context, mergedContext, meta, options);
},

handleCaughtError: async (
handleCaughtError: (
error: unknown,
customMessage?: string,
additionalContext?: LogContext,
Expand All @@ -453,7 +455,7 @@ export function createContextualErrorHandler(baseContext: LogContext) {
return handleCaughtError(error, customMessage, mergedContext, options);
},

withErrorHandling: async <T>(
withErrorHandling: <T>(
operation: () => Promise<T>,
context?: string,
additionalContext?: LogContext,
Expand Down
39 changes: 17 additions & 22 deletions flow-core/src/utils/logger/formatters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,7 @@
* Provides consistent formatting for console output, file logging, and structured data.
*/

import type { LogContext } from './types.ts';

/**
* Log level type using string literals
*/
export type LogLevel = 'DEBUG' | 'INFO' | 'WARN' | 'ERROR' | 'CRITICAL';
import type { LogContext, LogLevel } from './logger-types.ts';

/**
* Console color codes for terminal output
Expand All @@ -24,14 +19,14 @@ const colors = {
} as const;

/**
* Log level numeric values for comparison
* Log level numeric values for comparison (using lowercase keys)
*/
export const LogLevels = {
DEBUG: 10,
INFO: 20,
WARN: 30,
ERROR: 40,
CRITICAL: 50,
debug: 10,
info: 20,
warn: 30,
error: 40,
critical: 50,
} as const;

/**
Expand All @@ -53,8 +48,8 @@ export function colorize(color: keyof typeof colors, text: string): string {
*/
export function shouldLog(level: LogLevel): boolean {
const configLevel = Deno.env.get('FLOW_LOG_LEVEL') ||
(Deno.env.get('FLOW_ENV') !== 'production' ? 'DEBUG' : 'INFO');
const currentLevel = LogLevels[configLevel as LogLevel] || LogLevels.INFO;
(Deno.env.get('FLOW_ENV') !== 'production' ? 'debug' : 'info');
const currentLevel = LogLevels[configLevel as LogLevel] || LogLevels.info;
return LogLevels[level] >= currentLevel;
}

Expand Down Expand Up @@ -93,7 +88,7 @@ export function formatStructuredMessage(
level: level.toLowerCase(),
message,
service: serviceContext?.serviceName || 'flow-service',
version: serviceContext?.serviceVersion || Deno.env.get('FLOW_VERSION'),
version: serviceContext?.serviceVersion || Deno.env.get('FLOW_SERVICE_VERSION'),
environment: serviceContext?.environment || Deno.env.get('FLOW_ENV') || 'development',
instanceId: serviceContext?.instanceId,
...context,
Expand All @@ -119,13 +114,13 @@ export function formatConsoleMessage(
const prefix = `[${timestamp}] ${level.padEnd(5)}`;

if (isDevelopment) {
const coloredLevel = level === 'ERROR' || level === 'CRITICAL'
? colorize('red', level)
: level === 'WARN'
? colorize('yellow', level)
: level === 'DEBUG'
? colorize('blue', level)
: colorize('green', level);
const coloredLevel = level === 'error' || level === 'critical'
? colorize('red', level.toUpperCase())
: level === 'warn'
? colorize('yellow', level.toUpperCase())
: level === 'debug'
? colorize('blue', level.toUpperCase())
: colorize('green', level.toUpperCase());

const coloredPrefix = colorize('gray', `[${timestamp}]`) +
` ${coloredLevel.padEnd(5)}`;
Expand Down
53 changes: 41 additions & 12 deletions flow-core/src/utils/logger/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,20 @@
export type {
LogContext,
StructuredLogger,
LoggerConfig,
LoggingConfig,
LogChannelConfig,
ConsoleChannelConfig,
FileChannelConfig,
SentryChannelConfig,
SentryConfig,
ErrorSeverity,
ErrorHandlingOptions,
} from './types.ts';
} from './logger-types.ts';

export { LogLevel } from './types.ts';
export type { LogLevel } from './logger-types.ts';
export { validLogLevels } from './logger-types.ts';

// Export formatting utilities
export type { LogLevel as LogLevelString } from './formatters.ts';
// Export formatting utilities (LogLevel type is now imported from logger-types.ts)
export {
colorize,
shouldLog,
Expand Down Expand Up @@ -60,7 +65,7 @@ export {
} from './error-handlers.ts';

// Import types for function signatures
import type { StructuredLogger } from './types.ts';
import type { StructuredLogger } from './logger-types.ts';
import type { EnhancedStructuredLogger } from './structured-logger.ts';
import { createLogger, createEnhancedLogger } from './structured-logger.ts';

Expand All @@ -76,9 +81,21 @@ export function createDefaultLogger(
): StructuredLogger {
return createLogger(
{
enableConsole: true,
enableFile: true,
enableSentry: true,
consoleChannel: {
logChannelEnabled: true,
logLevel: 'info',
logFormat: 'pretty',
},
fileChannel: {
logChannelEnabled: true,
logLevel: 'info',
logFormat: 'json',
logFilePath: './logs/app.log',
},
sentryChannel: {
logChannelEnabled: true,
logLevel: 'error',
},
serviceContext: {
serviceName: appName,
serviceVersion: appVersion || 'unknown',
Expand Down Expand Up @@ -107,9 +124,21 @@ export function createDefaultEnhancedLogger(
): EnhancedStructuredLogger {
return createEnhancedLogger(
{
enableConsole: true,
enableFile: true,
enableSentry: true,
consoleChannel: {
logChannelEnabled: true,
logLevel: 'info',
logFormat: 'pretty',
},
fileChannel: {
logChannelEnabled: true,
logLevel: 'info',
logFormat: 'json',
logFilePath: './logs/app.log',
},
sentryChannel: {
logChannelEnabled: true,
logLevel: 'error',
},
serviceContext: {
serviceName: appName,
serviceVersion: appVersion || 'unknown',
Expand Down
Loading