grin-compiler/haskell-code-spot

Visual tool to spot odd runtime behaviour of Haskell programs.

Haskell Code Spot

Visual tool to spot odd runtime behaviour of Haskell programs.
Keywords: data scientist, GHC eventlog, UI experiments, creative/live coding

NOTE: GHC-WPC is optional, Haskell Code Spot works with vanilla GHC eventlog out of the box.

Blog

• WebUI for Haskell tooling!

Learn these for coding

• HTML + CSS + JS (https://www.youtube.com/kepowob/featured)
• Svelte (https://svelte.dev/tutorial/basics)
• D3.js (https://www.youtube.com/watch?v=_8V5o2UHG0E)
• D3 flame graph (https://github.com/spiermar/d3-flame-graph)
• C3.js (https://c3js.org/)
• CodeMirror (https://codemirror.net/doc/manual.html#api)
• Scotty (https://hackage.haskell.org/package/scotty)
• GHC RTS design (https://takenobu-hs.github.io/downloads/haskell_ghc_illustrated.pdf)
• GHC Eventlog (https://www.well-typed.com/blog/2019/09/eventful-ghc/)
• ghc-events library (https://hackage.haskell.org/package/ghc-events)
• GHC HIE files (https://www.haskell.org/ghc/blog/20190626-HIEFiles.html)

Quick Start Guide

In one terminal:

$ (cd server && stack build && stack exec code-spot-server)

In another terminal:

$ (cd client/src && npm install && npm run dev)

Now open http://localhost:5000/ in your browser!

You will see a visualisation of data/grin.eventlog (change in client/src/App.svelte).

How to build your eventlog

If stack project is used, profiling must be enabled. After compiled with profiling, one need to run it with RTS options plh.

stack build --profile --executable-profiling --library-profiling
stack exec --profile EXECUTABLE -- ARGUMENTS +RTS -p -l -h

Previews:

This project is still in the proof-of-concept phase, but we had a great fun implementing the initial version of heap inspections and the step-by-step debugger. All of these features are based on visualizing the EventLog from GHC.

Heap Live

Heap Size

Cost Center based stack trace in step-by-step style. See the demo video.

haskell-code-spot's Issues

code spot errors on ghcide

I followed the instructions and compiled then ran ghcide with:

stack build --profile --executable-profiling --library-profiling
stack exec --profile ghcide -- /tmp/blah/Bug.hs +RTS -p -l -h

I then changed the event log file, clicked fetch, and it seemed to load. Then a few seconds later:

101060
Error: <circle> attribute cx: Expected length, "NaN".

Perhaps a good enhancement would be for code spot to give up after some reasonable number like 50000 tries or so 😆

ghcideventlog.zip

Error on attempt to run NPM command in README

When I try to run the project using the quickstart instructions in the README, I get the following error:

> [email protected] dev
> rollup -c -w

[!] Error: Package subpath './compiler.js' is not defined by "exports" in /home/davidc/Downloads/haskell-code-spot/client/node_modules/svelte/package.json
Error: Package subpath './compiler.js' is not defined by "exports" in /home/davidc/Downloads/haskell-code-spot/client/node_modules/svelte/package.json
    at new NodeError (node:internal/errors:371:5)
    at throwExportsNotFound (node:internal/modules/esm/resolve:440:9)
    at packageExportsResolve (node:internal/modules/esm/resolve:692:3)
    at resolveExports (node:internal/modules/cjs/loader:482:36)
    at Function.Module._findPath (node:internal/modules/cjs/loader:522:31)
    at Function.Module._resolveFilename (node:internal/modules/cjs/loader:919:27)
    at Function.Module._load (node:internal/modules/cjs/loader:778:27)
    at Module.require (node:internal/modules/cjs/loader:1005:19)
    at require (node:internal/modules/cjs/helpers:102:18)
    at Object.<anonymous> (/home/davidc/Downloads/haskell-code-spot/client/node_modules/rollup-plugin-svelte/index.js:11:4)

SyntaxError: invalid regexp group in Firefox

Hi! I just tried out the instructions from the readme and I get "invalid regexp group" as of 222911a.

I successfully ran haskell-code-spot on my laptop some time ago at commit 429f2a3 and it worked.

Maybe I have the wrong npm version or something? I thought npm sorts all of that out, but maybe I am mistaken.

possibly related: sindresorhus/ip-regex#24