Move Jakarta JMS instrumentation to micrometer-jakarta10

Introduces a new module micrometer-jakarta10 and moves the previously merged JMS instrumentation there. The reason for this is that we tend to try to support a range of versions when possible for our users, and if Jakarta makes breaking changes in the future, we would not be able to support that in a single module (such as micrometer-core, or micrometer-jakarta) unless the new Jakarta artifacts used different coordinates.
micrometer-metrics · Oct 10, 2023 · 3cf4d2e · 3cf4d2e
1 parent 3d7a390
commit 3cf4d2e
Show file tree

Hide file tree

Showing 20 changed files with 80 additions and 18 deletions.
diff --git a/build.gradle b/build.gradle
@@ -327,7 +327,7 @@ subprojects {
 
             check.dependsOn("testModules")
 
-            if (!(project.name in ['micrometer-osgi-test'])) {
+            if (!(project.name in ['micrometer-jakarta10'])) {
                 apply plugin: 'me.champeau.gradle.japicmp'
                 apply plugin: 'de.undercouch.download'
 

diff --git a/micrometer-jakarta10/build.gradle b/micrometer-jakarta10/build.gradle
@@ -0,0 +1,26 @@
+description 'Module for Jakarta based instrumentations'
+
+jar {
+    bundle {
+
+        bnd '''\
+        Import-Package: \
+            jakarta.jms.*;resolution:=dynamic;version="${@}",\
+            io.micrometer.observation.*;resolution:=dynamic;version="${@}",\
+            *
+        '''.stripIndent()
+    }
+}
+
+dependencies {
+    api project(":micrometer-core")
+    api project(":micrometer-commons")
+    api project(":micrometer-observation")
+
+    optionalApi 'jakarta.jms:jakarta.jms-api'
+
+    testImplementation 'org.junit.jupiter:junit-jupiter'
+    testImplementation 'com.tngtech.archunit:archunit-junit5'
+    testImplementation 'org.mockito:mockito-core'
+    testImplementation 'org.assertj:assertj-core'
+}
diff --git a/...faultJmsProcessObservationConvention.java → ...faultJmsProcessObservationConvention.java b/...faultJmsProcessObservationConvention.java → ...faultJmsProcessObservationConvention.java
@@ -14,14 +14,13 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.KeyValue;
 import io.micrometer.common.KeyValues;
-import io.micrometer.core.instrument.binder.jms.JmsObservationDocumentation.LowCardinalityKeyNames;
 import jakarta.jms.*;
 
-import static io.micrometer.core.instrument.binder.jms.JmsObservationDocumentation.*;
+import io.micrometer.jakarta10.instrument.jms.JmsObservationDocumentation.*;
 
 /**
  * Default implementation for {@link JmsProcessObservationConvention}.

diff --git a/...faultJmsPublishObservationConvention.java → ...faultJmsPublishObservationConvention.java b/...faultJmsPublishObservationConvention.java → ...faultJmsPublishObservationConvention.java
@@ -14,13 +14,13 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.KeyValue;
 import io.micrometer.common.KeyValues;
 import jakarta.jms.*;
 
-import static io.micrometer.core.instrument.binder.jms.JmsObservationDocumentation.*;
+import static io.micrometer.jakarta10.instrument.jms.JmsObservationDocumentation.*;
 
 /**
  * Default implementation for {@link JmsPublishObservationConvention}.

diff --git a/...rument/binder/jms/JmsInstrumentation.java → ...10/instrument/jms/JmsInstrumentation.java b/...rument/binder/jms/JmsInstrumentation.java → ...10/instrument/jms/JmsInstrumentation.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.observation.ObservationRegistry;
 import jakarta.jms.Session;

diff --git a/...nder/jms/JmsObservationDocumentation.java → ...ment/jms/JmsObservationDocumentation.java b/...nder/jms/JmsObservationDocumentation.java → ...ment/jms/JmsObservationDocumentation.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.KeyValue;
 import io.micrometer.common.docs.KeyName;

diff --git a/...der/jms/JmsProcessObservationContext.java → ...ent/jms/JmsProcessObservationContext.java b/...der/jms/JmsProcessObservationContext.java → ...ent/jms/JmsProcessObservationContext.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.observation.transport.ReceiverContext;
 import jakarta.jms.JMSException;

diff --git a/.../jms/JmsProcessObservationConvention.java → .../jms/JmsProcessObservationConvention.java b/.../jms/JmsProcessObservationConvention.java → .../jms/JmsProcessObservationConvention.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationConvention;

diff --git a/...der/jms/JmsPublishObservationContext.java → ...ent/jms/JmsPublishObservationContext.java b/...der/jms/JmsPublishObservationContext.java → ...ent/jms/JmsPublishObservationContext.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.lang.Nullable;
 import io.micrometer.observation.transport.SenderContext;

diff --git a/.../jms/JmsPublishObservationConvention.java → .../jms/JmsPublishObservationConvention.java b/.../jms/JmsPublishObservationConvention.java → .../jms/JmsPublishObservationConvention.java
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationConvention;

diff --git a/...jms/MessageConsumerInvocationHandler.java → ...jms/MessageConsumerInvocationHandler.java b/...jms/MessageConsumerInvocationHandler.java → ...jms/MessageConsumerInvocationHandler.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.ObservationRegistry;

diff --git a/...jms/MessageProducerInvocationHandler.java → ...jms/MessageProducerInvocationHandler.java b/...jms/MessageProducerInvocationHandler.java → ...jms/MessageProducerInvocationHandler.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.lang.Nullable;
 import io.micrometer.observation.Observation;

diff --git a/.../binder/jms/SessionInvocationHandler.java → ...trument/jms/SessionInvocationHandler.java b/.../binder/jms/SessionInvocationHandler.java → ...trument/jms/SessionInvocationHandler.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.observation.ObservationRegistry;
 import jakarta.jms.MessageConsumer;

diff --git a/...e/instrument/binder/jms/package-info.java → ...akarta10/instrument/jms/package-info.java b/...e/instrument/binder/jms/package-info.java → ...akarta10/instrument/jms/package-info.java
@@ -19,7 +19,7 @@
  */
 @NonNullFields
 @NonNullApi
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.lang.NonNullApi;
 import io.micrometer.common.lang.NonNullFields;
diff --git a/micrometer-jakarta10/src/test/java/io/micrometer/jakarta10/NoJavaxArchitectureTests.java b/micrometer-jakarta10/src/test/java/io/micrometer/jakarta10/NoJavaxArchitectureTests.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright 2023 VMware, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.micrometer.jakarta10;
+
+import com.tngtech.archunit.junit.AnalyzeClasses;
+import com.tngtech.archunit.junit.ArchTest;
+import com.tngtech.archunit.lang.ArchRule;
+
+import static com.tngtech.archunit.lang.syntax.ArchRuleDefinition.noClasses;
+
+@AnalyzeClasses(packages = "io.micrometer.jakarta10")
+class NoJavaxArchitectureTests {
+
+    @ArchTest
+    static final ArchRule noJavaxDependencies = noClasses().that()
+        .resideInAPackage("io.micrometer.jakarta10..")
+        .should()
+        .dependOnClassesThat()
+        .resideInAPackage("javax..");
+
+}
diff --git a/...JmsProcessObservationConventionTests.java → ...JmsProcessObservationConventionTests.java b/...JmsProcessObservationConventionTests.java → ...JmsProcessObservationConventionTests.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.KeyValue;
 import jakarta.jms.*;

diff --git a/...JmsPublishObservationConventionTests.java → ...JmsPublishObservationConventionTests.java b/...JmsPublishObservationConventionTests.java → ...JmsPublishObservationConventionTests.java
@@ -13,7 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.micrometer.core.instrument.binder.jms;
+package io.micrometer.jakarta10.instrument.jms;
 
 import io.micrometer.common.KeyValue;
 import jakarta.jms.*;

diff --git a/micrometer-test/build.gradle b/micrometer-test/build.gradle
@@ -36,6 +36,7 @@ dependencies {
     implementation 'org.awaitility:awaitility'
 
     testImplementation project(':micrometer-observation-test')
+    testImplementation project(':micrometer-jakarta10')
 
     testImplementation 'org.jsr107.ri:cache-ri-impl'
 

diff --git a/...-test/src/test/java/io/micrometer/core/instrument/binder/jms/JmsInstrumentationTests.java b/...-test/src/test/java/io/micrometer/core/instrument/binder/jms/JmsInstrumentationTests.java
@@ -19,6 +19,7 @@
 import java.util.concurrent.TimeUnit;
 import java.util.stream.Stream;
 
+import io.micrometer.jakarta10.instrument.jms.JmsInstrumentation;
 import io.micrometer.observation.tck.TestObservationRegistry;
 import io.micrometer.observation.tck.TestObservationRegistryAssert;
 import jakarta.jms.*;

diff --git a/settings.gradle b/settings.gradle
@@ -43,6 +43,7 @@ include 'micrometer-test', 'micrometer-observation-test'
 }
 
 include 'micrometer-bom'
+include 'micrometer-jakarta10'
 include 'micrometer-jetty11'
 include 'micrometer-osgi-test'
 include 'docs'