Implement hasLanguage interop message for all enso objects #11538

Akirathan · 2024-11-12T12:41:50Z

Pull Request Description

This PR implements the Truffle contract that all the Enso objects must export hasLanguage and getLanguage messages. By refactoring EnsoObject from an interface to an abstract class.

Important Notes

Checklist

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

Run engine and stdlib benchmarks
The documentation has been updated, if necessary.
Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
All code follows the
Scala,
Java,
TypeScript,
and
Rust
style guides. In case you are using a language not listed above, follow the Rust style guide.
Unit tests have been written where possible.
If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
or the Snowflake database integration, a run of the Extra Tests has been scheduled.
- If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

- Also, EnsoObject exports hasLanguage and getLanguage interop messages. - BranchRecord converted to class

JaroslavTulach · 2024-11-12T17:33:11Z

Quick note: I believe there are other ways to enforce the contract while keeping EnsoObject an interface.

Keep in sync with doInvoke.

…tLanguage" This reverts commit b30f396.

Keep in sync with doInvoke.

engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java

Akirathan · 2024-11-14T15:49:27Z

An approach with leaving EnsoObject as interfce, and defining a separate class LanguageForEnsoObject with @ExportLibrary(value = InteropLibrary.class, receiverType = EnsoObject.class) does not work:

diff --git a/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java b/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java
index ce60158116..eb65b641b2 100644
--- a/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java
+++ b/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java
@@ -1,6 +1,15 @@
 package org.enso.interpreter.runtime.data;

 import com.oracle.truffle.api.interop.TruffleObject;
+import com.oracle.truffle.api.library.DynamicDispatchLibrary;
+import com.oracle.truffle.api.library.ExportLibrary;
+import com.oracle.truffle.api.library.ExportMessage;

 /** All non-primitive Enso types extends from {@code EnsoObject}. */
-public interface EnsoObject extends TruffleObject {}
+@ExportLibrary(DynamicDispatchLibrary.class)
+public interface EnsoObject extends TruffleObject {
+  @ExportMessage
+  Class<?> dispatch() {
+    return LanguageForEnsoObject.class;
+  }
+}
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/LanguageForEnsoObject.java b/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/LanguageForEnsoObject.java
index cfd3eda4c0..6114f01e0e 100644
--- a/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/LanguageForEnsoObject.java
+++ b/engine/runtime/src/main/java/org/enso/interpreter/runtime/data/LanguageForEnsoObject.java
@@ -1,8 +1,10 @@
 package org.enso.interpreter.runtime.data;

+import com.oracle.truffle.api.interop.InteropLibrary;
+import com.oracle.truffle.api.interop.TruffleObject;
 import com.oracle.truffle.api.library.ExportLibrary;

-@ExportLibrary()
-public final class LanguageForEnsoObject {
-
+@ExportLibrary(value = InteropLibrary.class, receiverType = EnsoObject.class)
+public final class LanguageForEnsoObject implements TruffleObject {
+  // TODO: Export hasLanguage and getLanguage methods
 }

This patch fails to compile because Truffle DSL processor fails with errror: "@ExportLibrary is not supported for interfaces". And the receiver type must export DynamicDispatchLibrary.

TL;DR; EnsoObject cannot stay as an interface.

With the exception of toDisplayString message.

It is not automatically delegated because it is implemented in the super type.

JaroslavTulach · 2024-11-15T10:57:19Z

engine/runtime-integration-tests/src/test/java/org/enso/interpreter/test/MetaObjectTest.java

+  /**
+   * Primitive values and exceptions currently don't have an associated language.
+   *
+   * <p>TODO[PM]: Will be implemented in https://github.com/enso-org/enso/pull/11468


How do you want to associate a language with java.lang.Long or java.lang.Boolean? What language you'd like to associate with such values? JavaScript? Enso?

Language can only be associated with Enso objects - e.g. subtypes of EnsoObject!

How do you want to associate a language with java.lang.Long or java.lang.Boolean? What language you'd like to associate with such values? JavaScript? Enso?

Literal 42 in Enso is really not a literal, it is an atom of type Integer. So you can, e.g., call 42.up_to 80 . each .... The same is true for True, which is not the same as java.lang.Boolean. In the comment, I am talking about Enso "primitives" and not Java primitives.

JaroslavTulach · 2024-11-15T13:45:43Z

Quick note: I believe there are other ways to enforce the contract while keeping EnsoObject an interface.

I stay corrected. According to @chumer:

yes interfaces are deliberately not supported as interface checks are expensive.
Additionally they are a big pain to implement. (if not impossible)
...
My recommendation is to make EnseBaseObject an abstract base class. You can still keep your interface

Let's turn EnsoObject into abstract class and gain the speed!

JaroslavTulach · 2024-11-15T13:48:18Z

engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java

+
+  @ExportMessage
+  @TruffleBoundary
+  public Object toDisplayString(boolean allowSideEffects) {


This method can be abstract. I suggest to make it abstract. Definitely don't delegate to toString() - that's just a way for the guest language hacker to gain too much information about Enso interpreter internals.

Refactored to abstract in 46ebbd3 . Note that it must be public, otherwise Truffle DSL errors with something like:

[error] /home/pavel/dev/enso/engine/runtime/src/main/java/org/enso/interpreter/runtime/warning/Warning.java:24:1: error: Found invisible exported elements in super type 'EnsoObject': [error] public final class Warning extends EnsoObject { [error] ^ - org.enso.interpreter.runtime.data.EnsoObject.toDisplayString(boolean) [error] Increase their visibility to resolve this problem.

JaroslavTulach

Turning EnsoObject into abstract class has a go!

This reverts commit a06c672.

Even if it wraps Nothing

This fixes native-image build of engine-runner.

Akirathan · 2024-11-18T19:40:31Z

Benchmarks scheduled:

GitHub
Benchmark Engine · enso-org/enso@6dd7ac5
Enso Analytics is a self-service data prep and analysis platform designed for data teams. - Benchmark Engine · 6dd7ac5

GitHub
Benchmark Standard Libraries · enso-org/enso@6dd7ac5
Enso Analytics is a self-service data prep and analysis platform designed for data teams. - Benchmark Standard Libraries · 6dd7ac5

Akirathan · 2024-11-19T12:04:00Z

stdlib benchmarks at https://github.com/enso-org/enso/actions/runs/11899829089 failed. Seems like a merge of newest develop will help here. Rescheduling benchmarks:

GitHub
Benchmark Standard Libraries · enso-org/enso@6dd7ac5
Enso Analytics is a self-service data prep and analysis platform designed for data teams. - Benchmark Standard Libraries · 6dd7ac5

GitHub
Benchmark Engine · enso-org/enso@965f999
Enso Analytics is a self-service data prep and analysis platform designed for data teams. - Benchmark Engine · 965f999

GitHub
Benchmark Standard Libraries · enso-org/enso@965f999
Enso Analytics is a self-service data prep and analysis platform designed for data teams. - Benchmark Standard Libraries · 965f999

Akirathan · 2024-11-19T17:19:14Z

No regressions in benchmarks, the PR is ready to merge.

* EnsoObject is an abstract class, not an interface. - Also, EnsoObject exports hasLanguage and getLanguage interop messages. - BranchRecord converted to class * Implement public getters in BranchResult * Fix compilation of EnsoFile * Add test that all enso values must have language * Revert EnsoException - remove * DataflowError and PanicException implement hasLanguage and getLanguage * DataflowError is not EnsoObject - change signatures in some builtins * Add more members to Module.isMemberInvocable. Keep in sync with doInvoke. * Revert "DataflowError and PanicException implement hasLanguage and getLanguage" This reverts commit b30f396. * Update the test - test only non-primitive and non-exception values * Fix indexes in CodeLocationsTest * Add more members to Function.isMemberInvocable Keep in sync with doInvoke. * EnsoObject.toDisplayString delegates to toString method * EnsoObject.toDisplayString is behind TruffleBoundary * Warning exports InteropLibrary which delegates to value. With the exception of toDisplayString message. * WithWarnings needs to explicitly export toDisplayString. It is not automatically delegated because it is implemented in the super type. * EnsoObject.toDisplayString just throws AssertionError * AssertionError is behind TruffleBoundary * Implement toDisplayString on some truffle objects * Warning exports WarningsLibrary * Revert "Warning exports WarningsLibrary" This reverts commit a06c672. * Add some warnings test * Warning.isNull is always false Even if it wraps Nothing * Add some unnecessary methods to fix the compilation * EnsoObject.toDisplayString is abstract * ImportExportScope.toDisplayString is behind TruffleBoundary. This fixes native-image build of engine-runner. * Hide some toDisplayString methods behind TruffleBoundary This fixes native-image build of engine-runner. Bypassing failing test.

Akirathan added 4 commits November 12, 2024 13:24

EnsoObject is an abstract class, not an interface.

02e77fc

- Also, EnsoObject exports hasLanguage and getLanguage interop messages. - BranchRecord converted to class

Implement public getters in BranchResult

3ab4f73

Fix compilation of EnsoFile

5c5b0b7

Add test that all enso values must have language

0e48f21

Akirathan added CI: No changelog needed Do not require a changelog entry for this PR. CI: Clean build required CI runners will be cleaned before and after this PR is built. labels Nov 12, 2024

Akirathan self-assigned this Nov 12, 2024

Akirathan added 3 commits November 12, 2024 17:42

Revert EnsoException - remove

aa419c0

DataflowError and PanicException implement hasLanguage and getLanguage

b30f396

DataflowError is not EnsoObject - change signatures in some builtins

613f380

Akirathan mentioned this pull request Nov 12, 2024

Fix displaying of host values in chrome devtools #11468

Open

5 tasks

enso-bot bot mentioned this pull request Nov 12, 2024

Java Values are displayed differently in the Chrome Devtools debugger #7890

Open

Akirathan changed the title ~~Convert EnsoObject to abstract class~~ Implement hasLanguage interop message for all enso objects Nov 13, 2024

Akirathan changed the title ~~Implement hasLanguage interop message for all enso objects~~ Implement hasLanguage interop message for all enso objects Nov 13, 2024

Akirathan added 6 commits November 13, 2024 12:27

Merge branch 'develop' into wip/akirathan/enso-object-abstract

c5508db

Add more members to Module.isMemberInvocable.

c682df0

Keep in sync with doInvoke.

Revert "DataflowError and PanicException implement hasLanguage and ge…

993399a

…tLanguage" This reverts commit b30f396.

Update the test - test only non-primitive and non-exception values

130180c

Fix indexes in CodeLocationsTest

bea21a6

Add more members to Function.isMemberInvocable

a59a72a

Keep in sync with doInvoke.

JaroslavTulach reviewed Nov 14, 2024

View reviewed changes

engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java Show resolved Hide resolved

EnsoObject.toDisplayString delegates to toString method

1140546

JaroslavTulach reviewed Nov 14, 2024

View reviewed changes

engine/runtime/src/main/java/org/enso/interpreter/runtime/data/EnsoObject.java Outdated Show resolved Hide resolved

EnsoObject.toDisplayString is behind TruffleBoundary

7fa2022

Akirathan added 3 commits November 14, 2024 18:08

Warning exports InteropLibrary which delegates to value.

f0dae47

With the exception of toDisplayString message.

WithWarnings needs to explicitly export toDisplayString.

5955ff3

It is not automatically delegated because it is implemented in the super type.

EnsoObject.toDisplayString just throws AssertionError

db225ed

Akirathan marked this pull request as ready for review November 14, 2024 17:57

Akirathan requested review from 4e6 and hubertp as code owners November 14, 2024 17:57

AssertionError is behind TruffleBoundary

06d1d4c

unfurl-links bot mentioned this pull request Nov 15, 2024

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

Open

Implement toDisplayString on some truffle objects

62aefe5

JaroslavTulach reviewed Nov 15, 2024

View reviewed changes

JaroslavTulach self-requested a review November 15, 2024 13:46

JaroslavTulach reviewed Nov 15, 2024

View reviewed changes

JaroslavTulach approved these changes Nov 15, 2024

View reviewed changes

Akirathan added 8 commits November 15, 2024 19:28

Warning exports WarningsLibrary

a06c672

Revert "Warning exports WarningsLibrary"

9f33d74

This reverts commit a06c672.

Add some warnings test

92722b8

Warning.isNull is always false

adb2d05

Even if it wraps Nothing

Add some unnecessary methods to fix the compilation

9a79c84

EnsoObject.toDisplayString is abstract

46ebbd3

ImportExportScope.toDisplayString is behind TruffleBoundary.

1c56a4c

This fixes native-image build of engine-runner.

Hide some toDisplayString methods behind TruffleBoundary

6dd7ac5

This fixes native-image build of engine-runner.

Merge branch 'develop' into wip/akirathan/enso-object-abstract

965f999

jdunkerley merged commit 04075c5 into develop Nov 20, 2024
42 of 43 checks passed

jdunkerley deleted the wip/akirathan/enso-object-abstract branch November 20, 2024 13:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement hasLanguage interop message for all enso objects #11538

Implement hasLanguage interop message for all enso objects #11538

Akirathan commented Nov 12, 2024 •

edited

Loading

JaroslavTulach commented Nov 12, 2024

Akirathan commented Nov 14, 2024

JaroslavTulach Nov 15, 2024

Akirathan Nov 15, 2024

JaroslavTulach commented Nov 15, 2024

JaroslavTulach Nov 15, 2024

Akirathan Nov 18, 2024

JaroslavTulach left a comment

Akirathan commented Nov 18, 2024 •

edited by unfurl-links bot

Loading

Akirathan commented Nov 19, 2024 •

edited by unfurl-links bot

Loading

Akirathan commented Nov 19, 2024 •

edited

Loading

Implement hasLanguage interop message for all enso objects #11538

Implement hasLanguage interop message for all enso objects #11538

Conversation

Akirathan commented Nov 12, 2024 • edited Loading

Pull Request Description

Important Notes

Checklist

JaroslavTulach commented Nov 12, 2024

Akirathan commented Nov 14, 2024

JaroslavTulach Nov 15, 2024

Choose a reason for hiding this comment

Akirathan Nov 15, 2024

Choose a reason for hiding this comment

JaroslavTulach commented Nov 15, 2024

JaroslavTulach Nov 15, 2024

Choose a reason for hiding this comment

Akirathan Nov 18, 2024

Choose a reason for hiding this comment

JaroslavTulach left a comment

Choose a reason for hiding this comment

Akirathan commented Nov 18, 2024 • edited by unfurl-links bot Loading

Akirathan commented Nov 19, 2024 • edited by unfurl-links bot Loading

Akirathan commented Nov 19, 2024 • edited Loading

Akirathan commented Nov 12, 2024 •

edited

Loading

Akirathan commented Nov 18, 2024 •

edited by unfurl-links bot

Loading

Akirathan commented Nov 19, 2024 •

edited by unfurl-links bot

Loading

Akirathan commented Nov 19, 2024 •

edited

Loading