cryptol-remote-api: Check for valid evaluation contexts
#1626
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is purely a refactoring that factors out the non-REPL-specific parts of the `validEvalContext` function into a separate `loadedParamModDeps` function. In a subsequent commit, we will use `loadedParamModDeps` in a non-REPL context.
The `check`, `prove or satisfy`, and `evaluate expression` commands now check if the type and schema of the supplied expression is valid, which can prevent panics that would arise from evaluating invalid expressions (e.g., ones that depend on definitions in parameterized modules). We do so by defining a `validEvalContext` function (inspired by a function of the same name in the Cryptol REPL) and using it where appropriate. I discovered that there was an unused error code (see the `evalInParamMod` function) in the remote API for this exact scenario, so I have repurposed the error code for this kind of situation. I've also expanded its payload to include both type parameters and definitions from the parameterized module, much like how the Cryptol REPL's `EvalInParamMod` exception currently works. Fixes #1623.
RyanGlScott
temporarily deployed
to
github-pages
GitHub Actions
Inactive
yav
approved these changes
Jun 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
check,prove or satisfy, andevaluate expressioncommands now check if the type and schema of the supplied expression is valid, which can prevent panics that would arise from evaluating invalid expressions (e.g., ones that depend on definitions in parameterized modules). We do so by defining avalidEvalContextfunction (inspired by a function of the same name in the Cryptol REPL) and using it where appropriate.I discovered that there was an unused error code (see the
evalInParamModfunction) in the remote API for this exact scenario, so I have repurposed the error code for this kind of situation. I've also expanded its payload to include both type parameters and definitions from the parameterized module, much like how the Cryptol REPL'sEvalInParamModexception currently works.Fixes #1623.