io.github.microcks.util.grpc.GrpcUtil Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of microcks-app Show documentation
The newest version!
/*
 * Copyright The Microcks 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.github.microcks.util.grpc;

import com.google.protobuf.DescriptorProtos;
import com.google.protobuf.Descriptors;
import com.google.protobuf.InvalidProtocolBufferException;
import com.google.protobuf.TypeRegistry;
import io.grpc.MethodDescriptor;
import io.grpc.protobuf.services.BinaryLogProvider;

import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.Base64;
import java.util.List;

/**
 * Helper class containing utility methods related to Grpc/Protobuf descriptors.
 * @author laurent
 */
public class GrpcUtil {

   private GrpcUtil() {
      // Private constructor to hide the implicit public one.
   }

   /**
    * Find a Protobuf method descriptor using a base64 encoded representation of the proto descriptor + service and
    * method name.
    * @param base64ProtobufDescriptor The encoded representation of proto descriptor as produced by protoc.
    * @param serviceName              The name of the service to get method for.
    * @param methodName               The name of the method.
    * @return A Protobuf MethodDescriptor
    * @throws InvalidProtocolBufferException            If representation is not understood as protobuf descriptor.
    * @throws Descriptors.DescriptorValidationException If included FileDescriptor cannot be validated.
    */
   public static Descriptors.MethodDescriptor findMethodDescriptor(String base64ProtobufDescriptor, String serviceName,
         String methodName) throws InvalidProtocolBufferException, Descriptors.DescriptorValidationException {

      // Now we may have serviceName as being the FQDN. We have to find short version to later findServiceByName().
      String shortServiceName = serviceName;
      if (serviceName.contains(".")) {
         shortServiceName = serviceName.substring(serviceName.lastIndexOf(".") + 1);
      }

      // Find descriptor with this service name as symbol.
      Descriptors.FileDescriptor fd = findFileDescriptorBySymbol(base64ProtobufDescriptor, shortServiceName);
      Descriptors.ServiceDescriptor sd = fd.findServiceByName(shortServiceName);

      return sd.findMethodByName(methodName);
   }

   /**
    * Get the Protobuf FileDescriptorSet from a base64 encoded representation of the proto descriptor.
    * @param base64ProtobufDescriptor The encoded representation of proto descriptor as produced by protoc.
    * @return A Protobuf FileDescriptorSet
    * @throws InvalidProtocolBufferException
    */
   public static DescriptorProtos.FileDescriptorSet getFileDescriptorSet(String base64ProtobufDescriptor)
         throws InvalidProtocolBufferException {
      // Protobuf binary descriptor has been encoded in base64 to be stored as a string.
      // Decode it and recreate DescriptorProtos objects.
      byte[] decodedBinaryPB = Base64.getDecoder().decode(base64ProtobufDescriptor.getBytes(StandardCharsets.UTF_8));
      return DescriptorProtos.FileDescriptorSet.parseFrom(decodedBinaryPB);
   }

   /**
    * Find a Protobuf file descriptor using a base64 encoded representation of the proto descriptor + symbol name.
    * @param base64ProtobufDescriptor The encoded representation of proto descriptor as produced by protoc.
    * @param symbol                   The name of a symbol to get descriptor for (can be a service, a message type or an
    *                                 extension).
    * @return A Protobuf FileDescriptor
    * @throws InvalidProtocolBufferException            If representation is not understood as protobuf descriptor.
    * @throws Descriptors.DescriptorValidationException If included FileDescriptor cannot be validated.
    */
   public static Descriptors.FileDescriptor findFileDescriptorBySymbol(String base64ProtobufDescriptor, String symbol)
         throws InvalidProtocolBufferException, Descriptors.DescriptorValidationException {

      // Get Descriptor objects corresponding to the base64 encoded descriptor.
      DescriptorProtos.FileDescriptorSet fds = getFileDescriptorSet(base64ProtobufDescriptor);

      if (fds.getFileCount() > 1) {
         // Build dependencies.
         List dependencies = new ArrayList<>();
         for (int i = 0; i < fds.getFileCount(); i++) {
            // Build descriptor and add to dependencies.
            Descriptors.FileDescriptor fd = Descriptors.FileDescriptor.buildFrom(fds.getFile(i),
                  dependencies.toArray(new Descriptors.FileDescriptor[dependencies.size()]), true);
            dependencies.add(fd);

            // Search for symbol.
            if (fd.findServiceByName(symbol) != null || fd.findMessageTypeByName(symbol) != null
                  || fd.findExtensionByName(symbol) != null) {
               return fd;
            }
         }
      }
      return Descriptors.FileDescriptor.buildFrom(fds.getFile(0), new Descriptors.FileDescriptor[] {}, true);
   }

   /**
    * Build a TypeRegistry for JSON parsing/serialization. Use the base64 encoded representation of the proto descriptor
    * to extract types information.
    * @param base64ProtobufDescriptor The encoded representation of proto descriptor as produced by protoc.
    * @return A TYpeRegistry instance.
    * @throws InvalidProtocolBufferException            If representation is not understood as protobuf descriptor.
    * @throws Descriptors.DescriptorValidationException If included FileDescriptor cannot be validated.
    */
   public static TypeRegistry buildTypeRegistry(String base64ProtobufDescriptor)
         throws InvalidProtocolBufferException, Descriptors.DescriptorValidationException {
      // Get Descriptor objects corresponding to the base64 encoded descriptor.
      DescriptorProtos.FileDescriptorSet fds = getFileDescriptorSet(base64ProtobufDescriptor);

      // Initialize a new TypeRegistry builder.
      TypeRegistry.Builder registryBuilder = TypeRegistry.newBuilder();

      // Build dependencies.
      List dependencies = new ArrayList<>();
      for (int i = 0; i < fds.getFileCount(); i++) {
         // Build descriptor and add to dependencies.
         Descriptors.FileDescriptor fd = Descriptors.FileDescriptor.buildFrom(fds.getFile(i),
               dependencies.toArray(new Descriptors.FileDescriptor[dependencies.size()]), true);
         dependencies.add(fd);

         registryBuilder.add(fd.getMessageTypes());
      }

      return registryBuilder.build();
   }

   /**
    * Build a generic GRPC Unary Method descriptor (using byte[] as input and byte[] as output.
    * @param fullMethodName The GRPC method full name (service fqdn / method)
    * @return A new MethodDescriptor using a byte array marshaller.
    */
   public static MethodDescriptor buildGenericUnaryMethodDescriptor(String fullMethodName) {
      return MethodDescriptor.newBuilder(BinaryLogProvider.BYTEARRAY_MARSHALLER, BinaryLogProvider.BYTEARRAY_MARSHALLER)
            .setType(MethodDescriptor.MethodType.UNARY).setFullMethodName(fullMethodName).build();
   }
}