builder_apm 0.4.2 → 0.5.1

data/app/views/builder_apm/js/_request_details.html.erb

@@ -1,192 +1,396 @@
 <script>
-var request_id = '<%= @request_id %>';
-var request_data = <%= @data.to_json.html_safe %>;
-var current_index = 0;
-
-$(document).ready(function() {
-    prepPage();
-    var request = JSON.parse(request_data);
-    tagQueriesWithNPlusOne(request);
-    const preparedData = flattenData(request.stack);
-
-    $("#details_div").empty()
-    if(request.exception_message) {
-        $("#details_div").append(errorDetails(request));
-    }
-    $("#details_div").append(renderDetails(preparedData));
-});
-
-function prepPage(){
-    $("#details_div").text("Loading Request Now...");
-    $("#options").empty();
-
-    // Create a new checkbox
-    var checkbox = $('<input />', {
-        type: 'checkbox',
-        id: 'chkShowMinorCalls',
-        value: 'showMinorCalls'
-    }).on('change', function() {
-        // Show/hide '.minor_call' elements based on checkbox status
-        if(this.checked) {
-            $('.minor_call').show();
-        } else {
-            $('.minor_call').hide();
+    var request_id = '<%= @request_id %>';
+    var request = JSON.parse(<%= @data.to_json.html_safe %>);
+    var diagnosis = <%= @diagnosis.to_json.html_safe %>;
+    var deeper_diagnosis = <%= @deeper_diagnosis.to_json.html_safe %>;
+    var has_api_key = <%= @has_api_key.to_s %>;
+
+    var current_index = 0;
+
+    $(document).ready(function () {
+        prepPage();
+        tagQueriesWithNPlusOne(request);
+        const preparedData = flattenData(request.stack);
+
+        mainDiv = $("#details_div")
+
+        mainDiv.empty();
+        mainDiv.append(renderRequestSummary(request));
+        if (diagnosis.length > 0) {
+            mainDiv.append(renderRequestDiagnosis(diagnosis));
+        }
+        if (deeper_diagnosis.length > 0) {
+            mainDiv.append(renderDeeperDiagnosis(deeper_diagnosis));
+        }
+
+        if (request.exception_message) {
+            mainDiv.append(errorDetails(request));
         }
-    });
 
-    // Create a label for the checkbox
-    var label = $('<label />', {
-        'for': 'chkShowMinorCalls',
-        text: 'Show Calls with less than 0.1ms duration',
+        mainDiv.append(renderDetails(preparedData));
     });
 
-    // Append the checkbox and label to the div
-    $("#options").append(checkbox).append(label);
-}
-
-function flattenData(stackData, level = 0) {
-    var result = [];
-  
-    stackData.forEach(function(stackItem, level) {
-        var start = new Date(stackItem.start_time);
-        var end = new Date(stackItem.end_time);
-        
-        if(stackItem.sql) {
-            result.push({
-                start: start, 
-                duration: stackItem.duration, 
-                sql: stackItem.sql, 
-                cached: stackItem.cached, 
-                record_count: stackItem.record_count, 
-                triggering_line: stackItem.triggering_line, 
-                params: stackItem.params,
-                level: level,
-                possibleNPlusOne: stackItem.possibleNPlusOne
-            });
-        } else {
-            var children = [];
-            if (stackItem.sql_events && stackItem.sql_events.length > 0) {
-                children = children.concat(flattenData(stackItem.sql_events, level+1));
+    function prepPage() {
+        $("#details_div").text("Loading Request Now...");
+        $("#options").empty();
+
+        // Create a new checkbox
+        var checkbox = $('<input />', {
+            type: 'checkbox',
+            id: 'chkShowMinorCalls',
+            value: 'showMinorCalls'
+        }).on('change', function () { // Show/hide '.minor_call' elements based on checkbox status
+            if (this.checked) {
+                $('.minor_call').show();
+            } else {
+                $('.minor_call').hide();
             }
+        });
+
+        // Create a label for the checkbox
+        var label = $('<label />', {
+            'for': 'chkShowMinorCalls',
+            text: 'Show Calls with less than 0.1ms duration'
+        });
+
+        // Append the checkbox and label to the div
+        $("#options").append(checkbox).append(label);
+    }
+
+    function callTheDoctor() {
+        $('.ai-doctor-button').hide();
+
+        // Show loading message with a simple animated "..." indicator
+        var loaded = false;
+        var dots = 0;
+        var doc_msg = getRandomMessage(wait_4_doc);
+        var loadingInterval = setInterval(function () {
+            $('.status-message').text(doc_msg + '.'.repeat(dots));
+            dots = (dots + 1) % 4;
+        }, 500);
+
+        function fetchDiagnosis() {
+            return $.get('/builder_apm/diagnose_request?request_id=' + request_id);
+        }
 
-            if (stackItem.children && stackItem.children.length > 0) {
-                children = children.concat(flattenData(stackItem.children, level+1));
+
+        Promise.race([fetchDiagnosis()]).then(response => {
+            if (response && response.full_diagnosis) {
+                clearInterval(loadingInterval);
+                renderRequestDiagnosis(response.full_diagnosis).insertAfter('.request-summary');
+                $('.status-message').hide();
+                return;
+            } else {
+                throw new Error("Failed to get valid response.");
             }
-            result.push({
-                start: start, 
-                duration: stackItem.duration, 
-                method: stackItem.method, 
-                method_line: stackItem.method_line, 
-                triggering_line: stackItem.triggering_line, 
-                children: children,
-                level
-            });
+        }).catch(err => {
+            console.error("Error:", err);
+            clearInterval(loadingInterval);
+            $('.ai-doctor-button').show();
+            $('.status-message').text(getRandomMessage(doc_not_in));
+        });
+    }
+
+
+    function getRandomMessage(messages) {
+        let randomIndex = Math.floor(Math.random() * messages.length);
+        return messages[randomIndex];
+    }
+
+    var wait_4_doc = [
+        "The Ai Doctor is on it! Analyzing your data now; please wait a moment.",
+        "Hold tight! The Ai Doctor is checking your stack trace and data.",
+        "Your request is being analyzed by the Ai Doctor. Give it a few minutes.",
+        "Summoning the Ai Doctor to review your input. Sit tight!",
+        "Please be patient. The Ai Doctor is examining your data for any anomalies.",
+        "Analysis in progress! The Ai Doctor is diving deep into your data.",
+        "The Ai Doctor is now on duty! Reviewing the provided details.",
+        "Your data is on the examination table! The Ai Doctor will be with you shortly.",
+        "Sending your information to the Ai Doctor for a thorough check-up. Hang on!",
+        "Ai Doctor is rolling up its sleeves! Your data is being analyzed, please wait.",
+        "The doctor is being called and will review your notes. This may take a couple of mins."
+    ];
+
+    var doc_not_in = [
+        "Oops! The Ai Doctor seems to be offline. Please retry in a bit.",
+        "Sorry, the Ai Doctor is currently out of reach. Give it another shot later.",
+        "Our apologies! The Ai Doctor is taking a short break. Try again shortly.",
+        "It looks like the Ai Doctor is tied up. Please attempt again later.",
+        "Regrettably, the Ai Doctor can't be reached right now. Please come back later.",
+        "Technical hiccup! The Ai Doctor isn't responsive. Kindly retry after some time.",
+        "Brief interruption — the Ai Doctor is momentarily out. Please revisit in a while.",
+        "We're experiencing a glitch. The Ai Doctor isn't on call right now. Please retry later.",
+        "Ai Doctor seems to be in a meeting. Please push the button again later.",
+        "Hold up! The Ai Doctor isn't taking appointments right now. Try after a moment.",
+        "The doctor is unavailable, please try again later"
+    ];
+
+    var no_key_4_doc = [
+        "Ai Doctor is currently inaccessible - API Key hasn't been configured.",
+        "Unable to access Ai Doctor - Missing API Key.",
+        "Ai Doctor can't be reached - Please set up your API Key.",
+        "Error: Ai Doctor is unavailable due to an unset API Key.",
+        "Ai Doctor service is offline - No API Key detected.",
+        "Ai Doctor cannot proceed - API Key configuration required.",
+        "Operation halted: Ai Doctor requires an API Key setup.",
+        "Api Key for Ai Doctor is missing - Service not accessible.",
+        "Ai Doctor is not operational - Ensure your API Key is established.",
+        "Connectivity issue with Ai Doctor - API Key setup needed."
+    ];
+
+    function renderRequestDiagnosis(diagnosis) { // Create the main diagnosis div
+        var diagnosisDiv = $('<div>').addClass('diagnosis-section').html('<h2 class="doc_title">Ai Doctor Analysis</h2><p>' + diagnosis + '</p>');
+
+        // Extract the file and line number from the diagnosis string
+        var parser = new DOMParser();
+        var doc = parser.parseFromString(diagnosis, 'text/html');
+
+        if (deeper_diagnosis.length === 0) {
+            // Add the AiDoctor button
+            // Create the deeper analysis button
+            var deeperAnalysisButton = $("<button>").addClass('deeper-analysis-button').html('<i class="cool-icon"></i> Deeper Analysis');
+            var message_div = $("<div>").addClass('deeper-analaysis-status-message');
+            if (has_api_key) {
+                deeperAnalysisButton.on('click', function () {
+                    deeperAnalysisHandler();
+                });
+            } else {
+                message_div.text(getRandomMessage(no_key_4_doc));
+                deeperAnalysisButton.addClass('disabled');
+            } diagnosisDiv.append(deeperAnalysisButton);
+            diagnosisDiv.append(message_div)
+        } else {
+            diagnosisDiv.find('input[type="checkbox"]').remove();
         }
-    });
 
-    // sort by start_time
-    result.sort((a, b) => a.start - b.start);
-
-    return result;
-}
-function getDurationClass(duration) {
-    if (duration < 500) {
-        return "green-circle";
-    } else if (duration >= 500 && duration < 1000) {
-        return "amber-circle";
-    } else {
-        return "red-circle";
+        return diagnosisDiv;
+    }
+
+    function renderDeeperDiagnosis(diagnosis) { // Create the main diagnosis div
+        var diagnosisDiv = $('<div>').addClass('diagnosis-section').html('<h2 class="doc_title">Ai Doctor Deeper Analysis</h2><p>' + diagnosis + '</p>');
+
+        return diagnosisDiv;
     }
-}
+    // An example handler function for the deeper analysis button click
+    function deeperAnalysisHandler() {
 
-function getFormattedDate(date) {
-    return `${date.toLocaleDateString('en-GB')} ${date.toLocaleTimeString('en-GB', { hour12: false, hour: '2-digit', minute: '2-digit', second: '2-digit' })}`;
-}
+        var selectedCheckboxes = document.querySelectorAll('input[name="deeper_dive_filename"]:checked');
 
-function renderDetails(stackData, level = 0) {
-    return stackData.map((item, index) => {
-        var itemDiv = $("<div>").addClass('bounding-box');
+        var selectedFiles = Array.from(selectedCheckboxes).map(checkbox => checkbox.value);
 
-        var formattedDate = getFormattedDate(item.start);
-        var formattedDuration = parseFloat(parseFloat(item.duration).toFixed(3)) + 'ms';
-        var durationClass = getDurationClass(item.duration);
+        console.log("Deeper analysis for:", selectedFiles);
 
-        var durationSpan = $("<span>").addClass("duration").append(
-            $("<span>").addClass("duration-circle " + durationClass),
-            `${formattedDuration}`
-        );
+        $('.deeper-analysis-button').hide();
 
-        if (item.method) { // If it's a method.
-            if(item.duration < 0.1 && level > 0){
-                itemDiv.addClass('minor_call');
-            }
-            itemDiv.addClass("method")
-                   .append($('<span>').addClass('date').text(formattedDate), durationSpan,
-                            $('<span>').addClass('description').text(item.method),
-                            $('<span>').addClass('method_line').text(item.method_line),
-                            $('<span>').addClass('trigger_line').text(item.triggering_line));
-            
-            if(item.children && item.children.length > 0) {
-                itemDiv.prepend($("<span>").addClass('has_children').text("+"))
-                       .append(
-                          $("<div>").addClass("children")
-                          .append(renderDetails(item.children, level +1))
-                          .hide()  // Hide the children initially
-                        );
-            }
-        } else { // If it's an SQL event.
-            itemDiv.addClass("sql-event")
-                   .append($('<span>').addClass('date').text(formattedDate), durationSpan,
-                            $('<span>').addClass('record_count').text(item.record_count + ' Results'),
-                            $('<span>').addClass('cached').text(item.cached ? 'Cached' : ''),
-                            $('<span>').addClass('n_plus_one').text(item.possibleNPlusOne ? 'Possible N+1' : ''),
-                            $('<span>').addClass('trigger_line').text(item.triggering_line),
-                            $('<span>').addClass('sql').text(item.sql));
-            
-            if(item.possibleNPlusOne) {
-                itemDiv.addClass('possible_n_plus_one');
-            }
-            if(item.params && item.params.length > 0) {
-                itemDiv.append($('<span>').addClass('params').text('Params: ' + item.params));
+        // Show loading message with a simple animated "..." indicator
+        var loaded = false;
+        var dots = 0;
+        var doc_msg = getRandomMessage(wait_4_doc);
+        var loadingInterval = setInterval(function () {
+            $('.deeper-analaysis-status-message').text(doc_msg + '.'.repeat(dots));
+            dots = (dots + 1) % 4;
+        }, 500);
+
+        function fetchDeeperDiagnosis() {
+            return $.post('/builder_apm/deeper_analysis', {
+                request_id: request_id,
+                files: selectedFiles
+            });
+        }
+
+
+        Promise.race([fetchDeeperDiagnosis()]).then(response => {
+            if (response && response.deeper_diagnosis) {
+                clearInterval(loadingInterval);
+                renderDeeperDiagnosis(response.deeper_diagnosis).insertAfter('.diagnosis-section');
+                $('.deeper-analaysis-status-message').hide();
+                return;
+            } else {
+                throw new Error("Failed to get valid response.");
             }
+        }).catch(err => {
+            console.error("Error:", err);
+            clearInterval(loadingInterval);
+            $('.ai-doctor-button').show();
+            $('.deeper-analaysis-status-message').text(getRandomMessage(doc_not_in));
+        });
+    }
+
+
+    function renderRequestSummary(request) {
+        var summaryDiv = $("<div>").addClass('request-summary');
+
+        // Add the details to the summary
+        summaryDiv.append($('<span>').addClass('url').text('URL: ' + request.path));
+        summaryDiv.append($('<span>').addClass('controller').text('Controller: ' + request.controller));
+        summaryDiv.append($('<span>').addClass('duration').text('Duration: ' + formatDuration(request.duration) + 'ms'));
+        summaryDiv.append($('<span>').addClass('db_duration').text('DB Duration: ' + formatDuration(request.db_runtime) + 'ms'));
+        summaryDiv.append($('<span>').addClass('view_duration').text('View Duration: ' + formatDuration(request.view_runtime) + 'ms'));
+        summaryDiv.append($('<span>').addClass('method').text('Method: ' + request.method));
+        summaryDiv.append($('<span>').addClass('params').text('Params: ' + JSON.stringify(request.params)));
+
+        if (diagnosis.length === 0) { // Add the AiDoctor button
+            var aiDoctorButton = $("<button>").addClass('ai-doctor-button').html('<i class="cool-icon"></i> Call AiDoctor');
+            var message_div = $("<div>").addClass('status-message');
+            if (has_api_key) {
+                aiDoctorButton.on('click', callTheDoctor);
+            } else {
+                message_div.text(getRandomMessage(no_key_4_doc));
+                aiDoctorButton.addClass('disabled');
+            } summaryDiv.append(aiDoctorButton);
+            summaryDiv.append(message_div)
         }
-        return itemDiv;
-    });
-}
-
-$(document).on('click', '.bounding-box', function(e) {
-    e.stopPropagation();
-    var toggleElement = $(this).find(".has_children:first");
-    if (toggleElement.length > 0) {
-        if (toggleElement.text() === "+") {
-            toggleElement.text("-");
+        return summaryDiv;
+    }
+
+    function formatDuration(value) {
+        if (isNaN(value)) {
+            return 'N/A'; // or whatever default/failover value you prefer
         } else {
-            toggleElement.text("+");
+            return parseFloat(value).toFixed(3);
         }
-        $(this).find(".children:first").slideToggle();
     }
-});
 
+    function flattenData(stackData, level = 0) {
+        var result = [];
+
+        stackData.forEach(function (stackItem, level) {
+            var start = new Date(stackItem.start_time);
+            var end = new Date(stackItem.end_time);
+
+            if (stackItem.sql) {
+                result.push({
+                    start: start,
+                    duration: stackItem.duration,
+                    sql: stackItem.sql,
+                    cached: stackItem.cached,
+                    record_count: stackItem.record_count,
+                    triggering_line: stackItem.triggering_line,
+                    params: stackItem.params,
+                    level: level,
+                    possibleNPlusOne: stackItem.possibleNPlusOne
+                });
+            } else {
+                var children = [];
+                if (stackItem.sql_events && stackItem.sql_events.length > 0) {
+                    children = children.concat(flattenData(stackItem.sql_events, level + 1));
+                }
 
-function errorDetails(request) {
-    // Create a container for the error details
-    var errorContainer = $('<div>').addClass('error_status');
+                if (stackItem.children && stackItem.children.length > 0) {
+                    children = children.concat(flattenData(stackItem.children, level + 1));
+                }
+                result.push({
+                    start: start,
+                    duration: stackItem.duration,
+                    method: stackItem.method,
+                    method_line: stackItem.method_line,
+                    triggering_line: stackItem.triggering_line,
+                    children: children,
+                    level
+                });
+            }
+        });
 
-    // Create and append elements for the exception class and message
-    var exceptionClassElement = $('<h2>').text(request.exception_class).css('margin', '0');
-    var exceptionMessageElement = $('<p>').text(request.exception_message);
-    errorContainer.append(exceptionClassElement, exceptionMessageElement);
+        // sort by start_time
+        result.sort((a, b) => a.start - b.start);
 
-    // Create and append an element for the backtrace
-    var backtraceElement = $('<ol>');
-    request.exception_backtrace.forEach(function(line) {
-        var lineElement = $('<li>').text(line);
-        backtraceElement.append(lineElement);
+        return result;
+    }
+    function getDurationClass(duration) {
+        if (duration < 500) {
+            return "green-circle";
+        } else if (duration >= 500 && duration < 1000) {
+            return "amber-circle";
+        } else {
+            return "red-circle";
+        }
+    }
+
+    function getFormattedDate(date) {
+        return `${
+            date.toLocaleDateString('en-GB')
+        } ${
+            date.toLocaleTimeString('en-GB', {
+                hour12: false,
+                hour: '2-digit',
+                minute: '2-digit',
+                second: '2-digit'
+            })
+        }`;
+    }
+
+    function renderDetails(stackData, level = 0) {
+        return stackData.map((item, index) => {
+            var itemDiv = $("<div>").addClass('bounding-box');
+
+            var formattedDate = getFormattedDate(item.start);
+            var formattedDuration = parseFloat(parseFloat(item.duration).toFixed(3)) + 'ms';
+            var durationClass = getDurationClass(item.duration);
+
+            var durationSpan = $("<span>").addClass("duration").append($("<span>").addClass("duration-circle " + durationClass), `${formattedDuration}`);
+
+            if (item.method) { // If it's a method.
+                if (item.duration < 0.1 && level > 0) {
+                    itemDiv.addClass('minor_call');
+                }
+                itemDiv.addClass("method").append($('<span>').addClass('date').text(formattedDate), durationSpan, $('<span>').addClass('description').text(item.method), $('<span>').addClass('method_line').text(item.method_line), $('<span>').addClass('trigger_line').text(item.triggering_line));
+
+                if (item.children && item.children.length > 0) {
+                    itemDiv.prepend($("<span>").addClass('has_children').text("+")).append($("<div>").addClass("children").append(renderDetails(item.children, level + 1)).hide() // Hide the children initially
+                    );
+                }
+            } else { // If it's an SQL event.
+                let resultsSpan = $('<span>').addClass('record_count').text(item.record_count + ' Results');
+
+                // Check if results are more than 50
+                if (item.record_count > 50) {
+                    resultsSpan.addClass('highlight-results').attr('title', "This is a large number of results. Review if this can be paginated or limited.");
+                }
+
+                itemDiv.addClass("sql-event").append($('<span>').addClass('date').text(formattedDate), durationSpan, resultsSpan, $('<span>').addClass('cached').text(item.cached ? 'Cached' : ''), $('<span>').addClass('n_plus_one').text(item.possibleNPlusOne ? 'Possible N+1' : ''), $('<span>').addClass('trigger_line').text(item.triggering_line), $('<span>').addClass('sql').text(item.sql));
+
+                if (item.possibleNPlusOne) {
+                    itemDiv.addClass('possible_n_plus_one');
+                }
+                if (item.params && item.params.length > 0) {
+                    itemDiv.append($('<span>').addClass('params').text('Params: ' + item.params));
+                }
+            }
+            return itemDiv;
+        });
+    }
+
+    $(document).on('click', '.bounding-box', function (e) {
+        e.stopPropagation();
+        var toggleElement = $(this).find(".has_children:first");
+        if (toggleElement.length > 0) {
+            if (toggleElement.text() === "+") {
+                toggleElement.text("-");
+            } else {
+                toggleElement.text("+");
+            }
+            $(this).find(".children:first").slideToggle();
+        }
     });
-    errorContainer.append(backtraceElement);
 
-    // Append the error details container to the body of the page
-    return errorContainer;
-}
 
-</script>
+    function errorDetails(request) { // Create a container for the error details
+        var errorContainer = $('<div>').addClass('error_status');
+
+        // Create and append elements for the exception class and message
+        var exceptionClassElement = $('<h2>').text(request.exception_class).css('margin', '0');
+        var exceptionMessageElement = $('<p>').text(request.exception_message);
+        errorContainer.append(exceptionClassElement, exceptionMessageElement);
+
+        // Create and append an element for the backtrace
+        var backtraceElement = $('<ol>');
+        request.exception_backtrace.forEach(function (line) {
+            var lineElement = $('<li>').text(line);
+            backtraceElement.append(lineElement);
+        });
+        errorContainer.append(backtraceElement);
+
+        // Append the error details container to the body of the page
+        return errorContainer;
+    }
+</script>

data/builder_apm.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "redis", "~> 4.5"
   
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) || f == 'README.md'  }
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/config/routes.rb

@@ -9,4 +9,7 @@ BuilderApm::Engine.routes.draw do
     get 'request_analysis', to: 'request_analysis#index'
     get 'n_plus_one', to: 'n_plus_one#index'
 
+    post 'deeper_analysis', to: 'diagnose_request#deeper_analysis', defaults: { format: 'json' }
+    get 'diagnose_request', to: 'diagnose_request#index', defaults: { format: 'json' }
+
 end

data/lib/builder_apm/configuration.rb

@@ -5,6 +5,9 @@ module BuilderApm
     attr_accessor :enable_active_record_profiler
     attr_accessor :enable_methods_profiler
     attr_accessor :enable_n_plus_one_profiler
+    attr_accessor :api_key
+    attr_accessor :api
+    attr_accessor :gems_to_track
 
     def initialize
       @redis_url = 'redis://localhost:6379/0'
@@ -12,6 +15,9 @@ module BuilderApm
       @enable_active_record_profiler = true
       @enable_methods_profiler = true
       @enable_n_plus_one_profiler = true
+      @api_key = nil
+      @api = 'Bravo'
+      @gems_to_track = ["bx_block_"]
     end
   end
 end