1.4.0 changes (#43)

* Improving parsing of Stack Traces, in particular when the first line (error message) itself contain the word <at>
* Adding support for Java stack traces seen in ColdBox async error handling

Author: TheRealAgentK

README.md

@@ -1,94 +1,104 @@
 raygun4cfml
 ===========
 
-Raygun.io API client for CFML.
+Raygun Crash Reporting client for CFML.
 
-Current Version: 1.3.1 (July 26 2021)
+Current Version: 1.4.0 (May 24 2022)
 
 Dependencies: 
 
 - Testbox (for running unit and BDD tests only)
 
 ## Library organisation
 
-/src contains the source code. The package structure is nz.co.ventego-creative.co.nz.raygun4cfml but the library's components themselves are independent of the package path. Therefore you can use the library in multiple ways:
+`/src` contains the source code. The package structure is `nz.co.ventego-creative.co.nz.raygun4cfml` but the library's components themselves are independent of the package path. Therefore you can use the library in multiple ways:
 
-- Put the content of /src into your webroot and instantiate RaygunClient through something like the following:
+- Put the content of `/src` into your webroot and instantiate `RaygunClient` through something like the following:
 
+    ```
     raygun = createObject("component","nz.co.ventego-creative.raygun4cfml.RaygunClient").init(
         apiKey = "YOURAPIKEYHERE"
     );
+    ```
+- Put the contents of `/src` into any other place of your choice and create a mapping to `/nz` in your server administrator or through code and then use the instantiation code as above.
 
-- Put the contents of /src into any other place of your choice and create a mapping to /nz in your server administrator or through code and then use the instantiation code as above.
-
-- Put the contents of the raygun4cfml into a place of your choice where your CFML has some sort of a mapping pointing towards and and just instantiate RaygunClient like this:
-
+- Put the contents of the `raygun4cfml` directory into a place of your choice where your CFML has some sort of a mapping pointing towards and and just instantiate `RaygunClient` like this:
+    
+    ```
     raygun = createObject("component","RaygunClient").init(
         apiKey = "YOURAPIKEYHERE"
     );
+    ```
     
-/samples contains a set of files that show how the library can be used in your code through a global error handler as well as a contributed example for ColdBox 3.6
+`/samples` contains a set of files that show how the library can be used in your code through a global error handler as well as a contributed example for ColdBox 3.6
 
-/tests contains manual tests and more samples as well as a structure (but no tests at this stage) for Testbox unit and BDD tests.
+`/tests` contains manual tests and more samples as well as a structure (but no tests at this stage) for Testbox unit and BDD tests.
 
 ## Getting and Using raygun4cfml
 
-Option 1 (preferred):
+### Option 1 (preferred):
 
 Use Commandbox and Forgebox to get the library and then follow the ideas outlined in 'Library organisation' for further setup.
 
 To get the latest from the master repository
 
-    box install raygun4cfml 
+```
+box install raygun4cfml 
+```
 
-To install a specific release or tag: 
-    
-    box install git://github.com/MindscapeHQ/raygun4cfml.git#{tagname}
-    
-Example tag names are 1.1.0, 1.0.2.0, 1.0.1.0 etc. Please check the list of tags on Github. Be aware that if you install any tag from before I introduced support for Commandbox and Forgebox there won't be a box.json file and therefore Commandbox will give you a warning as well as there won't be any dependency management for such an installation of the library.
+To install a specific release or tag:     
+
+```
+box install git://github.com/MindscapeHQ/raygun4cfml.git#{tagname}
+```
+
+Example tag names are `1.1.0`, `1.0.2.0`, `1.0.1.0` etc. Please check the list of tags on Github. Be aware that if you install any tag from before I introduced support for Commandbox and Forgebox there won't be a `box.json` file and therefore Commandbox will give you a warning as well as there won't be any dependency management for such an installation of the library.
     
 Shortcut for the above:
  
-    box install MindscapeHQ/raygun4cfml#{tagname}
-    
+```
+box install MindscapeHQ/raygun4cfml#{tagname}
+```
+
 To get the latest from my development repository (be warned, this might contain all sorts of untested code):
   
-    box install TheRealAgentK/raygun4cfml
+```
+box install TheRealAgentK/raygun4cfml
+```
 
-Option 2:
+### Option 2:
 
 Fork and clone the repo to your local system. Move the src/test directories into places of your choice and suitable for your system and follow the ideas outlined in 'Library organisation'.
 
-Option 3:
+### Option 3:
 
 Download a zip file containing the current content of the repo or a release/tag of your choice. Unzip the resulting file. Move the src/test directories into places of your choice and suitable for your system and follow the ideas outlined in 'Library organisation'.
 
-####Notes:
+#### Notes: 
 
 (1) Options 2 and 3 will not fulfill any necessary dependencies, you're on your own.
 
 ## Versions
 
 See changelog.md for further information.
 
-####Notes:
+## General Notes
 
-(1) All releases onwards from 0.5.0.0 will break your code if you've used 0.4 and older before and have used customRequestData. Please continue reading.
+(1) All releases onwards from 0.5.0.0 will break your code if you've used 0.4 and older before and have used `customRequestData`. 
 
-(2) If you are using the ACF Administrator setting: "Prefix serialized JSON with..." with anything else but the default prefix of "//", the library will not work.
+(2) If you are using the ACF Administrator setting: "Prefix serialized JSON with..." with anything else but the default prefix of `//`, the library will not work.
 
 (3) Version 1.1.0 and newer will not work on Adobe ColdFusion 8 and most likely not on Railo 3 (the latter not tested).
 
-
 ## How to contribute
 
-The main repository of this project is https://github.com/MindscapeHQ/raygun4cfml. Please fork from there, create a local develop branch and merge changes back to your local master branch to submit a pull request. Even better, get in touch with me on Twitter (@AgentK) or here on Github before you undertake any work so that it can be coordinated with what I'm doing.
+The main repository of this project is https://github.com/MindscapeHQ/raygun4cfml. Please fork from there, create a local develop or feature branch and merge changes back to your local master branch to submit a pull request. Even better, get in touch with me on Twitter (@AgentK) or here on Github before you undertake any work so that it can be coordinated with what I'm doing.
 
 Most of the active development happens in my own fork: https://github.com/TheRealAgentK/raygun4cfml - feel free to peek around in there.
 
 ## License
 
-Copyright 2013-2021 Kai Koenig, Ventego Creative Ltd
+Copyright 2013-2022 Kai Koenig, Ventego Creative Ltd
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

box.json

@@ -1,7 +1,7 @@
 {
     "name":"raygun4cfml",
-    "version":"1.3.1",
-    "location":"MindscapeHQ/raygun4cfml#1.3.0",
+    "version":"1.4.0",
+    "location":"MindscapeHQ/raygun4cfml#1.4.0",
     "author":"Kai Koenig <kai@ventego-creative.co.nz>",
     "homepage":"https://github.com/MindscapeHQ/raygun4cfml/",
     "documentation":"https://github.com/MindscapeHQ/raygun4cfml/blob/master/README.md",

changelog.md

@@ -1,6 +1,11 @@
 History
 =======
 
+1.4.0 (May 24 2022)
+
+- Supporting stack traces where certain elements (like TagContext) don't exist
+- Support for specifc Java strack traces stemming from asynchronous handling
+
 1.3.1 (Jul 26 2021)
 
 - Physical memory tracking again under certain conditions, provided the underlying Java code is available on the JVM (modules opened up).

src/nz/co/ventego-creative/raygun4cfml/RaygunClient.cfc

@@ -30,7 +30,7 @@ limitations under the License.
 			var returnContent = {};
 
 			returnContent["name"] = "raygun4cfml";
-			returnContent["version"] = "1.2.0";
+			returnContent["version"] = "1.4.0";
 			returnContent["clientUrl"] = "https://github.com/MindscapeHQ/raygun4cfml";
 
 			return returnContent;

src/nz/co/ventego-creative/raygun4cfml/RaygunClientMessage.cfc

@@ -30,75 +30,96 @@ limitations under the License.
 
 		<cfscript>
 			var returnContent = {};
+			
 			var stackTraceData = [];
 			var stackTraceLines = [];
 			var tagContextData = [];
+			var stackTraceLineElements = [];
+			var stackTraceLineElement = {};
 			var lenStackTraceLines = 0;
 			var lenTagContext = 0;
-			var stackTraceLineElements = [];
 			var j = 0;
+			
 			var isLucee = new RaygunInternalTools().isLucee();
 			var isACF2021 = new RaygunInternalTools().isACF2021();
+			
+			var entryPoint = arguments.issueDataStruct;
 
-			stackTraceLines = arguments.issueDataStruct.stacktrace.split("\sat");
-			lenStackTraceLines = ArrayLen(stackTraceLines);
-
-			for (j=2;j<=lenStackTraceLines;j++)
-			{
-				stackTraceLineElements = stackTraceLines[j].split("\(");
-				stackTraceData[j-1] = {};
-				stackTraceData[j-1]["methodName"] = Trim(ListLast(stackTraceLineElements[1],"."));
-				stackTraceData[j-1]["className"] = Trim(ListDeleteAt(stackTraceLineElements[1],ListLen(stackTraceLineElements[1],"."),"."));
-				// PR 26 - It seems there are Java Strack Traces without line numbers
-				// Check if a line number is present in the Java Stack Trace
-				// We look for a colon followed by number(s)
-				// If no line number, return 0 so it's apparent none was given.
-				if (ReFind("\:(?!\D+)",stackTraceLineElements[2])){
-					stackTraceData[j-1]["fileName"] = Trim(ReReplace(stackTraceLineElements[2].split("\:(?!\D+)")[1],"[\)\n\r]",""));
-					stackTraceData[j-1]["lineNumber"] = Trim(ReReplace(stackTraceLineElements[2].split("\:(?!\D+)")[2],"[\)\n\r]",""));
-				}
-				else
+ 			if (StructKeyExists(arguments.issueDataStruct,"Cause") && StructKeyExists(arguments.issueDataStruct.cause,"CatchBlock")) {
+ 				entryPoint = arguments.issueDataStruct.cause.CatchBlock;
+ 			}
+
+ 			if (isArray(entryPoint.stacktrace)) {
+ 				stackTraceData = entryPoint.stacktrace;
+ 			} elseif (isSimpleValue(entryPoint.stacktrace)) {
+ 				stackTraceLines = entryPoint.stacktrace.split("\sat");
+				lenStackTraceLines = ArrayLen(stackTraceLines);
+
+				for (j=2;j<=lenStackTraceLines;j++)
 				{
-					stackTraceData[j-1]["fileName"] = Trim(ReReplace(stackTraceLineElements[2],"[\)\n\r]",""));
-					stackTraceData[j-1]["lineNumber"] = 0;
+					stackTraceLineElements = stackTraceLines[j].split("\(");
+					
+					if (ArrayLen(stackTraceLineElements) == 2) {
+						
+						stackTraceLineElement = {};
+						stackTraceLineElement["methodName"] = Trim(ListLast(stackTraceLineElements[1],"."));
+						stackTraceLineElement["className"] = Trim(ListDeleteAt(stackTraceLineElements[1],ListLen(stackTraceLineElements[1],"."),"."));
+						// PR 26 - It seems there are Java Strack Traces without line numbers
+						// Check if a line number is present in the Java Stack Trace
+						// We look for a colon followed by number(s)
+						// If no line number, return 0 so it's apparent none was given.
+						if (ReFind("\:(?!\D+)",stackTraceLineElements[2])){
+							stackTraceLineElement["fileName"] = Trim(ReReplace(stackTraceLineElements[2].split("\:(?!\D+)")[1],"[\)\n\r]",""));
+							stackTraceLineElement["lineNumber"] = Trim(ReReplace(stackTraceLineElements[2].split("\:(?!\D+)")[2],"[\)\n\r]",""));
+						}
+						else
+						{
+							stackTraceLineElement["fileName"] = Trim(ReReplace(stackTraceLineElements[2],"[\)\n\r]",""));
+							stackTraceLineElement["lineNumber"] = 0;
+						}
+
+						ArrayAppend(stackTraceData, stackTraceLineElement);
+					}	
 				}
-			}
-
-			lenTagContext = arraylen(arguments.issueDataStruct.tagcontext);
+ 			}
 
-			for (j=1;j<=lenTagContext;j++)
-			{
-				tagContextData[j] = {};
-				tagContextData[j]["methodName"] = "";
-				tagContextData[j]["className"] = trim( arguments.issueDataStruct.tagcontext[j]["id"] );
-				tagContextData[j]["fileName"] = trim( arguments.issueDataStruct.tagcontext[j]["template"] );
-				tagContextData[j]["lineNumber"] = trim( arguments.issueDataStruct.tagcontext[j]["line"] );
-			}
+			if (structKeyExists(entryPoint,"tagcontext")) {
+				lenTagContext = arraylen(entryPoint.tagcontext);
 
+				for (j=1;j<=lenTagContext;j++)
+				{
+					tagContextData[j] = {};
+					tagContextData[j]["methodName"] = "";
+					tagContextData[j]["className"] = trim( entryPoint.tagcontext[j]["id"] );
+					tagContextData[j]["fileName"] = trim( entryPoint.tagcontext[j]["template"] );
+					tagContextData[j]["lineNumber"] = trim( entryPoint.tagcontext[j]["line"] );
+				}
+ 			}
+ 			
 			returnContent["data"] = {"JavaStrackTrace" = stackTraceData};
 			returnContent["stackTrace"] = tagContextData;
 
 			// if we deal with an error struct, there'll be a root cause
-			if (StructKeyExists(arguments.issueDataStruct,"RootCause")) {
-				if (StructKeyExists(arguments.issueDataStruct["RootCause"],"Type") and arguments.issueDataStruct["RootCause"]["Type"] eq "expression")
+			if (StructKeyExists(entryPoint,"RootCause")) {
+				if (StructKeyExists(entryPoint["RootCause"],"Type") and entryPoint["RootCause"]["Type"] eq "expression")
 				{
-					returnContent["data"]["type"] = arguments.issueDataStruct["RootCause"]["Type"];
+					returnContent["data"]["type"] = entryPoint["RootCause"]["Type"];
 				}
-				if (StructKeyExists(arguments.issueDataStruct["RootCause"],"Message"))
+				if (StructKeyExists(entryPoint["RootCause"],"Message"))
 				{
-					returnContent["message"] = arguments.issueDataStruct["RootCause"]["Message"];
+					returnContent["message"] = entryPoint["RootCause"]["Message"];
 				}
 				returnContent["catchingMethod"] = "Error struct";
 			} else {
-                // otherwise there's no root cause and the specific data has to be grabbed from somewhere else
-                if (!isLucee || isACF2021) {
-					returnContent["data"]["type"] = arguments.issueDataStruct.type;
+            // otherwise there's no root cause and the specific data has to be grabbed from somewhere else
+            if (!isLucee || isACF2021) {
+					returnContent["data"]["type"] = entryPoint.type;
 				}
-				returnContent["message"] = arguments.issueDataStruct.message;
+				returnContent["message"] = entryPoint.message;
 				returnContent["catchingMethod"] = "CFCatch struct";
 			}
 
-			returnContent["className"] = trim( arguments.issueDataStruct.type );
+			returnContent["className"] = trim( entryPoint.type );
 
 			return returnContent;
 		</cfscript>