unison/development.markdown

These are commands that will likely be useful during development.

Scala

Launch sbt in runtime-jvm directory, then here are various useful commands:

• main/test:run - runs all the tests
• main/test:run compilation - runs tests prefixed by "compilation"
• main/test:run 102932 compilation.let3 - runs tests prefixed by "compilation.let3" with the random seed 102932
• benchmark/run - presents menu of benchmarks to run
• ;clean;coverage;main/test:run;coverageReport followed optionally by ;coverageOff - generates test coverage report

Haskell

For doing compilation you can do:

stack repl unison-shared
stack repl unison-node

and select the node-tests or shared-tests executable to launch a REPL with access to the tests in either the shared or node project. From here, do Main.main to run the tests and :r for rapid recompile.

You can also do:

stack build unison-shared && stack exec shared-tests
stack build unison-node && stack exec node-tests

If you want to run the tests outside the REPL.

Note: As part of shared-tests, all the Unison code in unison-src/base.u is parsed and typechecked. If you're tweaking the parser and/or typechecker and want to quickly test changes, you can add some additional definitions to this file and rerun the tests.

To build/run the node container:

stack build --flag unison-node:leveldb unison-node
stack exec container

You can leave off the --flag unison-node:leveldb if you want, but it seems to be faster than the other backends.

What if you want a profiled build? Do:

stack build --executable-profiling --library-profiling --ghc-options="-fprof-auto -rtsopts" --flag:leveldb unison-node

Again you can leave off the flag. To run the container with profiling enabled, you do:

stack exec -- container +RTS -p

That will generate a container.prof plain text file with profiling data. More info on profiling.

To submit Unison programs to the container, do something like:

curl -H "Content-Type: text/plain; charset=UTF-8" --data-binary @unison-src/searchengine.u http://localhost:8081/compute/dummynode909

You can use any name you want in place of dummynode909.

Lastly, for viewing the output of a Unison program, there's currently just one way - using the Debug.watch or Debug.log functions:

-- Prints out labeled first argument then returns the second arg
Debug.log : forall a b . Text -> b -> a -> a

-- Prints out labeled version of its argument before returning
Debug.watch : forall a . Text -> a -> a

Here's an example use:

do Remote
  Remote.transfer alice
  result := ...
  pure (Debug.watch "got result" result)

If you think the runtime is busted and need to do debugging of message flows (hopefully never!), you can edit the file $(HOME)/.unisonconfig and add a single line like logging = 3 (3 is 'info', 2 is 'warn', the default). This will generate lots of output for even simple programs though.