Avoid use of Java Reflection (restructure part 5) #870

aslesarenko · 2023-03-07T20:10:55Z

This PR is focused on removing direct usages of Java reflection. Instead scalan.reflection package introduced in common module.
This is a next step towards Scala.js support.

The new reflection-like interface has two implementations:

using Java reflection (see JRClass) - can be used in JVM and Ergo node (ensures it works the same doesn't break consensus)
using static reflection (see SRClass) - uses special reflection metadata registrations (this can be used in JS)

Also:

a lot of code cleanup
missing ScalaDocs

# Conflicts: # build.sbt # graph-ir/src/main/scala/scalan/TypeDescs.scala # graph-ir/src/main/scala/special/sigma/impl/SigmaDslImpl.scala

codecov · 2023-03-07T21:05:31Z

Codecov Report

Merging #870 (c68759c) into v5.0.6-RC (cf1f192) will increase coverage by 4.62%.
The diff coverage is 62.35%.

@@              Coverage Diff              @@
##           v5.0.6-RC     #870      +/-   ##
=============================================
+ Coverage      75.93%   80.56%   +4.62%     
=============================================
  Files            218      220       +2     
  Lines          13599    13997     +398     
  Branches         477      473       -4     
=============================================
+ Hits           10327    11276     +949     
+ Misses          3272     2721     -551

Impacted Files	Coverage Δ
common/src/main/scala/scalan/package.scala	`100.00% <ø> (ø)`
.../src/main/scala/scalan/reflection/StaticImpl.scala	`0.00% <0.00%> (ø)`
...on/src/main/scala/scalan/util/CollectionUtil.scala	`82.24% <ø> (+0.96%)`	⬆️
common/src/main/scala/scalan/util/StringUtil.scala	`50.00% <ø> (+2.17%)`	⬆️
...-lib/src/main/scala/special/collection/Colls.scala	`84.61% <ø> (ø)`
...ain/scala/special/collection/CollsOverArrays.scala	`79.62% <ø> (ø)`
...in/scala/special/collection/ExtensionMethods.scala	`100.00% <ø> (ø)`
...ib/src/main/scala/special/collection/Helpers.scala	`100.00% <ø> (ø)`
...ib/src/main/scala/special/collection/package.scala	`80.00% <ø> (ø)`
...re-lib/src/main/scala/special/sigma/SigmaDsl.scala	`38.88% <ø> (ø)`
... and 188 more

... and 15 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

kushti · 2023-04-04T07:49:24Z

common/src/main/scala/scalan/reflection/JavaImpl.scala

+  override def getSimpleName: String = value.getSimpleName
+  override def getName: String = value.getName
+
+  /** A sequence that stores the constructors of this class. */


Just "Constructors of this class" ? see https://docs.scala-lang.org/style/scaladoc.html#general-style

kushti · 2023-04-04T07:50:32Z

common/src/main/scala/scalan/reflection/JavaImpl.scala

+    constructors
+  }
+
+  /** Helper method that returns a sequence of `JRConstructor` objects that were at least


"a sequence of" seems to be excessive here as well

kushti · 2023-04-04T07:52:11Z

common/src/main/scala/scalan/reflection/JavaImpl.scala

+  * @param declaringClass The JRClass that declares this method.
+  * @param value          The [[java.lang.reflect.Method]] instance that this JRMethod represents.
+  */
+class JRMethod private (declarigClass: JRClass[_], val value: Method) extends RMethod {


declaringClass

kushti · 2023-04-04T08:05:22Z

common/src/main/scala/scalan/reflection/package.scala

+    }
+  }
+
+  /** Creates a new SRMethod instance with the given parameters and handler function.


But what does "a new SRMethod instance" mean? It is obvious from the function signature that the functions returns an RMethod instance, what scaladoc is saying above that ?

kushti · 2023-04-04T08:06:15Z

common/src/main/scala/scalan/reflection/RClass.scala

@@ -0,0 +1,117 @@
+package scalan.reflection
+
+import scala.collection.mutable


unused import

kushti · 2023-04-04T08:42:24Z

graph-ir/src/main/scala/wrappers/scala/impl/WOptionsImpl.scala

 trait WOptionsDefs extends scalan.Scalan with WOptions {
  self: WrappersModule =>

-object WOption extends EntityObject("WOption") {
+class WOptionCls extends EntityObject("WOption") {


ScalaDoc missed

Why WOptionCls , not WOptionImpl ?

Because Impl is usually when some abstract class/interface is implemented. Here it is to:

avoid name collision

have a class type where WOption.type doesn't work (in reflection metadata, see usages of WOptionCls)

kushti · 2023-04-04T08:43:48Z

graph-ir/src/main/scala/wrappers/scalan/impl/WRTypesImpl.scala


-object WRType extends EntityObject("WRType") {
+class WRTypeCls extends EntityObject("WRType") {


ScalaDoc missed

kushti · 2023-04-04T08:45:16Z

graph-ir/src/main/scala/wrappers/special/impl/WSpecialPredefsImpl.scala

+  import scalan.reflection.RClass
+
+  // Abs -----------------------------------
+trait WSpecialPredefsDefs extends scalan.Scalan with WSpecialPredefs {


scaladocs missed in file

This file is just moved, has not been changed.

kushti · 2023-04-04T08:47:35Z

interpreter/src/main/scala/sigmastate/InterpreterReflection.scala

+import special.collection.Coll
+import special.sigma.{SigmaDslBuilder, AvlTree}
+
+/** Reflection metadata for `interpreter` module. */


Again, this scaladoc does not say much about what is going on here

kushti · 2023-04-04T09:44:26Z

sc/src/test/scala/thelastpackage/ZLastSpec.scala

+class ZLastSpec extends AnyPropSpec with BeforeAndAfterAll {
+
+  property("the last property") {
+


aslesarenko added 30 commits October 4, 2022 20:47

v5.x-restructure: abstract from Java reflection

68678d3

v5.x-restructure: optimize reflection.scala

f142baf

v5.x-restructure: collect classes, fields and methods

b5df752

v5.x-restructure: introduce JavaImpl.scala and StaticImpl.scala

94f8ea4

v5.x-restructure: towards implementing ReflectionData.scala

f52b936

v5.x-restructure: StaticImpl.scala first implementation

f7e1cf1

v5.x-restructure: create JRConstructors lazily

5bceb19

v5.x-restructure: removed overloadded methods of SigmaProp && and ||

ef05f18

v5.x-restructure: removed all usages of java.lang.reflect

ae72e2d

v5.x-restructure: register some simple SRClasses

4d380d3

v5.x-restructure: generate reflection constructors

bb8f592

v5.x-restructure: generate reflection methods

26a34a9

v5.x-restructure: generate reflection methods (part 2)

0697f81

v5.x-restructure: more registerClassEntry

ec38797

v5.x-restructure: more registerClassEntry (2)

028f812

v5.x-restructure: move registrations to Reflection.scala

20a1d2c

v5.x-restructure: move registrations to LibaryReflection.scala

0630471

v5.x-restructure: renamed ReflectionData -> CommonReflection

062226d

v5.x-restructure: removed library-api module

1b302f9

v5.x-restructure: removed sigma-api module

a234f7b

v5.x-restructure: removed sigma-library module (2 tests fail)

4f3bc44

v5.x-restructure: comment out reflection data for a while

5c3246e

v5.x-restructure: library-ir module renamed to graph-ir

4ec502d

v5.x-restructure: core module merged into graph-ir

f75de67

v5.x-restructure: library-impl module renamed to core-lib

37f81e4

v5.x-restructure: sigmastate module renamed to interpreter

3a15f51

v5.x-restructure: Reflection object for each module

0bd0e17

v5.x-restructure: new generator for reflection data

7c05056

v5.x-restructure: reflection data for SigmaProp

2a15c9a

v5.x-restructure: reflection data for BigInt, CollBuilder + cleanups

ce8ea19

aslesarenko added 5 commits October 20, 2022 23:15

v5.x-restructure: move GraphVizExport to Test scope

fb47766

v5.x-restructure: move BenchmarkUtil and ScalaNameUtil to Test scope

c1a97b4

v5.x-restructure: move more classes from common to downstream modules

aa12d79

Merge remote-tracking branch 'origin/v5.0.6-RC' into restructure-part5

829ec1a

# Conflicts: # build.sbt # graph-ir/src/main/scala/scalan/TypeDescs.scala # graph-ir/src/main/scala/special/sigma/impl/SigmaDslImpl.scala

restructure-part5: fixes after merge

df11cb8

aslesarenko added 8 commits March 8, 2023 12:49

restructure-part5: ScalaDoc for reflection + cleanups

f965e41

restructure-part5: removed SpecialPredef.scala

55a7f93

restructure-part5: more ScalaDocs

a411a12

restructure-part5: introduce printDebug in tests

e328d15

restructure-part5: make public compileWithCosting

a15daf8

restructure-part5: scrypto 2.3.0

0b134b1

restructure-part5: Platform for reflection

b21dea1

restructure-part5: TrieMap for Dupers

8dde9c0

aslesarenko marked this pull request as ready for review March 17, 2023 19:19

restructure-part5: ScalaDocs and cleanups

3cd3ec4

aslesarenko requested a review from kushti March 22, 2023 12:53

kushti requested changes Apr 4, 2023

View reviewed changes

aslesarenko added 2 commits April 11, 2023 15:10

restructure-part5: addressing review comments

71a93af

restructure-part5: ScalaDoc for ZLastSpec

1eb35c9

aslesarenko requested a review from kushti April 11, 2023 16:51

kushti approved these changes Apr 12, 2023

View reviewed changes

restructure-part5: comment out debug code

c68759c

aslesarenko changed the base branch from v5.0.6-RC to v5.0.7-RC April 13, 2023 15:05

aslesarenko merged commit cd9cf86 into v5.0.7-RC Apr 13, 2023

aslesarenko deleted the restructure-part5 branch April 13, 2023 15:08

aslesarenko mentioned this pull request Apr 13, 2023

Release candidate v5.0.7 #873

Merged

aslesarenko mentioned this pull request Apr 24, 2023

[v5.0.1] Project restructure #827

Closed

aslesarenko mentioned this pull request Aug 19, 2023

Restructure project #750

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Avoid use of Java Reflection (restructure part 5) #870

Avoid use of Java Reflection (restructure part 5) #870

aslesarenko commented Mar 7, 2023 •

edited

Loading

codecov bot commented Mar 7, 2023 •

edited

Loading

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

kushti Apr 4, 2023

aslesarenko Apr 11, 2023

		@@ -0,0 +1,117 @@
		package scalan.reflection

		import scala.collection.mutable


		object WRType extends EntityObject("WRType") {
		class WRTypeCls extends EntityObject("WRType") {

		class ZLastSpec extends AnyPropSpec with BeforeAndAfterAll {

		property("the last property") {

Avoid use of Java Reflection (restructure part 5) #870

Avoid use of Java Reflection (restructure part 5) #870

Conversation

aslesarenko commented Mar 7, 2023 • edited Loading

codecov bot commented Mar 7, 2023 • edited Loading

Codecov Report

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

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

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

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

aslesarenko commented Mar 7, 2023 •

edited

Loading

codecov bot commented Mar 7, 2023 •

edited

Loading