Merge branch 'development' of github.com:coldbox-modules/cbdebugger into development

Author: lmajano

ModuleConfig.cfc

@@ -34,18 +34,22 @@ component {
 		variables.settings = {
 			// Internal engine flags
 			engine : {
-				isLucee = server.keyExists( "lucee" ),
-				isBoxLang = server.keyExists( "boxlang" ),
-				isAdobe = server.keyExists( "coldfusion" ) && server.coldfusion.productName.findNoCase( "ColdFusion" )
+				isLucee   : server.keyExists( "lucee" ),
+				isBoxLang : server.keyExists( "boxlang" ),
+				isAdobe   : server.keyExists( "coldfusion" ) && server.coldfusion.productName.findNoCase(
+					"ColdFusion"
+				)
 			},
-
 			// This flag enables/disables the tracking of request data to our storage facilities
 			// To disable all tracking, turn this master key off
 			enabled          : true,
 			// This setting controls if you will activate the debugger for visualizations ONLY
 			// The debugger will still track requests even in non debug mode.
 			debugMode        : controller.getSetting( name = "environment", defaultValue = "production" ) == "development",
 			// The URL password to use to activate it on demand
+			// if set to cb:null, will generate random password
+			// to enable debugger in dev environment set to empty or custom password
+			// in live environment leave cb:null or set your own password
 			debugPassword    : "cb:null",
 			// This flag enables/disables the end of request debugger panel docked to the bottem of the page.
 			// If you disable i, then the only way to visualize the debugger is via the `/cbdebugger` endpoint

box.json

@@ -2,7 +2,7 @@
     "name":"ColdBox Debugger",
     "author":"Ortus Solutions <[email protected]",
     "location":"https://downloads.ortussolutions.com/ortussolutions/coldbox-modules/cbdebugger/@build.version@/[email protected]@.zip",
-    "version":"4.3.0",
+    "version":"4.4.0",
     "slug":"cbdebugger",
     "type":"modules",
     "homepage":"https://github.com/coldbox-modules/cbdebugger",

changelog.md

@@ -9,13 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.3.0] - 2024-06-18
+
 ### Addded
 
 - Lucee 6 Certification
 - BoxLang additions
+- Better information in dev env, if debugger is not accessible
 
 ### Fixed
 
+- CBDEBUGGER-25 - Account for null datasource in QoQ
 - Alias for testing mode in CommandBox 6
 - JVMUtil wrong location for the temp directory for producing heap dumps
 
@@ -45,7 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Dumb whitespace added by CFML engines when doing inline `<pre>#method()#</pre>` calls.
 - Better error handling when Debugger assets are not compiled instead of a cryptic error message:
-    `The parameter [str] to function [closure_m] is required but was not passed in.`
+      `The parameter [str] to function [closure_m] is required but was not passed in.`
 
 ## [4.1.0] - 2023-04-17
 
@@ -297,7 +301,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - <https://ortussolutions.atlassian.net/browse/CCM-25> Lucee support
 - <https://ortussolutions.atlassian.net/browse/CCM-24> Added names of rendered
 - Unloading of helpers on unload
-      views and layouts
+        views and layouts
 - Updated production ignore lists
 
 ## [1.0.1]
@@ -308,7 +312,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Create first module version
 
-[Unreleased]: https://github.com/coldbox-modules/cbdebugger/compare/v4.2.0...HEAD
+[Unreleased]: https://github.com/coldbox-modules/cbdebugger/compare/v4.3.0...HEAD
+
+[4.3.0]: https://github.com/coldbox-modules/cbdebugger/compare/v4.2.0...v4.3.0
 
 [4.2.0]: https://github.com/coldbox-modules/cbdebugger/compare/v4.1.0...v4.2.0
 

handlers/Main.cfc

@@ -30,11 +30,21 @@ component extends="coldbox.system.RestHandler" {
 	 * Debugger disabled event
 	 */
 	function disabled( event, rc, prc ){
+		var data = "Page Not Found";
+
+		if ( getSetting( "environment" ) == "DEVELOPMENT" ) {
+			data = " isDebugCookieValid defined: " & debuggerService.isDebugCookieValid();
+			data &= ", secretKey defined: " & debuggerService.isSecretKeyDefined();
+			data &= ", doesCookieMatchesSecretKey: " & debuggerService.doesCookieMatchesSecretKey();
+
+			data &= ", debugMode: " & debuggerService.getDebugMode();
+		}
+
 		event.renderData(
 			statusCode = 404,
 			statusText = "Not Found",
 			type       = "text",
-			data       = "Page Not Found"
+			data       = data
 		);
 	}
 

models/DebuggerService.cfc

@@ -146,23 +146,34 @@ component
 	 */
 	boolean function getDebugMode(){
 		// If no secretKey has been set, don't allow debug mode
-		if ( not ( len( variables.secretKey ) ) ) {
+		if ( not ( isSecretKeyDefined() ) ) {
 			return false;
 		}
 		// If Cookie exists, it's value is used.
 		if ( isDebugCookieValid() ) {
 			// Must be equal to the current secret key
-			if ( cookie[ variables.cookieName ] == variables.secretKey ) {
-				return true;
-			} else {
-				return false;
-			}
+			return doesCookieMatchesSecretKey()
 		}
 
 		// If there is no cookie, then use default to app setting
 		return variables.debugMode;
 	}
 
+	/**
+	 * returns boolean if secret key is defined
+	 * init() will set secret key
+	 */
+	boolean function isSecretKeyDefined(){
+		return javacast( "Boolean", len( variables.secretKey ) );
+	}
+
+	/**
+	 * checks if cookie matches secret key
+	 */
+	boolean function doesCookieMatchesSecretKey(){
+		return cookie[ variables.cookieName ] == variables.secretKey;
+	}
+
 	/**
 	 * Checks if the debug cookie is a valid cookie. Boolean
 	 */

package-lock.json

@@ -182,7 +182,7 @@
 														#numberFormat( q.endTime - q.startTime )# ms
 													</td>
 													<td align="center">
-														#q.datasource#
+														#( q.datasource ?: "QoQ" )#
 													</td>
 													<td>
 														<cfif q.template.len()>

views/main/panels/requestTracker/acfSqlPanel.cfm

@@ -31,7 +31,7 @@
 				</td>
 
 				<td align="center">
-					#q.datasource#
+					#( q.datasource ?: "QoQ" )#
 				</td>
 
 				<td>

views/main/panels/requestTracker/acfSqlTable.cfm

@@ -197,7 +197,7 @@
 														#numberFormat( q.executionTime / 1000000 )# ms
 													</td>
 													<td align="center">
-														#q.datasource#
+														#( q.datasource ?: "QoQ" )#
 													</td>
 													<td>
 														<cfif q.src.len()>

views/main/panels/requestTracker/luceeSqlPanel.cfm

@@ -30,7 +30,7 @@
 				</td>
 
 				<td align="center">
-					#q.datasource#
+					#( q.datasource ?: "QoQ" )#
 				</td>
 
 				<td>