├── .ci
├── ci-pipeline.yml
├── release-pipeline.yml
└── templates
│ └── publish.yml
├── .circleci
└── config.yml
├── .github
└── release-drafter.yml
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
├── build.gradle
├── gradle
└── wrapper
│ ├── gradle-wrapper.jar
│ └── gradle-wrapper.properties
├── gradlew
├── gradlew.bat
├── pipeline.yml
├── reactor-tools
├── build.gradle
└── src
│ ├── main
│ └── java
│ │ └── reactor
│ │ └── tools
│ │ └── agent
│ │ ├── CallSiteInfoAddingMethodVisitor.java
│ │ ├── ConstantSupplier.java
│ │ ├── HooksClassVisitor.java
│ │ ├── ReactorDebugAgent.java
│ │ └── ReturnHandlingMethodVisitor.java
│ └── test
│ └── java
│ └── reactor
│ └── tools
│ └── agent
│ └── ReactorDebugAgentTest.java
└── settings.gradle
/.ci/ci-pipeline.yml:
--------------------------------------------------------------------------------
1 | pr: [ master ]
2 |
3 | jobs:
4 | - job: build
5 | displayName: Build
6 | strategy:
7 | matrix:
8 | JDK8:
9 | jdkVersionOption: '1.8'
10 | JDK11:
11 | jdkVersionOption: '1.11'
12 | pool:
13 | name: 'Hosted Ubuntu 1604'
14 | steps:
15 | - task: Gradle@2
16 | displayName: Gradle build
17 | inputs:
18 | gradleWrapperFile: 'gradlew'
19 | jdkVersionOption: $(jdkVersionOption)
20 | options: '--no-daemon'
21 | tasks: 'build javadoc'
22 |
23 | - job: publish
24 | dependsOn: build
25 | condition: and(succeeded(), eq(variables['Build.SourceBranch'], 'refs/heads/master'))
26 | displayName: Publish SNAPSHOT
27 | pool:
28 | name: 'Hosted Ubuntu 1604'
29 | steps:
30 | - template: templates/publish.yml
31 | parameters:
32 | repoId: libs-snapshot-local
33 | version: 1.0.0.BUILD-SNAPSHOT
34 |
--------------------------------------------------------------------------------
/.ci/release-pipeline.yml:
--------------------------------------------------------------------------------
1 | pr: none
2 | trigger:
3 | batch: false
4 | branches:
5 | exclude: [ '*' ]
6 | tags:
7 | include: [ '*' ]
8 |
9 | jobs:
10 | - job: publish
11 | displayName: Publish
12 | pool:
13 | name: 'Hosted Ubuntu 1604'
14 | steps:
15 | - script: |
16 | echo "##vso[task.setvariable variable=version]$(git tag --points-at HEAD)"
17 | - template: templates/publish.yml
18 | parameters:
19 | version: $(version)
20 | ${{ if not(endsWith(variables['version'], '.RELEASE')) }}:
21 | repoId: libs-milestone-local
22 | # TODO support release publishing
23 |
--------------------------------------------------------------------------------
/.ci/templates/publish.yml:
--------------------------------------------------------------------------------
1 | parameters:
2 | repoId: ''
3 | version: ''
4 |
5 | steps:
6 | - bash: ./gradlew --no-daemon -Pversion=$GRADLE_VERSION publish
7 | env:
8 | GRADLE_VERSION: ${{ parameters.version }}
9 | GRADLE_PUBLISH_REPO_URL: https://repo.spring.io/${{ parameters.repoId }}
10 | GRADLE_PUBLISH_MAVEN_USER: $(artifactory.username)
11 | GRADLE_PUBLISH_MAVEN_PASSWORD: $(artifactory.password)
12 |
--------------------------------------------------------------------------------
/.circleci/config.yml:
--------------------------------------------------------------------------------
1 | version: 2
2 | jobs:
3 | build:
4 | docker:
5 | - image: circleci/openjdk:8-jdk
6 | steps:
7 | - checkout
8 | - run:
9 | command: ./gradlew build -x check
10 | - run:
11 | command: ./gradlew check
12 | - run:
13 | name: Save test results
14 | command: |
15 | mkdir -p ~/junit/
16 | find . -type f -regex ".*/build/test-results/.*xml" -exec cp {} ~/junit/ \;
17 | when: always
18 | - store_test_results:
19 | path: ~/junit
20 | - store_artifacts:
21 | path: ~/junit
22 | workflows:
23 | version: 2
24 | test_all:
25 | jobs:
26 | - build
27 |
--------------------------------------------------------------------------------
/.github/release-drafter.yml:
--------------------------------------------------------------------------------
1 | template: |
2 | # What's Changed
3 | $CHANGES
4 | categories:
5 | - title: 🚀 Features / Enhancements
6 | label: type/enhancement
7 | - title: 🐛 Bug Fixes
8 | label: type/bug
9 | - title: 📖 Documentation
10 | label: type/docs
11 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /.gradle/
2 | build/
3 |
4 | .idea/
5 | *.iml
6 | *.ipr
7 | *.iws
8 |
9 | .DS_Store
10 |
11 | .vscode/
12 |
13 | .project
14 | .classpath
15 | bin/
16 |
17 | credentials.yml
18 |
--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: java
2 | jdk:
3 | - openjdk8
4 | - openjdk11
5 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | https://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright {yyyy} {name of copyright owner}
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | https://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
203 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # reactor-tools is no longer actively maintained by VMware, Inc.
2 |
3 | # Reactor tools (experimental)
4 |
5 | [](https://travis-ci.org/reactor/reactor-tools)
6 | [](https://repo.spring.io/milestone/io/projectreactor/reactor-tools/)
7 | [](https://repo.spring.io/snapshot/io/projectreactor/reactor-tools/)
8 |
9 | > ⚠️ Starting from Reactor 3.3.0.M2, reactor-tools is now moved to https://github.com/reactor/reactor-core.
10 |
11 | A set of tools to improve Project Reactor's debugging and development experience.
12 |
13 | ## Getting it
14 |
15 | Download it from Maven Central repositories (stable releases only) or repo.spring.io:
16 |
17 | ```groovy
18 | repositories {
19 | maven { url 'https://repo.spring.io/milestone' }
20 | // maven { url 'https://repo.spring.io/snapshot' }
21 | }
22 |
23 | dependencies {
24 | compile 'io.projectreactor:reactor-tools:$LATEST_RELEASE'
25 | // compile 'io.projectreactor:reactor-tools:$LATEST_SNAPSHOT'
26 | }
27 | ```
28 | Where:
29 |
30 | |||
31 | |-|-|
32 | |`$LATEST_RELEASE`|[](https://repo.spring.io/milestone/io/projectreactor/reactor-tools/)|
33 | |`$LATEST_SNAPSHOT`|[](https://repo.spring.io/snapshot/io/projectreactor/reactor-tools/)|
34 |
35 | # Usage
36 | ## Reactor Debug agent - production-ready assembly back-tracing
37 | `ReactorDebugAgent` is a Java agent which helps debugging exceptions in your application without paying a runtime cost (unlike `Hooks.onOperatorDebug()`).
38 |
39 | It transforms (via bytecode transformation) chains like:
40 | ```java
41 | Flux.range(0, 5)
42 | .single()
43 | ```
44 |
45 | to:
46 | ```java
47 | Flux flux = Flux.range(0, 5);
48 | flux = Hooks.addCallSiteInfo(flux, "Flux.range\n foo.Bar.baz(Bar.java:21)"));
49 | flux = flux.single();
50 | flux = Hooks.addCallSiteInfo(flux, "Flux.single\n foo.Bar.baz(Bar.java:22)"));
51 | ```
52 | making it possible to back trace the error:
53 | ```
54 | java.lang.IndexOutOfBoundsException: Source emitted more than one item
55 | at reactor.core.publisher.MonoSingle$SingleSubscriber.onNext(MonoSingle.java:129)
56 | ...
57 | at java.lang.Thread.run(Thread.java:748)
58 | Suppressed: reactor.core.publisher.FluxOnAssembly$OnAssemblyException:
59 | Assembly trace from producer [reactor.core.publisher.MonoSingle] :
60 | reactor.core.publisher.Flux.single(Flux.java:7380)
61 | foo.Bar.baz(Bar.java:22)
62 | Error has been observed by the following operator(s):
63 | |_ Flux.single ⇢ foo.Bar.baz(Bar.java:22)
64 | ```
65 |
66 | To enable it, you need to initialize the agent first:
67 | ```java
68 | ReactorDebugAgent.init();
69 | ```
70 |
71 | ℹ️Since the implementation will instrument your classes when they are loaded, the best place to put it is before everything else in your `main(String[])` methood:
72 | ```java
73 | public static void main(String[] args) {
74 | ReactorDebugAgent.init();
75 | SpringApplication.run(Application.class, args);
76 | }
77 | ```
78 |
79 | You may also re-process existing classes if you cannot run the init eagerly:
80 | ```java
81 | ReactorDebugAgent.init();
82 | ReactorDebugAgent.processExistingClasses();
83 | ```
84 | > ⚠️Be aware that the re-processing takes a couple of seconds due to the need to iterate over all loaded classes and apply the transformation.
85 | >
86 | > Use it only if you see that some call-sites are not instrumented.
87 |
88 | _Works with Reactor Core version 3.2.6 or higher_
89 |
90 |
91 | ### Limitations
92 | Java 8 users **must use JDK** instead of JRE:
93 | https://bytebuddy.net/javadoc/1.9.12/net/bytebuddy/agent/ByteBuddyAgent.html#install--
94 |
95 | We plan to relax this requirement in future versions by shipping a "real" Java agent you can attach with the `-javaagent:` JVM flag.
96 |
97 | -------------------------------------
98 | _Licensed under [Apache Software License 2.0](www.apache.org/licenses/LICENSE-2.0)_
99 |
100 | _Sponsored by [Pivotal](https://pivotal.io)_
101 |
--------------------------------------------------------------------------------
/build.gradle:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | subprojects {
18 | apply plugin: 'java'
19 | group = 'io.projectreactor'
20 |
21 | repositories {
22 | jcenter()
23 | }
24 |
25 | tasks.withType(JavaCompile).all {
26 | options*.encoding = 'UTF-8'
27 |
28 | sourceCompatibility = targetCompatibility = 1.8
29 | }
30 |
31 | plugins.withType(MavenPublishPlugin) {
32 | project.publishing {
33 | repositories {
34 | maven {
35 | url System.getenv('GRADLE_PUBLISH_REPO_URL')
36 | credentials {
37 | username = System.getenv('GRADLE_PUBLISH_MAVEN_USER')
38 | password = System.getenv('GRADLE_PUBLISH_MAVEN_PASSWORD')
39 | }
40 | }
41 | }
42 | }
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/spring-attic/reactor-tools/7efac62370e0151609a91e2df1866ee30bda3d18/gradle/wrapper/gradle-wrapper.jar
--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-5.3-bin.zip
4 | zipStoreBase=GRADLE_USER_HOME
5 | zipStorePath=wrapper/dists
6 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env sh
2 |
3 | ##############################################################################
4 | ##
5 | ## Gradle start up script for UN*X
6 | ##
7 | ##############################################################################
8 |
9 | # Attempt to set APP_HOME
10 | # Resolve links: $0 may be a link
11 | PRG="$0"
12 | # Need this for relative symlinks.
13 | while [ -h "$PRG" ] ; do
14 | ls=`ls -ld "$PRG"`
15 | link=`expr "$ls" : '.*-> \(.*\)$'`
16 | if expr "$link" : '/.*' > /dev/null; then
17 | PRG="$link"
18 | else
19 | PRG=`dirname "$PRG"`"/$link"
20 | fi
21 | done
22 | SAVED="`pwd`"
23 | cd "`dirname \"$PRG\"`/" >/dev/null
24 | APP_HOME="`pwd -P`"
25 | cd "$SAVED" >/dev/null
26 |
27 | APP_NAME="Gradle"
28 | APP_BASE_NAME=`basename "$0"`
29 |
30 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
31 | DEFAULT_JVM_OPTS=""
32 |
33 | # Use the maximum available, or set MAX_FD != -1 to use that value.
34 | MAX_FD="maximum"
35 |
36 | warn () {
37 | echo "$*"
38 | }
39 |
40 | die () {
41 | echo
42 | echo "$*"
43 | echo
44 | exit 1
45 | }
46 |
47 | # OS specific support (must be 'true' or 'false').
48 | cygwin=false
49 | msys=false
50 | darwin=false
51 | nonstop=false
52 | case "`uname`" in
53 | CYGWIN* )
54 | cygwin=true
55 | ;;
56 | Darwin* )
57 | darwin=true
58 | ;;
59 | MINGW* )
60 | msys=true
61 | ;;
62 | NONSTOP* )
63 | nonstop=true
64 | ;;
65 | esac
66 |
67 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
68 |
69 | # Determine the Java command to use to start the JVM.
70 | if [ -n "$JAVA_HOME" ] ; then
71 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
72 | # IBM's JDK on AIX uses strange locations for the executables
73 | JAVACMD="$JAVA_HOME/jre/sh/java"
74 | else
75 | JAVACMD="$JAVA_HOME/bin/java"
76 | fi
77 | if [ ! -x "$JAVACMD" ] ; then
78 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
79 |
80 | Please set the JAVA_HOME variable in your environment to match the
81 | location of your Java installation."
82 | fi
83 | else
84 | JAVACMD="java"
85 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
86 |
87 | Please set the JAVA_HOME variable in your environment to match the
88 | location of your Java installation."
89 | fi
90 |
91 | # Increase the maximum file descriptors if we can.
92 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
93 | MAX_FD_LIMIT=`ulimit -H -n`
94 | if [ $? -eq 0 ] ; then
95 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
96 | MAX_FD="$MAX_FD_LIMIT"
97 | fi
98 | ulimit -n $MAX_FD
99 | if [ $? -ne 0 ] ; then
100 | warn "Could not set maximum file descriptor limit: $MAX_FD"
101 | fi
102 | else
103 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
104 | fi
105 | fi
106 |
107 | # For Darwin, add options to specify how the application appears in the dock
108 | if $darwin; then
109 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
110 | fi
111 |
112 | # For Cygwin, switch paths to Windows format before running java
113 | if $cygwin ; then
114 | APP_HOME=`cygpath --path --mixed "$APP_HOME"`
115 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
116 | JAVACMD=`cygpath --unix "$JAVACMD"`
117 |
118 | # We build the pattern for arguments to be converted via cygpath
119 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
120 | SEP=""
121 | for dir in $ROOTDIRSRAW ; do
122 | ROOTDIRS="$ROOTDIRS$SEP$dir"
123 | SEP="|"
124 | done
125 | OURCYGPATTERN="(^($ROOTDIRS))"
126 | # Add a user-defined pattern to the cygpath arguments
127 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then
128 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
129 | fi
130 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
131 | i=0
132 | for arg in "$@" ; do
133 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
134 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
135 |
136 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
137 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
138 | else
139 | eval `echo args$i`="\"$arg\""
140 | fi
141 | i=$((i+1))
142 | done
143 | case $i in
144 | (0) set -- ;;
145 | (1) set -- "$args0" ;;
146 | (2) set -- "$args0" "$args1" ;;
147 | (3) set -- "$args0" "$args1" "$args2" ;;
148 | (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
149 | (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
150 | (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
151 | (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
152 | (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
153 | (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
154 | esac
155 | fi
156 |
157 | # Escape application args
158 | save () {
159 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
160 | echo " "
161 | }
162 | APP_ARGS=$(save "$@")
163 |
164 | # Collect all arguments for the java command, following the shell quoting and substitution rules
165 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
166 |
167 | # by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
168 | if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
169 | cd "$(dirname "$0")"
170 | fi
171 |
172 | exec "$JAVACMD" "$@"
173 |
--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
1 | @if "%DEBUG%" == "" @echo off
2 | @rem ##########################################################################
3 | @rem
4 | @rem Gradle startup script for Windows
5 | @rem
6 | @rem ##########################################################################
7 |
8 | @rem Set local scope for the variables with windows NT shell
9 | if "%OS%"=="Windows_NT" setlocal
10 |
11 | set DIRNAME=%~dp0
12 | if "%DIRNAME%" == "" set DIRNAME=.
13 | set APP_BASE_NAME=%~n0
14 | set APP_HOME=%DIRNAME%
15 |
16 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
17 | set DEFAULT_JVM_OPTS=
18 |
19 | @rem Find java.exe
20 | if defined JAVA_HOME goto findJavaFromJavaHome
21 |
22 | set JAVA_EXE=java.exe
23 | %JAVA_EXE% -version >NUL 2>&1
24 | if "%ERRORLEVEL%" == "0" goto init
25 |
26 | echo.
27 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
28 | echo.
29 | echo Please set the JAVA_HOME variable in your environment to match the
30 | echo location of your Java installation.
31 |
32 | goto fail
33 |
34 | :findJavaFromJavaHome
35 | set JAVA_HOME=%JAVA_HOME:"=%
36 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
37 |
38 | if exist "%JAVA_EXE%" goto init
39 |
40 | echo.
41 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
42 | echo.
43 | echo Please set the JAVA_HOME variable in your environment to match the
44 | echo location of your Java installation.
45 |
46 | goto fail
47 |
48 | :init
49 | @rem Get command-line arguments, handling Windows variants
50 |
51 | if not "%OS%" == "Windows_NT" goto win9xME_args
52 |
53 | :win9xME_args
54 | @rem Slurp the command line arguments.
55 | set CMD_LINE_ARGS=
56 | set _SKIP=2
57 |
58 | :win9xME_args_slurp
59 | if "x%~1" == "x" goto execute
60 |
61 | set CMD_LINE_ARGS=%*
62 |
63 | :execute
64 | @rem Setup the command line
65 |
66 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
67 |
68 | @rem Execute Gradle
69 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
70 |
71 | :end
72 | @rem End local scope for the variables with windows NT shell
73 | if "%ERRORLEVEL%"=="0" goto mainEnd
74 |
75 | :fail
76 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
77 | rem the _cmd.exe /c_ return code!
78 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
79 | exit /b 1
80 |
81 | :mainEnd
82 | if "%OS%"=="Windows_NT" endlocal
83 |
84 | :omega
85 |
--------------------------------------------------------------------------------
/pipeline.yml:
--------------------------------------------------------------------------------
1 | # fly --target spring login --concourse-url https://ci.spring.io --team-name "spring-team"
2 | # fly --target spring set-pipeline --config pipeline.yml --load-vars-from=credentials.yml --pipeline reactor-tools
3 | # fly --target spring trigger-job --job=reactor-tools/build -w
4 | ---
5 | resource_types:
6 | - name: artifactory-resource
7 | type: docker-image
8 | source:
9 | repository: springio/artifactory-resource
10 | tag: 0.0.6
11 |
12 | resources:
13 | - name: source
14 | type: git
15 | source:
16 | uri: https://github.com/reactor/reactor-tools.git
17 | branch: master
18 |
19 | - name: tagged-source
20 | type: git
21 | source:
22 | uri: https://github.com/reactor/reactor-tools.git
23 | branch: master
24 | tag_filter: "*"
25 |
26 | - name: artifactory-repo
27 | type: artifactory-resource
28 | source:
29 | uri: "https://repo.spring.io"
30 | username: {{artifactory-username}}
31 | password: {{artifactory-password}}
32 | build_name: reactor-tools
33 |
34 | jobs:
35 | - name: build
36 | serial: true
37 | plan:
38 | - get: source
39 | trigger: true
40 |
41 | - task: build
42 | privileged: true
43 | config:
44 | platform: linux
45 | image_resource:
46 | type: docker-image
47 | source: { repository: openjdk, tag: 8-jdk }
48 | inputs:
49 | - name: source
50 | outputs:
51 | - name: distribution-repository
52 | caches:
53 | - path: source/.gradle
54 | run:
55 | dir: source
56 | path: bash
57 | args:
58 | - -exc
59 | - |
60 | rm -rf ~/.gradle
61 | ln -s $PWD/.gradle ~/.gradle
62 | ./gradlew build publish -Pversion=1.0.0.BUILD-SNAPSHOT
63 | cp -a build/repo/. ../distribution-repository/
64 | find ../distribution-repository
65 |
66 | - put: artifactory-repo
67 | params:
68 | repo: libs-snapshot-local
69 | folder: distribution-repository
70 | build_uri: "https://ci.spring.io/teams/${BUILD_TEAM_NAME}/pipelines/${BUILD_PIPELINE_NAME}/jobs/${BUILD_JOB_NAME}/builds/${BUILD_NAME}"
71 | build_number: "${BUILD_PIPELINE_NAME}-${BUILD_JOB_NAME}-${BUILD_NAME}"
72 | disable_checksum_uploads: true
73 |
74 | - name: release-milestone
75 | serial: true
76 | plan:
77 | - get: tagged-source
78 | trigger: true
79 |
80 | - task: build
81 | config:
82 | platform: linux
83 | image_resource:
84 | type: docker-image
85 | source: { repository: openjdk, tag: 8-jdk }
86 | inputs:
87 | - name: tagged-source
88 | outputs:
89 | - name: distribution-repository
90 | caches:
91 | - path: tagged-source/.gradle
92 | run:
93 | dir: tagged-source
94 | path: bash
95 | args:
96 | - -exc
97 | - |
98 | TAG=$(git tag --points-at HEAD)
99 |
100 | rm -rf ~/.gradle
101 | ln -s $PWD/.gradle ~/.gradle
102 | ./gradlew build publish -Pversion=$TAG
103 | cp -a build/repo/. ../distribution-repository/
104 | find ../distribution-repository
105 |
106 | - put: artifactory-repo
107 | params:
108 | repo: libs-milestone-local
109 | folder: distribution-repository
110 | build_uri: "https://ci.spring.io/teams/${BUILD_TEAM_NAME}/pipelines/${BUILD_PIPELINE_NAME}/jobs/${BUILD_JOB_NAME}/builds/${BUILD_NAME}"
111 | build_number: "${BUILD_PIPELINE_NAME}-${BUILD_JOB_NAME}-${BUILD_NAME}"
112 | disable_checksum_uploads: true
113 |
--------------------------------------------------------------------------------
/reactor-tools/build.gradle:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | plugins {
18 | id 'com.github.johnrengelman.shadow' version '4.0.3'
19 | id "java"
20 | id "maven-publish"
21 | }
22 |
23 | description = 'Reactor Tools'
24 |
25 | dependencies {
26 | compileOnly 'io.projectreactor:reactor-core:3.2.6.RELEASE'
27 |
28 | compile 'org.ow2.asm:asm:7.1'
29 | compile 'org.ow2.asm:asm-commons:7.1'
30 | compile 'net.bytebuddy:byte-buddy-agent:1.9.6'
31 |
32 | testCompile 'io.projectreactor:reactor-core:3.2.6.RELEASE'
33 | testCompile 'junit:junit:4.12'
34 | testCompile "org.assertj:assertj-core:3.11.1"
35 | }
36 |
37 | test {
38 | // Creates a JVM per test because the agent can be installed only once
39 | forkEvery = 1
40 | maxParallelForks = 1
41 | jvmArgs = [
42 | "-Xverify:all",
43 | JavaVersion.current().isJava9Compatible()
44 | ? "-Xlog:redefine+class*=warning"
45 | : "-XX:TraceRedefineClasses=2"
46 | ]
47 |
48 | testLogging {
49 | displayGranularity 1
50 | showStackTraces = true
51 | showStandardStreams = true
52 | exceptionFormat = 'full'
53 | events "STARTED", "PASSED", "FAILED", "SKIPPED"
54 |
55 | }
56 | }
57 |
58 | shadowJar {
59 | classifier = null
60 | }
61 |
62 | project.tasks.build.dependsOn(shadowJar)
63 |
64 | task relocateShadowJar(type: com.github.jengelman.gradle.plugins.shadow.tasks.ConfigureShadowRelocation) {
65 | target = tasks.shadowJar
66 | prefix = "reactor.tools.shaded"
67 | }
68 |
69 | tasks.shadowJar.dependsOn tasks.relocateShadowJar
70 |
71 | task sourcesJar(type: Jar) {
72 | classifier 'sources'
73 | from sourceSets.main.allJava
74 | }
75 |
76 | task javadocJar(type: Jar) {
77 | from javadoc
78 | classifier = 'javadoc'
79 | }
80 |
81 | publishing {
82 | publications {
83 | mavenJava(MavenPublication) { publication ->
84 | artifacts.removeAll { it.classifier == null }
85 | artifact project.tasks.shadowJar
86 | artifact sourcesJar
87 | artifact javadocJar
88 | }
89 | }
90 | }
91 |
--------------------------------------------------------------------------------
/reactor-tools/src/main/java/reactor/tools/agent/CallSiteInfoAddingMethodVisitor.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package reactor.tools.agent;
18 |
19 | import org.objectweb.asm.Label;
20 | import org.objectweb.asm.MethodVisitor;
21 | import org.objectweb.asm.Opcodes;
22 | import org.objectweb.asm.Type;
23 |
24 | import java.util.concurrent.atomic.AtomicBoolean;
25 |
26 | /**
27 | * Adds callSite info to every operator call (except "checkpoint").
28 | * Before:
29 | *
30 | * Flux.just(1)
31 | * .map(it -> it)
32 | *
33 | * After:
34 | *
35 | * Flux flux = Hooks.addCallSiteInfo(Flux.just(1), "Flux.just -> MyClass.myMethod(MyClass.java:12);
36 | * flux = Hooks.addCallSiteInfo(flux.map(it -> it), "Flux.map -> MyClass.myMethod(MyClass.java:13);
37 | *
38 | *
39 | */
40 | class CallSiteInfoAddingMethodVisitor extends MethodVisitor {
41 |
42 | static boolean isCorePublisher(String className) {
43 | switch (className) {
44 | case "reactor/core/publisher/Flux":
45 | case "reactor/core/publisher/Mono":
46 | case "reactor/core/publisher/ParallelFlux":
47 | case "reactor/core/publisher/GroupedFlux":
48 | return true;
49 | default:
50 | return false;
51 | }
52 | }
53 |
54 | final String currentMethod;
55 |
56 | final String currentClassName;
57 |
58 | final String currentSource;
59 |
60 | final AtomicBoolean changed;
61 |
62 | int currentLine = -1;
63 |
64 | CallSiteInfoAddingMethodVisitor(
65 | MethodVisitor visitor,
66 | String currentClassName,
67 | String currentMethod,
68 | String currentSource,
69 | AtomicBoolean changed
70 | ) {
71 | super(Opcodes.ASM7, visitor);
72 | this.currentMethod = currentMethod;
73 | this.currentClassName = currentClassName;
74 | this.currentSource = currentSource;
75 | this.changed = changed;
76 | }
77 |
78 | @Override
79 | public void visitLineNumber(int line, Label start) {
80 | super.visitLineNumber(line, start);
81 | currentLine = line;
82 | }
83 |
84 | @Override
85 | public void visitMethodInsn(int opcode, String owner, String name, String descriptor, boolean isInterface) {
86 | super.visitMethodInsn(opcode, owner, name, descriptor, isInterface);
87 | if (isCorePublisher(owner)) {
88 | if ("checkpoint".equals(name)) {
89 | return;
90 | }
91 | String returnType = Type.getReturnType(descriptor).getInternalName();
92 | if (!returnType.startsWith("reactor/core/publisher/")) {
93 | return;
94 | }
95 |
96 | changed.set(true);
97 |
98 | String callSite = String.format(
99 | "\t%s.%s\n\t%s.%s(%s:%d)\n",
100 | owner.replace("/", "."), name,
101 | currentClassName.replace("/", "."), currentMethod, currentSource, currentLine
102 | );
103 | super.visitLdcInsn(callSite);
104 | super.visitMethodInsn(
105 | Opcodes.INVOKESTATIC,
106 | "reactor/core/publisher/Hooks",
107 | "addCallSiteInfo",
108 | HooksClassVisitor.ADD_CALLSITE_INFO_METHOD,
109 | false
110 | );
111 | super.visitTypeInsn(Opcodes.CHECKCAST, returnType);
112 | }
113 | }
114 | }
115 |
--------------------------------------------------------------------------------
/reactor-tools/src/main/java/reactor/tools/agent/ConstantSupplier.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package reactor.tools.agent;
18 |
19 | import java.util.function.Supplier;
20 |
21 | /**
22 | * This is a helper class to return a static string supplier.
23 | */
24 | @SuppressWarnings("unused")
25 | public class ConstantSupplier implements Supplier {
26 |
27 | public static ConstantSupplier of(String constant) {
28 | return new ConstantSupplier(constant);
29 | }
30 |
31 | private final String constant;
32 |
33 | private ConstantSupplier(String constant) {
34 | this.constant = constant;
35 | }
36 |
37 | @Override
38 | public String get() {
39 | return constant;
40 | }
41 | }
42 |
--------------------------------------------------------------------------------
/reactor-tools/src/main/java/reactor/tools/agent/HooksClassVisitor.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package reactor.tools.agent;
18 |
19 | import org.objectweb.asm.*;
20 | import org.objectweb.asm.commons.GeneratorAdapter;
21 |
22 | /**
23 | * Adds the following method to {@link reactor.core.publisher.Hooks},
24 | * to be called by the call site instrumentation.
25 | *
26 | * public static Publisher addCallSiteInfo(Publisher p, String callSite) {
27 | * return Hooks.addAssemblyInfo(
28 | * p,
29 | * new AssemblySnapshot(null, new ConstantSupplier(callSite))
30 | * );
31 | * }
32 | *
33 | */
34 | class HooksClassVisitor extends ClassVisitor {
35 |
36 | static final String ADD_CALLSITE_INFO_METHOD = "(Lorg/reactivestreams/Publisher;Ljava/lang/String;)Lorg/reactivestreams/Publisher;";
37 | final ClassWriter cw;
38 |
39 | HooksClassVisitor(ClassWriter cw) {
40 | super(Opcodes.ASM7, cw);
41 | this.cw = cw;
42 | }
43 |
44 | @Override
45 | public void visitEnd() {
46 | int access = Opcodes.ACC_PUBLIC | Opcodes.ACC_STATIC;
47 | String methodName = "addCallSiteInfo";
48 | MethodVisitor addAssemblyInfoMethod = cw.visitMethod(
49 | access,
50 | methodName,
51 | ADD_CALLSITE_INFO_METHOD,
52 | ADD_CALLSITE_INFO_METHOD,
53 | new String[0]
54 | );
55 |
56 | GeneratorAdapter adapter = new GeneratorAdapter(addAssemblyInfoMethod, access, methodName, ADD_CALLSITE_INFO_METHOD);
57 |
58 | adapter.visitCode();
59 | adapter.loadArg(0);
60 |
61 | adapter.newInstance(Type.getObjectType("reactor/core/publisher/FluxOnAssembly$AssemblySnapshot"));
62 | adapter.dup();
63 |
64 | adapter.visitInsn(Opcodes.ACONST_NULL);
65 |
66 | adapter.loadArg(1);
67 | adapter.visitMethodInsn(
68 | Opcodes.INVOKESTATIC,
69 | "reactor/tools/agent/ConstantSupplier",
70 | "of",
71 | "(Ljava/lang/String;)Lreactor/tools/agent/ConstantSupplier;",
72 | false
73 | );
74 | adapter.visitMethodInsn(
75 | Opcodes.INVOKESPECIAL,
76 | "reactor/core/publisher/FluxOnAssembly$AssemblySnapshot",
77 | "",
78 | "(Ljava/lang/String;Ljava/util/function/Supplier;)V",
79 | false
80 | );
81 | adapter.visitMethodInsn(
82 | Opcodes.INVOKESTATIC,
83 | "reactor/core/publisher/Hooks",
84 | "addAssemblyInfo",
85 | "(Lorg/reactivestreams/Publisher;Lreactor/core/publisher/FluxOnAssembly$AssemblySnapshot;)Lorg/reactivestreams/Publisher;",
86 | false
87 | );
88 |
89 | adapter.returnValue();
90 | adapter.endMethod();
91 |
92 | super.visitEnd();
93 | }
94 | }
95 |
--------------------------------------------------------------------------------
/reactor-tools/src/main/java/reactor/tools/agent/ReactorDebugAgent.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package reactor.tools.agent;
18 |
19 | import java.lang.instrument.ClassFileTransformer;
20 | import java.lang.instrument.Instrumentation;
21 | import java.lang.instrument.UnmodifiableClassException;
22 | import java.security.ProtectionDomain;
23 | import java.util.concurrent.atomic.AtomicBoolean;
24 | import java.util.stream.Stream;
25 |
26 | import net.bytebuddy.agent.ByteBuddyAgent;
27 | import org.objectweb.asm.ClassReader;
28 | import org.objectweb.asm.ClassVisitor;
29 | import org.objectweb.asm.ClassWriter;
30 | import org.objectweb.asm.MethodVisitor;
31 | import org.objectweb.asm.Opcodes;
32 | import org.objectweb.asm.Type;
33 | import reactor.core.publisher.Hooks;
34 |
35 | public class ReactorDebugAgent {
36 |
37 | private static Instrumentation instrumentation;
38 |
39 | public static synchronized void init() {
40 | if (instrumentation != null) {
41 | return;
42 | }
43 | instrumentation = ByteBuddyAgent.install();
44 |
45 | ClassFileTransformer transformer = new ClassFileTransformer() {
46 | @Override
47 | public byte[] transform(
48 | ClassLoader loader,
49 | String className,
50 | Class classBeingRedefined,
51 | ProtectionDomain protectionDomain,
52 | byte[] bytes
53 | ) {
54 | if ("reactor/core/publisher/Hooks".equals(className)) {
55 | ClassReader cr = new ClassReader(bytes);
56 | ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_FRAMES);
57 |
58 | ClassVisitor classVisitor = new HooksClassVisitor(cw);
59 |
60 | cr.accept(classVisitor, 0);
61 | return cw.toByteArray();
62 | }
63 |
64 | return null;
65 | }
66 | };
67 | instrumentation.addTransformer(transformer, true);
68 | try {
69 | instrumentation.retransformClasses(Hooks.class);
70 | }
71 | catch (UnmodifiableClassException e) {
72 | throw new RuntimeException(e);
73 | }
74 | instrumentation.removeTransformer(transformer);
75 |
76 | transformer = new ClassFileTransformer() {
77 | @Override
78 | public byte[] transform(
79 | ClassLoader loader,
80 | String className,
81 | Class clazz,
82 | ProtectionDomain protectionDomain,
83 | byte[] bytes
84 | ) {
85 | if (loader == null) {
86 | return null;
87 | }
88 |
89 | if (
90 | className == null ||
91 | className.startsWith("java/") ||
92 | className.startsWith("jdk/") ||
93 | className.startsWith("sun/") ||
94 | className.startsWith("com/sun/") ||
95 | className.startsWith("reactor/core/")
96 | ) {
97 | return null;
98 | }
99 |
100 | if (
101 | clazz != null && (
102 | clazz.isPrimitive() ||
103 | clazz.isArray() ||
104 | clazz.isAnnotation() ||
105 | clazz.isSynthetic()
106 | )
107 | ) {
108 | return null;
109 | }
110 |
111 | ClassReader cr = new ClassReader(bytes);
112 | ClassWriter cw = new ClassWriter(cr, ClassWriter.COMPUTE_MAXS);
113 |
114 | AtomicBoolean changed = new AtomicBoolean();
115 | ClassVisitor classVisitor = new ClassVisitor(Opcodes.ASM7, cw) {
116 |
117 | private String currentClassName = "";
118 |
119 | private String currentSource = "";
120 |
121 | @Override
122 | public void visitSource(String source, String debug) {
123 | super.visitSource(source, debug);
124 | currentSource = source;
125 | }
126 |
127 | @Override
128 | public void visit(int version, int access, String name, String signature, String superName, String[] interfaces) {
129 | super.visit(version, access, name, signature, superName, interfaces);
130 | currentClassName = name;
131 | }
132 |
133 | @Override
134 | public MethodVisitor visitMethod(int access, String currentMethod, String descriptor, String signature, String[] exceptions) {
135 | MethodVisitor visitor = super.visitMethod(access, currentMethod, descriptor, signature, exceptions);
136 |
137 | String returnType = Type.getReturnType(descriptor).getInternalName();
138 | switch (returnType) {
139 | // Handle every core publisher type.
140 | // Note that classes like `GroupedFlux` or `ConnectableFlux` are not included,
141 | // because they don't have a type-preserving "checkpoint" method
142 | case "reactor/core/publisher/Flux":
143 | case "reactor/core/publisher/Mono":
144 | case "reactor/core/publisher/ParallelFlux":
145 | visitor = new ReturnHandlingMethodVisitor(visitor, returnType, currentClassName, currentMethod, currentSource, changed);
146 | }
147 |
148 | return new CallSiteInfoAddingMethodVisitor(visitor, currentClassName, currentMethod, currentSource, changed);
149 | }
150 | };
151 |
152 | try {
153 | cr.accept(classVisitor, 0);
154 | }
155 | catch (Throwable e) {
156 | e.printStackTrace();
157 | throw e;
158 | }
159 |
160 | if (!changed.get()) {
161 | return null;
162 | }
163 |
164 | return cw.toByteArray();
165 | }
166 | };
167 |
168 | instrumentation.addTransformer(transformer, true);
169 | }
170 |
171 | public static synchronized void processExistingClasses() {
172 | if (instrumentation == null) {
173 | throw new IllegalStateException("Must be initialized first!");
174 | }
175 |
176 | try {
177 | Class[] classes = Stream
178 | .of(instrumentation.getInitiatedClasses(ClassLoader.getSystemClassLoader()))
179 | .filter(aClass -> {
180 | try {
181 | if (aClass.getClassLoader() == null) return false;
182 | if (aClass.isPrimitive() || aClass.isArray() || aClass.isInterface()) return false;
183 | if (aClass.isAnnotation() || aClass.isSynthetic()) return false;
184 | String name = aClass.getName();
185 | if (name == null) return false;
186 | if (name.startsWith("[")) return false;
187 | if (name.startsWith("java.")) return false;
188 | if (name.startsWith("sun.")) return false;
189 | if (name.startsWith("com.sun.")) return false;
190 | if (name.startsWith("jdk.")) return false;
191 | if (name.startsWith("reactor.core.")) return false;
192 |
193 | // May trigger NoClassDefFoundError, fail fast
194 | aClass.getConstructors();
195 | }
196 | catch (LinkageError e) {
197 | return false;
198 | }
199 |
200 | return true;
201 | })
202 | .toArray(Class[]::new);
203 |
204 | instrumentation.retransformClasses(classes);
205 | }
206 | catch (Throwable e) {
207 | e.printStackTrace();
208 | // Some classes fail to re-transform (e.g. worker.org.gradle.internal.UncheckedException)
209 | // See https://bugs.openjdk.java.net/browse/JDK-8014229
210 | }
211 | }
212 |
213 | }
214 |
--------------------------------------------------------------------------------
/reactor-tools/src/main/java/reactor/tools/agent/ReturnHandlingMethodVisitor.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package reactor.tools.agent;
18 |
19 | import org.objectweb.asm.Label;
20 | import org.objectweb.asm.MethodVisitor;
21 | import org.objectweb.asm.Opcodes;
22 | import org.objectweb.asm.Type;
23 |
24 | import java.util.concurrent.atomic.AtomicBoolean;
25 |
26 | /**
27 | * Checkpoints every method returning Mono/Flux/ParallelFlux,
28 | * unless there were operator calls in the method body.
29 | * Before:
30 | *
31 | * public Mono request() {
32 | * return MyWebClient.get("/foo").bodyToMono(String.class);
33 | * }
34 | *
35 | * After:
36 | *
37 | * public Mono request() {
38 | * return MyWebClient.get("/foo").bodyToMono(String.class).checkpoint("MyClass.request(MyClass.java:123)");
39 | * }
40 | *
41 | *
42 | */
43 | class ReturnHandlingMethodVisitor extends MethodVisitor {
44 |
45 | final AtomicBoolean changed;
46 |
47 | final String currentClassName;
48 |
49 | final String currentMethod;
50 |
51 | final String returnType;
52 |
53 | final String currentSource;
54 |
55 | int currentLine = -1;
56 |
57 | boolean checkpointed = false;
58 |
59 | ReturnHandlingMethodVisitor(
60 | MethodVisitor visitor,
61 | String returnType,
62 | String currentClassName,
63 | String currentMethod,
64 | String currentSource,
65 | AtomicBoolean changed
66 | ) {
67 | super(Opcodes.ASM7, visitor);
68 | this.changed = changed;
69 | this.currentClassName = currentClassName;
70 | this.currentMethod = currentMethod;
71 | this.returnType = returnType;
72 | this.currentSource = currentSource;
73 | }
74 |
75 | @Override
76 | public void visitLineNumber(int line, Label start) {
77 | super.visitLineNumber(line, start);
78 | currentLine = line;
79 | }
80 |
81 | @Override
82 | public void visitMethodInsn(int opcode, String owner, String name, String descriptor, boolean isInterface) {
83 | super.visitMethodInsn(opcode, owner, name, descriptor, isInterface);
84 |
85 | if (!checkpointed && CallSiteInfoAddingMethodVisitor.isCorePublisher(owner)) {
86 | String returnType = Type.getReturnType(descriptor).getInternalName();
87 | if (returnType.startsWith("reactor/core/publisher/")) {
88 | checkpointed = true;
89 | }
90 | }
91 | }
92 |
93 | @Override
94 | public void visitInsn(int opcode) {
95 | if (!checkpointed && Opcodes.ARETURN == opcode) {
96 | changed.set(true);
97 |
98 | super.visitInsn(Opcodes.DUP);
99 | Label atReturn = new Label();
100 | super.visitJumpInsn(Opcodes.IFNULL, atReturn); // skip if null
101 |
102 | String callSite = String.format(
103 | "%s.%s(%s:%d)",
104 | currentClassName.replace("/", "."), currentMethod, currentSource, currentLine
105 | );
106 | super.visitLdcInsn(callSite);
107 | super.visitMethodInsn(
108 | Opcodes.INVOKEVIRTUAL,
109 | returnType,
110 | "checkpoint",
111 | "(Ljava/lang/String;)L" + returnType + ";",
112 | false
113 | );
114 |
115 | super.visitLabel(atReturn);
116 | super.visitFrame(Opcodes.F_SAME1, 0, null, 1, new Object[] { returnType });
117 | }
118 |
119 | super.visitInsn(opcode);
120 | }
121 | }
122 |
--------------------------------------------------------------------------------
/reactor-tools/src/test/java/reactor/tools/agent/ReactorDebugAgentTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright (c) 2019-Present Pivotal Software Inc, All Rights Reserved.
3 | *
4 | * Licensed under the Apache License, Version 2.0 (the "License");
5 | * you may not use this file except in compliance with the License.
6 | * You may obtain a copy of the License at
7 | *
8 | * https://www.apache.org/licenses/LICENSE-2.0
9 | *
10 | * Unless required by applicable law or agreed to in writing, software
11 | * distributed under the License is distributed on an "AS IS" BASIS,
12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | * See the License for the specific language governing permissions and
14 | * limitations under the License.
15 | */
16 |
17 | package reactor.tools.agent;
18 |
19 | import org.junit.Test;
20 | import reactor.core.Scannable;
21 | import reactor.core.publisher.Flux;
22 | import reactor.core.publisher.Mono;
23 |
24 | import java.util.function.Function;
25 |
26 | import static org.assertj.core.api.Assertions.assertThat;
27 |
28 | public class ReactorDebugAgentTest {
29 |
30 | static {
31 | ReactorDebugAgent.init();
32 |
33 | // Since ReactorDebugAgentTest is already loaded, we need to re-process it
34 | ReactorDebugAgent.processExistingClasses();
35 | }
36 |
37 | @Test
38 | public void shouldAddAssemblyInfo() {
39 | int baseline = getBaseline();
40 | Flux flux = Flux.just(1);
41 |
42 | assertThat(Scannable.from(flux).stepName())
43 | .startsWith("Flux.just ⇢ reactor.tools.agent.ReactorDebugAgentTest.shouldAddAssemblyInfo(ReactorDebugAgentTest.java:" + (baseline + 1));
44 | }
45 |
46 | @Test
47 | public void shouldWorkWithMethodChains() {
48 | int baseline = getBaseline();
49 | Flux flux = Flux.just(1).map(it -> it);
50 |
51 | assertThat(Scannable.from(flux).stepName())
52 | .startsWith("Flux.map ⇢ reactor.tools.agent.ReactorDebugAgentTest.shouldWorkWithMethodChains(ReactorDebugAgentTest.java:" + (baseline + 1));
53 | }
54 |
55 | @Test
56 | public void shouldNotAddToCheckpoint() {
57 | Flux flux = Flux.just(1).checkpoint("foo");
58 |
59 | assertThat(Scannable.from(flux).stepName())
60 | .isEqualTo("checkpoint(\"foo\")");
61 | }
62 |
63 | @Test
64 | public void shouldInstrumentReturns() {
65 | Mono mono = methodReturningMono(Mono.just(1));
66 |
67 | assertThat(Scannable.from(mono).stepName())
68 | .startsWith("checkpoint(\"reactor.tools.agent.ReactorDebugAgentTest.methodReturningMono(ReactorDebugAgentTest.java:" + (methodReturningMonoBaseline + 2));
69 | }
70 |
71 | @Test
72 | public void shouldWorkWithGroupedFlux() {
73 | int baseline = getBaseline();
74 | Flux flux = Flux.just(1).groupBy(it -> it).blockFirst().map(Function.identity());
75 |
76 | assertThat(Scannable.from(flux).stepName())
77 | .startsWith("GroupedFlux.map ⇢ reactor.tools.agent.ReactorDebugAgentTest.shouldWorkWithGroupedFlux(ReactorDebugAgentTest.java:" + (baseline + 1));
78 | }
79 |
80 | // See https://github.com/reactor/reactor-tools/issues/7
81 | @Test
82 | public void shouldHandleNullReturnValue() {
83 | Mono mono = methodReturningNullMono();
84 |
85 | assertThat(mono).isNull();
86 | }
87 |
88 | static final int methodReturningMonoBaseline = getBaseline();
89 | private Mono methodReturningMono(Mono mono) {
90 | return mono;
91 | }
92 |
93 | private Mono methodReturningNullMono() {
94 | return null;
95 | }
96 |
97 | private static int getBaseline() {
98 | return new Exception().getStackTrace()[1].getLineNumber();
99 | }
100 | }
101 |
--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | include 'reactor-tools'
2 |
--------------------------------------------------------------------------------