com.google.api.tools.framework.aspects.versioning.VersionConfigAspect Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of api-compiler Show documentation
Google API Compiler.
The newest version!
/*
 * Copyright (C) 2016 Google 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
 *
 * 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 com.google.api.tools.framework.aspects.versioning;

import com.google.api.tools.framework.aspects.ConfigAspectBase;
import com.google.api.tools.framework.aspects.ConfigRuleSet;
import com.google.api.tools.framework.aspects.http.HttpConfigAspect;
import com.google.api.tools.framework.aspects.http.model.HttpAttribute;
import com.google.api.tools.framework.aspects.http.model.HttpAttribute.LiteralSegment;
import com.google.api.tools.framework.aspects.versioning.model.ApiVersionUtil;
import com.google.api.tools.framework.aspects.versioning.model.RestVersionsAttribute;
import com.google.api.tools.framework.aspects.versioning.model.VersionAttribute;
import com.google.api.tools.framework.model.ConfigAspect;
import com.google.api.tools.framework.model.DiagReporter.LocationContext;
import com.google.api.tools.framework.model.DiagReporter.MessageLocationContext;
import com.google.api.tools.framework.model.Interface;
import com.google.api.tools.framework.model.Method;
import com.google.api.tools.framework.model.Model;
import com.google.api.tools.framework.model.ProtoElement;
import com.google.api.tools.framework.model.SimpleLocation;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Sets;
import com.google.inject.Key;
import com.google.inject.name.Names;
import com.google.protobuf.Api;
import java.util.Collections;
import java.util.List;
import java.util.Set;

/**
 * Configuration aspect for versioning.
 */
public class VersionConfigAspect extends ConfigAspectBase {

  public static final Key KEY = Key.get(String.class, Names.named("version"));

  public static final String NAME = "versioning";

  private final Set roots = Sets.newHashSet();

  public static VersionConfigAspect create(Model model) {
    return new VersionConfigAspect(model);
  }

  private VersionConfigAspect(Model model) {
    super(model, NAME);
  }

  /**
   * Returns dependencies. Depends on http attributes used for determining the version
   * from the HTTP path.
   */
  @Override
  public List> mergeDependencies() {
    return ImmutableList.>of(HttpConfigAspect.class);
  }

  @Override
  public void startMerging() {
    // Load the roots here since roots in the model was empty when VersionConfigAspect was created.
    for (ProtoElement root: getModel().getRoots()) {
      roots.add(root);
    }

    // Verify the config_version is explicitly specified in the service config.
    if (!getModel().getServiceConfig().hasConfigVersion()) {
      error(SimpleLocation.TOPLEVEL, "config_version is not specified in the service config file.");
    }

    // Detect config version location.
    LocationContext configVersionLocation =
        MessageLocationContext.create(getModel().getServiceConfig().getConfigVersion(), "value");

    if (getModel().getConfigVersion() > Model.getDevConfigVersion()) {
      error(
          configVersionLocation,
          String.format("config_version %s is invalid, the latest config_version is %s.",
              getModel().getConfigVersion(), Model.getDevConfigVersion()));
    }
  }

  @Override
  public void merge(ProtoElement element) {
    if (element instanceof Interface) {
      merge((Interface) element);
    }
    if (element instanceof Method) {
      merge((Method) element);
    }
  }

  private void merge(Interface iface) {
    Api api = iface.getConfig();
    if (api == null) {
        return;
    }
    // Get user-defined api version, which is optional.
    String apiVersion = api.getVersion();
    String packageName = iface.getFile().getFullName();
    if (Strings.isNullOrEmpty(apiVersion)) {
      // If version is not provided by user, extract major version from package name.
      apiVersion = ApiVersionUtil.extractDefaultMajorVersionFromPackageName(packageName);
    }
    iface.setConfig(api.toBuilder().setVersion(apiVersion).build());
    iface.putAttribute(VersionAttribute.KEY, VersionAttribute.create(apiVersion));
  }

  private void merge(Method method) {
    // TODO(user): Cleanup the use of apiVersion restVersions (VersionAttribute vs
    // RestVersionsAttribute) in the tools framework. Some references are using the attributes
    // incorrectly due to the confusion caused by the names.
    String apiVersion = deriveApiVersion(method);
    Set restVersions = calculateRestVersions(method);
    method.putAttribute(VersionAttribute.KEY, VersionAttribute.create(apiVersion));
    // UM uses the logical version with a suffix appended, if defined.
    String versionSuffix = method.getModel().getApiV1VersionSuffix();
    method.putAttribute(VersionAttribute.USAGE_MANAGER_KEY,
        VersionAttribute.create(ApiVersionUtil.appendVersionSuffix(apiVersion, versionSuffix)));

    // Add the rest versions into RestVersionsAttribute only if parent of the method is included in
    // the model roots.
    if (roots.contains(method.getParent())) {
      if (getModel().hasAttribute(RestVersionsAttribute.KEY)) {
        getModel().getAttribute(RestVersionsAttribute.KEY).getVersions().addAll(restVersions);
      } else {
        getModel().putAttribute(RestVersionsAttribute.KEY,
            new RestVersionsAttribute(restVersions));
      }
    }
  }

  @SuppressWarnings("deprecation")
  private String deriveApiVersion(Method element) {

    // Derive the version from the prefix of the http path. Validation of
    // syntax of version in path happens elsewhere, so we take just the first path segment
    // literal. If none is given, assume 'v1'.
    HttpAttribute http = element.getAttribute(HttpAttribute.KEY);
    if (http == null || http.getPath().isEmpty()
        || !(http.getPath().get(0) instanceof LiteralSegment)) {
      return "v1";
    }
    return ((LiteralSegment) http.getPath().get(0)).getLiteral();
  }

  /*
   * The rest versions are calculated based on RestMethod(s) this proto method maps to.
   */
  private static Set calculateRestVersions(Method method) {
    Set restVersions = Sets.newHashSet();
    if (!method.hasAttribute(HttpAttribute.KEY)) {
      // Return an empty set if the proto method doesn't have http binding.
      return restVersions;
    }

    // Exclude rest version introduced by System APIs.
    for (String prefix : ConfigRuleSet.SYSTEM_PROTO_PREFIXES) {
      if (method.getFullName().startsWith(prefix)) {
        return Collections.emptySet();
      }
    }

    for (HttpAttribute binding : method.getAttribute(HttpAttribute.KEY).getAllBindings()) {
      restVersions.add(binding.getRestMethod().getVersionWithDefault());
    }
    return restVersions;
  }
}