Reducing helper methods in `Standard.Base.Meta` #12031

JaroslavTulach · 2025-01-09T14:28:36Z

Pull Request Description

reducing the amount of code inside of Meta.enso in preparation of Function metadata call #5226
moving Instrumenter into internal packages
moving Instrumenter.uuid (used by visualizations) into Runtime.value_for_uuid
fixing Meta.meta Cons... behavior for no non-default argument constructors

Important Notes

This is the snapshot of Meta API
Turning Meta.is_a from a builtin into regular method had its issues - solved by Prefer module methods over Any instance ones #12048
Making Meta.Type, Meta.Atom, etc. constructors private revealed another set of problems - solved by Types with private constructors can be public #12052

Checklist

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

All code follows the formatting guidelines
Unit tests have been written where possible.
Signature test for Meta API snapshot written

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

distribution/lib/Standard/Base/0.0.0-dev/src/Meta_Helpers.enso

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso

…lpers5226

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

… Any

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

…access to such types

test/Examples_Tests/src/Signatures_Spec.enso

JaroslavTulach · 2025-01-21T06:54:45Z

...ne/runtime/src/main/java/org/enso/interpreter/node/expression/builtin/meta/MetaKindNode.java

+final class MetaKindNode extends Node {
+  final long execute(@AcceptsError Object value) {
+    if (value instanceof Atom) {
+      return 2;


I expect magic constant complains... but the most important thing is consistency with Enso source code and I am not aware of any other way to enforce it than having some tests (which do exist).

Fair. It is indeed well-tested I think.

I'd just add a comment in both files mentioning that we want to be consistent with the other file - so if any modification has to happen it is easier to find where the relevant parts are.

I don't want to risk loosing the green CI status.

Is that really a good reason to submit code with bad formatting to the repo?

All code follows the formatting guidelines

This is no longer true.

I know we don't (yet) have an official style guide for Enso but misaligned comments are surely not something we should introduce not-by-mistake.

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso

JaroslavTulach · 2025-01-21T08:59:03Z

There is a failure in test/Table_Tests related to removal of Instrumentor, @radeusgd:

Reason: An unexpected panic was thrown: (No_Such_Method.Error (Unresolved_Symbol.Value UnresolvedSymbol<collapsed>) UnresolvedSymbol<instrument>)
️         at <enso> Table_Aggregate_Auto_Constructor.perform<arg-0>(/Users/runner/work/enso/enso/test/Table_Tests/src/Helpers/Table_Aggregate_Auto_Constructor.enso:50:20-52)
️         at <enso> Table_Aggregate_Auto_Constructor.perform<arg-0>(/Users/runner/work/enso/enso/test/Table_Tests/src/Helpers/Table_Aggregate_Auto_Constructor.enso:51:11-24)
️         at <enso> Table_Aggregate_Auto_Constructor.perform<arg-0>(/Users/runner/work/enso/enso/test/Table_Tests/src/Helpers/Table_Aggregate_Auto_Constructor.enso:52:11-27)
️         at <enso> Table_Aggregate_Auto_Constructor.perform<arg-0>(/Users/runner/work/enso/enso/test/Table_Tests/src/Helpers/Table_Aggregate_Auto_Constructor.enso:53:11-25)
️         at <enso> Table_Aggregate_Auto_Constructor.perform(/Users/runner/work/enso/enso/test/Table_Tests/src/Helpers/Table_Aggregate_Auto_Constructor.enso:54:11-18)
️         at <enso> Auto_Constructor_Instrumentation_Spec.add_specs.Auto_Constructor_Instrumentation_Spec.add_specs<arg-1>(/Users/runner/work/enso/enso/test/Table_Tests/src/Helpers/Auto_Constructor_Instrumentation_Spec.enso:13:20-80)

Shall I create test/Table_Internal_Tests and move the test in there?

Update: 67fcec2 creates test/Table_Internal_Tests.

…lpers5226

hubertp

Please provide instructions in a more visible location.

test/Examples_Tests/src/Signatures_Spec.enso

JaroslavTulach · 2025-01-22T05:55:26Z

test/Examples_Tests/data/signatures/Meta.md

@@ -0,0 +1,48 @@
+## Enso Signatures 1.0
+## module Standard.Base.Meta


Snapshot of the Meta API used by the Signature_Spec

distribution/lib/Standard/Base/0.0.0-dev/src/Internal/Instrumentor.enso

… of a value

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Dictionary.enso

Akirathan

LGTM. Just minor nitpicks.

Akirathan · 2025-01-22T16:10:45Z

test/Base_Tests/src/Semantic/Meta_Spec.enso

@@ -346,6 +354,30 @@ add_specs suite_builder =
            Meta.get_annotation My_Type .Value "bar" . should_equal Nothing
            Meta.get_annotation My_Type .Value "baz" . should_equal (My_Type.Value 1 2 3)

+        group_builder.specify "atom constructor with suspended evalution" <|


Suggested change

group_builder.specify "atom constructor with suspended evalution" <|

group_builder.specify "atom constructor with suspended evaluation" <|

Akirathan · 2025-01-22T16:11:05Z

test/Base_Tests/src/Semantic/Meta_Spec.enso

+                _ ->
+                    Test.fail "Expecting Meta.Constructor, but was: "+m.to_text
+
+        group_builder.specify "atom without suspended evalution" <|


Suggested change

group_builder.specify "atom without suspended evalution" <|

group_builder.specify "atom without suspended evaluation" <|

Akirathan · 2025-01-22T16:23:29Z

...src/main/java/org/enso/interpreter/node/expression/builtin/meta/FindAtomConstructorNode.java

+        if (MethodRootNode.constructorFor(fn) instanceof AtomConstructor atom) {
+          return atom;
+        }
+        if (fn.isThunk()) {


Can there be a nested thunk inside a thunk? If not, I would remove the for loop, and just check if fn.isThunk at the beginning of the method and solve the thunk first.

I am working on changing this line in a subsequent PR that is going to introduce Meta.Function.

Moving @Builtin_Method definitions outside of Meta

d2ce49c

JaroslavTulach self-assigned this Jan 9, 2025

JaroslavTulach requested review from jdunkerley, radeusgd, GregoryTravis, AdRiley, marthasharkey, 4e6, hubertp and Akirathan as code owners January 9, 2025 14:28

JaroslavTulach commented Jan 9, 2025

View reviewed changes

engine/runtime-integration-tests/src/test/java/org/enso/interpreter/test/meta/MetaIsATest.java Outdated Show resolved Hide resolved

radeusgd reviewed Jan 9, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Meta_Helpers.enso Outdated Show resolved Hide resolved

JaroslavTulach mentioned this pull request Jan 9, 2025

Function metadata call #5226

Open

radeusgd reviewed Jan 9, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso Outdated Show resolved Hide resolved

JaroslavTulach commented Jan 9, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso Show resolved Hide resolved

JaroslavTulach commented Jan 9, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso Show resolved Hide resolved

JaroslavTulach commented Jan 9, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso Outdated Show resolved Hide resolved

JaroslavTulach commented Jan 9, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso Outdated Show resolved Hide resolved

enso-bot bot mentioned this pull request Jan 10, 2025

caught_panic.stack_trace includes stack frames from the handler itself #8153

Closed

JaroslavTulach added 4 commits January 13, 2025 05:42

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

a18693e

…lpers5226

Moving Meta_Helpers into Internal namespace

531ecdf

Reverting changes in tests. Meta.is_a has to work.

4ae769b

Adjustiments to call Meta.is_a even it is not builtin

9770c1a

JaroslavTulach commented Jan 13, 2025

View reviewed changes

engine/runtime/src/main/java/org/enso/interpreter/node/callable/InvokeMethodNode.java Outdated Show resolved Hide resolved

Dispatch on non-associated type continues to prefer virtual method on…

17fdff4

… Any

JaroslavTulach commented Jan 13, 2025

View reviewed changes

engine/runtime-integration-tests/src/test/java/org/enso/interpreter/test/AnyOrStaticTest.java Outdated Show resolved Hide resolved

JaroslavTulach added 2 commits January 13, 2025 11:30

Making constructors of Meta types private reveals issues in checking …

0c074ac

…access to such types

Type is always public even it has no public constructors

4ef7d8b

JaroslavTulach added the CI: Clean build required CI runners will be cleaned before and after this PR is built. label Jan 13, 2025

Meta.Constructor can be converted to qualified accessor Function

fd5d2af

JaroslavTulach commented Jan 21, 2025

View reviewed changes

test/Examples_Tests/src/Signatures_Spec.enso Outdated Show resolved Hide resolved

JaroslavTulach added 2 commits January 21, 2025 07:29

Robust when --in-project distribution/lib/Standard/Base/0.0.0-dev/

dc5d820

Moving value_for_uuid into Runtime

2f78b17

JaroslavTulach marked this pull request as ready for review January 21, 2025 06:49

JaroslavTulach requested a review from radeusgd January 21, 2025 06:49

JaroslavTulach commented Jan 21, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Meta.enso Show resolved Hide resolved

JaroslavTulach mentioned this pull request Jan 21, 2025

CI check for Standard.Base API changes via snapshotting #10507

Open

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

33bdcbd

…lpers5226

hubertp reviewed Jan 21, 2025

View reviewed changes

test/Examples_Tests/src/Signatures_Spec.enso Outdated Show resolved Hide resolved

GregoryTravis approved these changes Jan 21, 2025

View reviewed changes

JaroslavTulach added 2 commits January 22, 2025 06:39

Tests accessing Instrumentor need to run with --disable-private-check

67fcec2

Moving the signature snapshot into its own file

2f8d126

JaroslavTulach commented Jan 22, 2025

View reviewed changes

JaroslavTulach added 2 commits January 22, 2025 08:37

Adjusting micro's Meta to match current builtins

e776053

Better resolution of a conflict in changelog

4daed89

JaroslavTulach force-pushed the wip/jtulach/MetaHelpers5226 branch from fb3196f to 4daed89 Compare January 22, 2025 07:48

JaroslavTulach added 2 commits January 22, 2025 09:35

Any value can be converted .to Meta.Type

a394c4e

Generate conversion methods into signature files

57d19a7

radeusgd reviewed Jan 22, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Internal/Instrumentor.enso Outdated Show resolved Hide resolved

JaroslavTulach added 2 commits January 22, 2025 10:57

Use value.to Meta.Type . qualified_name to obtain qualified type name…

ba13b0d

… of a value

Fixing indentation of documentation

90d2e2a

radeusgd reviewed Jan 22, 2025

View reviewed changes

distribution/lib/Standard/Base/0.0.0-dev/src/Data/Dictionary.enso Show resolved Hide resolved

radeusgd approved these changes Jan 22, 2025

View reviewed changes

JaroslavTulach requested a review from hubertp January 22, 2025 11:33

Akirathan approved these changes Jan 22, 2025

View reviewed changes

JaroslavTulach merged commit 1f5ba9d into develop Jan 22, 2025
49 checks passed

JaroslavTulach deleted the wip/jtulach/MetaHelpers5226 branch January 22, 2025 17:35

enso-bot bot mentioned this pull request Jan 22, 2025

getMembers polyglot message of Type should include methods from Any #12045

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reducing helper methods in `Standard.Base.Meta` #12031

Reducing helper methods in `Standard.Base.Meta` #12031

JaroslavTulach commented Jan 9, 2025 •

edited

Loading

JaroslavTulach Jan 21, 2025 •

edited

Loading

radeusgd Jan 22, 2025

JaroslavTulach Jan 22, 2025

radeusgd Jan 22, 2025

JaroslavTulach commented Jan 21, 2025 •

edited

Loading

hubertp left a comment

JaroslavTulach Jan 22, 2025

Akirathan left a comment

Akirathan Jan 22, 2025

Akirathan Jan 22, 2025

Akirathan Jan 22, 2025

JaroslavTulach Jan 22, 2025

		@@ -0,0 +1,48 @@
		## Enso Signatures 1.0
		## module Standard.Base.Meta

	group_builder.specify "atom constructor with suspended evalution" <\|
	group_builder.specify "atom constructor with suspended evaluation" <\|

	group_builder.specify "atom without suspended evalution" <\|
	group_builder.specify "atom without suspended evaluation" <\|

Reducing helper methods in Standard.Base.Meta #12031

Reducing helper methods in Standard.Base.Meta #12031

Conversation

JaroslavTulach commented Jan 9, 2025 • edited Loading

Pull Request Description

Important Notes

Checklist

JaroslavTulach Jan 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JaroslavTulach commented Jan 21, 2025 • edited Loading

hubertp left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Akirathan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Reducing helper methods in `Standard.Base.Meta` #12031

Reducing helper methods in `Standard.Base.Meta` #12031

JaroslavTulach commented Jan 9, 2025 •

edited

Loading

JaroslavTulach Jan 21, 2025 •

edited

Loading

JaroslavTulach commented Jan 21, 2025 •

edited

Loading