Rename hibernate-common, jedis-common, jms-common, redisson-common modules to versioned form

Adds base versions to four common javaagent modules and moves their
internal classes into versioned packages (per #16090 / #18181 convention):

- hibernate-common -> hibernate-common-3.3
  io.opentelemetry.javaagent.instrumentation.hibernate -> .hibernate.common.v3_3
- jedis-common -> jedis-common-1.4
  io.opentelemetry.javaagent.instrumentation.jedis -> .jedis.common.v1_4
- jms-common -> jms-common-1.1
  io.opentelemetry.javaagent.instrumentation.jms -> .jms.common.v1_1
  (bootstrap class JmsReceiveContextHolder stays in
   io.opentelemetry.javaagent.bootstrap.jms)
- redisson-common -> redisson-common-3.0
  io.opentelemetry.javaagent.instrumentation.redisson -> .redisson.common.v3_0

Cross-version test helpers under .../testing/ keep their unversioned
package names since they are reused by multiple version modules.

Author: trask

.fossa.yml

@@ -513,7 +513,7 @@ targets:
       target: ':instrumentation:hibernate:hibernate-6.0:javaagent'
     - type: gradle
       path: ./
-      target: ':instrumentation:hibernate:hibernate-common:javaagent'
+      target: ':instrumentation:hibernate:hibernate-common-3.3:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:hibernate:hibernate-procedure-call-4.3:javaagent'
@@ -591,7 +591,7 @@ targets:
       target: ':instrumentation:jedis:jedis-4.0:javaagent'
     - type: gradle
       path: ./
-      target: ':instrumentation:jedis:jedis-common:javaagent'
+      target: ':instrumentation:jedis:jedis-common-1.4:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:jetty:jetty-11.0:javaagent'
@@ -624,10 +624,10 @@ targets:
       target: ':instrumentation:jms:jms-3.0:javaagent'
     - type: gradle
       path: ./
-      target: ':instrumentation:jms:jms-common:bootstrap'
+      target: ':instrumentation:jms:jms-common-1.1:bootstrap'
     - type: gradle
       path: ./
-      target: ':instrumentation:jms:jms-common:javaagent'
+      target: ':instrumentation:jms:jms-common-1.1:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:jsf:jsf-common-jakarta:javaagent'
@@ -882,7 +882,7 @@ targets:
       target: ':instrumentation:redisson:redisson-3.17:javaagent'
     - type: gradle
       path: ./
-      target: ':instrumentation:redisson:redisson-common:javaagent'
+      target: ':instrumentation:redisson:redisson-common-3.0:javaagent'
     - type: gradle
       path: ./
       target: ':instrumentation:restlet:restlet-1.1:javaagent'

.github/scripts/check-package-names.sh

@@ -1,70 +1,188 @@
 #!/bin/bash -e
 
-for dir in $(find instrumentation -name "*.java" | grep library/src/main/java | sed 's#/[^/]*$##' | sort -u); do
+check_source_set() {
+  local source_set="$1"
+  local expected_prefix="$2"
 
-  module_name=$(echo "$dir" | sed 's#.*/\([^/]*\)/library/src/main/java[0-9]*/.*#\1#')
+  for dir in $(find instrumentation -name "*.java" | grep "$source_set/src/main/java" | sed 's#/[^/]*$##' | sort -u); do
 
-  if [[ "$module_name" =~ ^java- ]]; then
-    continue
-  fi
-  if [[ "$module_name" == "jmx-metrics" ]]; then
-    continue
-  fi
-  if [[ "$module_name" == "runtime-telemetry" ]]; then
-    continue
-  fi
-  if [[ "$module_name" == "servlet-common" ]]; then
-    continue
-  fi
-  if [[ "$module_name" == "graphql-java-common-12.0" ]]; then
-    continue
-  fi
+    module_name=$(echo "$dir" | sed "s#.*/\([^/]*\)/$source_set/src/main/java[0-9]*/.*#\1#")
 
-  # these are possibly problematic
-  if [[ "$dir" == "instrumentation/grpc-1.6/library/src/main/java/io/grpc/override" ]]; then
-    continue
-  fi
-  if [[ "$dir" == "instrumentation/lettuce/lettuce-5.1/library/src/main/java/io/lettuce/core/protocol" ]]; then
-    continue
-  fi
-  if [[ "$dir" == "instrumentation/nats/nats-2.17/library/src/main/java/io/nats/client/impl" ]]; then
-    continue
-  fi
-  if [[ "$dir" == "instrumentation/rxjava/rxjava-1.0/library/src/main/java/rx" ]]; then
-    continue
-  fi
+    if [[ "$module_name" =~ ^java- ]]; then
+      continue
+    fi
+    if [[ "$module_name" == "jmx-metrics" ]]; then
+      continue
+    fi
+    if [[ "$module_name" == "runtime-telemetry" ]]; then
+      continue
+    fi
+    if [[ "$module_name" == "servlet-common" ]]; then
+      continue
+    fi
+    if [[ "$module_name" == "graphql-java-common-12.0" ]]; then
+      continue
+    fi
 
-  # some common modules don't have any base version (might have a variant instead, ex: javax)
-  # - jdbc
-  # - lettuce-common
-  # - netty-common
-  # - oshi
-  # - resources
-  # - servlet-common-javax
-  if [[ ! "$module_name" =~ [0-9]$ && "$module_name" != "jdbc" && "$module_name" != "lettuce-common" && "$module_name" != "netty-common" && "$module_name" != "oshi" && "$module_name" != "resources" && "$module_name" != "servlet-common-javax" ]]; then
-    echo "module name doesn't have a base version: $dir"
-    exit 1
-  fi
+    # these are possibly problematic
+    if [[ "$source_set" == "library" ]]; then
+      if [[ "$dir" == "instrumentation/grpc-1.6/library/src/main/java/io/grpc/override" ]]; then
+        continue
+      fi
+      if [[ "$dir" == "instrumentation/lettuce/lettuce-5.1/library/src/main/java/io/lettuce/core/protocol" ]]; then
+        continue
+      fi
+      if [[ "$dir" == "instrumentation/nats/nats-2.17/library/src/main/java/io/nats/client/impl" ]]; then
+        continue
+      fi
+      if [[ "$dir" == "instrumentation/rxjava/rxjava-1.0/library/src/main/java/rx" ]]; then
+        continue
+      fi
+    fi
 
-  # convention: if module ends with -java (followed by version), remove -java from the package name
-  simple_module_name=$(echo "$module_name" | sed 's/-[0-9.]*$//' | sed 's/-java$//' | sed 's/-//g')
-  base_version=$(echo "$module_name" | sed 's/.*-\([0-9.]*\)$/\1/' | sed 's/\./_/g')
+    if [[ "$source_set" == "javaagent" ]]; then
+      # advice packages that must live under the instrumented library's own namespace
+      case "$dir" in
+        instrumentation/clickhouse/clickhouse-client-v1-0.5/javaagent/src/main/java/com/clickhouse/client*) continue ;;
+        instrumentation/finagle-http-23.11/javaagent/src/main/java/com/twitter/finagle*) continue ;;
+        instrumentation/finagle-http-23.11/javaagent/src/main/java/io/netty/channel*) continue ;;
+        instrumentation/reactor/reactor-netty/reactor-netty-1.0/javaagent/src/main/java/reactor/netty/http/client*) continue ;;
+        instrumentation/spring/spring-webmvc/spring-webmvc-3.1/javaagent/src/main/java/org/springframework/web/servlet/v3_1*) continue ;;
+        instrumentation/spring/spring-webmvc/spring-webmvc-6.0/javaagent/src/main/java/org/springframework/web/servlet/v6_0*) continue ;;
+        instrumentation/vertx/vertx-redis-client-4.0/javaagent/src/main/java/io/vertx/redis/client/impl*) continue ;;
+      esac
 
-  if [[ "$module_name" =~ [0-9]$ ]]; then
-    expected_package_name="io/opentelemetry/instrumentation/$simple_module_name/v$base_version"
-  else
-    expected_package_name="io/opentelemetry/instrumentation/$simple_module_name"
-  fi
+      # historical javaagent modules that do not follow the module-name <-> package-name convention
+      case "$dir" in
+        instrumentation/akka/akka-actor-fork-join-2.5/javaagent/*) continue ;;
+        instrumentation/akka/akka-http-10.0/javaagent/*) continue ;;
+        instrumentation/aws-sdk/aws-sdk-1.11/javaagent/*) continue ;;
+        instrumentation/aws-sdk/aws-sdk-2.2/javaagent/*) continue ;;
+        instrumentation/camel-2.20/javaagent/*) continue ;;
+        instrumentation/clickhouse/clickhouse-client-common/javaagent/*) continue ;;
+        instrumentation/elasticsearch/elasticsearch-api-client-7.16/javaagent/*) continue ;;
+        instrumentation/elasticsearch/elasticsearch-rest-common-5.0/javaagent/*) continue ;;
+        instrumentation/elasticsearch/elasticsearch-transport-common/javaagent/*) continue ;;
+        instrumentation/external-annotations/javaagent/*) continue ;;
+        instrumentation/hibernate/hibernate-procedure-call-4.3/javaagent/*) continue ;;
+        instrumentation/internal/internal-application-logger/javaagent/*) continue ;;
+        instrumentation/internal/internal-eclipse-osgi-3.6/javaagent/*) continue ;;
+        instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-annotations/javaagent/*) continue ;;
+        instrumentation/jaxrs/jaxrs-2.0/jaxrs-2.0-common/javaagent/*) continue ;;
+        instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-annotations/javaagent/*) continue ;;
+        instrumentation/jaxrs/jaxrs-3.0/jaxrs-3.0-common/javaagent/*) continue ;;
+        instrumentation/jaxrs/jaxrs-common/javaagent/*) continue ;;
+        instrumentation/jaxws/jaxws-cxf-3.0/javaagent/*) continue ;;
+        instrumentation/jaxws/jaxws-jws-api-1.1/javaagent/*) continue ;;
+        instrumentation/jaxws/jaxws-metro-2.2/javaagent/*) continue ;;
+        instrumentation/jsf/jsf-mojarra-1.2/javaagent/*) continue ;;
+        instrumentation/jsf/jsf-mojarra-3.0/javaagent/*) continue ;;
+        instrumentation/jsf/jsf-myfaces-1.2/javaagent/*) continue ;;
+        instrumentation/jsf/jsf-myfaces-3.0/javaagent/*) continue ;;
+        instrumentation/kotlinx-coroutines/kotlinx-coroutines-1.0/javaagent/*) continue ;;
+        instrumentation/kotlinx-coroutines/kotlinx-coroutines-flow-1.3/javaagent/*) continue ;;
+        instrumentation/liberty/liberty-dispatcher-20.0/javaagent/*) continue ;;
+        instrumentation/opensearch/opensearch-rest-common/javaagent/*) continue ;;
+        instrumentation/opentelemetry-api/opentelemetry-api-1.0/javaagent/*) continue ;;
+        instrumentation/opentelemetry-extension-annotations-1.0/javaagent/*) continue ;;
+        instrumentation/opentelemetry-extension-kotlin-1.0/javaagent/*) continue ;;
+        instrumentation/opentelemetry-instrumentation-annotations-1.16/javaagent/*) continue ;;
+        instrumentation/opentelemetry-instrumentation-api/javaagent/*) continue ;;
+        instrumentation/play/play-mvc/play-mvc-2.4/javaagent/*) continue ;;
+        instrumentation/play/play-mvc/play-mvc-2.6/javaagent/*) continue ;;
+        instrumentation/play/play-ws/play-ws-common/javaagent/*) continue ;;
+        instrumentation/scala-fork-join-2.8/javaagent/*) continue ;;
+        instrumentation/spark-2.3/javaagent/*) continue ;;
+        instrumentation/spring/spring-boot-actuator-autoconfigure-2.0/javaagent/*) continue ;;
+        instrumentation/spring/spring-boot-resources/javaagent/*) continue ;;
+        instrumentation/spring/spring-cloud-aws-3.0/javaagent/*) continue ;;
+        instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-2.0/javaagent/*) continue ;;
+        instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-common/javaagent/*) continue ;;
+        instrumentation/spring/spring-cloud-gateway/spring-cloud-gateway-webmvc-4.3/javaagent/*) continue ;;
+        instrumentation/spring/spring-webmvc/spring-webmvc-common/javaagent/*) continue ;;
+        instrumentation/vertx/vertx-http-client/vertx-http-client-common/javaagent/*) continue ;;
+        instrumentation/vertx/vertx-sql-client/vertx-sql-client-common/javaagent/*) continue ;;
+      esac
+    fi
 
-  package_name=$(echo "$dir" | sed 's#.*/src/main/java[0-9]*/##')
+    # some common modules don't have any base version (might have a variant instead, ex: javax)
+    if [[ ! "$module_name" =~ [0-9]$ ]]; then
+      case "$source_set:$module_name" in
+        # library:
+        library:jdbc) ;;
+        library:lettuce-common) ;;
+        library:netty-common) ;;
+        library:oshi) ;;
+        library:resources) ;;
+        library:servlet-common-javax) ;;
+        # javaagent:
+        javaagent:clickhouse-client-common) ;;
+        javaagent:elasticsearch-transport-common) ;;
+        javaagent:executors) ;;
+        javaagent:external-annotations) ;;
+        javaagent:http-url-connection) ;;
+        javaagent:internal-application-logger) ;;
+        javaagent:internal-class-loader) ;;
+        javaagent:internal-lambda) ;;
+        javaagent:internal-reflection) ;;
+        javaagent:internal-url-class-loader) ;;
+        javaagent:jaxrs-common) ;;
+        javaagent:jaxws-common) ;;
+        javaagent:jdbc) ;;
+        javaagent:jetty-common) ;;
+        javaagent:jsf-common-jakarta) ;;
+        javaagent:jsf-common-javax) ;;
+        javaagent:methods) ;;
+        javaagent:opensearch-rest-common) ;;
+        javaagent:opentelemetry-instrumentation-api) ;;
+        javaagent:oshi) ;;
+        javaagent:payara) ;;
+        javaagent:play-ws-common) ;;
+        javaagent:quarkus-resteasy-reactive) ;;
+        javaagent:rmi) ;;
+        javaagent:spring-boot-resources) ;;
+        javaagent:spring-cloud-gateway-common) ;;
+        javaagent:spring-webmvc-common) ;;
+        javaagent:tomcat-common) ;;
+        javaagent:tomcat-jdbc) ;;
+        javaagent:xxl-job-common) ;;
+        *)
+          echo "module name doesn't have a base version: $dir"
+          exit 1
+          ;;
+      esac
+    fi
 
-  # deal with differences like module name elasticsearch-rest and package name elasticsearch.rest
-  expected_package_name_normalized=$(echo "$expected_package_name" | sed 's#/##g')
-  package_name_normalized=$(echo "$package_name" | sed 's#/##g')
+    # build expected package name by walking the module name's dash-separated tokens:
+    # a version token (e.g. "3.0") becomes "/v3_0", any other token becomes "/<token>";
+    # the literal token "java" is elided (e.g. graphql-java-20.0 -> graphql/v20_0).
+    # this also handles multi-version modules like jaxrs-2.0-resteasy-3.1 -> jaxrs/v2_0/resteasy/v3_1.
+    expected_package_name="$expected_prefix"
+    IFS='-' read -ra module_parts <<< "$module_name"
+    for part in "${module_parts[@]}"; do
+      if [[ "$part" == "java" ]]; then
+        continue
+      fi
+      if [[ "$part" =~ ^[0-9][0-9.]*$ ]]; then
+        expected_package_name="$expected_package_name/v${part//./_}"
+      else
+        expected_package_name="$expected_package_name/$part"
+      fi
+    done
 
-  if [[ "$package_name_normalized" != "$expected_package_name_normalized"* ]]; then
-    echo "ERROR: $dir"
-    exit 1
-  fi
+    package_name=$(echo "$dir" | sed 's#.*/src/main/java[0-9]*/##')
 
-done
+    # deal with differences like module name elasticsearch-rest and package name elasticsearch.rest
+    expected_package_name_normalized=$(echo "$expected_package_name" | sed 's#/##g')
+    package_name_normalized=$(echo "$package_name" | sed 's#/##g')
+
+    if [[ "$package_name_normalized" != "$expected_package_name_normalized"* ]]; then
+      echo "ERROR: $dir"
+      exit 1
+    fi
+
+  done
+}
+
+check_source_set "library" "io/opentelemetry/instrumentation"
+check_source_set "javaagent" "io/opentelemetry/javaagent/instrumentation"

instrumentation/hibernate/hibernate-3.3/javaagent/build.gradle.kts

@@ -21,7 +21,7 @@ muzzle {
 dependencies {
   library("org.hibernate:hibernate-core:3.3.0.GA")
 
-  implementation(project(":instrumentation:hibernate:hibernate-common:javaagent"))
+  implementation(project(":instrumentation:hibernate:hibernate-common-3.3:javaagent"))
 
   testInstrumentation(project(":instrumentation:jdbc:javaagent"))
   // Added to ensure cross compatibility:

instrumentation/hibernate/hibernate-3.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/hibernate/v3_3/CriteriaInstrumentation.java

@@ -16,9 +16,9 @@
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateOperation;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateOperationScope;
-import io.opentelemetry.javaagent.instrumentation.hibernate.SessionInfo;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateOperation;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateOperationScope;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.SessionInfo;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;

instrumentation/hibernate/hibernate-3.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/hibernate/v3_3/Hibernate3Singletons.java

@@ -7,9 +7,9 @@
 
 import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
 import io.opentelemetry.instrumentation.api.util.VirtualField;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateInstrumenterFactory;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateOperation;
-import io.opentelemetry.javaagent.instrumentation.hibernate.SessionInfo;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateInstrumenterFactory;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateOperation;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.SessionInfo;
 import org.hibernate.Criteria;
 import org.hibernate.Query;
 import org.hibernate.Transaction;

instrumentation/hibernate/hibernate-3.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/hibernate/v3_3/QueryInstrumentation.java

@@ -7,7 +7,7 @@
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
-import static io.opentelemetry.javaagent.instrumentation.hibernate.OperationNameUtil.getOperationNameForQuery;
+import static io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.OperationNameUtil.getOperationNameForQuery;
 import static io.opentelemetry.javaagent.instrumentation.hibernate.v3_3.Hibernate3Singletons.QUERY_SESSION_INFO;
 import static io.opentelemetry.javaagent.instrumentation.hibernate.v3_3.Hibernate3Singletons.instrumenter;
 import static net.bytebuddy.matcher.ElementMatchers.named;
@@ -17,9 +17,9 @@
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateOperation;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateOperationScope;
-import io.opentelemetry.javaagent.instrumentation.hibernate.SessionInfo;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateOperation;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateOperationScope;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.SessionInfo;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;

instrumentation/hibernate/hibernate-3.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/hibernate/v3_3/SessionInstrumentation.java

@@ -7,8 +7,8 @@
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
-import static io.opentelemetry.javaagent.instrumentation.hibernate.OperationNameUtil.getEntityName;
-import static io.opentelemetry.javaagent.instrumentation.hibernate.OperationNameUtil.getSessionMethodOperationName;
+import static io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.OperationNameUtil.getEntityName;
+import static io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.OperationNameUtil.getSessionMethodOperationName;
 import static io.opentelemetry.javaagent.instrumentation.hibernate.v3_3.Hibernate3Singletons.CRITERIA_SESSION_INFO;
 import static io.opentelemetry.javaagent.instrumentation.hibernate.v3_3.Hibernate3Singletons.QUERY_SESSION_INFO;
 import static io.opentelemetry.javaagent.instrumentation.hibernate.v3_3.Hibernate3Singletons.TRANSACTION_SESSION_INFO;
@@ -23,9 +23,9 @@
 import io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateOperation;
-import io.opentelemetry.javaagent.instrumentation.hibernate.HibernateOperationScope;
-import io.opentelemetry.javaagent.instrumentation.hibernate.SessionInfo;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateOperation;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.HibernateOperationScope;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.SessionInfo;
 import net.bytebuddy.asm.Advice;
 import net.bytebuddy.description.type.TypeDescription;
 import net.bytebuddy.matcher.ElementMatcher;

instrumentation/hibernate/hibernate-3.3/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/hibernate/v3_3/SessionUtil.java

@@ -6,7 +6,7 @@
 package io.opentelemetry.javaagent.instrumentation.hibernate.v3_3;
 
 import io.opentelemetry.instrumentation.api.util.VirtualField;
-import io.opentelemetry.javaagent.instrumentation.hibernate.SessionInfo;
+import io.opentelemetry.javaagent.instrumentation.hibernate.common.v3_3.SessionInfo;
 import javax.annotation.Nullable;
 import org.hibernate.Session;
 import org.hibernate.StatelessSession;