feat: use shaded protobuf-java , instead of applications (#414)

* test to use shaded util, instead of client

* muzzle fix

* nit fix

* feat spotlessApply

* refactor code

Author: thugrock7

instrumentation/grpc-1.6/build.gradle.kts

@@ -15,7 +15,7 @@ muzzle {
         group = "io.grpc"
         module = "grpc-core"
         versions = "[1.6.0,)"
-        // for body capture via com.google.protobuf.Message to exist always
+
         extraDependency("com.google.protobuf:protobuf-java:3.3.1")
         extraDependency("io.grpc:grpc-netty:1.6.0")
     }

instrumentation/grpc-1.6/src/main/java/io/opentelemetry/javaagent/instrumentation/hypertrace/grpc/v1_6/GrpcSpanDecorator.java

@@ -23,13 +23,10 @@
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf.util.JsonFormat;
 import io.opentelemetry.javaagent.instrumentation.hypertrace.grpc.GrpcSemanticAttributes;
-import java.io.IOException;
 import java.util.LinkedHashMap;
 import java.util.Map;
 import java.util.function.Function;
 import org.hypertrace.agent.core.instrumentation.HypertraceSemanticAttributes;
-import org.hypertrace.agent.core.instrumentation.buffer.BoundedBuffersFactory;
-import org.hypertrace.agent.core.instrumentation.buffer.BoundedCharArrayWriter;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -44,12 +41,13 @@ public static void addMessageAttribute(Object message, Span span, AttributeKey<S
     if (message instanceof Message) {
       Message mb = (Message) message;
       try {
-        BoundedCharArrayWriter writer = BoundedBuffersFactory.createWriter();
-        PRINTER.appendTo(mb, writer);
-        span.setAttribute(key, writer.toString());
-      } catch (IOException e) {
-        log.error("Failed to decode message to JSON", e);
+        String jsonOutput = ProtobufMessageConverter.getMessage(mb);
+        span.setAttribute(key, jsonOutput);
+      } catch (Exception e) {
+        log.error("Failed to decode message as JSON", e);
       }
+    } else {
+      log.debug("message is not an instance of com.google.protobuf.Message");
     }
   }
 

instrumentation/grpc-1.6/src/main/java/io/opentelemetry/javaagent/instrumentation/hypertrace/grpc/v1_6/ProtobufMessageConverter.java

@@ -0,0 +1,94 @@
+/*
+ * Copyright The Hypertrace Authors
+ *
+ * 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
+ *
+ *     http://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.opentelemetry.javaagent.instrumentation.hypertrace.grpc.v1_6;
+
+import com.google.protobuf.Descriptors;
+import com.google.protobuf.Message;
+import io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf.DescriptorProtos.FileDescriptorProto;
+import io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf.Descriptors.Descriptor;
+import io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf.Descriptors.FileDescriptor;
+import io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf.DynamicMessage;
+import io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf.util.JsonFormat;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class ProtobufMessageConverter {
+  private static final Logger log = LoggerFactory.getLogger(ProtobufMessageConverter.class);
+  /**
+   * Converts an unrelocated protobuf message into a relocated DynamicMessage via a byte-array
+   * round-trip.
+   *
+   * @param message The original protobuf message (an instance of com.google.protobuf.Message).
+   * @return A relocated DynamicMessage built from your relocated protobuf classes.
+   * @throws Exception if conversion fails.
+   */
+  public static DynamicMessage convertToRelocatedDynamicMessage(Message message) throws Exception {
+    // 1. Serialize the original message to bytes.
+    byte[] messageBytes = message.toByteArray();
+
+    // 2. Obtain the original (unrelocated) message descriptor.
+    Descriptors.Descriptor originalDescriptor = message.getDescriptorForType();
+
+    // 3. Get the unrelocated file descriptor and its proto representation.
+    Descriptors.FileDescriptor unrelocatedFileDescriptor = originalDescriptor.getFile();
+    com.google.protobuf.DescriptorProtos.FileDescriptorProto unrelocatedFileProto =
+        unrelocatedFileDescriptor.toProto();
+    byte[] fileProtoBytes = unrelocatedFileProto.toByteArray();
+
+    // 4. Parse the file descriptor proto using relocated classes.
+    // This converts the unrelocated FileDescriptorProto into your relocated FileDescriptorProto.
+    FileDescriptorProto relocatedFileProto = FileDescriptorProto.parseFrom(fileProtoBytes);
+
+    // 5. Build the relocated FileDescriptor.
+    FileDescriptor relocatedFileDescriptor =
+        FileDescriptor.buildFrom(relocatedFileProto, new FileDescriptor[] {});
+
+    // 6. Find the relocated message descriptor by name.
+    Descriptor relocatedDescriptor =
+        relocatedFileDescriptor.findMessageTypeByName(originalDescriptor.getName());
+    if (relocatedDescriptor == null) {
+      throw new IllegalStateException(
+          "Could not find relocated descriptor for message type: " + originalDescriptor.getName());
+    }
+
+    // 7. Parse the original message bytes using the relocated descriptor.
+    DynamicMessage relocatedMessage = DynamicMessage.parseFrom(relocatedDescriptor, messageBytes);
+    return relocatedMessage;
+  }
+
+  /**
+   * Method that takes an incoming message, converts it to a relocated one, prints it as JSON using
+   * the relocated JsonFormat
+   *
+   * @param message The incoming (unrelocated) protobuf message.
+   */
+  public static String getMessage(Message message) {
+    try {
+      // Convert the unrelocated message into a relocated DynamicMessage.
+      DynamicMessage relocatedMessage = convertToRelocatedDynamicMessage(message);
+
+      // Use the relocated JsonFormat to print the message as JSON.
+      JsonFormat.Printer relocatedPrinter = JsonFormat.printer();
+      String jsonOutput = relocatedPrinter.print(relocatedMessage);
+
+      return jsonOutput;
+    } catch (Exception e) {
+      log.error("Failed to convert message with relocated protobuf message: {}", e.getMessage());
+    }
+    return "";
+  }
+}

shaded-protobuf-java-util/build.gradle.kts

@@ -4,17 +4,18 @@ plugins {
 }
 
 dependencies {
-    implementation("com.google.protobuf:protobuf-java-util:3.25.5") {
-        exclude("com.google.protobuf", "protobuf-java")
-        exclude("com.google.guava", "guava")
-    }
+    implementation("com.google.protobuf:protobuf-java-util:3.25.5")
+
     // fix vulnerability
     constraints {
         implementation("com.google.code.gson:gson:2.8.9")
     }
 }
 
 tasks.shadowJar {
+    relocate("com.google.protobuf", "io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf")
     relocate("com.google.protobuf.util", "io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.protobuf.util")
     relocate("com.google.gson", "io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.gson")
+    relocate("com.google.common", "io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.common") // Add this
+    relocate("com.google.guava", "io.opentelemetry.javaagent.instrumentation.hypertrace.com.google.guava")
 }