Custom compiler crash/panic handler #731

JakubSchwenkbeck · 2024-12-09T18:05:50Z

Motivation

Print and log a more verbose compiler crash/panic message with information about the specific user setup
Resolves #576.

Changes

Implemented the generateCrashReport function, which creates a more verbose output if the compiler crashes/panics.
This Report retrieves general and backend-specific information to make crashes more reproducable or traceable

It holds information about :

Effekt Version
Backend
OS
JVM
and a full stacktrace.

Additionally, the report is written to a .md-file in the .out/ directory

Testing

I added INTERNAL_ERROR("some text here") to the compileSource function in JVM/.../Driver.scala to crash the compiler and retrieve the new message

Printing example using `INTERNAL_ERROR` looks like this:

[info] === Effekt Compiler Crash Report ===

[Error] : Internal compiler error: some text here

The compiler unexpectedly panicked. This is a compiler bug.
Please report it: https://github.com/effekt-lang/effekt/issues/new?labels=bug

Effekt Version: 0.10.0

Backend used: js

A detailed crash report has been written to:
/home/jakub/Effekt/effekt/bin/./out

Operating System: Linux

JVM Version: 21.0.5

Full Stack Trace:
PlainTextError(Internal compiler error: some text here,None,Error)
        at effekt.util.messages$CompilerPanic$.apply(Messages.scala:37)
        at effekt.util.messages$.INTERNAL_ERROR(Messages.scala:53)
        at effekt.Driver.compileSource(Driver.scala:54)
        at effekt.Driver.compileSource$(Driver.scala:21)
        at effekt.Server$.compileSource(Server.scala:261)
        at effekt.Server$.compileSource(Server.scala:261)
        at kiama.util.Compiler.compileFile(Compiler.scala:102)
        at kiama.util.Compiler.compileFile$(Compiler.scala:22)
        at effekt.Server$.compileFile(Server.scala:261)
        at effekt.Driver.run$$anonfun$1(Driver.scala:41)
        at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15)
        at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10)
        at scala.collection.immutable.List.foreach(List.scala:333)
        at effekt.Driver.run(Driver.scala:42)
        at effekt.Driver.run$(Driver.scala:21)
        at effekt.Server$.run(Server.scala:261)
        at effekt.Server$.run(Server.scala:261)
        at kiama.util.Compiler.driver(Compiler.scala:86)
        at kiama.util.Compiler.driver$(Compiler.scala:22)
        at effekt.Server$.driver(Server.scala:261)
        at kiama.util.Compiler.main(Compiler.scala:50)
        at kiama.util.Compiler.main$(Compiler.scala:22)
        at effekt.Server$.main(Server.scala:261)
        at effekt.Server.main(Server.scala)


Arguments passed to the compiler:

--backend=js
compilecrash.effekt

… report with Information about : OS, JVM, a full stacktrace . Additionally, the crash report is written into a log file

… in effektVersion

effekt/jvm/src/main/scala/effekt/Driver.scala

marvinborner

Thanks for the PR! I think there are some design/layout choices that we could discuss (e.g. emitting markdown for copy/pasting to GitHub), but otherwise this looks like a good initial implementation.

We should also make sure that things like the System.getProperty calls work on all platforms (including Windows!)

added correct Effekt Version

JakubSchwenkbeck · 2024-12-10T09:49:52Z

Hey, thanks for the help with the Effekt Version!
I haven't compiled Effekt on Windows yet, maybe if there's time I could test this:)

Do you mean the markdown should be added to the written log? I don't see how much more a markdown could do for the readability opposed to the current way of pasting into a code-box, but I surely can implement the md-support aswell:)

JakubSchwenkbeck · 2024-12-11T19:00:05Z

Hey:) Would this be a desirable outcome when returning the log in .md? (@marvinborner )

# Effekt Compiler Crash Report

**Where to Report**: [https://github.com/effekt-lang/effekt/issues](https://github.com/effekt-lang/effekt/issues)



---

## Compiler Details
- **Effekt Compiler Version**: 0.10.0
- **Backend-specific info**:
  - **Name**: js
  - **Compiler**: `effekt.generator.js.JavaScriptNode@7c6908d7`
  - **Runner**: `effekt.JSNodeRunner$@3c9754d8`
- **Operating System**: Linux (amd64) `5.15.167.4-microsoft-standard-WSL2`
- **JVM Version**: `21.0.5 (Ubuntu)`

---

## Full Stack Trace
at effekt.util.messages$CompilerPanic$.apply(Messages.scala:37)
at effekt.util.messages$.INTERNAL_ERROR(Messages.scala:53)
at effekt.Driver.compileSource(Driver.scala:54)
at effekt.Driver.compileSource$(Driver.scala:21)
at effekt.Server$.compileSource(Server.scala:261)
at effekt.Server$.compileSource(Server.scala:261)
at kiama.util.Compiler.compileFile(Compiler.scala:102)
at kiama.util.Compiler.compileFile$(Compiler.scala:22)
at effekt.Server$.compileFile(Server.scala:261)
at effekt.Driver.run$$anonfun$1(Driver.scala:41)
at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15)
at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10)
at scala.collection.immutable.List.foreach(List.scala:333)
at effekt.Driver.run(Driver.scala:42)
at effekt.Driver.run$(Driver.scala:21)
at effekt.Server$.run(Server.scala:261)
at effekt.Server$.run(Server.scala:261)
at kiama.util.Compiler.driver(Compiler.scala:86)
at kiama.util.Compiler.driver$(Compiler.scala:22)
at effekt.Server$.driver(Server.scala:261)
at kiama.util.Compiler.main(Compiler.scala:50)
at kiama.util.Compiler.main$(Compiler.scala:22)
at effekt.Server$.main(Server.scala:261)
at effekt.Server.main(Server.scala)

---

## Additional Info
- **Crash report saved to**: `./out/crash-report.log`

Effekt Compiler Crash Report

Where to Report: https://github.com/effekt-lang/effekt/issues

Compiler Details

Effekt Compiler Version: 0.10.0
Backend-specific info:
- Name: js
- Compiler: effekt.generator.js.JavaScriptNode@7c6908d7
- Runner: effekt.JSNodeRunner$@3c9754d8
Operating System: Linux (amd64) 5.15.167.4-microsoft-standard-WSL2
JVM Version: 21.0.5 (Ubuntu)

Full Stack Trace

at effekt.util.messages$CompilerPanic$.apply(Messages.scala:37)
at effekt.util.messages$.INTERNAL_ERROR(Messages.scala:53)
at effekt.Driver.compileSource(Driver.scala:54)
at effekt.Driver.compileSource$(Driver.scala:21)
at effekt.Server$.compileSource(Server.scala:261)
at effekt.Server$.compileSource(Server.scala:261)
at kiama.util.Compiler.compileFile(Compiler.scala:102)
at kiama.util.Compiler.compileFile$(Compiler.scala:22)
at effekt.Server$.compileFile(Server.scala:261)
at effekt.Driver.run$$anonfun$1(Driver.scala:41)
at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15)
at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10)
at scala.collection.immutable.List.foreach(List.scala:333)
at effekt.Driver.run(Driver.scala:42)
at effekt.Driver.run$(Driver.scala:21)
at effekt.Server$.run(Server.scala:261)
at effekt.Server$.run(Server.scala:261)
at kiama.util.Compiler.driver(Compiler.scala:86)
at kiama.util.Compiler.driver$(Compiler.scala:22)
at effekt.Server$.driver(Server.scala:261)
at kiama.util.Compiler.main(Compiler.scala:50)
at kiama.util.Compiler.main$(Compiler.scala:22)
at effekt.Server$.main(Server.scala:261)
at effekt.Server.main(Server.scala)

Additional Info

Crash report saved to: ./out/crash-report.log

…piler/verbose-crash # Conflicts: # effekt/jvm/src/main/scala/effekt/Driver.scala

JakubSchwenkbeck · 2024-12-16T13:57:57Z

Hey:)
I completed my implementation and therefore switched from a draft to the PR.
I decided on logging the markdown version in a .md file and made some minor layout changes, an example is analog to the body of the main-comment, just with some md-specific highlighting

jiribenes

Hi @JakubSchwenkbeck, this seems like a great first draft.
Please take a look at my comments below to guide the next steps! :)

effekt/jvm/src/main/scala/effekt/Driver.scala

JakubSchwenkbeck · 2024-12-17T10:16:42Z

What do you think of this Layout?

MARKDOWN:

Effekt Compiler Crash Report

[Error] : Internal compiler error: some text here

The compiler unexpectedly panicked. This is a compiler bug.
Please report it: Submit an issue

Compiler Information

Effekt Version: 0.10.0

Backend: js

System Information

Operating System: Linux
Arch: amd64
Version: 5.15.167.4-microsoft-standard-WSL2

JVM Version: 21.0.5 (Ubuntu, /usr/lib/jvm/java-21-openjdk-amd64)

Full Stack Trace

  at effekt.util.messages$CompilerPanic$.apply(Messages.scala:37)
  at effekt.util.messages$.INTERNAL_ERROR(Messages.scala:53)
  at effekt.Driver.compileSource(Driver.scala:54)
  at effekt.Driver.compileSource$(Driver.scala:21)
  at effekt.Server$.compileSource(Server.scala:261)
  at effekt.Server$.compileSource(Server.scala:261)
  at kiama.util.Compiler.compileFile(Compiler.scala:102)
  at kiama.util.Compiler.compileFile$(Compiler.scala:22)
  at effekt.Server$.compileFile(Server.scala:261)
  at effekt.Driver.run$$anonfun$1(Driver.scala:41)
  at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15)
  at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10)
  at scala.collection.immutable.List.foreach(List.scala:333)
  at effekt.Driver.run(Driver.scala:42)
  at effekt.Driver.run$(Driver.scala:21)
  at effekt.Server$.run(Server.scala:261)
  at effekt.Server$.run(Server.scala:261)
  at kiama.util.Compiler.driver(Compiler.scala:86)
  at kiama.util.Compiler.driver$(Compiler.scala:22)
  at effekt.Server$.driver(Server.scala:261)
  at kiama.util.Compiler.main(Compiler.scala:50)
  at kiama.util.Compiler.main$(Compiler.scala:22)
  at effekt.Server$.main(Server.scala:261)
  at effekt.Server.main(Server.scala)

Arguments Passed to the Compiler

compilecrash.effekt

TERMINAL:

[info] === Effekt Compiler Crash Report ===

[Error] : Internal compiler error: some text here

The compiler unexpectedly panicked. This is a compiler bug.
Please report it: https://github.com/effekt-lang/effekt/issues/new?labels=bug

Effekt Version: 0.10.0

Backend used: js

A detailed crash report has been written to:
/home/jakub/Effekt/effekt/bin/./out/crash-report.md

Operating System: Linux

JVM Version: 21.0.5

Full Stack Trace:
at effekt.util.messages$CompilerPanic$.apply(Messages.scala:37)
at effekt.util.messages$.INTERNAL_ERROR(Messages.scala:53)
at effekt.Driver.compileSource(Driver.scala:54)
at effekt.Driver.compileSource$(Driver.scala:21)
at effekt.Server$.compileSource(Server.scala:261)
at effekt.Server$.compileSource(Server.scala:261)
at kiama.util.Compiler.compileFile(Compiler.scala:102)
at kiama.util.Compiler.compileFile$(Compiler.scala:22)
at effekt.Server$.compileFile(Server.scala:261)
at effekt.Driver.run$$anonfun$1(Driver.scala:41)
at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15)
at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10)
at scala.collection.immutable.List.foreach(List.scala:333)
at effekt.Driver.run(Driver.scala:42)
at effekt.Driver.run$(Driver.scala:21)
at effekt.Server$.run(Server.scala:261)
at effekt.Server$.run(Server.scala:261)
at kiama.util.Compiler.driver(Compiler.scala:86)
at kiama.util.Compiler.driver$(Compiler.scala:22)
at effekt.Server$.driver(Server.scala:261)
at kiama.util.Compiler.main(Compiler.scala:50)
at kiama.util.Compiler.main$(Compiler.scala:22)
at effekt.Server$.main(Server.scala:261)
at effekt.Server.main(Server.scala)

Arguments passed to the compiler:

compilecrash.effekt

jiribenes · 2024-12-17T16:36:02Z

Could you please post the current version of the generated report here, please? :)

JakubSchwenkbeck · 2024-12-17T19:48:30Z

The Current Terminal print :

[info] === Effekt Compiler Crash Report ===

[Error] : Internal compiler error: some text here

The compiler unexpectedly panicked. This is a compiler bug.
Please report it: https://github.com/effekt-lang/effekt/issues/new?labels=bug

Effekt Version: 0.10.0

Backend used: js

A detailed crash report has been written to:
/home/jakub/Effekt/effekt/bin/./out

Operating System: Linux

JVM Version: 21.0.5

Full Stack Trace:
PlainTextError(Internal compiler error: some text here,None,Error)
        at effekt.util.messages$CompilerPanic$.apply(Messages.scala:37)
        at effekt.util.messages$.INTERNAL_ERROR(Messages.scala:53)
        at effekt.Driver.compileSource(Driver.scala:54)
        at effekt.Driver.compileSource$(Driver.scala:21)
        at effekt.Server$.compileSource(Server.scala:261)
        at effekt.Server$.compileSource(Server.scala:261)
        at kiama.util.Compiler.compileFile(Compiler.scala:102)
        at kiama.util.Compiler.compileFile$(Compiler.scala:22)
        at effekt.Server$.compileFile(Server.scala:261)
        at effekt.Driver.run$$anonfun$1(Driver.scala:41)
        at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15)
        at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10)
        at scala.collection.immutable.List.foreach(List.scala:333)
        at effekt.Driver.run(Driver.scala:42)
        at effekt.Driver.run$(Driver.scala:21)
        at effekt.Server$.run(Server.scala:261)
        at effekt.Server$.run(Server.scala:261)
        at kiama.util.Compiler.driver(Compiler.scala:86)
        at kiama.util.Compiler.driver$(Compiler.scala:22)
        at effekt.Server$.driver(Server.scala:261)
        at kiama.util.Compiler.main(Compiler.scala:50)
        at kiama.util.Compiler.main$(Compiler.scala:22)
        at effekt.Server$.main(Server.scala:261)
        at effekt.Server.main(Server.scala)


Arguments passed to the compiler:

--backend=js
compilecrash.effekt

JakubSchwenkbeck · 2024-12-17T19:51:11Z

This is the markdown- log

Effekt Compiler Crash Report

ERROR : Internal compiler error: some text here

The compiler unexpectedly panicked. This is a compiler bug.
Please report it: Submit an issue

Compiler Information

Effekt Version: 0.10.0

Backend: js

System Information

Operating System: Linux
Arch: amd64
Version: 5.15.167.4-microsoft-standard-WSL2

JVM Version: 21.0.5 (Ubuntu, OpenJDK Runtime Environment)

Full Stack Trace

PlainTextError(Internal compiler error: some text here,None,Error)
	at effekt.util.messages$CompilerPanic$.apply(Messages.scala:37)
	at effekt.util.messages$.INTERNAL_ERROR(Messages.scala:53)
	at effekt.Driver.compileSource(Driver.scala:54)
	at effekt.Driver.compileSource$(Driver.scala:21)
	at effekt.Server$.compileSource(Server.scala:261)
	at effekt.Server$.compileSource(Server.scala:261)
	at kiama.util.Compiler.compileFile(Compiler.scala:102)
	at kiama.util.Compiler.compileFile$(Compiler.scala:22)
	at effekt.Server$.compileFile(Server.scala:261)
	at effekt.Driver.run$$anonfun$1(Driver.scala:41)
	at scala.runtime.function.JProcedure1.apply(JProcedure1.java:15)
	at scala.runtime.function.JProcedure1.apply(JProcedure1.java:10)
	at scala.collection.immutable.List.foreach(List.scala:333)
	at effekt.Driver.run(Driver.scala:42)
	at effekt.Driver.run$(Driver.scala:21)
	at effekt.Server$.run(Server.scala:261)
	at effekt.Server$.run(Server.scala:261)
	at kiama.util.Compiler.driver(Compiler.scala:86)
	at kiama.util.Compiler.driver$(Compiler.scala:22)
	at effekt.Server$.driver(Server.scala:261)
	at kiama.util.Compiler.main(Compiler.scala:50)
	at kiama.util.Compiler.main$(Compiler.scala:22)
	at effekt.Server$.main(Server.scala:261)
	at effekt.Server.main(Server.scala)

Arguments Passed to the Compiler


--backend=js
compilecrash.effekt

JakubSchwenkbeck · 2024-12-17T19:53:09Z

I'm flexible with the design, changing the layout / contet only needs minor String-manipulations, so feel free to knitpick:)

JakubSchwenkbeck and others added 2 commits December 9, 2024 18:56

added generateCrashReport function which creates a more verbose crash…

717b3e4

… report with Information about : OS, JVM, a full stacktrace . Additionally, the crash report is written into a log file

took out unnecessary lines in the report and commented out Null value…

b0a6152

… in effektVersion

marvinborner reviewed Dec 9, 2024

View reviewed changes

effekt/jvm/src/main/scala/effekt/Driver.scala Outdated Show resolved Hide resolved

marvinborner reviewed Dec 9, 2024

View reviewed changes

Update Driver.scala

75f3a1e

added correct Effekt Version

JakubSchwenkbeck added 2 commits December 16, 2024 14:32

changed info-retrieval and added markdown support for logging

3bc5621

Merge remote-tracking branch 'origin/compiler/verbose-crash' into com…

433aef3

…piler/verbose-crash # Conflicts: # effekt/jvm/src/main/scala/effekt/Driver.scala

JakubSchwenkbeck marked this pull request as ready for review December 16, 2024 13:34

optimized markdown layout

fbc76e6

JakubSchwenkbeck requested a review from marvinborner December 16, 2024 13:50

reconstructed the printing report

5f56356

jiribenes requested changes Dec 16, 2024

View reviewed changes

JakubSchwenkbeck added 7 commits December 17, 2024 11:24

updated info-retrieval and write markdown-log fist

579b670

implemented report as direct consequence of the Error

df5358f

out-path is now set by the config.outputPath()

2c88880

switched out user-specific path with Runtime information

6f61d5b

added error Message in report

895e07a

fixed missing Error Import

18d6add

added printStackTrace with a StringWriter

d7b191e

JakubSchwenkbeck requested a review from jiribenes December 17, 2024 13:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom compiler crash/panic handler #731

Custom compiler crash/panic handler #731

JakubSchwenkbeck commented Dec 9, 2024 •

edited

Loading

marvinborner left a comment •

edited

Loading

JakubSchwenkbeck commented Dec 10, 2024

JakubSchwenkbeck commented Dec 11, 2024 •

edited

Loading

JakubSchwenkbeck commented Dec 16, 2024

jiribenes left a comment

JakubSchwenkbeck commented Dec 17, 2024 •

edited

Loading

jiribenes commented Dec 17, 2024 •

edited

Loading

JakubSchwenkbeck commented Dec 17, 2024

JakubSchwenkbeck commented Dec 17, 2024

JakubSchwenkbeck commented Dec 17, 2024

Custom compiler crash/panic handler #731

Are you sure you want to change the base?

Custom compiler crash/panic handler #731

Conversation

JakubSchwenkbeck commented Dec 9, 2024 • edited Loading

Motivation

Changes

It holds information about :

Testing

Printing example using INTERNAL_ERROR looks like this:

marvinborner left a comment • edited Loading

Choose a reason for hiding this comment

JakubSchwenkbeck commented Dec 10, 2024

JakubSchwenkbeck commented Dec 11, 2024 • edited Loading

Effekt Compiler Crash Report

Compiler Details

Full Stack Trace

Additional Info

JakubSchwenkbeck commented Dec 16, 2024

jiribenes left a comment

Choose a reason for hiding this comment

JakubSchwenkbeck commented Dec 17, 2024 • edited Loading

MARKDOWN:

Effekt Compiler Crash Report

Compiler Information

System Information

Full Stack Trace

Arguments Passed to the Compiler

TERMINAL:

jiribenes commented Dec 17, 2024 • edited Loading

JakubSchwenkbeck commented Dec 17, 2024

JakubSchwenkbeck commented Dec 17, 2024

Effekt Compiler Crash Report

Compiler Information

System Information

Full Stack Trace

Arguments Passed to the Compiler

JakubSchwenkbeck commented Dec 17, 2024

JakubSchwenkbeck commented Dec 9, 2024 •

edited

Loading

Printing example using `INTERNAL_ERROR` looks like this:

marvinborner left a comment •

edited

Loading

JakubSchwenkbeck commented Dec 11, 2024 •

edited

Loading

JakubSchwenkbeck commented Dec 17, 2024 •

edited

Loading

jiribenes commented Dec 17, 2024 •

edited

Loading