v4.0 Release

Author: lmajano

.github/workflows/ci.yml

@@ -44,10 +44,9 @@ jobs:
           node-version: 12.x
 
       - name: Setup CommandBox
-        uses: Ortus-Solutions/setup-commandbox@main
+        uses: Ortus-Solutions/setup-commandbox@v2.0.1
         with:
           forgeboxAPIKey: ${{ secrets.FORGEBOX_TOKEN }}
-          version: 5.4.2
 
       - name: Setup Environment Variables For Build Process
         id: current_version

.github/workflows/pr.yml

@@ -1,13 +1,18 @@
 name: Pull Requests
 
 on:
+  push:
+    branches-ignore:
+      - "main"
+      - "master"
+      - "development"
   pull_request:
     branches:
       - development
 
 jobs:
   tests:
-    uses: coldbox-modules/cbdebugger/.github/workflows/tests.yml@development
+    uses: ./.github/workflows/tests.yml
 
   # Format PR
   format:

.github/workflows/tests.yml

@@ -5,7 +5,7 @@ on:
   workflow_call:
     secrets:
       SLACK_WEBHOOK_URL:
-        required: true
+        required: false
 
 jobs:
   tests:
@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        cfengine: [ "lucee@5", "adobe@2016", "adobe@2018", "adobe@2021" ]
+        cfengine: [ "lucee@5", "adobe@2018", "adobe@2021" ]
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v2
@@ -50,9 +50,7 @@ jobs:
           printf "DB_BUNDLENAME=com.mysql.cj\n" >> .env
 
       - name: Setup CommandBox CLI
-        uses: Ortus-Solutions/setup-commandbox@main
-        with:
-          version: 5.4.2
+        uses: Ortus-Solutions/[email protected]
 
       - name: Install Dependencies
         run: |
@@ -62,10 +60,6 @@ jobs:
       - name: Start ${{ matrix.cfengine }} Server
         run: |
           box server start serverConfigFile="server-${{ matrix.cfengine }}.json" --noSaveSettings --debug
-          # Install Adobe 2021 cfpm modules
-          if [[ "${{ matrix.cfengine }}" == "adobe@2021" ]] ; then
-            box run-script install:2021
-          fi
           curl http://127.0.0.1:60299
 
       - name: Run Tests

ModuleConfig.cfc

@@ -7,7 +7,7 @@ component {
 
 	// Module Properties
 	this.title              = "ColdBox Debugger";
-	this.author             = "Curt Gratz - Ortus Solutions";
+	this.author             = "Ortus Solutions";
 	this.version            = "@build.version@[email protected]@";
 	this.webURL             = "https://www.ortussolutions.com";
 	this.description        = "The ColdBox Debugger Module";
@@ -45,8 +45,8 @@ component {
 			requestPanelDock : true,
 			// Request Tracker Options
 			requestTracker   : {
-				// Store the request profilers in heap memory or in cachebox, default is cachebox
-				storage                      : "cachebox",
+				// Store the request profilers in heap memory or in cachebox, default is memory
+				storage                      : "memory",
 				// Which cache region to store the profilers in
 				cacheName                    : "template",
 				// Track all cbdebugger events, by default this is off, turn on, when actually profiling yourself :) How Meta!
@@ -140,6 +140,10 @@ component {
 				"beforeProfilerReportPanels",
 				// After any individual profiler report panels are rendered
 				"afterProfilerReportPanels",
+				// Fires after the module has fully loaded and been configured with all runtime settings
+				"onDebuggerLoad",
+				// Fires after the module is unloaded
+				"onDebuggerUnload",
 				// When the request tracker has been created and placed in request scope
 				"onDebuggerRequestTrackerCreation",
 				// Before the request tracker is saved in the profiler, last chance to influence the recording
@@ -161,16 +165,16 @@ component {
 	function onLoad(){
 		// Only activate interceptions and collectors if master switch is on or in test mode disable it
 		if ( variables.settings.enabled ) {
+			var interceptorService = controller.getInterceptorService();
+
 			/******************** REQUEST COLLECTOR ************************************/
 
-			controller
-				.getInterceptorService()
-				.registerInterceptor(
-					interceptorClass = "#moduleMapping#.interceptors.RequestCollector",
-					interceptorName  = "RequestCollector@cbdebugger"
-				);
+			interceptorService.registerInterceptor(
+				interceptorClass = "#moduleMapping#.interceptors.RequestCollector",
+				interceptorName  = "RequestCollector@cbdebugger"
+			);
 
-			/******************** PROFILE OBJECTS ************************************/
+			/******************** OBJECT PROFILING ************************************/
 
 			if ( variables.settings.requestTracker.profileObjects ) {
 				// Object Profiler Aspect
@@ -192,6 +196,15 @@ component {
 				);
 			}
 
+			/******************** WIREBOX COLLECTOR ************************************/
+
+			if ( variables.settings.requestTracker.profileWireBoxObjectCreation ) {
+				interceptorService.registerInterceptor(
+					interceptorClass = "#moduleMapping#.interceptors.WireBoxCollector",
+					interceptorName  = "WireBoxCollector@cbdebugger"
+				);
+			}
+
 			/******************** PROFILE INTERCEPTIONS ************************************/
 
 			if ( variables.settings.requestTracker.profileInterceptions ) {
@@ -223,51 +236,43 @@ component {
 			/******************** QB COLLECTOR ************************************/
 
 			if ( variables.settings.qb.enabled && controller.getModuleService().isModuleRegistered( "qb" ) ) {
-				controller
-					.getInterceptorService()
-					.registerInterceptor(
-						interceptorClass = "#moduleMapping#.interceptors.QBCollector",
-						interceptorName  = "QBCollector@cbdebugger"
-					);
+				interceptorService.registerInterceptor(
+					interceptorClass = "#moduleMapping#.interceptors.QBCollector",
+					interceptorName  = "QBCollector@cbdebugger"
+				);
 			}
 
 			/******************** QUICK COLLECTOR ************************************/
 
 			if ( variables.settings.qb.enabled && controller.getModuleService().isModuleRegistered( "quick" ) ) {
-				controller
-					.getInterceptorService()
-					.registerInterceptor(
-						interceptorClass = "#moduleMapping#.interceptors.QuickCollector",
-						interceptorName  = "QuickCollector@cbdebugger"
-					);
+				interceptorService.registerInterceptor(
+					interceptorClass = "#moduleMapping#.interceptors.QuickCollector",
+					interceptorName  = "QuickCollector@cbdebugger"
+				);
 			}
 
 			/******************** CBORM COLLECTOR ************************************/
 
 			if ( variables.settings.cborm.enabled && controller.getModuleService().isModuleRegistered( "cborm" ) ) {
-				controller
-					.getInterceptorService()
-					.registerInterceptor(
-						interceptorClass = "#moduleMapping#.interceptors.CBOrmCollector",
-						interceptorName  = "CBOrmCollector@cbdebugger"
-					);
+				interceptorService.registerInterceptor(
+					interceptorClass = "#moduleMapping#.interceptors.CBOrmCollector",
+					interceptorName  = "CBOrmCollector@cbdebugger"
+				);
 			}
 
 			/******************** ACFSQL COLLECTOR ************************************/
 
-			// Do not load on lucee or ACF 2016
-			if (
-				variables.settings.acfSql.enabled && !server.keyExists( "lucee" ) && server.coldfusion.productVersion.listFirst() gt "2016"
-			) {
-				controller
-					.getInterceptorService()
-					.registerInterceptor(
-						interceptorClass = "#moduleMapping#.interceptors.ACFSqlCollector",
-						interceptorName  = "ACFSqlCollector@cbdebugger"
-					);
+			if ( variables.settings.acfSql.enabled && !server.keyExists( "lucee" ) ) {
+				interceptorService.registerInterceptor(
+					interceptorClass = "#moduleMapping#.interceptors.ACFSqlCollector",
+					interceptorName  = "ACFSqlCollector@cbdebugger"
+				);
 			} else {
 				variables.settings.acfSql.enabled = false;
 			}
+
+			// Announce debugger loaded
+			interceptorService.announce( "onDebuggerLoad" );
 		}
 		// end master switch
 	}
@@ -278,11 +283,15 @@ component {
 	function onUnload(){
 		// Only if we are enabled
 		if ( variables.settings.enabled ) {
-			controller.getInterceptorService().unregister( "RequestCollector@cbdebugger" );
-			controller.getInterceptorService().unregister( "QBCollector@cbdebugger" );
-			controller.getInterceptorService().unregister( "QuickCollector@cbdebugger" );
-			controller.getInterceptorService().unregister( "CBOrmCollector@cbdebugger" );
-			controller.getInterceptorService().unregister( "ACFSqlCollector@cbdebugger" );
+			var interceptorService = controller.getInterceptorService();
+
+			interceptorService.announce( "onDebuggerUnload" );
+			interceptorService.unregister( "RequestCollector@cbdebugger" );
+			interceptorService.unregister( "WireBoxCollector@cbdebugger" );
+			interceptorService.unregister( "QBCollector@cbdebugger" );
+			interceptorService.unregister( "QuickCollector@cbdebugger" );
+			interceptorService.unregister( "CBOrmCollector@cbdebugger" );
+			interceptorService.unregister( "ACFSqlCollector@cbdebugger" );
 		}
 	}
 

aspects/InterceptorProfiler.cfc

@@ -13,10 +13,7 @@ component implements="coldbox.system.aop.MethodInterceptor" accessors="true" {
 	/**
 	 * Constructor
 	 */
-	function init(
-		required excludedInterceptions,
-		required includedInterceptions
-	){
+	function init( required excludedInterceptions, required includedInterceptions ){
 		variables.excludedInterceptions = arguments.excludedInterceptions;
 		variables.includedInterceptions = arguments.includedInterceptions;
 		return this;
@@ -26,9 +23,8 @@ component implements="coldbox.system.aop.MethodInterceptor" accessors="true" {
 	 * The AOP method invocation
 	 */
 	any function invokeMethod( required invocation ){
-
 		// Quick exit check: If no included interceptions, just bail
-		if( !arrayLen( variables.includedInterceptions ) ){
+		if ( !arrayLen( variables.includedInterceptions ) ) {
 			return arguments.invocation.proceed();
 		}
 
@@ -44,10 +40,7 @@ component implements="coldbox.system.aop.MethodInterceptor" accessors="true" {
 
 		// Do we need to profile it or not?
 		if (
-			arrayContainsNoCase(
-				variables.excludedInterceptions,
-				state
-			) && !arrayContainsNoCase(
+			arrayContainsNoCase( variables.excludedInterceptions, state ) && !arrayContainsNoCase(
 				variables.includedInterceptions,
 				state
 			)
@@ -66,16 +59,16 @@ component implements="coldbox.system.aop.MethodInterceptor" accessors="true" {
 		}
 
 		// Is this an entity interception? If so, log it to assist
-		if( data.keyExists( "entity" ) ){
-			txName &= "( #getEntityName( data )# )";
+		if ( data.keyExists( "entity" ) ) {
+			txName &= "( #getEntityName( data )# ) @ #getTickCount()#";
 		}
 
 		// create FR tx with method name
-		var labelHash = variables.timerService.start( txName );
+		variables.timerService.start( label: txName, type: "interceptor" );
 		// proceed invocation
-		var results   = arguments.invocation.proceed();
+		var results = arguments.invocation.proceed();
 		// close tx
-		variables.timerService.stop( labelhash );
+		variables.timerService.stop( txName );
 		// return results
 		if ( !isNull( results ) ) {
 			return results;
@@ -87,12 +80,12 @@ component implements="coldbox.system.aop.MethodInterceptor" accessors="true" {
 	 */
 	private string function getEntityName( required data ){
 		// If passed, just relay it back
-		if( arguments.data.keyExists( "entityName" ) ){
+		if ( arguments.data.keyExists( "entityName" ) ) {
 			return arguments.data.entityName;
 		}
 
 		// Check if we have a quick entity
-		if( structKeyExists( arguments.data.entity, "mappingName" ) ){
+		if ( structKeyExists( arguments.data.entity, "mappingName" ) ) {
 			return arguments.data.entity.mappingName();
 		}
 

aspects/ObjectProfiler.cfc

@@ -24,7 +24,8 @@ component implements="coldbox.system.aop.MethodInterceptor" accessors="true" {
 	 */
 	any function invokeMethod( required invocation ) output=false{
 		// default tx name
-		var txName = "[Object Profiler] #arguments.invocation.getTargetName()#.#arguments.invocation.getMethod()#()";
+		var txName        = "[Object Profiler] #arguments.invocation.getTargetName()#.#arguments.invocation.getMethod()#()";
+		var targetMapping = arguments.invocation.getTargetMapping();
 
 		// check metadata for tx name if they desire to influence the label
 		var methodMD = arguments.invocation.getMethodMetadata();
@@ -33,13 +34,22 @@ component implements="coldbox.system.aop.MethodInterceptor" accessors="true" {
 		}
 
 		// create with method name
-		var labelhash = variables.timerService.start( txName );
+		variables.timerService.start(
+			label   : txName,
+			metadata: {
+				path : targetMapping.getObjectMetadata()?.path ?: targetMapping.getPath(),
+				name : targetMapping.getName(),
+				type : targetMapping.getType(),
+				line : methodMD.keyExists( "position" ) ? methodMD.position.start : 1
+			},
+			type: "object-profiler"
+		);
 
 		// proceed invocation
 		var results = arguments.invocation.proceed();
 
 		// Stop the timer
-		variables.timerService.stop( labelhash );
+		variables.timerService.stop( txName );
 
 		// return results
 		if ( !isNull( results ) ) {

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":"3.5.0",
+    "version":"3.6.0",
     "slug":"cbdebugger",
     "type":"modules",
     "homepage":"https://github.com/coldbox-modules/cbdebugger",
@@ -55,20 +55,14 @@
         "format":"cfformat run appenders,aspects,handlers,interceptors,models,test-harness/tests/**.cfc,ModuleConfig.cfc --overwrite",
         "format:watch":"cfformat watch appenders,aspects,handlers,interceptors,models,test-harness/tests/**.cfc,ModuleConfig.cfc ./.cfformat.json",
         "format:check":"cfformat check appenders,aspects,handlers,interceptors,models,test-harness/tests/**.cfc,ModuleConfig.cfc",
-        "cfpm":"echo '\".engine/adobe2021/WEB-INF/cfusion/bin/cfpm.sh\"' | run",
-        "cfpm:install":"echo '\".engine/adobe2021/WEB-INF/cfusion/bin/cfpm.sh\" install ${1}' | run",
-        "install:2021":"run-script cfpm:install zip,debugger,orm,mysql,postgresql,sqlserver,feed",
         "install:dependencies":"install && cd test-harness && install",
         "start:lucee":"server start [email protected]",
-        "start:2016":"server start [email protected]",
         "start:2018":"server start [email protected]",
         "start:2021":"server start [email protected]",
         "stop:lucee":"server stop name=cbdebugger-lucee@5",
-        "stop:2016":"server stop name=cbdebugger-adobe@2016",
         "stop:2018":"server stop name=cbdebugger-adobe@2018",
         "stop:2021":"server stop name=cbdebugger-adobe@2021",
         "logs:lucee":"server log name=cbdebugger-lucee@5 --follow",
-        "logs:2016":"server log name=cbdebugger-adobe@2016 --follow",
         "logs:2018":"server log name=cbdebugger-adobe@2018 --follow",
         "logs:2021":"server log name=cbdebugger-adobe@2021 --follow"
     },

build/.travis.yml

@@ -10,7 +10,6 @@ env:
     - MODULE_ID=cbdebugger
   matrix:
     - ENGINE=lucee@5
-    - ENGINE=adobe@2016
     - ENGINE=adobe@2018
 
 branches: