WIP: fix client log links in test report/ui

Author: danceratopz

cmd/hiveview/assets/lib/app-suite.js

@@ -197,11 +197,12 @@ function showSuiteData(data, suiteID) {
             {
                 title: 'Logs',
                 name: 'logs',
-                data: 'clientInfo',
+                data: null, // Use null to allow access to the full row data
                 width: '20%',
                 responsivePriority: 1,
-                render: function (clientInfo, type, row) {
-                    return formatClientLogsList(data, row.testIndex, clientInfo);
+                render: function (_, type, row) {
+                    // Pass both clientInfo and the row data to allow showing logs even if clientInfo is null
+                    return formatClientLogsList(data, row.testIndex, row.clientInfo);
                 }
             },
         ],
@@ -317,21 +318,112 @@ function deselectTest(row, closeDetails) {
     history.replaceState(null, null, '#');
 }
 
-function testHasClients(testData) {
-    return testData.clientInfo && Object.getOwnPropertyNames(testData.clientInfo).length > 0;
+function testHasClients(testData, suiteData) {
+    // Check if the test has any associated clients directly
+    if (testData.clientInfo && Object.getOwnPropertyNames(testData.clientInfo).length > 0) {
+        return true;
+    }
+
+    // Check for clientLogs in the test result (indicates shared client usage)
+    if (testData.summaryResult && testData.summaryResult.clientLogs) {
+        return Object.getOwnPropertyNames(testData.summaryResult.clientLogs).length > 0;
+    }
+
+    // Check for shared clients at the suite level
+    if (suiteData && suiteData.sharedClients && Object.getOwnPropertyNames(suiteData.sharedClients).length > 0) {
+        return true;
+    }
+
+    return false;
 }
 
 // formatClientLogsList turns the clientInfo part of a test into a list of links.
 function formatClientLogsList(suiteData, testIndex, clientInfo) {
     let links = [];
-    for (let instanceID in clientInfo) {
-        let instanceInfo = clientInfo[instanceID];
-        let logfile = routes.resultsRoot + instanceInfo.logFile;
-        let url = routes.clientLog(suiteData.suiteID, suiteData.name, testIndex, logfile);
-        let link = html.makeLink(url, instanceInfo.name);
-        link.classList.add('log-link');
-        links.push(link.outerHTML);
+    let testData = suiteData.testCases[testIndex];
+
+    // Process regular clients from clientInfo
+    if (clientInfo) {
+        for (let instanceID in clientInfo) {
+            let instanceInfo = clientInfo[instanceID];
+            if (instanceInfo.logFile) {
+                // For regular (non-shared) clients or for shared clients with client segments,
+                // we use the logFile directly from clientInfo - this should point to either
+                // the full log file or to the extracted segment file in shared_clients/
+                let logfile = routes.resultsRoot + instanceInfo.logFile;
+                let url = routes.clientLog(suiteData.suiteID, suiteData.name, testIndex, logfile);
+
+                // Add (shared) indicator to shared client names
+                let name = instanceInfo.name;
+                if (instanceInfo.isShared || instanceInfo.logFile.includes('shared_clients/')) {
+                    name += ' (shared)';
+                }
+
+                let link = html.makeLink(url, name);
+                link.classList.add('log-link');
+                if (instanceInfo.isShared || instanceInfo.logFile.includes('shared_clients/')) {
+                    link.classList.add('shared-client-link');
+                }
+                links.push(link.outerHTML);
+            }
+        }
     }
+
+    // Check for shared client log segments
+    if (testData && testData.summaryResult && testData.summaryResult.clientLogs) {
+        for (let clientID in testData.summaryResult.clientLogs) {
+            // Skip if we already have a log link for this client
+            let alreadyHasLink = false;
+            if (clientInfo) {
+                for (let instanceID in clientInfo) {
+                    if (instanceID === clientID) {
+                        alreadyHasLink = true;
+                        break;
+                    }
+                }
+            }
+            if (alreadyHasLink) continue;
+
+            // Find the shared client in the suite
+            if (suiteData.sharedClients && suiteData.sharedClients[clientID]) {
+                let sharedClient = suiteData.sharedClients[clientID];
+
+                // Look for the log segment file in the shared_clients directory
+                // The pattern is: shared_clients/timestamp-clientName-clientID-testIndex.log
+                let dirPath = 'shared_clients/';
+                let pattern = `-${sharedClient.name}-${clientID}-test${testIndex}.log`;
+
+                // We would ideally search for matching files here, but since we can't
+                // we'll just list the available client, linking to its original logfile
+                // When clicking, the UI should dynamically try to locate the correct segment
+                // We need to look for the segment file in the shared_clients directory
+                // The pattern is now: shared_clients/timestamp-clientName-clientID-testIndex.log
+                // But we can't search for it directly here, so we'll use the pattern to construct
+                // a best guess of the filename based on our updated naming convention
+                let logfile = routes.resultsRoot + sharedClient.logFile;
+                let url = routes.clientLog(suiteData.suiteID, suiteData.name, testIndex, logfile);
+                let link = html.makeLink(url, sharedClient.name + ' (shared)');
+                link.classList.add('log-link');
+                link.classList.add('shared-client-link');
+                links.push(link.outerHTML);
+            }
+        }
+    }
+
+    // If we still don't have any links but there are shared clients in the suite,
+    // add links to the shared clients
+    if (links.length === 0 && suiteData.sharedClients) {
+        for (let instanceID in suiteData.sharedClients) {
+            let instanceInfo = suiteData.sharedClients[instanceID];
+            let logfile = routes.resultsRoot + instanceInfo.logFile;
+            let url = routes.clientLog(suiteData.suiteID, suiteData.name, testIndex, logfile);
+            let link = html.makeLink(url, instanceInfo.name + ' (shared)');
+            link.classList.add('log-link');
+            link.classList.add('shared-client-link');
+            links.push(link.outerHTML);
+        }
+    }
+
     return links.join(', ');
 }
 
@@ -360,7 +452,7 @@ function formatTestDetails(suiteData, row) {
         p.innerHTML = formatTestStatus(d.summaryResult);
         container.appendChild(p);
     }
-    if (!row.column('logs:name').responsiveHidden() && testHasClients(d)) {
+    if (!row.column('logs:name').responsiveHidden() && testHasClients(d, suiteData)) {
         let p = document.createElement('p');
         p.innerHTML = '<b>Clients:</b> ' + formatClientLogsList(suiteData, d.testIndex, d.clientInfo);
         container.appendChild(p);
@@ -480,6 +572,33 @@ function formatTestLog(suiteData, testIndex, logData, container) {
     }
 
     container.appendChild(output);
+
+    // Show client log segments if available
+    if (d.summaryResult.clientLogs && Object.keys(d.summaryResult.clientLogs).length > 0) {
+        let p = document.createElement('p');
+        p.innerHTML = '<b>Client Log Segments:</b>';
+        container.appendChild(p);
+
+        let logSegmentsDiv = document.createElement('div');
+        logSegmentsDiv.classList.add('client-log-segments');
+
+        for (let clientID in d.summaryResult.clientLogs) {
+            let segment = d.summaryResult.clientLogs[clientID];
+            let clientName = clientID;
+
+            // Try to find a friendly name for the client
+            if (suiteData.sharedClients && suiteData.sharedClients[clientID]) {
+                clientName = suiteData.sharedClients[clientID].name || clientID;
+            }
+
+            let segmentInfo = document.createElement('div');
+            segmentInfo.classList.add('client-log-segment');
+            segmentInfo.innerHTML = `<b>${clientName}:</b> Lines ${segment.start} to ${segment.end}`;
+            logSegmentsDiv.appendChild(segmentInfo);
+        }
+
+        container.appendChild(logSegmentsDiv);
+    }
 }
 
 function formatTestDetailLines(lines) {

cmd/hiveview/assets/lib/app-viewer.js

@@ -33,13 +33,16 @@ $(document).ready(function () {
             showError('Invalid parameters! Missing \'suitefile\' or \'testid\' in URL.');
             return;
         }
-        fetchTestLog(routes.resultsRoot + suiteFile, testIndex, line);
+        // Pass clientID parameter if available (for shared client logs)
+        let clientID = queryParam('clientid');
+        fetchTestLog(routes.resultsRoot + suiteFile, testIndex, line, clientID);
         return;
     }
 
     // Check for file name.
     let file = queryParam('file');
     if (file) {
+        // Show the file directly - either a regular client log or a segment file
         $('#fileload').val(file);
         showText('Loading file...');
         fetchFile(file, line);
@@ -78,10 +81,10 @@ function setHL(num, scroll) {
 function showLinkBack(suiteID, suiteName, testID) {
     var text, url;
     if (testID) {
-        text = 'Back to test ' + testID + ' in suite ‘' + suiteName + '’';
+        text = 'Back to test ' + testID + ' in suite \'' + suiteName + '\'';
         url = routes.testInSuite(suiteID, suiteName, testID);
     } else {
-        text = 'Back to test suite ‘' + suiteName + '’';
+        text = 'Back to test suite \'' + suiteName + '\'';
         url = routes.suite(suiteID, suiteName);
     }
     $('#link-back').html(makeLink(url, text));
@@ -185,7 +188,7 @@ async function fetchFile(url, line /* optional jump to line */ ) {
 }
 
 // fetchTestLog loads the suite file and displays the output of a test.
-async function fetchTestLog(suiteFile, testIndex, line) {
+async function fetchTestLog(suiteFile, testIndex, line, clientID) {
     let data;
     try {
         data = await load(suiteFile, 'json');
@@ -201,6 +204,8 @@ async function fetchTestLog(suiteFile, testIndex, line) {
     let test = data.testCases[testIndex];
     let name = test.name;
     let logtext;
+
+    // First check for regular test output
     if (test.summaryResult.details) {
         logtext = test.summaryResult.details;
     } else if (test.summaryResult.log) {
@@ -216,9 +221,73 @@ async function fetchTestLog(suiteFile, testIndex, line) {
             showError('Loading test log failed.', err);
             return;
         }
+    }
+    // Check for client logs
+    else if (test.summaryResult.clientLogs) {
+        // Use clientID passed to the function or from the URL parameters
+        clientID = clientID || queryParam('clientid');
+        if (clientID && test.summaryResult.clientLogs[clientID]) {
+            // Get the client log segment
+            let segment = test.summaryResult.clientLogs[clientID];
+
+            // Look for shared client info
+            let clientInfo;
+            if (test.clientInfo && test.clientInfo[clientID]) {
+                clientInfo = test.clientInfo[clientID];
+            } else if (data.sharedClients && data.sharedClients[clientID]) {
+                clientInfo = data.sharedClients[clientID];
+            }
+
+            if (clientInfo && clientInfo.logFile) {
+                try {
+                    // Load the full client log file
+                    let url = routes.resultsRoot + clientInfo.logFile;
+                    showRawLink(url, 'raw client log');
+
+                    // Load the entire file and extract the segment
+                    let fullLog = await load(url, 'text');
+
+                    // Extract the segment based on byte offsets
+                    logtext = fullLog.substring(segment.start, segment.end);
+
+                    // Add header to indicate this is a segment
+                    logtext = `--- Shared client log segment for ${clientInfo.name} (test ${testIndex}) ---\n` +
+                              `--- From position ${segment.start} to ${segment.end} ---\n\n` +
+                              logtext;
+                } catch(err) {
+                    showError('Loading client log segment failed.', err);
+                    return;
+                }
+            } else {
+                showError('Client information not found for: ' + clientID);
+                return;
+            }
+        } else {
+            // If clientID wasn't specified but clientLogs exist, show a list of available logs
+            logtext = "This test used shared clients. Please select a client log to view:\n\n";
+
+            for (let id in test.summaryResult.clientLogs) {
+                let clientName = id;
+                if (data.sharedClients && data.sharedClients[id]) {
+                    clientName = data.sharedClients[id].name || id;
+                } else if (test.clientInfo && test.clientInfo[id]) {
+                    clientName = test.clientInfo[id].name || id;
+                }
+
+                logtext += `Client: ${clientName} (${id})\n`;
+
+                // Create a URL to view this specific client's log
+                let params = new URLSearchParams(window.location.search);
+                params.set('clientid', id);
+                let clientLogUrl = window.location.pathname + '?' + params.toString();
+                logtext += `View log: ${clientLogUrl}\n\n`;
+            }
+        }
     } else {
         showError('test has no details/log');
+        return;
     }
+
     showTitle('Test:', name);
     showText(logtext);
     setHL(line, true);
@@ -243,4 +312,4 @@ Prism.languages.log = {
     'boolean': /\b(?:true|false)\b/,
     'ip': /\b\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}\b/,
     'important': /\[[A-Z]+\]/
-};
+};

cmd/hiveview/assets/lib/app.css

@@ -254,6 +254,26 @@ td.ellipsis {
     font-weight: bold;
 }
 
+/* Styles for shared client links */
+.shared-client-link {
+    font-style: italic;
+    color: var(--bs-primary);
+}
+
+/* Styles for client log segments */
+.client-log-segments {
+    margin-top: 0.5rem;
+    padding-left: 1rem;
+}
+
+.client-log-segment {
+    margin-bottom: 0.5rem;
+    padding: 0.3rem 0.5rem;
+    background: var(--bs-dark-bg-subtle);
+    border-radius: 4px;
+    font-size: 0.9em;
+}
+
 .dataTable tr {
     scroll-margin: 8em 0 0 0;
 }

cmd/hiveview/assets/lib/routes.js

@@ -20,13 +20,19 @@ export function testLog(suiteID, suiteName, testIndex) {
     return 'viewer.html?' + params.toString();
 }
 
-export function clientLog(suiteID, suiteName, testIndex, file) {
+export function clientLog(suiteID, suiteName, testIndex, file, clientID) {
     let params = new URLSearchParams({
         'suiteid': suiteID,
         'suitename': suiteName,
         'testid': testIndex,
         'file': file,
     });
+
+    // If clientID is provided, add it to parameters for shared client logs
+    if (clientID) {
+        params.append('clientid', clientID);
+    }
+
     return 'viewer.html?' + params.toString();
 }