Vector should preserve warnings #3938
Merged
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
hubertp
requested review from
jdunkerley,
radeusgd,
4e6 and
JaroslavTulach
as code owners
JaroslavTulach
approved these changes
Dec 1, 2022
radeusgd
approved these changes
Dec 2, 2022
engine/runtime/src/main/java/org/enso/interpreter/node/callable/SequenceLiteralNode.java
Outdated
Show resolved
Hide resolved
engine/runtime/src/main/java/org/enso/interpreter/runtime/data/ArrayRope.java
Outdated
Show resolved
Hide resolved
jdunkerley
approved these changes
Dec 5, 2022
hubertp
changed the title
hubertp
force-pushed
the
wip/hubert/preserve-vector-warnings-182221022
branch
from
4a1678b
to
c645b67
Compare
JaroslavTulach
approved these changes
Dec 6, 2022
| * @return the associated warnings | ||
| */ | ||
| @GenerateLibrary.Abstract(ifExported = {"hasWarnings"}) | ||
| public Warning[] getWarnings(Object receiver, Node location) throws UnsupportedMessageException { |
There was a problem hiding this comment.
Wouldn't it be easier to return any polyglot object that hasArrayElements? That might save few conversions/wrappings later.
There was a problem hiding this comment.
Can't do, it seems. Warnings need to be sorted later with per-creation timestamp
| Warning[] valuesWarnings = warningsLibrary.getWarnings(value, null); | ||
| allWarnings = new Warning[valuesWarnings.length + warningsArr.length]; | ||
| System.arraycopy(warningsArr, 0, allWarnings, 0, warningsArr.length); | ||
| System.arraycopy(valuesWarnings, 0, allWarnings, warningsArr.length, valuesWarnings.length); |
There was a problem hiding this comment.
Here we are trying hard to create Warning[] and then we are going to convert it back to TruffleObject I assume.
| public static Array getAll(Object value, WarningsLibrary warnings) { | ||
| if (warnings.hasWarnings(value)) { | ||
| try { | ||
| return new Array((Object[]) warnings.getWarnings(value, null)); |
There was a problem hiding this comment.
Here we take the array and wrap it again into TruffleObject. Maybe ArrayRope itself could be a TruffleObject?
There was a problem hiding this comment.
My main concern is that we have a contract on returning Warnings in a specific order. I think it is a topic worth exploring but potentially in a separate PR.
engine/runtime/src/main/java/org/enso/interpreter/node/callable/InvokeMethodNode.java
Show resolved
Hide resolved
...e/src/main/java/org/enso/interpreter/node/expression/builtin/text/util/ExpectStringNode.java
Outdated
Show resolved
Hide resolved
engine/runtime/src/main/java/org/enso/interpreter/runtime/data/Array.java
Outdated
Show resolved
Hide resolved
engine/runtime/src/main/java/org/enso/interpreter/runtime/data/Array.java
Outdated
Show resolved
Hide resolved
engine/runtime/src/main/java/org/enso/interpreter/runtime/data/Array.java
Outdated
Show resolved
Hide resolved
engine/runtime/src/main/java/org/enso/interpreter/runtime/data/Array.java
Outdated
Show resolved
Hide resolved
|
Checked the benchmarks and they look OK |
hubertp
force-pushed
the
wip/hubert/preserve-vector-warnings-182221022
branch
from
c645b67
to
fed4ead
Compare
radeusgd
reviewed
Dec 6, 2022
When Vector was created via a sequence literal, we simply dropped any associated any warnings associated with it. This change propagates Warnings during the creation of the Vector. Ideally, it would be sufficient to propagate warnings from the individual elements to the underlying storage but doesn't go well with `Vector.fromArray`.
Added a WarningsLibrary that exposes `hasWarnings` and `getWarnings` messages. That way we can have a single storage that defines how to extract warnings from an Array and the others just delegate to it. This simplifies logic added to sequence literals to handle warnings.
Since warnings are no longer automatically extracted from Array-like structures, we delay the operation until an actual polyglot method call is performed. Discovered a bug in `Warning.detach_selected_warnings` which was missing any usage or tests.
Previously, accessing an element of an Array-like structure would only return warnings of that element or of the structure itself. Now, accessing an element also returns warnings from all its elements as well.
hubertp
force-pushed
the
wip/hubert/preserve-vector-warnings-182221022
branch
from
8b731f6
to
fc0b232
Compare
radeusgd
approved these changes
Dec 7, 2022
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.
Pull Request Description
When Vector was created via a sequence literal, we simply dropped any associated any warnings associated with it.
Similarly doing any mapping on a Vector with warnings would create a new Vector with warnings now missing.
Rather than ducktaping every creation of
Array/Vector/whateverso that they propagate warnings, decided to address the problem at the root. Array-like structures no longer remove warnings from values. Instead, whoever uses the values should ensure, if necessary, that they are gone. This was mostly problematic for polyglot calls.Added a
WarningsLibrarythat exposeshasWarnings,getWarningsandremoveWarningsto deal with warnings-related logic. This is primarily used in Vector which delegates all calls to the underlying storage but can be used in any collection.Bonus points: warnings now survive multi-dimensional Vectors.
Important note
This PR addresses:
(initially the solution was very limited as it only addressed the former).
While working on polyglot calls discovered by accident that
Warning.detach_selected_warningswas buggy and not tested. This is now fixed.Checklist
Please include the following checklist in your PR:
Scala,
Java,
and
Rust
style guides.
./run ide buildand./run ide watch.