[ refactor ] Improve error handling in `Core` #3434

spcfox · 2024-12-03T12:13:22Z

Description

Added utility functions to handle errors in Core.
Added new error types: NonZeroExitCode, SystemError, CodegenNotFound, UnsupportedOpertaion.
Added error handling in many places where they were ignored.
All coreLift_ calls replaced by explicit result processing.
Removed Maybe from compileExpr and incCompileFile signatures. Instead of returning Nothing, throw is used. Earlier both variants were found in the code. Using throw allows you to pass a more clear error.
fix Successful exit code after error in --exec #3427: the --exec command returns the program exit code. If several --exec options are passed, the result of the last execution will be returned.
Removed CompilationFailed from REPLResult. More specific errors using throw are returned instead.

Should this change go in the CHANGELOG?

If this is a fix, user-facing change, a compiler change, or a new paper
implementation, I have updated CHANGELOG_NEXT.md (and potentially also
CONTRIBUTORS.md).

…ignatures

src/Compiler/ES/Node.idr

src/Compiler/RefC/RefC.idr

gallais · 2024-12-03T13:28:19Z

src/Compiler/Scheme/Gambit.idr

-         ok <- coreLift $ system cmd
-         if ok == 0
-            then pure (Just execPath)
-            else pure Nothing
+         safeSystem cmd
+         pure (Just execPath)


This is not logically equivalent. Why is it legitimate to drop the Nothing branch?

safeSystem throws an error if the exit code is not zero. This makes the errors more clear

gallais · 2024-12-03T13:30:52Z

src/Compiler/Scheme/Racket.idr

+         when mkexec $ logTime 1 "Build racket" $
+             safeSystem $ raco ++ ["-o", outBinAbs, outRktAbs]
+
+         -- TODO: add launcher script
+         let outShRel = outputDir </> outfile
+         makeShPlatform isWindows (if mkexec then "" else racket ++ " ") outShRel appDirRel outRktFile
+         handleFileError outShRel $ chmodRaw outShRel 0o755
+         pure (Just outShRel)


Again we're also dropping the Nothing branch

safeSystem throw NonZeroExitCode. I replaced all Nothing with throw. Currently Nothing just wraps around to CompilationFailed. A more specific cause of the error is passed to throw.

Idris2/src/Idris/REPL.idr

Lines 815 to 818 in ec74792

ok <- compile cg tm_erased outfile

maybe (pure CompilationFailed)

(pure . Compiled)

ok

spcfox · 2024-12-03T19:34:09Z

src/Compiler/ES/Node.idr

     node <- coreLift findNode
-     quoted_node <- pure $ "\"" ++ node ++ "\"" -- Windows often have a space in the path.
-     coreLift_ $ system (quoted_node ++ " " ++ outn)
+     system $ "\"" ++ node ++ "\" " ++ out -- Windows often have a space in the path.


Why does escapeArg not enclose in quotes in Windows?

Idris2/libs/base/System/Escape.idr

Lines 10 to 14 in ec74792

escapeArg : String -> String

escapeArg cmd = let escapedCmdChars = pack $ unpack cmd >>= escapeArgChar in

if isWindows

then escapedCmdChars

else "\"" ++ escapedCmdChars ++ "\""

Oh, it escapes spaces, okay

Idris2/libs/base/System/Escape.idr

Line 21 in ec74792

c == ' ' || c == '\t' || c == '\n' || c == ';' || c == ',' || c == '=' || c == '\x0B' || c == '\x0C' || c == '\xFF' ||

Maybe, it worth to add a comment nearby about this to make it clear for the future readers

CI on windows fails if I replace quoting with escapeArg. It's looks like problem with escapeArg

CI on windows fails if I replace quoting with escapeArg. It's looks like problem with escapeArg

I think it's a Node.js problem nodejs/node#56146

…ir` and `changeDir`

spcfox added 6 commits December 3, 2024 14:58

[ base ] Replace believe_me with proof in Cast Int ExitCode

c62d5dd

[ refactor ] Improve error handling in Core

2b9ce71

[ refactor ] Remove Maybe from compileExpr and incCompileFile s…

7ebca98

…ignatures

[ refactor ] Return the exit code from the --exec command

2ebca14

Update contributors list

d8d360a

[ fix ] Add cast from Int to ExitCode to Libraries

49fd711

spcfox force-pushed the cg-error-handle branch from d89dd5a to 49fd711 Compare December 3, 2024 13:02

spcfox added 2 commits December 3, 2024 16:09

[ refactor ] Add docs to Core.currentDir

2957ed3

[ test ] Add test for exit code in REPL

bbbe608

spcfox marked this pull request as draft December 3, 2024 13:41

gallais reviewed Dec 3, 2024

View reviewed changes

[ fix ] Fix tests and node execution

b14709a

spcfox commented Dec 3, 2024

View reviewed changes

spcfox added 5 commits December 3, 2024 23:35

[ fix ] Fix racket compiler

efda936

[ refactor ] Rename changeDir and unsafeChangeDir to `safeChangeD…

da95aee

…ir` and `changeDir`

[ refactor ] Add CodegenNotFound error

97db425

[ refactor ] Add UnsupportedOpertaion Error

6ae2977

[ fix ] Return coreLift_

93f89ef

spcfox marked this pull request as ready for review December 4, 2024 12:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ refactor ] Improve error handling in `Core` #3434

[ refactor ] Improve error handling in `Core` #3434

spcfox commented Dec 3, 2024 •

edited

Loading

gallais Dec 3, 2024

spcfox Dec 3, 2024

gallais Dec 3, 2024

spcfox Dec 3, 2024 •

edited

Loading

spcfox Dec 3, 2024

spcfox Dec 5, 2024

buzden Dec 5, 2024

spcfox Dec 5, 2024

spcfox Dec 5, 2024 •

edited

Loading

	ok <- compile cg tm_erased outfile
	maybe (pure CompilationFailed)
	(pure . Compiled)
	ok

	escapeArg : String -> String
	escapeArg cmd = let escapedCmdChars = pack $ unpack cmd >>= escapeArgChar in
	if isWindows
	then escapedCmdChars
	else "\"" ++ escapedCmdChars ++ "\""

[ refactor ] Improve error handling in Core #3434

Are you sure you want to change the base?

[ refactor ] Improve error handling in Core #3434

Conversation

spcfox commented Dec 3, 2024 • edited Loading

Description

Should this change go in the CHANGELOG?

gallais Dec 3, 2024

Choose a reason for hiding this comment

spcfox Dec 3, 2024

Choose a reason for hiding this comment

gallais Dec 3, 2024

Choose a reason for hiding this comment

spcfox Dec 3, 2024 • edited Loading

Choose a reason for hiding this comment

spcfox Dec 3, 2024

Choose a reason for hiding this comment

spcfox Dec 5, 2024

Choose a reason for hiding this comment

buzden Dec 5, 2024

Choose a reason for hiding this comment

spcfox Dec 5, 2024

Choose a reason for hiding this comment

spcfox Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

[ refactor ] Improve error handling in `Core` #3434

[ refactor ] Improve error handling in `Core` #3434

spcfox commented Dec 3, 2024 •

edited

Loading

spcfox Dec 3, 2024 •

edited

Loading

spcfox Dec 5, 2024 •

edited

Loading