DefaultInstanceMessageFactory.java

// Copyright 2022 Google LLC
//
// 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 dev.cel.common.internal;

import com.google.protobuf.Descriptors.Descriptor;
import com.google.protobuf.GeneratorNames;
import com.google.protobuf.Message;
import com.google.protobuf.MessageLite;
import dev.cel.common.annotations.Internal;
import java.util.Optional;

/**
 * Singleton factory for creating default messages from a protobuf descriptor.
 *
 * <p>CEL Library Internals. Do Not Use.
 */
@Internal
public final class DefaultInstanceMessageFactory {
  private static final DefaultInstanceMessageFactory INSTANCE = new DefaultInstanceMessageFactory();

  /** Gets a single instance of this MessageFactory */
  public static DefaultInstanceMessageFactory getInstance() {
    return INSTANCE;
  }

  /**
   * Creates a default instance of a protobuf message given a descriptor. This is essentially the
   * same as calling FooMessage.getDefaultInstance(), except reflection is leveraged.
   *
   * @return Default instance of a type. Returns an empty optional if the descriptor used to
   *     construct the type via reflection is different to the provided descriptor or if the
   *     descriptor class isn't loaded in the binary.
   */
  public Optional<Message> getPrototype(Descriptor descriptor) {
    MessageLite defaultInstance =
        DefaultInstanceMessageLiteFactory.getInstance()
            .getPrototype(descriptor.getFullName(), GeneratorNames.getBytecodeClassName(descriptor))
            .orElse(null);
    if (defaultInstance == null) {
      return Optional.empty();
    }

    if (!(defaultInstance instanceof Message)) {
      throw new IllegalArgumentException(
          "Expected a full protobuf message, but got: " + defaultInstance.getClass());
    }

    Message fullMessage = (Message) defaultInstance;

    // Reference equality is intended. We want to make sure the descriptors are equal
    // to guarantee types to be hermetic if linked types is disabled.
    if (fullMessage.getDescriptorForType() != descriptor) {
      return Optional.empty();
    }
    return Optional.of(fullMessage);
  }

  private DefaultInstanceMessageFactory() {}
}