Merge pull request #33 from mputz86/main

Added some trouble shooting points for macOS (Big Sur) setup

book/docs/setup/MacOS.md

@@ -7,32 +7,32 @@ Go give u/RikAlexander karma!
 
 ## Notes
 
-Should work on Catalina and Big Sur. (Was tested on 2 Macs with Big Sur)  
+Should work on Catalina and Big Sur. (Was tested on 2 Macs with Big Sur)
 
 ## Setup
 
 1 - Install Nix
 
     [$] sh <(curl -L https://nixos.org/nix/install) --darwin-use-unencrypted-nix-store-volume
-    
+
 
 2 - Close terminal & reopen (to make sure that all environment variables are set)
 
 3 - Check Nix installation / version with
 
     [$] nix --version
-    
+
 
 4 - Edit the /etc/nix/nix.conf file
 
     [$] nano /etc/nix/nix.conf
-    
+
 
 5 - Add these lines to the file:
 
     substituters        = https://hydra.iohk.io https://iohk.cachix.org https://cache.nixos.org/
     trusted-public-keys = hydra.iohk.io:f/Ea+s+dFdN+3Y/G+FDgSq+a5NEWhJGzdjvKNGv0/EQ= iohk.cachix.org-1:DpRUyj7h7V830dp/i6Nti+NEO2/nhblbov/8MW7Rqoo= cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY=
-    
+
 
 _**Note:**_ These lines are there to avoid very long build times
 
@@ -43,24 +43,24 @@ _**Note 2:**_ if the file /etc/nix/nix.conf doesn't exist: create it. (`[$] mkdi
 7 - Now to install, clone the git repo first
 
     [$] git clone https://github.com/input-output-hk/plutus.git
-    
+
 
 8 - All the following builds should be executed while in the plutus directory
 
     [$] cd plutus
-    
+
 
 9 - Build the Plutus Core (This may take some time :) be patient)
 
     [$] nix build -f default.nix plutus.haskell.packages.plutus-core.components.library
-    
+
 
 _**Note:**_
 
 On MacOS BigSur some users have reported that the building failed with an error like:
 
     error: while setting up the build environment: getting attributes of path '/usr/lib/libSystem.B.dylib': No such file or directory
-    
+
 
 To resolve this, we will change the nix build to an unstable (read: newer) build of nixpkgs.
 
@@ -81,52 +81,52 @@ You should heck out these links (Thank you u/call_me_coldass):
 
     [$] nix-build -A plutus-playground.client
     [$] nix-build -A plutus-playground.server
-    
+
 
 11 - Build other plutus dependencies
 
     [$] nix-build -A plutus-playground.generate-purescript
     [$] nix-build -A plutus-playground.start-backend
     [$] nix-build -A plutus-pab
-    
+
 
 12 - Go into nix-shell
 
     [$] nix-shell
-    
+
 
 13 - inside of the nix-shell
 
     [$] cd plutus-pab
     [$] plutus-pab-generate-purs
     [$] cd ../plutus-playground-server
     [$] plutus-playground-generate-purs
-    
+
 
 14 - start the playground server
 
     [$] plutus-playground-server
-
 
-
+
+
 
 **Great! All set.**
 
-  
+
 
 15 - Now in a new terminal window:
 
     [$] cd plutus
     [$] nix-shell
     [$] cd plutus-playground-client
-    
+
 
 16 - Here we compile / build the frontend of the playground
 
     [$] npm run start
-
 
-
+
+
 
 **We're done!**
 
@@ -138,4 +138,61 @@ Open your finest browser and navigate to:
 
 Cloned from [Reddit](https://www.reddit.com/r/cardano/comments/mmzut6/macos_plutus_playground_build_instructions/)
 
-Go give u/RikAlexander karma!
+Go give u/RikAlexander karma!
+
+
+
+## Troubleshooting
+
+
+### `nix-shell` exits with segmentation fault
+
+Error message:
+```bash
+[$] nix-shell
+[1]    296 segmentation fault  nix-shell
+```
+
+Solutions:
+- Comment out the line `withHoogle = false;` in `shell.nix` before running `nix-shell`
+```nix
+#withHoogle = false;
+```
+- Better: Switch to master branch, this issue (along with others) should be solved.
+  E.g. the following fixes some more issues with macOS Big Sur
+    - Commit: 34aa9c323ed6da68a11f41d41d5aca9f469aaf4b
+    - Date: 23.04.2021
+
+
+### `haskell-language-server` fails with segmentation fault / You can't get any Haskell editor-integration working
+
+- Problem: running `[$] haskell-language-server` in one of the plutus-pioneer-program repos fails with a segmentation fault
+```bash
+[$] cd plutus-pioneer-program/code/week01
+[$] haskell-language-server
+haskell-language-server version: 0.9.0.0 ...
+...
+[INFO] Using interface files cache dir: ghcide
+[INFO] Making new HscEnv[plutus-pioneer-program-week01-0.1.0.0-inplace]
+Segmentation fault: 11
+```
+
+Solution:
+- Upgrade the `plutus` repo to a later release (maybe master branch).
+  Since `haskell-language-server` has version 0.9.0.0 (as you can see in the first line after execution) and this version is not ready for macOS Big Sur.
+_**Note**_ This error probably occurs due to the linker changes introduced in macOS Big Sur, [see](https://github.com/input-output-hk/haskell.nix/issues/982)
+
+
+### `npm run start` for the `plutus-playground-client` fails with modules not found
+
+Problem: Server exits prematurely with compilation errors. Complaining about modules it could not find.
+
+Solution:
+- Trigger rebuild of client:
+[$] cd plutus-playground-client
+[$] npm clean-install
+```
+- Try to start client: `[$] npm run start`
+- If this is insufficient, try cleaning up the git repo and redo the previous steps
+[$] git clean -xfd
+```