@sun-asterisk/sunlint/rules/common/C035_error_logging_context/analyzer.js

☀️ SunLint - Multi-language static analysis tool for code quality and security | Sun* Engineering Standards

/**
 * C035 Main Analyzer - Error Logging Context Detection
 * Primary: Symbol-based analysis (when available)
 * Fallback: Regex-based for all other cases
 */

const C035SymbolBasedAnalyzer = require('./symbol-based-analyzer.js');
const C035RegexBasedAnalyzer = require('./regex-based-analyzer.js');

class C035Analyzer {
  constructor(options = {}) {
    if (process.env.SUNLINT_DEBUG) {
      console.log(`🔧 [C035] Constructor called with options:`, !!options);
      console.log(`🔧 [C035] Options type:`, typeof options, Object.keys(options || {}));
    }
    
    this.ruleId = 'C035';
    this.ruleName = 'Error Logging Context Analysis';
    this.description = 'Khi xử lý lỗi, phải ghi log đầy đủ thông tin liên quan - structured logging with context';
    this.semanticEngine = options.semanticEngine || null;
    this.verbose = options.verbose || false;
    
    // Configuration
    this.config = {
      useSymbolBased: true,      // Primary approach
      fallbackToRegex: true,     // Only when symbol fails completely
      symbolBasedOnly: false     // Can be set to true for pure mode
    };
    
    // Initialize both analyzers
    try {
      this.symbolAnalyzer = new C035SymbolBasedAnalyzer(this.semanticEngine);
      if (process.env.SUNLINT_DEBUG) {
        console.log(`🔧 [C035] Symbol analyzer created successfully`);
      }
    } catch (error) {
      console.error(`🔧 [C035] Error creating symbol analyzer:`, error);
    }
    
    try {
      this.regexAnalyzer = new C035RegexBasedAnalyzer(this.semanticEngine);
      if (process.env.SUNLINT_DEBUG) {
        console.log(`🔧 [C035] Regex analyzer created successfully`);
      }
    } catch (error) {
      console.error(`🔧 [C035] Error creating regex analyzer:`, error);
    }
    
    if (process.env.SUNLINT_DEBUG) {
      console.log(`🔧 [C035] Constructor completed`);
    }
  }

  /**
   * Initialize with semantic engine
   */
  async initialize(semanticEngine = null) {
    if (semanticEngine) {
      this.semanticEngine = semanticEngine;
    }
    this.verbose = semanticEngine?.verbose || false;
    
    // Initialize both analyzers
    await this.symbolAnalyzer.initialize(semanticEngine);
    await this.regexAnalyzer.initialize(semanticEngine);
    
    // Ensure verbose flag is propagated
    this.regexAnalyzer.verbose = this.verbose;
    this.symbolAnalyzer.verbose = this.verbose;
    
    if (this.verbose) {
      console.log(`🔧 [C035 Hybrid] Analyzer initialized - verbose: ${this.verbose}`);
    }
  }

  async analyze(files, language, options = {}) {
    if (process.env.SUNLINT_DEBUG) {
      console.log(`🔧 [C035] analyze() method called with ${files.length} files, language: ${language}`);
    }
    
    const violations = [];
    
    for (const filePath of files) {
      try {
        if (process.env.SUNLINT_DEBUG) {
          console.log(`🔧 [C035] Processing file: ${filePath}`);
        }
        
        const fileViolations = await this.analyzeFile(filePath, options);
        violations.push(...fileViolations);
        
        if (process.env.SUNLINT_DEBUG) {
          console.log(`🔧 [C035] File ${filePath}: Found ${fileViolations.length} violations`);
        }
      } catch (error) {
        console.warn(`❌ [C035] Analysis failed for ${filePath}:`, error.message);
      }
    }
    
    if (process.env.SUNLINT_DEBUG) {
      console.log(`🔧 [C035] Total violations found: ${violations.length}`);
    }
    
    return violations;
  }

  async analyzeFile(filePath, options = {}) {
    if (process.env.SUNLINT_DEBUG) {
      console.log(`🔧 [C035] analyzeFile() called for: ${filePath}`);
    }
    
    // 1. Try Symbol-based analysis first (primary)
    if (this.config.useSymbolBased && 
        this.semanticEngine?.project && 
        this.semanticEngine?.initialized) {
      try {
        if (process.env.SUNLINT_DEBUG) {
          console.log(`🔧 [C035] Trying symbol-based analysis...`);
        }
        const sourceFile = this.semanticEngine.project.getSourceFile(filePath);
        if (sourceFile) {
          if (process.env.SUNLINT_DEBUG) {
            console.log(`🔧 [C035] Source file found, analyzing with symbol-based...`);
          }
          const violations = await this.symbolAnalyzer.analyzeFileWithSymbols(filePath, { ...options, verbose: options.verbose });
          
          // Mark violations with analysis strategy
          violations.forEach(v => v.analysisStrategy = 'symbol-based');
          
          if (process.env.SUNLINT_DEBUG) {
            console.log(`✅ [C035] Symbol-based analysis: ${violations.length} violations`);
          }
          return violations; // Return even if 0 violations - symbol analysis completed successfully
        } else {
          if (process.env.SUNLINT_DEBUG) {
            console.log(`⚠️ [C035] Source file not found in project`);
          }
        }
      } catch (error) {
        console.warn(`⚠️ [C035] Symbol analysis failed: ${error.message}`);
        // Continue to fallback
      }
    } else {
      if (process.env.SUNLINT_DEBUG) {
        console.log(`🔄 [C035] Symbol analysis conditions check:`);
        console.log(`  - useSymbolBased: ${this.config.useSymbolBased}`);
        console.log(`  - semanticEngine: ${!!this.semanticEngine}`);
        console.log(`  - semanticEngine.project: ${!!this.semanticEngine?.project}`);
        console.log(`  - semanticEngine.initialized: ${this.semanticEngine?.initialized}`);
        console.log(`🔄 [C035] Symbol analysis unavailable, using regex fallback`);
      }
    }
    
    // 2. Fallback to regex-based analysis
    if (this.config.fallbackToRegex) {
      try {
        if (process.env.SUNLINT_DEBUG) {
          console.log(`🔧 [C035] Trying regex-based analysis...`);
        }
        const violations = await this.regexAnalyzer.analyzeFileBasic(filePath, options);
        
        // Mark violations with analysis strategy
        violations.forEach(v => v.analysisStrategy = 'regex-fallback');
        
        if (process.env.SUNLINT_DEBUG) {
          console.log(`🔄 [C035] Regex-based analysis: ${violations.length} violations`);
        }
        return violations;
      } catch (error) {
        console.error(`❌ [C035] Regex analysis failed: ${error.message}`);
      }
    }
    
    if (options?.verbose) {
      console.log(`🔧 [C035] No analysis methods succeeded, returning empty`);
    }
    return [];
  }

  async analyzeFileBasic(filePath, options = {}) {
    console.log(`🔧 [C035] analyzeFileBasic() called for: ${filePath}`);
    console.log(`🔧 [C035] semanticEngine exists: ${!!this.semanticEngine}`);
    console.log(`🔧 [C035] symbolAnalyzer exists: ${!!this.symbolAnalyzer}`);
    console.log(`🔧 [C035] regexAnalyzer exists: ${!!this.regexAnalyzer}`);
    
    try {
      // Try symbol-based analysis first
      if (this.semanticEngine?.isSymbolEngineReady?.() && 
          this.semanticEngine.project) {
        
        if (this.verbose) {
          console.log(`🔍 [C035] Using symbol-based analysis for ${filePath}`);
        }
        
        const violations = await this.symbolAnalyzer.analyzeFileBasic(filePath, options);
        return violations;
      }
    } catch (error) {
      if (this.verbose) {
        console.warn(`⚠️ [C035] Symbol analysis failed: ${error.message}`);
      }
    }
    
    // Fallback to regex-based analysis
    if (this.verbose) {
      console.log(`🔄 [C035] Using regex-based analysis (fallback) for ${filePath}`);
    }
    
    console.log(`🔧 [C035] About to call regexAnalyzer.analyzeFileBasic()`);
    try {
      const result = await this.regexAnalyzer.analyzeFileBasic(filePath, options);
      console.log(`🔧 [C035] Regex analyzer returned: ${result.length} violations`);
      return result;
    } catch (error) {
      console.error(`🔧 [C035] Error in regex analyzer:`, error);
      return [];
    }
  }

  /**
   * Methods for compatibility with different engine invocation patterns
   */
  async analyzeFileWithSymbols(filePath, options = {}) {
    return this.analyzeFile(filePath, options);
  }

  async analyzeWithSemantics(filePath, options = {}) {
    return this.analyzeFile(filePath, options);
  }
}

module.exports = C035Analyzer;