Promote broken values instead of ignoring them #11777

JaroslavTulach · 2024-12-05T10:17:35Z

Pull Request Description

Partially fixes #5430 by propagating DataflowErrors found during statement execution out of the method.

Important Notes

This change may affect behavior of existing methods that ignore DataflowError as discussed here.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

The documentation has been updated, if necessary.
All code follows the
Scala,
Java,
Unit tests have been written where possible.
Engine benchmarks run is fine
StdLib benchmarks run seems fine

...ion-tests/src/test/java/org/enso/interpreter/test/semantic/DataflowErrorPropagationTest.java

Akirathan · 2024-12-05T10:51:55Z

engine/runtime/src/main/java/org/enso/interpreter/node/callable/function/BlockNode.java

    for (ExpressionNode statement : statements) {
-      statement.executeGeneric(frame);
+      var result = statement.executeGeneric(frame);
+      if (result != nothing) {


Why not get rid of this if statement and use simply just if (result instanceof DataflowError err). If it is an instance of DataflowError, it cannot be nothing.

Indeed this seems redundant, can we remove it, or is there some reason that we don't see here?

The reason is the other part of #5430:

what should happen when the value is not Nothing

and it is not DataflowError (which is immediately returned)

Avoid discarded (error) values in runtime #5430 talks about such values, but

I don't know what to do with them (they are not as simple as DataflowError)

related is Unexpected block behaviour with multiline operators #9944

We don't need to solve it in this PR. Just my 2 Kč explanation of the != Nothing check. In any case, that's for another PR.

JaroslavTulach · 2024-12-05T12:14:27Z

There are two failed tests in standard libraries:

This is the kind of errors we can expect if we enable this DataflowError propagation. Can you fix the tests easily, @GregoryTravis, @radeusgd?

Btw. this change makes the Decimal_Spec error go away:

diff --git test/Base_Tests/src/Data/Decimal_Spec.enso test/Base_Tests/src/Data/Decimal_Spec.enso
index 3465ce9cd8..6e3a463b82 100644
--- test/Base_Tests/src/Data/Decimal_Spec.enso
+++ test/Base_Tests/src/Data/Decimal_Spec.enso
@@ -487,7 +487,7 @@ add_specs suite_builder =
             (Decimal.from_integer 7297927982888383 . multiply  (Decimal.from_integer 828737) (Math_Context.new 6)) . should_equal (Decimal.from_integer 6048060000000000000000 )
             (Decimal.new "893872388.3535345" . multiply  (Decimal.new "72374727737.23434535") (Math_Context.new 14)) . should_equal (Decimal.new "64693770738918000000")
 
-            (Decimal.new "909678645268840" . divide (Decimal.new "28029830") (Math_Context.new 6)) . should_equal (Decimal.new "32453900 ")
+            _ = (Decimal.new "909678645268840" . divide (Decimal.new "28029830") (Math_Context.new 6)) . should_equal (Decimal.new "32453900 ")
             (Decimal.new "384456406.7860325392609633764" . divide (Decimal.new "24556.125563546") (Math_Context.new 7)) . should_equal (Decimal.new "15656.23")
 
             (Decimal.from_integer 3948539458034580838458034803485 . add (Decimal.from_integer 237957498573948579387495837459837) (Math_Context.new 20)) . should_equal (Decimal.from_integer 241906038031983160230000000000000)

e.g. exactly as expected it is enough to add a dummy assignment and the problem goes away. I assume you want to do a better fix @GregoryTravis - please integrate it into my branch, so it gets green.

diff --git test/Base_Tests/src/Data/Time/Date_Range_Spec.enso test/Base_Tests/src/Data/Time/Date_Range_Spec.enso
index b2b469ae1c..22843aa6cb 100644
--- test/Base_Tests/src/Data/Time/Date_Range_Spec.enso
+++ test/Base_Tests/src/Data/Time/Date_Range_Spec.enso
@@ -157,7 +157,7 @@ add_specs suite_builder =
                 r.partition p . should_equal (r.to_vector.partition p)
                 r.all p . should_equal (r.to_vector.all p)
                 r.any p . should_equal (r.to_vector.any p)
-                r.find p . should_equal (r.to_vector.find p)
+                _ = r.find p . should_equal (r.to_vector.find p)
                 r.index_of p . should_equal (r.to_vector.index_of p)
                 r.last_index_of p . should_equal (r.to_vector.last_index_of p)
                 count_mondays acc date =
@@ -170,7 +170,7 @@ add_specs suite_builder =
                 r.partition fc . should_equal (r.to_vector.partition fc)
                 r.all fc . should_equal (r.to_vector.all fc)
                 r.any fc . should_equal (r.to_vector.any fc)
-                r.find fc . should_equal (r.to_vector.find fc)
+                _ = r.find fc . should_equal (r.to_vector.find fc)
                 r.index_of fc . should_equal (r.to_vector.index_of fc)
                 r.last_index_of fc . should_equal (r.to_vector.last_index_of fc)

same for Date_Range_Spec @radeusgd.

…wrongly written test

radeusgd

Santa came early this year! 🎄
I'm so happy to finally see this change - deep down I knew we may be losing something due to the unhandled errors disappearing into the void. And you confirmed my suspicions. Thankfully that isn't that many errors and they look relatively harmless. But I'm happy that from now on I can keep writing code with the peace of mind that errors will go on unnoticed.

Also we can now remove most instances of if_not_error - yay! 🎉 It was basically a workaround for ensuring error propagation. I guess we want to keep the function because it is still useful when we want to control the propagation with 'more precision'. But in numerous cases it should be no longer needed and we can remove a lot of unnecessary indentation from the code.

I submitted commits that fix should_equal silently breaking if expected value provided is dataflow error (in that case should_fail_with is expected). I will add a commit fixing the Date_Range_Spec tests in a moment.

JaroslavTulach · 2024-12-05T13:40:03Z

we want to keep the function because ...

... we already published first customer releases and we are dedicated to backward compatibility, right?

JaroslavTulach · 2024-12-06T03:53:51Z

Engine benchmarks run is fine - looks like nobody writes benchmarks for errors ;-) I also glanced StdLib benchmarks run and found nothing suspicious.

JaroslavTulach · 2024-12-06T03:55:50Z

@radeusgd, @GregoryTravis there are still failures in stdlib tests:

Can you fix them?

jdunkerley

Approving the libs bits.

…ateDataflowError5429

JaroslavTulach · 2024-12-09T13:32:48Z

Except these two errors:

Date_Range

Decimal_Spec

There seem to be additional ones:

GregoryTravis · 2024-12-10T15:21:52Z

Can you fix them?

I will look at these, after the release.

engine/runtime/src/main/java/org/enso/interpreter/node/callable/function/BlockNode.java

radeusgd · 2024-12-17T18:17:44Z

I think I have fixed all the test failures in stdlib, let's see what the CI says.

I also scheduled a run of the nightly CI: https://github.com/enso-org/enso/actions/runs/12378958829 - not sure if Snowflake will run as it has failing tests on develop but we can at least see if there are no more failures than expected.

GitHub
Extra Nightly Tests · enso-org/enso@434ba8a
Enso Analytics is a self-service data prep and analysis platform designed for data teams. - Extra Nightly Tests · 434ba8a

JaroslavTulach

Thank you guys for fixing the test failures. Radek, I don't like the rhs_error_check "friend API situation". We shouldn't be cheating like this (at least not in my PR ;-).

JaroslavTulach · 2024-12-18T06:25:32Z

distribution/lib/Standard/Test/0.0.0-dev/src/Extensions.enso

-                                p.first != p.second
-                            "; first difference at index " + diff.to_text + " "
-                        False -> "; lengths differ (" + self.length.to_text + " != " + that.length.to_text + ") "
+Any.should_equal self that frames_to_skip=0 = rhs_error_check that <|


Finally I see it. This wraps the original code in rhs_error_check helper function. It doesn't change API of Any.should_equal (it is not easy to see that when argument definition is mixed with code on the same line). As a result of the additional function call, the frames shift and thus 4+frame_to_skip. The rest remains unchanged.

JaroslavTulach · 2024-12-18T06:29:09Z

distribution/lib/Standard/Test/0.0.0-dev/src/Extensions.enso

@@ -294,15 +297,20 @@ Error.should_equal self that frames_to_skip=0 =
            1.00000001 . should_equal 1.00000002 epsilon=0.0001
 Number.should_equal : Float -> Float -> Integer -> Spec_Result
 Number.should_equal self that epsilon=0 frames_to_skip=0 =
-    matches = case that of


This change is way easier of parse, we the function signature clearly stays unaffected.

distribution/lib/Standard/Test/0.0.0-dev/src/Extensions_Helpers.enso

test/Table_Tests/src/Util.enso

…ateDataflowError5430

Partially fixes #5430 by propagating `DataflowError`s found during statement execution out of the method. # Important Notes This change [may affect behavior](https://github.com/enso-org/enso/pull/11673/files#r1871128327) of existing methods that ignore `DataflowError` as [discussed here](https://github.com/enso-org/enso/pull/11673/files#r1871128327).

Currently a DataflowError may get lost in a middle of block statements

1c2d007

JaroslavTulach self-assigned this Dec 5, 2024

JaroslavTulach requested review from 4e6, hubertp and Akirathan as code owners December 5, 2024 10:17

Propagate Error ASAP instead of ignoring it

49c628e

JaroslavTulach changed the title ~~Currently a DataflowError may get lost in a middle of block statements~~ Propagate DataflowError in middle of block instead of ignoring it Dec 5, 2024

JaroslavTulach requested a review from radeusgd December 5, 2024 10:25

JaroslavTulach commented Dec 5, 2024

View reviewed changes

...ion-tests/src/test/java/org/enso/interpreter/test/semantic/DataflowErrorPropagationTest.java Show resolved Hide resolved

JaroslavTulach mentioned this pull request Dec 5, 2024

Clear cache on reload #11673

Merged

5 tasks

JaroslavTulach requested a review from GregoryTravis December 5, 2024 10:35

Akirathan reviewed Dec 5, 2024

View reviewed changes

Akirathan approved these changes Dec 5, 2024

View reviewed changes

check for dataflow error in should_equal rhs and report it - this is …

91f7497

…wrongly written test

radeusgd requested review from jdunkerley, AdRiley and marthasharkey as code owners December 5, 2024 13:05

add error check in remaining should_equal overrides

1ed8505

radeusgd approved these changes Dec 5, 2024

View reviewed changes

enso-bot bot mentioned this pull request Dec 6, 2024

Allow (multi_value : Table) : Column to succeed #11482

Closed

align behaviour of find across range/vector

7373304

jdunkerley approved these changes Dec 6, 2024

View reviewed changes

Merge remote-tracking branch 'origin/develop' into wip/jtulach/Propag…

00516f5

…ateDataflowError5429

JaroslavTulach mentioned this pull request Dec 11, 2024

Enhance Managed_Resource to allow implementation of in-memory caches #11577

Merged

3 tasks

radeusgd added 6 commits December 17, 2024 12:52

fix invalid tests

bed6609

remove unnecessary Not_Found type (clashing with another existing one)

1647c53

remove check that was actually too strict

ef80339

fix cloud test cleanup

a8571c4

fix a test which was propagating error and crashing suite builder

6551756

fixing other tests that break Table Tests progress

09fb17f

JaroslavTulach commented Dec 17, 2024

View reviewed changes

engine/runtime/src/main/java/org/enso/interpreter/node/callable/function/BlockNode.java Show resolved Hide resolved

GregoryTravis approved these changes Dec 17, 2024

View reviewed changes

radeusgd added 2 commits December 17, 2024 18:34

fixing more issues in Table tests

3b8c089

enable Context to fix lazy init issue

434ba8a

enso-bot bot mentioned this pull request Dec 18, 2024

Too many duplicated Name.Literal instances #10330

Closed

JaroslavTulach added 2 commits December 18, 2024 07:21

Merging with latest develop

777c38b

Speculate on statements returning Nothing

8748349

JaroslavTulach commented Dec 18, 2024

View reviewed changes

JaroslavTulach and others added 7 commits December 18, 2024 07:58

Code style issues found in CHANGELOG.md file

b7430cb

duplicate rhs_error_check and make it imperative to avoid nesting

fe5b9e1

fix offsets and finally add tests for this

3ce19c7

Documenting propagation of _broken values_

afedc71

Renaming to Errors & Panics

bda76cf

Merge remote-tracking branch 'origin/develop' into wip/jtulach/Propag…

0130601

…ateDataflowError5430

Reorganizing changelog

5916204

JaroslavTulach changed the title ~~Propagate DataflowError in middle of block instead of ignoring it~~ Promote broken values instead of ignoring them Dec 19, 2024

JaroslavTulach added CI: No changelog needed Do not require a changelog entry for this PR. CI: Keep up to date Automatically update this PR to the latest develop. CI: Ready to merge This PR is eligible for automatic merge labels Dec 19, 2024

Merge branch 'develop' into wip/jtulach/PropagateDataflowError5430

5bfe082

mergify bot merged commit 014b562 into develop Dec 19, 2024
35 of 37 checks passed

mergify bot deleted the wip/jtulach/PropagateDataflowError5430 branch December 19, 2024 11:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Promote broken values instead of ignoring them #11777

Promote broken values instead of ignoring them #11777

JaroslavTulach commented Dec 5, 2024 •

edited

Loading

Akirathan Dec 5, 2024

radeusgd Dec 5, 2024

JaroslavTulach Dec 5, 2024 •

edited

Loading

JaroslavTulach commented Dec 5, 2024 •

edited

Loading

radeusgd left a comment

JaroslavTulach commented Dec 5, 2024

JaroslavTulach commented Dec 6, 2024

JaroslavTulach commented Dec 6, 2024

jdunkerley left a comment

JaroslavTulach commented Dec 9, 2024

GregoryTravis commented Dec 10, 2024

radeusgd commented Dec 17, 2024 •

edited by unfurl-links bot

Loading

JaroslavTulach left a comment

JaroslavTulach Dec 18, 2024

JaroslavTulach Dec 18, 2024

Promote broken values instead of ignoring them #11777

Promote broken values instead of ignoring them #11777

Conversation

JaroslavTulach commented Dec 5, 2024 • edited Loading

Pull Request Description

Important Notes

Checklist

Akirathan Dec 5, 2024

Choose a reason for hiding this comment

radeusgd Dec 5, 2024

Choose a reason for hiding this comment

JaroslavTulach Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

JaroslavTulach commented Dec 5, 2024 • edited Loading

radeusgd left a comment

Choose a reason for hiding this comment

JaroslavTulach commented Dec 5, 2024

JaroslavTulach commented Dec 6, 2024

JaroslavTulach commented Dec 6, 2024

jdunkerley left a comment

Choose a reason for hiding this comment

JaroslavTulach commented Dec 9, 2024

GregoryTravis commented Dec 10, 2024

radeusgd commented Dec 17, 2024 • edited by unfurl-links bot Loading

JaroslavTulach left a comment

Choose a reason for hiding this comment

JaroslavTulach Dec 18, 2024

Choose a reason for hiding this comment

JaroslavTulach Dec 18, 2024

Choose a reason for hiding this comment

JaroslavTulach commented Dec 5, 2024 •

edited

Loading

JaroslavTulach Dec 5, 2024 •

edited

Loading

JaroslavTulach commented Dec 5, 2024 •

edited

Loading

radeusgd commented Dec 17, 2024 •

edited by unfurl-links bot

Loading