@ceschiatti/redistail 0.0.2 → 0.0.4

package/src/cli/layers.ts

@@ -0,0 +1,492 @@
+/**
+ * Layer composition and dependency injection for the redistail CLI utility.
+ *
+ * This module provides all service layers and their composition for the redistail
+ * application. It follows Effect-TS patterns for dependency injection, resource
+ * management, and proper error handling. The layers are composed to create a
+ * complete application environment with all necessary services.
+ *
+ * Requirements addressed:
+ * - 7.1: Integration with effect-redis package services
+ * - 7.2: Effect-TS patterns for error handling and resource management
+ * - 7.3: Service composition through Effect Layers
+ * - 7.4: Proper error handling and resource management
+ */
+
+import { Context, Effect, Layer } from 'effect';
+import {
+  Redis,
+  RedisPubSub,
+  RedisStream,
+  RedisConnectionOptions,
+  RedisConnectionOptionsLive,
+  RedisLive,
+  RedisPubSubLive,
+  RedisStreamLive,
+} from 'effect-redis';
+import { CLIConfigService, CLIConfigServiceLive } from './config-service.js';
+import {
+  DisplayServiceTag,
+  createTestDisplayService,
+  type DisplayService,
+} from './display-service.js';
+import {
+  PubSubMonitorService,
+  PubSubMonitorServiceLive,
+} from './pubsub-monitor-service.js';
+import {
+  StreamMonitorService,
+  StreamMonitorServiceLive,
+} from './stream-monitor-service.js';
+import {
+  SignalHandlerService,
+  SignalHandlerServiceLive,
+} from './signal-handler-service.js';
+import type { RedistailConfig, ConfigError, RedistailError } from './types.js';
+import { RedistailConfig as RedistailConfigConstructor } from './types.js';
+
+// ============================================================================
+// Configuration Layer
+// ============================================================================
+
+/**
+ * Context tag for RedistailConfig dependency injection
+ */
+const RedistailConfigTag = Context.GenericTag<RedistailConfig>(
+  '@redistail/RedistailConfig',
+);
+
+/**
+ * Live layer that provides RedistailConfig by loading from environment
+ * This layer depends on CLIConfigService to load the configuration
+ */
+export const RedistailConfigLive: Layer.Layer<
+  RedistailConfig,
+  ConfigError,
+  CLIConfigService
+> = Layer.effect(
+  RedistailConfigTag,
+  Effect.gen(function* () {
+    const configService = yield* CLIConfigService;
+    return yield* configService.loadConfig();
+  }),
+);
+
+// ============================================================================
+// Redis Connection Layer
+// ============================================================================
+
+/**
+ * Live layer that provides Redis connection configuration based on RedistailConfig
+ * This layer creates the appropriate Redis connection options from the loaded configuration
+ *
+ * Requirement 7.1: Integrates with effect-redis RedisConnectionOptions
+ */
+export const RedisConnectionLive: Layer.Layer<
+  RedisConnectionOptions,
+  never,
+  RedistailConfig
+> = Layer.effect(
+  RedisConnectionOptions,
+  Effect.gen(function* () {
+    const config = yield* RedistailConfigTag;
+
+    // Determine the Redis URL - prefer explicit URL over host/port
+    const redisUrl =
+      config.redis.url ?? `redis://${config.redis.host}:${config.redis.port}`;
+
+    // Create Redis connection options with timeout and retry configuration
+    const connectionOptions = {
+      url: redisUrl,
+      socket: {
+        connectTimeout: config.redis.timeout,
+        reconnectStrategy: (retries: number) => {
+          // Use exponential backoff with max attempts from config
+          if (retries >= config.redis.retryAttempts) {
+            return false; // Stop retrying after max attempts
+          }
+          return Math.min(config.redis.retryDelay * 2 ** retries, 30000);
+        },
+      },
+      // Set command timeout
+      commandsQueueMaxLength: 1000,
+    };
+
+    // Return the connection options shape
+    return {
+      options: connectionOptions,
+      createClient: undefined,
+    };
+  }),
+);
+
+// ============================================================================
+// Display Service Layer
+// ============================================================================
+
+/**
+ * Live layer that provides DisplayService with configuration
+ * This layer depends on RedistailConfig to configure display options
+ */
+export const DisplayServiceLive: Layer.Layer<
+  DisplayService,
+  never,
+  RedistailConfig
+> = Layer.effect(
+  DisplayServiceTag,
+  Effect.gen(function* () {
+    const config = yield* RedistailConfigTag;
+    return createTestDisplayService(config);
+  }),
+);
+
+// ============================================================================
+// Helper Functions for Layer Creation
+// ============================================================================
+
+/**
+ * Create a Redis connection layer with custom options
+ *
+ * Requirement 7.1: Provides integration with effect-redis connection system
+ */
+export const createRedisConnectionLayer = (
+  host: string,
+  port: number,
+  options?: {
+    url?: string;
+    timeout?: number;
+    retryAttempts?: number;
+    retryDelay?: number;
+  },
+): Layer.Layer<RedisConnectionOptions> => {
+  const redisUrl = options?.url ?? `redis://${host}:${port}`;
+  const timeout = options?.timeout ?? 5000;
+  const retryAttempts = options?.retryAttempts ?? 3;
+  const retryDelay = options?.retryDelay ?? 1000;
+
+  return RedisConnectionOptionsLive({
+    url: redisUrl,
+    socket: {
+      connectTimeout: timeout,
+      reconnectStrategy: (retries: number) => {
+        if (retries >= retryAttempts) {
+          return false;
+        }
+        return Math.min(retryDelay * 2 ** retries, 30000);
+      },
+    },
+    commandsQueueMaxLength: 1000,
+  });
+};
+
+/**
+ * Create a layer with custom Redis connection options
+ */
+export const createRedisOptionsLayer = (
+  options: Parameters<typeof RedisConnectionOptionsLive>[0],
+): Layer.Layer<RedisConnectionOptions> => RedisConnectionOptionsLive(options);
+
+/**
+ * Create a test configuration layer
+ */
+export const createTestConfigLayer = (
+  config: RedistailConfig,
+): Layer.Layer<RedistailConfig> => Layer.succeed(RedistailConfigTag, config);
+
+// ============================================================================
+// Application Layer Composition
+// ============================================================================
+
+/**
+ * Complete application layer that provides all services needed for redistail
+ * This is the main layer that applications should use to get all dependencies
+ *
+ * OPTIMIZATION: Only includes Redis services that are actually used by the CLI:
+ * - RedisPubSub: For PubSub channel monitoring
+ * - RedisStream: For Stream monitoring
+ * - Core Redis service (RedisLive) is excluded as it's not used by redistail
+ *
+ * This reduces Redis connections from 5 to 4 (2 for PubSub + 2 for Stream)
+ *
+ * Requirements 7.1, 7.2, 7.3, 7.4: This layer integrates with effect-redis,
+ * uses Effect-TS patterns, provides service composition and proper error handling
+ */
+
+// Build the base configuration layer first
+// CLIConfigServiceLive has no dependencies
+// RedistailConfigLive depends on CLIConfigService
+const ConfigLayer = Layer.provide(RedistailConfigLive, CLIConfigServiceLive);
+
+// RedisConnectionLive depends on RedistailConfig
+// We need to provide RedistailConfig to it, which comes from ConfigLayer
+const ConnectionLayer = Layer.provide(RedisConnectionLive, ConfigLayer);
+
+// Only create the Redis services that are actually used by the CLI
+// RedisLive (core Redis service) is not used by redistail CLI
+const RedisPubSubServiceLayer = Layer.provide(RedisPubSubLive, ConnectionLayer);
+const RedisStreamServiceLayer = Layer.provide(RedisStreamLive, ConnectionLayer);
+
+// Merge only the Redis services that are actually needed
+const RequiredRedisServicesLayer = Layer.mergeAll(
+  RedisPubSubServiceLayer,
+  RedisStreamServiceLayer,
+);
+
+// DisplayServiceLive depends on RedistailConfig
+const DisplayLayer = Layer.provide(DisplayServiceLive, ConfigLayer);
+
+// PubSubMonitorServiceLive depends on RedisPubSub and CLIConfigService
+const PubSubMonitorLayer = Layer.provide(
+  PubSubMonitorServiceLive,
+  Layer.merge(RedisPubSubServiceLayer, CLIConfigServiceLive),
+);
+
+// StreamMonitorServiceLive depends on RedisStream and CLIConfigService
+const StreamMonitorLayer = Layer.provide(
+  StreamMonitorServiceLive,
+  Layer.merge(RedisStreamServiceLayer, CLIConfigServiceLive),
+);
+
+// Compose the final application layer
+export const AppLive = Layer.mergeAll(
+  CLIConfigServiceLive,
+  SignalHandlerServiceLive,
+  ConfigLayer,
+  DisplayLayer,
+  RequiredRedisServicesLayer,
+  PubSubMonitorLayer,
+  StreamMonitorLayer,
+);
+
+/**
+ * Layer for PubSub-only applications
+ * Provides only the services needed for PubSub monitoring
+ *
+ * Requirement 7.3: Service composition through Effect Layers
+ */
+export const PubSubAppLive = (() => {
+  // Build the dependency chain step by step
+  const configLayer = Layer.provide(RedistailConfigLive, CLIConfigServiceLive);
+  const connectionLayer = Layer.provide(RedisConnectionLive, configLayer);
+  const displayLayer = Layer.provide(DisplayServiceLive, configLayer);
+  const pubsubLayer = Layer.provide(RedisPubSubLive, connectionLayer);
+  const monitorLayer = Layer.provide(
+    PubSubMonitorServiceLive,
+    Layer.merge(pubsubLayer, CLIConfigServiceLive),
+  );
+
+  // Merge all the layers together - only what's needed for PubSub
+  return Layer.mergeAll(
+    CLIConfigServiceLive,
+    SignalHandlerServiceLive,
+    configLayer,
+    displayLayer,
+    pubsubLayer,
+    monitorLayer,
+  );
+})();
+
+/**
+ * Layer for Stream-only applications
+ * Provides only the services needed for Stream monitoring
+ *
+ * Requirement 7.3: Service composition through Effect Layers
+ */
+export const StreamAppLive = (() => {
+  // Build the dependency chain step by step
+  const configLayer = Layer.provide(RedistailConfigLive, CLIConfigServiceLive);
+  const connectionLayer = Layer.provide(RedisConnectionLive, configLayer);
+  const displayLayer = Layer.provide(DisplayServiceLive, configLayer);
+  const streamLayer = Layer.provide(RedisStreamLive, connectionLayer);
+  const monitorLayer = Layer.provide(
+    StreamMonitorServiceLive,
+    Layer.merge(streamLayer, CLIConfigServiceLive),
+  );
+
+  // Merge all the layers together - only what's needed for Streams
+  return Layer.mergeAll(
+    CLIConfigServiceLive,
+    SignalHandlerServiceLive,
+    configLayer,
+    displayLayer,
+    streamLayer,
+    monitorLayer,
+  );
+})();
+
+// ============================================================================
+// Testing Layers
+// ============================================================================
+
+/**
+ * Create a test layer with custom configuration
+ * Useful for testing with specific Redis configurations
+ *
+ * Requirement 7.4: Proper resource management for testing
+ */
+export const createTestAppLayer = (config: RedistailConfig) =>
+  Layer.mergeAll(CLIConfigServiceLive, SignalHandlerServiceLive).pipe(
+    Layer.provideMerge(createTestConfigLayer(config)),
+    Layer.provideMerge(RedisConnectionLive),
+    Layer.provideMerge(
+      Layer.mergeAll(RedisLive, RedisPubSubLive, RedisStreamLive),
+    ),
+    Layer.provideMerge(DisplayServiceLive),
+    Layer.provideMerge(
+      Layer.mergeAll(PubSubMonitorServiceLive, StreamMonitorServiceLive),
+    ),
+  );
+
+/**
+ * Create a minimal test layer with mock Redis connection
+ * Useful for unit testing without actual Redis connection
+ *
+ * Requirement 7.4: Resource management for testing scenarios
+ */
+export const createMockAppLayer = (config: RedistailConfig) =>
+  Layer.mergeAll(CLIConfigServiceLive, SignalHandlerServiceLive).pipe(
+    Layer.provideMerge(createTestConfigLayer(config)),
+    Layer.provideMerge(DisplayServiceLive),
+  );
+
+// ============================================================================
+// Error Handling Utilities
+// ============================================================================
+
+/**
+ * Helper to handle layer initialization errors gracefully
+ * Provides proper error handling and resource management (Requirement 7.4)
+ */
+export const handleLayerError = <E>(error: E): Effect.Effect<never, never> =>
+  Effect.gen(function* () {
+    // Log the error details
+    yield* Effect.logError(`Layer initialization failed: ${String(error)}`);
+
+    // Provide specific error messages based on error type
+    if (typeof error === 'object' && error !== null && '_tag' in error) {
+      const taggedError = error as { _tag: string; message?: string };
+      if (taggedError._tag === 'ConfigError') {
+        yield* Effect.logError(
+          'Configuration error - check environment variables and Redis connection settings',
+        );
+      } else if (taggedError._tag === 'RedisConnectionError') {
+        yield* Effect.logError(
+          'Redis connection error - check Redis server availability',
+        );
+      } else if (taggedError._tag === 'MonitoringError') {
+        yield* Effect.logError(
+          'Monitoring error - check Redis connection and topic names',
+        );
+      }
+    }
+
+    // Exit with error code
+    return yield* Effect.sync(() => process.exit(1));
+  });
+
+/**
+ * Create a default RedistailConfig for testing and development
+ *
+ * Requirement 7.4: Proper configuration management
+ */
+export const createDefaultConfig = (
+  overrides?: Partial<RedistailConfig>,
+): RedistailConfig =>
+  RedistailConfigConstructor({
+    redis: {
+      host: '127.0.0.1',
+      port: 6379,
+      timeout: 5000,
+      retryAttempts: 3,
+      retryDelay: 1000,
+      ...overrides?.redis,
+    },
+    display: {
+      colors: true,
+      timestamps: true,
+      prettyJson: true,
+      ...overrides?.display,
+    },
+    monitoring: {
+      blockTimeout: 5000,
+      maxReconnectAttempts: 5,
+      ...overrides?.monitoring,
+    },
+  });
+
+// ============================================================================
+// Layer Validation and Utilities
+// ============================================================================
+
+/**
+ * Validate that all required services are available in a layer
+ * This is a compile-time check to ensure layer completeness
+ *
+ * Requirement 7.3: Service composition validation
+ */
+export const validateAppLayer = (): void => {
+  // This function serves as a compile-time check for layer dependencies
+  // If there are missing dependencies, TypeScript will show errors here
+
+  // The AppLive layer should provide all these services
+  const _appLayerCheck = AppLive;
+
+  // Suppress unused variable warning
+  void _appLayerCheck;
+};
+
+// ============================================================================
+// Re-exports for Convenience
+// ============================================================================
+
+// Re-export commonly used services and types for convenience
+export {
+  CLIConfigService,
+  DisplayServiceTag,
+  PubSubMonitorService,
+  StreamMonitorService,
+  SignalHandlerService,
+  Redis,
+  RedisPubSub,
+  RedisStream,
+};
+
+export type { RedistailConfig, RedistailError, ConfigError };
+
+// Export the RedistailConfigTag for use in other modules
+export { RedistailConfigTag };
+
+// ============================================================================
+// Documentation and Examples
+// ============================================================================
+
+/**
+ * Example usage of the layers:
+ *
+ * ```typescript
+ * import { AppLive, runWithAppLayer } from './layers.js';
+ * import { Effect } from 'effect';
+ *
+ * const myProgram = Effect.gen(function* () {
+ *   const cliService = yield* CLIConfigService;
+ *   const config = yield* cliService.loadConfig();
+ *   // ... use other services
+ * });
+ *
+ * // Run with complete application layer
+ * Effect.runPromise(Effect.provide(myProgram, AppLive));
+ * ```
+ *
+ * For testing:
+ *
+ * ```typescript
+ * import { createTestAppLayer, createDefaultConfig } from './layers.js';
+ *
+ * const testConfig = createDefaultConfig({
+ *   redis: { host: 'localhost', port: 6380 }
+ * });
+ *
+ * const testLayer = createTestAppLayer(testConfig);
+ * Effect.runPromise(Effect.provide(myProgram, testLayer));
+ * ```
+ */