@ceschiatti/redistail 0.0.2 → 0.0.4

package/src/cli/display-service.ts

@@ -0,0 +1,321 @@
+/**
+ * Display service for formatting and outputting Redis messages.
+ *
+ * This service handles message formatting for both PubSub and Stream messages,
+ * including timestamp formatting, color support, JSON pretty-printing,
+ * safe handling of binary content, and proper output stream separation.
+ */
+
+import { Context, Effect, Console, Layer } from 'effect';
+import type { PubSubMessage, StreamMessage, RedistailError } from './types.js';
+import { RedistailConfig } from './types.js';
+
+// ============================================================================
+// Service Interface
+// ============================================================================
+
+/**
+ * Service interface for message display and formatting
+ */
+export interface DisplayService {
+  readonly formatPubSubMessage: (
+    message: PubSubMessage,
+  ) => Effect.Effect<string, never>;
+  readonly formatStreamMessage: (
+    message: StreamMessage,
+  ) => Effect.Effect<string, never>;
+  readonly formatError: (error: RedistailError) => Effect.Effect<string, never>;
+  readonly outputMessage: (formatted: string) => Effect.Effect<void, never>;
+  readonly outputError: (error: string) => Effect.Effect<void, never>;
+}
+
+/**
+ * Service tag for dependency injection
+ */
+export const DisplayServiceTag = Context.GenericTag<DisplayService>(
+  '@redistail/DisplayService',
+);
+
+// ============================================================================
+// Color Constants
+// ============================================================================
+
+/**
+ * ANSI color codes for terminal output
+ */
+const COLORS = {
+  RESET: '\x1b[0m',
+  TIMESTAMP: '\x1b[90m', // Bright black (gray)
+  PUBSUB_CHANNEL: '\x1b[36m', // Cyan
+  STREAM_INFO: '\x1b[35m', // Magenta
+  FIELD_KEY: '\x1b[33m', // Yellow
+  CONTENT: '\x1b[37m', // White
+  ERROR: '\x1b[31m', // Red
+} as const;
+
+// ============================================================================
+// Utility Functions
+// ============================================================================
+
+/**
+ * Format a Date object as an ISO-like timestamp for display
+ */
+const formatTimestamp = (date: Date): string =>
+  date.toISOString().replace('T', ' ').replace('Z', '');
+
+/**
+ * Attempt to pretty-print JSON content if valid, otherwise return as-is
+ */
+const tryPrettyPrintJson = (content: string, prettyJson: boolean): string => {
+  if (!prettyJson) return content;
+
+  try {
+    const parsed = JSON.parse(content);
+    return JSON.stringify(parsed, null, 2);
+  } catch {
+    // Not valid JSON, return original content
+    return content;
+  }
+};
+
+/**
+ * Escape non-printable characters in content for safe display
+ */
+const escapeNonPrintable = (content: string): string => {
+  // Create regex for non-printable characters using String.fromCharCode to avoid linter issues
+  const chars = [];
+  // Add control characters 0x00-0x1F
+  for (let i = 0; i <= 0x1f; i++) {
+    chars.push(String.fromCharCode(i));
+  }
+  // Add DEL and extended control characters 0x7F-0x9F
+  for (let i = 0x7f; i <= 0x9f; i++) {
+    chars.push(String.fromCharCode(i));
+  }
+  const nonPrintableRegex = new RegExp(`[${chars.join('')}]`, 'g');
+
+  return content.replace(nonPrintableRegex, (char) => {
+    const code = char.charCodeAt(0);
+    return `\\x${code.toString(16).padStart(2, '0')}`;
+  });
+};
+
+/**
+ * Apply color to text if colors are enabled
+ */
+const colorize = (text: string, color: string, enabled: boolean): string =>
+  enabled ? `${color}${text}${COLORS.RESET}` : text;
+
+/**
+ * Check if content appears to be binary (contains null bytes or high percentage of non-printable chars)
+ */
+const isBinaryContent = (content: string): boolean => {
+  // Check for null bytes (common in binary data)
+  if (content.includes('\0')) return true;
+
+  // Create regex for non-printable characters using String.fromCharCode to avoid linter issues
+  const chars = [];
+  // Add control characters 0x00-0x1F
+  for (let i = 0; i <= 0x1f; i++) {
+    chars.push(String.fromCharCode(i));
+  }
+  // Add DEL and extended control characters 0x7F-0x9F
+  for (let i = 0x7f; i <= 0x9f; i++) {
+    chars.push(String.fromCharCode(i));
+  }
+  const nonPrintableRegex = new RegExp(`[${chars.join('')}]`, 'g');
+
+  const nonPrintableCount = (content.match(nonPrintableRegex) || []).length;
+  const nonPrintableRatio = nonPrintableCount / content.length;
+
+  // Consider binary if more than 10% non-printable characters
+  return nonPrintableRatio > 0.1;
+};
+
+/**
+ * Format content safely, handling JSON, binary data, and non-printable characters
+ */
+const formatContent = (
+  content: string,
+  prettyJson: boolean,
+  colors: boolean,
+): string => {
+  // First, check if content is binary and needs escaping
+  const safeContent = isBinaryContent(content)
+    ? escapeNonPrintable(content)
+    : content;
+
+  // Try to pretty-print JSON if enabled
+  const formattedContent = tryPrettyPrintJson(safeContent, prettyJson);
+
+  // Apply color if enabled
+  return colorize(formattedContent, COLORS.CONTENT, colors);
+};
+
+// ============================================================================
+// Service Implementation
+// ============================================================================
+
+/**
+ * Create a DisplayService implementation with the given configuration
+ */
+const createDisplayService = (config: RedistailConfig): DisplayService => ({
+  formatPubSubMessage: (message: PubSubMessage) =>
+    Effect.sync(() => {
+      const parts: string[] = [];
+
+      // Add timestamp if enabled
+      if (config.display.timestamps) {
+        const timestamp = formatTimestamp(message.timestamp);
+        parts.push(
+          colorize(timestamp, COLORS.TIMESTAMP, config.display.colors),
+        );
+      }
+
+      // Add channel name in brackets
+      const channel = `[${message.channel}]`;
+      parts.push(
+        colorize(channel, COLORS.PUBSUB_CHANNEL, config.display.colors),
+      );
+
+      // Add formatted content
+      const content = formatContent(
+        message.content,
+        config.display.prettyJson,
+        config.display.colors,
+      );
+      parts.push(content);
+
+      return parts.join(' ');
+    }),
+
+  formatStreamMessage: (message: StreamMessage) =>
+    Effect.sync(() => {
+      const parts: string[] = [];
+
+      // Add timestamp if enabled
+      if (config.display.timestamps) {
+        const timestamp = formatTimestamp(message.timestamp);
+        parts.push(
+          colorize(timestamp, COLORS.TIMESTAMP, config.display.colors),
+        );
+      }
+
+      // Add stream key and entry ID in brackets
+      const streamInfo = `[${message.streamKey}:${message.entryId}]`;
+      parts.push(
+        colorize(streamInfo, COLORS.STREAM_INFO, config.display.colors),
+      );
+
+      // Format fields as key=value pairs
+      const fieldPairs = Object.entries(message.fields).map(([key, value]) => {
+        const coloredKey = colorize(
+          key,
+          COLORS.FIELD_KEY,
+          config.display.colors,
+        );
+        const formattedValue = formatContent(
+          value,
+          config.display.prettyJson,
+          config.display.colors,
+        );
+        return `${coloredKey}=${formattedValue}`;
+      });
+
+      if (fieldPairs.length > 0) {
+        parts.push(fieldPairs.join(' '));
+      }
+
+      return parts.join(' ');
+    }),
+
+  formatError: (error: RedistailError) =>
+    Effect.sync(() => {
+      const errorMessage = `ERROR: ${error.message}`;
+      return colorize(errorMessage, COLORS.ERROR, config.display.colors);
+    }),
+
+  outputMessage: (formatted: string) => Console.log(formatted), // Messages go to stdout
+
+  outputError: (error: string) => Console.error(error), // Errors go to stderr
+});
+
+// ============================================================================
+// Service Layer
+// ============================================================================
+
+/**
+ * Create a DisplayService layer with the given configuration
+ */
+export const makeDisplayServiceLayer = (
+  config: RedistailConfig,
+): Layer.Layer<DisplayService> =>
+  Layer.succeed(DisplayServiceTag, createDisplayService(config));
+
+/**
+ * Live layer that provides DisplayService implementation
+ * This is a convenience layer that uses default configuration
+ */
+export const DisplayServiceLive: Layer.Layer<DisplayService> = Layer.effect(
+  DisplayServiceTag,
+  Effect.sync(() => {
+    // Use default configuration for the live layer
+    // In practice, this would be provided by the application layer
+    const defaultConfig = RedistailConfig({
+      redis: {
+        host: '127.0.0.1',
+        port: 6379,
+        timeout: 5000,
+        retryAttempts: 3,
+        retryDelay: 1000,
+      },
+      display: {
+        colors: true,
+        timestamps: true,
+        prettyJson: true,
+      },
+      monitoring: {
+        blockTimeout: 5000,
+        maxReconnectAttempts: 5,
+      },
+    });
+    return createDisplayService(defaultConfig);
+  }),
+);
+
+// ============================================================================
+// Utility Functions for Testing
+// ============================================================================
+
+/**
+ * Create a DisplayService for testing with custom configuration
+ */
+export const createTestDisplayService = (
+  config: RedistailConfig,
+): DisplayService => createDisplayService(config);
+
+/**
+ * Helper to strip ANSI color codes from formatted output for testing
+ */
+export const stripAnsiColors = (text: string): string => {
+  // Create regex for ANSI escape sequences using String.fromCharCode to avoid linter issues
+  const esc = String.fromCharCode(0x1b); // ESC character
+  const ansiRegex = new RegExp(`${esc}\\[[0-9;]*m`, 'g');
+  return text.replace(ansiRegex, '');
+};
+
+/**
+ * Helper to check if text contains ANSI color codes
+ */
+export const hasAnsiColors = (text: string): boolean => {
+  // Create regex for ANSI escape sequences using String.fromCharCode to avoid linter issues
+  const esc = String.fromCharCode(0x1b); // ESC character
+  const ansiRegex = new RegExp(`${esc}\\[[0-9;]*m`);
+  return ansiRegex.test(text);
+};
+
+// ============================================================================
+// Additional Exports
+// ============================================================================
+
+// All exports are already defined above