Merge pull request #13686 from codeconsole/6.2.x-error-printer-attrs

codeconsole · web-flow · commit 8079fa542b7b · 2024-10-01T16:43:11.000-05:00
Allow customzing css classes for the ErrorsViewStackTracePrinter
diff --git a/grails-bootstrap/src/main/groovy/org/grails/exceptions/reporting/CodeSnippetPrinter.groovy b/grails-bootstrap/src/main/groovy/org/grails/exceptions/reporting/CodeSnippetPrinter.groovy
@@ -27,7 +27,11 @@ interface CodeSnippetPrinter {
      * Attempts to present a preview code snippet of the code that went wrong
      *
      * @param exception The exception
+     * @param optional attributes for formatting
      * @return The code snippet or nothing if it can't be previewed
      */
+    String prettyPrintCodeSnippet(Throwable exception, Map attrs)
+
+    @Deprecated
     String prettyPrintCodeSnippet(Throwable exception)
 }
diff --git a/grails-bootstrap/src/main/groovy/org/grails/exceptions/reporting/DefaultStackTracePrinter.groovy b/grails-bootstrap/src/main/groovy/org/grails/exceptions/reporting/DefaultStackTracePrinter.groovy
@@ -23,7 +23,13 @@ import org.codehaus.groovy.control.MultipleCompilationErrorsException
  */
 class DefaultStackTracePrinter implements StackTracePrinter {
 
+    @Deprecated
     String prettyPrint(Throwable t) {
+        prettyPrint(t, [:])
+    }
+
+    @Override
+    String prettyPrint(Throwable t, Map attrs) {
         if (t == null) return ''
         if (!t.stackTrace) return 'No stack trace available'
         final sw = new StringWriter()
diff --git a/grails-bootstrap/src/main/groovy/org/grails/exceptions/reporting/StackTracePrinter.groovy b/grails-bootstrap/src/main/groovy/org/grails/exceptions/reporting/StackTracePrinter.groovy
@@ -29,5 +29,16 @@ interface StackTracePrinter {
      * @param throwable The throwable
      * @return The result
      */
+    @Deprecated
     String prettyPrint(Throwable throwable)
+
+    /**
+     * Pretty print the given stack trace and return the result
+     *
+     * @param throwable The throwable
+     * @param optional attributes for formatting
+     * @return The result
+     */
+    String prettyPrint(Throwable throwable, Map attrs)
+
 }
diff --git a/grails-core/src/main/groovy/org/grails/core/exceptions/DefaultErrorsPrinter.groovy b/grails-core/src/main/groovy/org/grails/core/exceptions/DefaultErrorsPrinter.groovy
@@ -47,7 +47,12 @@ class DefaultErrorsPrinter extends DefaultStackTracePrinter implements CodeSnipp
         res == null ? te.className : res.getFilename()
     }
 
+    @Deprecated
     String prettyPrintCodeSnippet(Throwable exception) {
+        prettyPrintCodeSnippet(exception, [:])
+    }
+
+    String prettyPrintCodeSnippet(Throwable exception, Map attrs) {
         if (exception == null) {
             return ''
         }
@@ -86,7 +91,7 @@ class DefaultErrorsPrinter extends DefaultStackTracePrinter implements CodeSnipp
                     if (lineNumbersShown[res.filename].contains(lineNumber)) continue // don't repeat the same lines twice
 
                     lineNumbersShown[res.filename] << lineNumber
-                    pw.print formatCodeSnippetStart(res, lineNumber)
+                    pw.print formatCodeSnippetStart(res, lineNumber, attrs)
                     def input = null
                     try {
                         input = res.inputStream
@@ -101,10 +106,10 @@ class DefaultErrorsPrinter extends DefaultStackTracePrinter implements CodeSnipp
                                 if (currentLineNumber in range) {
                                     boolean isErrorLine = currentLineNumber == lineNumber
                                     if (isErrorLine) {
-                                        pw.print formatCodeSnippetErrorLine(currentLineNumber, currentLine)
+                                        pw.print formatCodeSnippetErrorLine(currentLineNumber, currentLine, attrs)
                                     }
                                     else {
-                                        pw.print formatCodeSnippetLine(currentLineNumber, currentLine)
+                                        pw.print formatCodeSnippetLine(currentLineNumber, currentLine, attrs)
                                     }
                                 }
                                 else if (currentLineNumber > last) {
@@ -198,18 +203,32 @@ class DefaultErrorsPrinter extends DefaultStackTracePrinter implements CodeSnipp
         ""
     }
 
+    @Deprecated
     String formatCodeSnippetStart(Resource resource, int lineNumber) {
+        formatCodeSnippetStart(resource, lineNumber, [:])
+    }
+
+    String formatCodeSnippetStart(Resource resource, int lineNumber, Map attrs) {
         """Around line $lineNumber of $resource.filename
 """
-
     }
 
+    @Deprecated
     protected String formatCodeSnippetLine(int currentLineNumber, currentLine) {
+        formatCodeSnippetLine(currentLineNumber, currentLine, [:])
+    }
+
+    protected String formatCodeSnippetLine(int currentLineNumber, currentLine, Map attrs) {
         """${currentLineNumber}: ${currentLine}
 """
     }
 
+    @Deprecated
     protected String formatCodeSnippetErrorLine(int currentLineNumber, currentLine) {
+        formatCodeSnippetErrorLine(currentLineNumber, currentLine, [:])
+    }
+
+    protected String formatCodeSnippetErrorLine(int currentLineNumber, currentLine, Map attrs) {
         """${currentLineNumber}: ${currentLine}
 """
     }
diff --git a/grails-web-common/src/main/groovy/org/grails/web/errors/ErrorsViewStackTracePrinter.groovy b/grails-web-common/src/main/groovy/org/grails/web/errors/ErrorsViewStackTracePrinter.groovy
@@ -38,23 +38,23 @@ class ErrorsViewStackTracePrinter extends DefaultErrorsPrinter {
     }
 
     @Override
-    String prettyPrint(Throwable t) {
+    String prettyPrint(Throwable t, Map attrs) {
         if (t instanceof GrailsWrappedRuntimeException) {
             t = t.cause
         }
-        return super.prettyPrint(t)
+        return super.prettyPrint(t, attrs)
     }
 
     @Override
-    String prettyPrintCodeSnippet(Throwable t) {
+    String prettyPrintCodeSnippet(Throwable t, Map attrs) {
         if (t instanceof GrailsWrappedRuntimeException) {
             t = t.cause
         }
-        return super.prettyPrintCodeSnippet(t)
+        return super.prettyPrintCodeSnippet(t, attrs)
     }
 
     @Override
-    String formatCodeSnippetStart(Resource resource, int lineNumber) {
+    String formatCodeSnippetStart(Resource resource, int lineNumber, Map attrs) {
         String path = resource.filename
         // try calc better path
         try {
@@ -67,8 +67,8 @@ class ErrorsViewStackTracePrinter extends DefaultErrorsPrinter {
             path = resource.filename
         }
         """\
-<h2>Around line ${lineNumber} of <span class="filename">${path}</span></h2>
-<pre class="snippet">"""
+<h2>Around line ${lineNumber} of <span class="${attrs['filenameClass'] ?: 'filename'}">${path}</span></h2>
+<pre class="${attrs['snippetClass'] ?: 'snippet'}">"""
     }
 
     @Override
@@ -77,13 +77,13 @@ class ErrorsViewStackTracePrinter extends DefaultErrorsPrinter {
     }
 
     @Override
-    protected String formatCodeSnippetLine(int currentLineNumber, Object currentLine) {
-        """<code class="line"><span class="lineNumber">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""
+    protected String formatCodeSnippetLine(int currentLineNumber, Object currentLine, Map attrs) {
+        """<code class="${attrs['lineClass'] ?: 'line'}"><span class="${attrs['lineNumberClass'] ?: 'lineNumber'}">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""
     }
 
     @Override
-    protected String formatCodeSnippetErrorLine(int currentLineNumber, Object currentLine) {
-        """<code class="line error"><span class="lineNumber">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""
+    protected String formatCodeSnippetErrorLine(int currentLineNumber, Object currentLine, Map attrs) {
+        """<code class="${attrs['lineErrorClass'] ?: 'line error'}"><span class="${attrs['lineNumberClass'] ?: 'lineNumber'}">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""
     }
 
     @Override

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,11 @@ interface CodeSnippetPrinter {`
`27`	`27`	`* Attempts to present a preview code snippet of the code that went wrong`
`28`	`28`	`*`
`29`	`29`	`* @param exception The exception`
	`30`	`+ * @param optional attributes for formatting`
`30`	`31`	`* @return The code snippet or nothing if it can't be previewed`
`31`	`32`	`*/`
	`33`	`+ String prettyPrintCodeSnippet(Throwable exception, Map attrs)`
	`34`	`+`
	`35`	`+ @Deprecated`
`32`	`36`	`String prettyPrintCodeSnippet(Throwable exception)`
`33`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,23 +38,23 @@ class ErrorsViewStackTracePrinter extends DefaultErrorsPrinter {`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`@Override`
`41`		`- String prettyPrint(Throwable t) {`
	`41`	`+ String prettyPrint(Throwable t, Map attrs) {`
`42`	`42`	`if (t instanceof GrailsWrappedRuntimeException) {`
`43`	`43`	`t = t.cause`
`44`	`44`	`}`
`45`		`- return super.prettyPrint(t)`
	`45`	`+ return super.prettyPrint(t, attrs)`
`46`	`46`	`}`
`47`	`47`
`48`	`48`	`@Override`
`49`		`- String prettyPrintCodeSnippet(Throwable t) {`
	`49`	`+ String prettyPrintCodeSnippet(Throwable t, Map attrs) {`
`50`	`50`	`if (t instanceof GrailsWrappedRuntimeException) {`
`51`	`51`	`t = t.cause`
`52`	`52`	`}`
`53`		`- return super.prettyPrintCodeSnippet(t)`
	`53`	`+ return super.prettyPrintCodeSnippet(t, attrs)`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`@Override`
`57`		`- String formatCodeSnippetStart(Resource resource, int lineNumber) {`
	`57`	`+ String formatCodeSnippetStart(Resource resource, int lineNumber, Map attrs) {`
`58`	`58`	`String path = resource.filename`
`59`	`59`	`// try calc better path`
`60`	`60`	`try {`
`@@ -67,8 +67,8 @@ class ErrorsViewStackTracePrinter extends DefaultErrorsPrinter {`
`67`	`67`	`path = resource.filename`
`68`	`68`	`}`
`69`	`69`	`"""\`
`70`		`-<h2>Around line ${lineNumber} of <span class="filename">${path}</span></h2>`
`71`		`-<pre class="snippet">"""`
	`70`	`+<h2>Around line ${lineNumber} of <span class="${attrs['filenameClass'] ?: 'filename'}">${path}</span></h2>`
	`71`	`+<pre class="${attrs['snippetClass'] ?: 'snippet'}">"""`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`@Override`
`@@ -77,13 +77,13 @@ class ErrorsViewStackTracePrinter extends DefaultErrorsPrinter {`
`77`	`77`	`}`
`78`	`78`
`79`	`79`	`@Override`
`80`		`- protected String formatCodeSnippetLine(int currentLineNumber, Object currentLine) {`
`81`		`- """<code class="line"><span class="lineNumber">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""`
	`80`	`+ protected String formatCodeSnippetLine(int currentLineNumber, Object currentLine, Map attrs) {`
	`81`	`+ """<code class="${attrs['lineClass'] ?: 'line'}"><span class="${attrs['lineNumberClass'] ?: 'lineNumber'}">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""`
`82`	`82`	`}`
`83`	`83`
`84`	`84`	`@Override`
`85`		`- protected String formatCodeSnippetErrorLine(int currentLineNumber, Object currentLine) {`
`86`		`- """<code class="line error"><span class="lineNumber">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""`
	`85`	`+ protected String formatCodeSnippetErrorLine(int currentLineNumber, Object currentLine, Map attrs) {`
	`86`	`+ """<code class="${attrs['lineErrorClass'] ?: 'line error'}"><span class="${attrs['lineNumberClass'] ?: 'lineNumber'}">${currentLineNumber}:</span>${currentLine.encodeAsHTML()}</code>"""`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`@Override`