com.spotify.apollo.meta.MetaInfoTracker Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of apollo-api-impl Show documentation
There is a newer version: 1.6.1
/*
 * -\-\-
 * Spotify Apollo API Implementations
 * --
 * Copyright (C) 2013 - 2015 Spotify AB
 * --
 * 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.spotify.apollo.meta;

import com.spotify.apollo.Request;
import com.spotify.apollo.dispatch.Endpoint;
import com.spotify.apollo.dispatch.EndpointInfo;
import com.spotify.apollo.request.OngoingRequest;
import com.spotify.apollo.route.Route;
import com.spotify.apollo.meta.model.Meta;
import com.spotify.apollo.meta.model.MetaGatherer;
import com.spotify.apollo.meta.model.MetaGatherer.CallsGatherer;
import com.spotify.apollo.meta.model.MetaGatherer.EndpointGatherer;
import com.spotify.apollo.meta.model.MetaInfoBuilder;
import com.spotify.apollo.meta.model.Model;
import com.typesafe.config.Config;

import java.util.List;
import java.util.Optional;

import static java.util.Collections.singletonList;

public class MetaInfoTracker {

  private final MetaGatherer gatherer;

  public MetaInfoTracker(
      Descriptor descriptor,
      String containerVersion,
      Config configNode) {
    final Model.MetaInfo metaInfo = new MetaInfoBuilder()
        .buildVersion(descriptor.serviceName() + ' ' + descriptor.version())
        .containerVersion(containerVersion)
        .build();

    gatherer = Meta.createGatherer(metaInfo, configNode);
  }

  public MetaGatherer getGatherer() {
    return gatherer;
  }

  public  void gatherEndpoints(List endpoints) {
    CallsGatherer callsGatherer = gatherer.getServiceCallsGatherer();
    for (E endpoint : endpoints) {
      EndpointInfo info = endpoint.info();

      String uri = info.getUri();
      String endpointDocString = formatDocString(info.getDocString());

      EndpointGatherer endpointGatherer =
          callsGatherer.uriMethodsEndpointGatherer(uri, singletonList(info.getRequestMethod()));

      endpointGatherer.setUri(uri);
      endpointGatherer.addMethod(info.getRequestMethod());
      endpointGatherer.setDocstring(endpointDocString);

      // see https://github.com/spotify/apollo/issues/13
//      endpointGatherer.setResponseContentType(endpoint.getContentType());

      // query parameters are not available
    }
  }

  private static String formatDocString(Optional docString) {
    if (!docString.isPresent()) {
      return "Lacks DocString annotation.";
    }

    return docString.get().summary() + "\n\n" + docString.get().description();
  }

  private class IncomingGatherer implements IncomingCallsGatherer {

    @Override
    public void gatherIncomingCall(OngoingRequest ongoingRequest, Endpoint endpoint) {
      Request message = ongoingRequest.request();
      String fromService = message.service().orElse(null);
      String method = message.method();
      EndpointInfo info = endpoint.info();
      String endpointMethodName = info.getJavaMethodName();
      CallsGatherer callsGatherer = gatherer.getIncomingCallsGatherer(fromService);
      EndpointGatherer endpointGatherer = callsGatherer.namedEndpointGatherer(endpointMethodName);
      endpointGatherer.setUri(info.getUri());
      endpointGatherer.addMethod(method);
      for (String name : message.parameters().keySet()) {
        endpointGatherer.addQueryParameterName(name);
      }
    }
  }

  private final IncomingGatherer incomingGatherer = new IncomingGatherer();

  public IncomingCallsGatherer incomingCallsGatherer() {
    return incomingGatherer;
  }

  private class OutgoingGatherer implements OutgoingCallsGatherer {

    public void gatherOutgoingCall(String toService, Request request) {
      @SuppressWarnings("UnusedDeclaration")
      CallsGatherer callsGatherer = gatherer.getOutgoingCallsGatherer(toService);
      // Don't know how to convert outgoing uri:s to a useful limited set of endpoints, so
      // not too useful to collect any info other than that the external service is called.
      // The request method, content type and query parameters are available.
    }
  }

  private OutgoingGatherer outgoingGatherer = new OutgoingGatherer();

  public OutgoingCallsGatherer outgoingCallsGatherer() {
    return outgoingGatherer;
  }
}