Refactor Core / Proxy Agents; Fixes & optimizations for providers; Fixes for run-time ClassLoader to work with JDK 17 and modular class loading

Author: vsilaev

README.md

@@ -1,7 +1,7 @@
-[![Maven Central](https://img.shields.io/maven-central/v/net.tascalate.javaflow/net.tascalate.javaflow.parent.svg)](https://search.maven.org/artifact/net.tascalate.javaflow/net.tascalate.javaflow.parent/2.6.4/pom) [![GitHub release](https://img.shields.io/github/release/vsilaev/tascalate-javaflow.svg)](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.6.4) [![license](https://img.shields.io/github/license/vsilaev/tascalate-javaflow.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
+[![Maven Central](https://img.shields.io/maven-central/v/net.tascalate.javaflow/net.tascalate.javaflow.parent.svg)](https://search.maven.org/artifact/net.tascalate.javaflow/net.tascalate.javaflow.parent/2.7.0/pom) [![GitHub release](https://img.shields.io/github/release/vsilaev/tascalate-javaflow.svg)](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.7.0) [![license](https://img.shields.io/github/license/vsilaev/tascalate-javaflow.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)
 
 # IMPORTANT NOTICE FOR RELEASE 2.5.0!!!
-Java 9+ is fully supported now, all artefacts are modular multi-release JAR-s that works correctly with Java versions 1.6 to 11. The library code was tested with JDK 11, and all features of the Java 11 bytecode (including nest of inner classes) works correctly.
+Java 9+ is fully supported now, all artefacts are modular multi-release JAR-s that works correctly with Java versions 1.6 to 17. The library code was tested with JDK 17, and all features of the Java 17 bytecode (including nest of inner classes) works correctly.
 
 # IMPORTANT NOTICE FOR RELEASE 2.3.0!!!
 - `net.tascalate.javaflow.extras` artifact is withdrawn, its code serves as a basis for the project [Tascalate JavaFlow Util](https://github.com/vsilaev/tascalate-javaflow-util)
@@ -29,7 +29,7 @@ You have to add the following configuration to enable build-time instrumentation
 		<dependency>
 			<groupId>net.tascalate.javaflow</groupId>
 			<artifactId>net.tascalate.javaflow.api</artifactId>
-			<version>2.6.4</version>
+			<version>2.7.0</version>
 		</dependency>
 		<!-- Add-on for Java 8 and above -->
 		<dependency>
@@ -46,15 +46,15 @@ You have to add the following configuration to enable build-time instrumentation
 				<groupId>org.apache.maven.plugins</groupId>
 				<artifactId>maven-compiler-plugin</artifactId>
 				<configuration>
-					<!-- versions 1.6 -- 11 are supported -->
+					<!-- versions 1.6 -- 17 are supported -->
 					<source>1.6</source>
 					<target>1.6</target>
 				</configuration>
 			</plugin>
 			<plugin>
 				<groupId>net.tascalate.javaflow</groupId>
 				<artifactId>net.tascalate.javaflow.tools.maven</artifactId>
-				<version>2.6.4</version>
+				<version>2.7.0</version>
 				<executions>
 					<execution>
 						<phase>process-classes</phase>
@@ -67,7 +67,7 @@ You have to add the following configuration to enable build-time instrumentation
 		</plugins>
 	</build>
 ```
-Note that if you are using continuations with Java 1.8 lambdas then you need to add [Tascalate JavaFlow instrumentation agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.4/javaflow.instrument-continuations.jar) at run-time as command-line option, while lambda-related classes are generated by JVM on the fly and there is no other way to instrument them. If this is not an option, then you can de-sugar all lambdas with [RetroLambda](https://github.com/luontola/retrolambda) Maven plugin at build-time (RetroLambda output is supported by Tascalate JavaFlow 2.3.2 or higher).
+Note that if you are using continuations with Java 1.8 lambdas then you need to add [Tascalate JavaFlow instrumentation agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.7.0/javaflow.instrument-continuations.jar) at run-time as command-line option, while lambda-related classes are generated by JVM on the fly and there is no other way to instrument them. If this is not an option, then you can de-sugar all lambdas with [RetroLambda](https://github.com/luontola/retrolambda) Maven plugin at build-time (RetroLambda output is supported by Tascalate JavaFlow 2.3.2 or higher).
 
 Please refer to [pom.xml](https://github.com/vsilaev/tascalate-javaflow-examples/blob/master/net.tascalate.javaflow.examples.common/pom.xml) in examples project for typical Maven configuration
 
@@ -78,7 +78,7 @@ There is a separate Ant task for applying JavaFlow instrumentation at build-time
 It's possibe to instrument compiled Java classes as below:
 ```xml
     <target name="instrument-classes" description="JavaFlow Instrumentation" depends="compile">
-        <taskdef name="javaflow" classname="org.apache.commons.javaflow.ant.AntRewriteTask" 
+        <taskdef name="javaflow" classname="org.apache.commons.javaflow.tools.ant.AntRewriteTask" 
         classpathref="ant-lib-classpath"/>
         <echo message="JavaFlow instrumentation of compiled classes in ${classes.dir}" />
         <javaflow srcdir="${classes.dir}" destdir="${i-classes.dir}" classpathref="classpath"/>
@@ -87,7 +87,7 @@ It's possibe to instrument compiled Java classes as below:
 ... as well as re-write packaged JAR file:
 ```xml
     <target name="instrument-jar" description="JavaFlow Instrumentation" depends="jar">
-        <taskdef name="javaflow" classname="org.apache.commons.javaflow.ant.AntRewriteTask" 
+        <taskdef name="javaflow" classname="org.apache.commons.javaflow.tools.ant.AntRewriteTask" 
         classpathref="ant-lib-classpath"/>
         <echo message="JavaFlow instrumentation of compiled classes in ${jar.dir}/${ant.project.name}.jar" />
         <javaflow srcdir="${jar.dir}" destdir="${i-jar.dir}" classpathref="classpath"/>
@@ -96,7 +96,7 @@ It's possibe to instrument compiled Java classes as below:
 You may download a complete [examples project setup](https://github.com/vsilaev/tascalate-javaflow-examples/releases/download/1.0.10/tascalate-javaflow-ant-project-setup1.zip) from [the latest release](https://github.com/vsilaev/tascalate-javaflow-examples/releases/tag/1.0.10) for complete configuration template. Please pay attention to <code>ant-lib</code> folder with Ant TaskDef and <code>lib</code> folders with compile-/runtime-dependencies.
 
 # Java Instrumentation Agent (Runt-time Instrumentation)
-As an alternative to compile-time bytecode instrumentation, you MAY use [Tascalate JavaFlow Instrumentation Agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.4/javaflow.instrument-continuations.jar) from [the latest release](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.6.4) to enable continuations support at class-loading time. Please note, that if you are using Java 8 and creating continuable lambda functions (either anonymous or/and as method references), and you don't replace them with tools like [RetroLambda](https://github.com/luontola/retrolambda) as mentioned above, then you SHOULD use this instrumentation agent always: as long as Java run-time generates implementation of functional interfaces on the fly there is no other option to instrument them. To enable Tascalate JavaFlow Instrumentation Agent please add the following arguments to Java command line:
+As an alternative to compile-time bytecode instrumentation, you MAY use [Tascalate JavaFlow Instrumentation Agent](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.7.0/javaflow.instrument-continuations.jar) from [the latest release](https://github.com/vsilaev/tascalate-javaflow/releases/tag/2.7.0) to enable continuations support at class-loading time. Please note, that if you are using Java 8 and creating continuable lambda functions (either anonymous or/and as method references), and you don't replace them with tools like [RetroLambda](https://github.com/luontola/retrolambda) as mentioned above, then you SHOULD use this instrumentation agent always: as long as Java run-time generates implementation of functional interfaces on the fly there is no other option to instrument them. To enable Tascalate JavaFlow Instrumentation Agent please add the following arguments to Java command line:
 ```bash
     java -javaagent:<path-to-jar>/javaflow.instrument-continuations.jar <rest-of arguments>
 ```
@@ -105,22 +105,22 @@ The agent JAR file includes all necessary dependencies and requires no additiona
 Another useful application of the instrumentation agent is to apply it for debugging code within your IDE of choice. Just specify the "-javaagent" option listed above in your IDE debug/run configuration and you will be able to perform quick "debug-fix" loops without executing full project rebuild. 
 
 # Command-line tools
-It's possible to use a stand-alone command-line utility [JavaFlowRewriteJar.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.4/JavaFlowRewriteJar.jar) to instrument JAR archives containing continuable classes. Please use the following command:
+It's possible to use a stand-alone command-line utility [JavaFlowRewriteJar.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.7.0/JavaFlowRewriteJar.jar) to instrument JAR archives containing continuable classes. Please use the following command:
 
 ```bash
     java -jar JavaFlowRewriteJar.jar src1.jar dst1.jar src2.jar dst2.jar...
 ```
 Note, that the source and the destination should be different files.
 
 # CDI Support
-To work correctly in CDI environment continuable methods should be advised only by continuation-aware CDI proxies (interceptors, scope proxies, etc). Obviously, generation of these proxies is out of our control. Plus, major CDI containers (JBoss Weld and Apache OpenWebBeans) generates such proxies dynamically at run-time. Therefore if you plan to use Tascalate JavaFlow continuations with managed beans' methods then it's necessary to instrument CDI-specific proxies with [javaflow.instrument-cdi-proxy.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.6.4/javaflow.instrument-cdi-proxy.jar) Java Agent:
+To work correctly in CDI environment continuable methods should be advised only by continuation-aware CDI proxies (interceptors, scope proxies, etc). Obviously, generation of these proxies is out of our control. Plus, major CDI containers (JBoss Weld and Apache OpenWebBeans) generates such proxies dynamically at run-time. Therefore if you plan to use Tascalate JavaFlow continuations with managed beans' methods then it's necessary to instrument CDI-specific proxies with [javaflow.instrument-proxies.jar](https://github.com/vsilaev/tascalate-javaflow/releases/download/2.7.0/javaflow.instrument-proxies.jar) Java Agent:
 ```bash
-    java -javaagent:<path-to-jar>/javaflow.instrument-cdi-proxy.jar <rest-of arguments>
+    java -javaagent:<path-to-jar>/javaflow.instrument-proxies.jar <rest-of arguments>
 ```
 Please note, that CDI-specific agent neither requires javaflow.instrument-continuations.jar to operate correctly nor provides class file transformers for continuable methods. So if your project runs with CDI environment AND uses Java 8 lambdas then you have to add 2 Java agents, every serving different purpose:
 ```bash
     java -javaagent:<path-to-jar>/javaflow.instrument-continuations.jar \
-         -javaagent:<path-to-jar>/javaflow.instrument-cdi-proxy.jar \
+         -javaagent:<path-to-jar>/javaflow.instrument-proxies.jar \
 	 <rest-of arguments>
 ```
 CDI functionality is tested with JBoss Weld 2.x - 3.1.7, 4.0.x and Apache OpenWebBeans 1.6.x - 2.0.23. Contribution for other CDI/CDI-like containers (Spring, Google Guice, etc) is welcome.

net.tascalate.javaflow.tools.cdi-javaagent/.classpath renamed to net.tascalate.javaflow.agent.common/.classpath

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>net.tascalate.javaflow.agent.common</name>
+	<comment>Continuations / CoRoutines library for Java 1.5 - 1.8, incl. build tools &amp; CDI support. 
+        This project is based on completely re-worked Apache Jakarta Commons JavaFlow library. NO_M2ECLIPSE_SUPPORT: Project files created with the maven-eclipse-plugin are not supported in M2Eclipse.</comment>
+	<projects>
+		<project>net.tascalate.javaflow.providers.asm5</project>
+		<project>net.tascalate.javaflow.spi</project>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.m2e.core.maven2Builder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.m2e.core.maven2Nature</nature>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+	</natures>
+</projectDescription>

net.tascalate.javaflow.agent.common/.project

@@ -8,10 +8,10 @@
 		<relativePath>../</relativePath>
 	</parent>
 
-	<artifactId>net.tascalate.javaflow.tools.instrument</artifactId>
+	<artifactId>net.tascalate.javaflow.agent.common</artifactId>
 	<packaging>jar</packaging>
 
-	<name>Tascalate JavaFlow / Tools / Common Instrumentation Agent Code</name>
+	<name>Tascalate JavaFlow / Agent / Common Instrumentation Agent Code</name>
 
 	<properties>
 		<license.header>../HEADER-ORIGINAL.txt</license.header>

net.tascalate.javaflow.tools.cdi-javaagent/.settings/org.eclipse.core.resources.prefs renamed to net.tascalate.javaflow.agent.common/.settings/org.eclipse.core.resources.prefs

@@ -13,12 +13,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-module net.tascalate.javaflow.tools.instrument {
+module net.tascalate.javaflow.agent.common {
     requires transitive java.instrument;
 
     requires org.slf4j;
 
     requires transitive net.tascalate.javaflow.spi;
 
-    exports org.apache.commons.javaflow.instrumentation.common; 
+    exports org.apache.commons.javaflow.agent.common; 
 }

net.tascalate.javaflow.tools.instrument/.settings/org.eclipse.jdt.core.prefs renamed to net.tascalate.javaflow.agent.common/.settings/org.eclipse.jdt.core.prefs

@@ -1,5 +1,5 @@
 /**
- * Copyright 2013-2019 Valery Silaev (http://vsilaev.com)
+ * Copyright 2013-2021 Valery Silaev (http://vsilaev.com)
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.commons.javaflow.instrumentation.common;
+package org.apache.commons.javaflow.agent.common;
 
 import java.lang.instrument.ClassFileTransformer;
 import java.lang.instrument.IllegalClassFormatException;