Restrict the use of the shell setting

- This was added to work around a node-security change on windows, which did not effect other platforms
- The `purs ide server` command is executed with globs that should be passed literally, not interpreted
  by the shell. Path length issues and lack of globstar in the shell used can result in a wrong set of files
  and thus missing docs/references.

This change restricts that shell setting to windows only, as the simplest thing that could possibly work. With any luck cmd.exe will not be able to interpret these globs anyway

Author: nwolverson

src/IdePurescript/Build.purs

@@ -18,14 +18,14 @@ import Effect.Exception (catchException)
 import Effect.Ref (Ref)
 import Effect.Ref as Ref
 import Foreign.Object as Object
-import IdePurescript.Exec (findBins, getPathVar, whichSync)
+import IdePurescript.Exec (findBins, getPathVar, shellSetting, whichSync)
 import IdePurescript.PscErrors (PscResult(..), parsePscOutput)
 import IdePurescript.PscIdeServer (ErrorLevel(..), Notify)
 import Node.Buffer (Buffer)
 import Node.Buffer as Buffer
 import Node.ChildProcess (ChildProcess)
 import Node.ChildProcess as CP
-import Node.ChildProcess.Types (Exit(..), enableShell)
+import Node.ChildProcess.Types (Exit(..))
 import Node.Encoding as Encoding
 import Node.Errors.SystemError (toError)
 import Node.EventEmitter (on_, once_)
@@ -73,7 +73,7 @@ spawn { command: Command cmd args, directory, useNpmDir } = do
     { path, pathExt: Nothing }
     cmd
   CP.spawn' cmd' args
-    (_ { cwd = Just directory, env = env, shell = Just enableShell })
+    (_ { cwd = Just directory, env = env, shell = shellSetting })
 
 -- Spawn with npm path, "which" call (windows support) and version info gathering
 spawnWithVersion ::
@@ -92,7 +92,7 @@ spawnWithVersion { command: Command cmd args, directory, useNpmDir } = do
                 env
             Just <$> CP.spawn' cmdBin args
               ( _
-                  { cwd = Just directory, env = Just childEnv, shell = Just enableShell }
+                  { cwd = Just directory, env = Just childEnv, shell = shellSetting }
               )
           _ -> pure Nothing
   pure { cmdBins, cp }

src/IdePurescript/Exec.purs

@@ -10,12 +10,18 @@ import Effect (Effect)
 import Effect.Aff (Aff)
 import Effect.Class (liftEffect)
 import Foreign.Object as Object
-import Node.ChildProcess.Types (enableShell)
+import Node.ChildProcess.Types (Shell, enableShell)
 import Node.Path as Path
-import Node.Process (getEnv, lookupEnv)
+import Node.Platform (Platform(..))
+import Node.Process (getEnv, lookupEnv, platform)
 import Node.Which (which')
 import PscIde.Server (Executable(..), findBins')
 
+shellSetting :: Maybe Shell
+shellSetting = case platform of
+  Just Win32 -> Just enableShell
+  _ -> Nothing
+
 findBins :: forall a. Either a String -> String -> Aff (Array Executable)
 findBins pathVar server = do
   env <- liftEffect getEnv
@@ -24,7 +30,7 @@ findBins pathVar server = do
     , path: either (const Nothing) Just pathVar
     , env: either (const Nothing) (Just <<< flip (Object.insert "PATH") env)
         pathVar
-    , shell: Just enableShell
+    , shell: shellSetting
     }
     server
 

src/IdePurescript/PscIdeServer.purs

@@ -24,11 +24,10 @@ import Data.Tuple (Tuple(..))
 import Effect (Effect)
 import Effect.Aff (Aff, attempt, try)
 import Effect.Class (liftEffect)
-import IdePurescript.Exec (findBins, getPathVar)
+import IdePurescript.Exec (findBins, getPathVar, shellSetting)
 import IdePurescript.PscIde (cwd) as PscIde
 import Node.Buffer as Buffer
 import Node.ChildProcess (ChildProcess, stderr, stdout)
-import Node.ChildProcess.Types (enableShell)
 import Node.Encoding (Encoding(..))
 import Node.EventEmitter (on_)
 import Node.Path (normalize)
@@ -231,7 +230,7 @@ startServer
             , source = glob
             , logLevel = logLevel
             , outputDirectory = outputDirectory
-            , shell = Just enableShell
+            , shell = shellSetting
             }
         )
     where

src/LanguageServer/IdePurescript/Server.purs

@@ -19,15 +19,14 @@ import Data.Time.Duration (Milliseconds(..))
 import Effect.Aff (Aff, attempt, delay, makeAff)
 import Effect.Class (class MonadEffect, liftEffect)
 import Foreign (Foreign)
-import IdePurescript.Exec (findBins, getPathVar)
+import IdePurescript.Exec (findBins, getPathVar, shellSetting)
 import IdePurescript.PscIdeServer (ErrorLevel(..), Notify)
 import IdePurescript.PscIdeServer as P
 import LanguageServer.IdePurescript.Config (ConfigFn)
 import LanguageServer.IdePurescript.Config as Config
 import LanguageServer.Protocol.Types (Settings)
 import Node.Buffer (toString)
 import Node.ChildProcess as CP
-import Node.ChildProcess.Types (enableShell)
 import Node.Encoding (Encoding(..))
 import Node.Process (lookupEnv)
 import PscIde (load)
@@ -107,7 +106,7 @@ getPackagerPaths enabled binName settings root =
         makeAff \cb -> do
           void
             $ CP.execFile' bin [ "sources" ]
-                (_ { cwd = Just root, shell = Just enableShell })
+                (_ { cwd = Just root, shell = shellSetting })
                 ( \{ stdout } -> do
                     text <- toString UTF8 stdout
                     cb $ pure $ lines text