Debug Apex With Open Source AI Models and GitHub Actions

name: AI Powered Logs Analyzer

on:
  workflow_dispatch:
    inputs:
      org_alias:
        type: string
        description: "Salesforce org alias"
        required: true
        default: "dev"
      days_back:
        type: number
        description: "Number of days back to retrieve logs"
        required: true
        default: 7
      model_name:
        type: choice
        description: "Ollama model to use"
        options:
          - mistral
          - mistral:instruct
        default: mistral

env:
  ORG_ALIAS: ${{ github.event.inputs.org_alias }}
  DAYS_BACK: ${{ github.event.inputs.days_back }}
  MODEL_NAME: ${{ github.event.inputs.model_name }}
  NODE_VERSION: "20"
  LOG_DIR: "sf-logs"

jobs:
  collect-logs:
    name: Setup Environment & Collect Logs
    runs-on: ubuntu-latest
    outputs:
      log_count: ${{ steps.query.outputs.log_count }}
      has_logs: ${{ steps.query.outputs.has_logs }}
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: ${{ env.NODE_VERSION }}


      - name: Install dependencies
        run: |
          npm install --global @salesforce/cli
          sf plugins:update
          sudo apt-get update && sudo apt-get install -y jq
      
      - name: 🔐 Authenticate to Salesforce Org
        run: |
          echo "${{ secrets.ORG_SFDX_URL }}" | sf org login sfdx-url --alias $ORG_ALIAS --set-default --sfdx-url-stdin
          sf org list

      - name: Query Debug Logs
        id: query
        timeout-minutes: 10
        run: |
          # Calculate start time (UTC)
          START_TIME=$(date -u -d "$DAYS_BACK days ago" '+%Y-%m-%dT%H:%M:%S.000Z')
          echo "🔍 Querying logs since: $START_TIME"
          
          # Create log directory
          mkdir -p "$LOG_DIR"
          
          # Query logs with proper SOQL syntax
          QUERY="SELECT Id, Application, DurationMilliseconds, LogLength, LogUserId, Operation, StartTime, Status \
                   FROM ApexLog \
                  WHERE StartTime >= $START_TIME \
                  ORDER BY StartTime DESC \
                  LIMIT 100"          
          echo "Executing SOQL query..."
          sf data query \
            --query "$QUERY" \
            --target-org "$ORG_ALIAS" \
            --result-format json > logs_query.json
            
          # Extract log information
          log_count=$(jq -r '.result.totalSize' logs_query.json)
          
          if [ "$log_count" -eq 0 ]; then
            echo "⚠️ No logs found in the last $DAYS_BACK days"
            echo "log_count=0" >> $GITHUB_OUTPUT
            echo "has_logs=false" >> $GITHUB_OUTPUT
            echo "No logs found in the last $DAYS_BACK days" > "$LOG_DIR/no-logs-found.txt"
          else
            echo "📊 Found $log_count debug logs"
            echo "log_count=$log_count" >> $GITHUB_OUTPUT
            echo "has_logs=true" >> $GITHUB_OUTPUT
            
            # Save log metadata
            jq '.result.records[] | {Id, Application, DurationMilliseconds, LogLength, Operation, StartTime, Status}' \
              logs_query.json > "$LOG_DIR/log_metadata.json"
          fi

      - name: Download Log Contents
        if: steps.query.outputs.has_logs == 'true'
        timeout-minutes: 45
        run: |
          echo "📥 Downloading log contents..."
          
          # Extract log IDs
          log_ids=$(jq -r '.result.records[].Id' logs_query.json)
          total_logs=$(echo "$log_ids" | wc -l)
          current=0
          
          echo "Starting download of $total_logs logs..."

          # Download logs with progress tracking using `sf apex log get`
          downloaded_count=0
          for logid in $log_ids; do
            current=$((current + 1))
            echo "[$current/$total_logs] Attempting to download log: $logid"
          
            log_file="$LOG_DIR/$logid.log"
            tmp_error=$(mktemp)
          
            # Run and redirect stdout to log, stderr to temp error
            if sf apex log get --log-id "$logid" --target-org "$ORG_ALIAS" > "$log_file" 2> "$tmp_error"; then
              if [ -s "$log_file" ]; then
                echo "✅ Successfully downloaded $logid"
                downloaded_count=$((downloaded_count + 1))
              else
                echo "⚠️ Log $logid is empty (0 bytes)"
                echo "$logid (empty content)" >> "$LOG_DIR/failed_downloads.txt"
                rm -f "$log_file"  # Optional: delete empty log files
              fi
            else
              echo "❌ Failed to download log $logid"
              echo "$logid" >> "$LOG_DIR/failed_downloads.txt"
              if [ -s "$tmp_error" ]; then
                echo "🔍 Error details for $logid:"
                cat "$tmp_error"
                # Optional: Save the error only if non-empty
                cp "$tmp_error" "$LOG_DIR/errors_$logid.txt"
              else
                echo "⚠️ No error output for $logid"
              fi
            fi
          
            rm -f "$tmp_error"
            sleep 0.5
          done
          
          # Count successful downloads
          downloaded_count=$(find "$LOG_DIR" -name "*.log" | wc -l)
          echo "✅ Successfully downloaded $downloaded_count out of $total_logs logs"
          
      - name: Upload Log Artifacts
        uses: actions/upload-artifact@v4
        with:
          name: salesforce-debug-logs
          path: ${{ env.LOG_DIR }}
          retention-days: 7
          if-no-files-found: warn

      - name: 📄 Summary of Collected Logs
        run: |
          {
            echo "## 📊 Collect Logs Summary" 
            echo "- Org Alias: **$ORG_ALIAS**" 
            echo "- Days Back: **$DAYS_BACK**"
            echo "- Logs Found: **${{ steps.query.outputs.log_count }}**" 
            if [ "${{ steps.query.outputs.has_logs }}" = "true" ]; then
              downloaded=$(find "$LOG_DIR" -name "*.log" | wc -l)
              echo "- Logs Downloaded: **$downloaded**" 
              echo "- Artifact: \`salesforce-debug-logs\`"
            else
              echo "- No logs found in specified period"
            fi
          } >> $GITHUB_STEP_SUMMARY
          
  analyze-logs:
    name: Analyze Logs with Ollama
    runs-on: ubuntu-latest
    needs: collect-logs
    if: needs.collect-logs.outputs.has_logs == 'true'
    steps:
      - name: Download Log Artifacts
        uses: actions/download-artifact@v4
        with:
          name: salesforce-debug-logs
          path: logs

      - name: Install Ollama
        run: |
          echo "🚀 Installing Ollama..."
          curl -fsSL https://ollama.com/install.sh | sh
          ollama serve &
          for i in {1..30}; do
            if curl -s http://localhost:11434/api/version > /dev/null; then
              break
            fi
            sleep 2
          done

      - name: Download Model
        timeout-minutes: 30
        run: |
          MODEL="${{ inputs.MODEL_NAME }}"
          echo "Downloading Ollama model: $MODEL"
          ollama pull "$MODEL"
          
          echo "🔍 Verifying model installation..."
          ollama list


      - name: Analyze logs in batches
        run: |
          REPORT_FILE="analysis_report.md"
          BATCH_SIZE=5
          MODEL="${{ inputs.model_name }}"
      
          # Initialize report
          echo "# AI Log Analysis Report" > "$REPORT_FILE"
          echo "Model used: $MODEL" >> "$REPORT_FILE"
          echo "" >> "$REPORT_FILE"
      
          # Function to generate AI prompt
          generate_prompt() {
            local combined_logs="$1"
            cat <<EOF
            You are a Salesforce Debug Log analyzer. 
            Read the following Apex debug logs (multiple) and produce a **short structured report** in markdown.
            
            **Rules:**
            - Use ONLY the information present in the logs. Do not speculate.
            - NO Java, pseudo-code, or unrelated language examples.
            - NO generic Salesforce explanations.
            - Output must be under 500 words.
            
            **Output Format (Markdown table):**
            | Category | Findings |
            |----------|----------|
            | Problems & Errors | Bullet points of exceptions, failed DML, missing data, etc. |
            | Latency Sources | Bullet points with operation names and durations in ms (if available) |
            | Governor Limit Usage | Bullet points showing limit name, used/total, and % |
            | Code Anti-Patterns | Bullet points identifying inefficient patterns like SOQL/DML in loops, inefficient queries, etc. |
            
            **Additional:**
              - Sort each section by severity/impact.
              - For governor limits, only list limits above 50% usage or breached.
              - For anti-patterns, flag:
                - SOQL queries inside 'for' loops
                - DML operations inside loops
                - Large collections without bulk handling
                - Use of deprecated methods
              - Indicate which log file each finding came from in parentheses.

            Logs:
            $combined_logs
          EOF
          }      
          # Process logs in batches
          batch=()
          for file in logs/*.log; do
            batch+=("$file")
      
            # If batch is full, process it
            if [[ ${#batch[@]} -eq $BATCH_SIZE ]]; then
              combined=$(cat "${batch[@]}")
              echo "## Batch starting with ${batch[0]}" >> "$REPORT_FILE"
      
              prompt="$(generate_prompt "$combined")"
              ollama run "$MODEL" "$prompt" >> "$REPORT_FILE"
              echo -e "\n---\n" >> "$REPORT_FILE"
      
              # Reset batch
              batch=()
            fi
          done
      
          # Process final incomplete batch
          if [[ ${#batch[@]} -gt 0 ]]; then
            combined=$(cat "${batch[@]}")
            echo "## Final Batch starting with ${batch[0]}" >> "$REPORT_FILE"
      
            prompt="$(generate_prompt "$combined")"
            ollama run "$MODEL" "$prompt" >> "$REPORT_FILE"
            echo -e "\n---\n" >> "$REPORT_FILE"
          fi
          
      - name: Upload Analysis Report
        uses: actions/upload-artifact@v4
        with:
          name: salesforce-log-analysis
          path: analysis_report.md
          retention-days: 7

      - name: 📄 Summary of Analysis
        env:
          MODEL: ${{ inputs.model_name }}
        run: |
          {
            echo "## 🧠 Analysis Summary"
            total_logs=$(ls logs/*.log 2>/dev/null | wc -l || echo 0)
            echo "- Logs Analyzed: **$total_logs**" 
            echo "- Model: \`$MODEL\`"
            echo "- Report File: \`analysis_report.md\` (saved as artifact \`salesforce-log-analysis\`)" 
          } >> $GITHUB_STEP_SUMMARY