Skip to content

fix: environment leak when function calls error #388

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DeveloperC286 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: environment leak when function calls error #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions src/evaluator/expression/call/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
use crate::evaluator::Evaluator;
use crate::evaluator::Object;
use crate::syntax_analysis::Block;
use crate::syntax_analysis::Expression;

impl Evaluator {
Expand All @@ -19,22 +20,32 @@ impl Evaluator {
}

self.environment.push();

for (argument, parameter_identifier) in arguments.into_iter().zip(parameters) {
let argument_evaluation = self.evaluate_expression(argument)?;

self.environment
.set(parameter_identifier, argument_evaluation);
}

let block_call_evaluation = self.evaluate_block(block)?;
// The call's environment is popped before the result is propagated, so an error
// inside the call does not leave an orphaned environment behind.
let call_evaluation = self.evaluate_call(arguments, parameters, block);
self.environment.pop();
Ok(block_call_evaluation)
call_evaluation
}
object => anyhow::bail!(
"Cannot call an object of type {}, only functions are callable.",
object.type_name()
),
}
}

fn evaluate_call(
&mut self,
arguments: Vec<Expression>,
parameters: Vec<String>,
block: Block,
) -> anyhow::Result<Object> {
for (argument, parameter_identifier) in arguments.into_iter().zip(parameters) {
let argument_evaluation = self.evaluate_expression(argument)?;

self.environment
.set(parameter_identifier, argument_evaluation);
}

self.evaluate_block(block)
}
}
38 changes: 38 additions & 0 deletions src/tests/environment/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,41 @@ fn test_environment(code_1: &str, code_2: &str, code_3: &str, snapshot_name: &st
assert_successive_environment!(evaluator, code_2, format!("{snapshot_name}_2"));
assert_successive_environment!(evaluator, code_3, format!("{snapshot_name}_3"));
}

#[template]
#[rstest(
code_1,
code_2,
code_3,
snapshot_name,
case(
"let divide = fn(x) { x / 0 };",
"divide(1);",
"let a = 25;",
"environment_call_error_case_1"
),
case(
"let identity = fn(x) { x };",
"identity(1 / 0);",
"let a = 25;",
"environment_call_error_case_2"
),
case(
"let call_divide = fn(x) { let divide = fn(y) { y / 0 }; divide(x) };",
"call_divide(1);",
"let a = 25;",
"environment_call_error_case_3"
)
)]
fn environment_call_error_cases(code_1: &str, code_2: &str, code_3: &str, snapshot_name: &str) {}

// A call which errors must still pop its environment, otherwise the erroring call's environment
// leaks and every subsequent binding lands in it.
#[apply(environment_call_error_cases)]
fn test_environment_call_error(code_1: &str, code_2: &str, code_3: &str, snapshot_name: &str) {
let mut evaluator = crate::evaluator::Evaluator::new();

assert_successive_environment!(evaluator, code_1, format!("{snapshot_name}_1"));
assert_successive_environment_error!(evaluator, code_2, format!("{snapshot_name}_2"));
assert_successive_environment!(evaluator, code_3, format!("{snapshot_name}_3"));
}
31 changes: 31 additions & 0 deletions ...ey_interpreter__tests__environment__test_environment_call_error_case_1_1_environment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
source: src/tests/environment/mod.rs
expression: evaluator
---
Evaluator {
environment: Environment {
variables: {
"divide": Function {
parameters: [
"x",
],
block: Block {
nodes: [
Expression {
expression: Infix {
left_hand: Identifier {
identifier: "x",
},
operator: Divide,
right_hand: Integer {
literal: 0,
},
},
},
],
},
},
},
sub_environment: None,
},
}
5 changes: 5 additions & 0 deletions ...key_interpreter__tests__environment__test_environment_call_error_case_1_1_evaluation.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
source: src/tests/environment/mod.rs
expression: evaluation
---
Null
31 changes: 31 additions & 0 deletions ...ey_interpreter__tests__environment__test_environment_call_error_case_1_2_environment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
source: src/tests/environment/mod.rs
expression: evaluator
---
Evaluator {
environment: Environment {
variables: {
"divide": Function {
parameters: [
"x",
],
block: Block {
nodes: [
Expression {
expression: Infix {
left_hand: Identifier {
identifier: "x",
},
operator: Divide,
right_hand: Integer {
literal: 0,
},
},
},
],
},
},
},
sub_environment: None,
},
}
7 changes: 7 additions & 0 deletions ...terpreter__tests__environment__test_environment_call_error_case_1_2_evaluation_error.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
source: src/tests/environment/mod.rs
expression: error
---
Err(
"Division by zero, cannot apply the / infix operator to a right hand operand of 0.",
)
34 changes: 34 additions & 0 deletions ...ey_interpreter__tests__environment__test_environment_call_error_case_1_3_environment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
source: src/tests/environment/mod.rs
expression: evaluator
---
Evaluator {
environment: Environment {
variables: {
"a": Integer {
value: 25,
},
"divide": Function {
parameters: [
"x",
],
block: Block {
nodes: [
Expression {
expression: Infix {
left_hand: Identifier {
identifier: "x",
},
operator: Divide,
right_hand: Integer {
literal: 0,
},
},
},
],
},
},
},
sub_environment: None,
},
}
5 changes: 5 additions & 0 deletions ...key_interpreter__tests__environment__test_environment_call_error_case_1_3_evaluation.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
source: src/tests/environment/mod.rs
expression: evaluation
---
Null
25 changes: 25 additions & 0 deletions ...ey_interpreter__tests__environment__test_environment_call_error_case_2_1_environment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
source: src/tests/environment/mod.rs
expression: evaluator
---
Evaluator {
environment: Environment {
variables: {
"identity": Function {
parameters: [
"x",
],
block: Block {
nodes: [
Expression {
expression: Identifier {
identifier: "x",
},
},
],
},
},
},
sub_environment: None,
},
}
5 changes: 5 additions & 0 deletions ...key_interpreter__tests__environment__test_environment_call_error_case_2_1_evaluation.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
source: src/tests/environment/mod.rs
expression: evaluation
---
Null
25 changes: 25 additions & 0 deletions ...ey_interpreter__tests__environment__test_environment_call_error_case_2_2_environment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
source: src/tests/environment/mod.rs
expression: evaluator
---
Evaluator {
environment: Environment {
variables: {
"identity": Function {
parameters: [
"x",
],
block: Block {
nodes: [
Expression {
expression: Identifier {
identifier: "x",
},
},
],
},
},
},
sub_environment: None,
},
}
7 changes: 7 additions & 0 deletions ...terpreter__tests__environment__test_environment_call_error_case_2_2_evaluation_error.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
source: src/tests/environment/mod.rs
expression: error
---
Err(
"Division by zero, cannot apply the / infix operator to a right hand operand of 0.",
)
28 changes: 28 additions & 0 deletions ...ey_interpreter__tests__environment__test_environment_call_error_case_2_3_environment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
source: src/tests/environment/mod.rs
expression: evaluator
---
Evaluator {
environment: Environment {
variables: {
"a": Integer {
value: 25,
},
"identity": Function {
parameters: [
"x",
],
block: Block {
nodes: [
Expression {
expression: Identifier {
identifier: "x",
},
},
],
},
},
},
sub_environment: None,
},
}
5 changes: 5 additions & 0 deletions ...key_interpreter__tests__environment__test_environment_call_error_case_2_3_evaluation.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
source: src/tests/environment/mod.rs
expression: evaluation
---
Null
57 changes: 57 additions & 0 deletions ...ey_interpreter__tests__environment__test_environment_call_error_case_3_1_environment.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
source: src/tests/environment/mod.rs
expression: evaluator
---
Evaluator {
environment: Environment {
variables: {
"call_divide": Function {
parameters: [
"x",
],
block: Block {
nodes: [
Statement {
statement: Let {
identifier: "divide",
expression: Function {
parameters: [
"y",
],
block: Block {
nodes: [
Expression {
expression: Infix {
left_hand: Identifier {
identifier: "y",
},
operator: Divide,
right_hand: Integer {
literal: 0,
},
},
},
],
},
},
},
},
Expression {
expression: Call {
function: Identifier {
identifier: "divide",
},
arguments: [
Identifier {
identifier: "x",
},
],
},
},
],
},
},
},
sub_environment: None,
},
}
5 changes: 5 additions & 0 deletions ...key_interpreter__tests__environment__test_environment_call_error_case_3_1_evaluation.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
source: src/tests/environment/mod.rs
expression: evaluation
---
Null
Loading
Loading