the-algorithm/src/java/com/twitter/search/earlybird_root/EarlybirdServiceValidationBehavior.java

package com.twitter.search.earlybird_root;

import org.apache.thrift.TException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.twitter.search.common.metrics.SearchCounter;
import com.twitter.search.common.root.ValidationBehavior;
import com.twitter.search.earlybird.common.EarlybirdRequestUtil;
import com.twitter.search.earlybird.thrift.EarlybirdDebugInfo;
import com.twitter.search.earlybird.thrift.EarlybirdRequest;
import com.twitter.search.earlybird.thrift.EarlybirdResponse;
import com.twitter.search.earlybird.thrift.EarlybirdResponseCode;
import com.twitter.search.earlybird.thrift.ThriftSearchQuery;

public class EarlybirdServiceValidationBehavior
    extends ValidationBehavior.DefaultValidationBehavior<EarlybirdRequest, EarlybirdResponse> {
  private static final Logger LOG =
      LoggerFactory.getLogger(EarlybirdServiceValidationBehavior.class);

  private static final EarlybirdDebugInfo EARLYBIRD_DEBUG_INFO =
          new EarlybirdDebugInfo().setHost("earlybird_root");

  private static final SearchCounter INVALID_SUCCESS_RESPONSE_THRESHOLD_TOO_LOW =
      SearchCounter.export("invalid_success_response_threshold_too_low");
  private static final SearchCounter INVALID_SUCCESS_RESPONSE_THRESHOLD_TOO_HIGH =
      SearchCounter.export("invalid_success_response_threshold_too_high");

  protected EarlybirdResponse createErrorResponse(String errorMsg) {
    EarlybirdResponse response = new EarlybirdResponse(EarlybirdResponseCode.CLIENT_ERROR, 0);

    // We're changing some ERROR logs to WARN on our side, so we want to ensure
    // that the response contains the debug information the client needs to
    // resolve the problem.
    response.setDebugInfo(EARLYBIRD_DEBUG_INFO);
    response.setDebugString(errorMsg);

    return response;
  }

  @Override
  public EarlybirdResponse getResponseIfInvalidRequest(EarlybirdRequest request) {
    // First, fix up the query.
    EarlybirdRequestUtil.checkAndSetCollectorParams(request);
    EarlybirdRequestUtil.logAndFixExcessiveValues(request);

    try {
      request.validate();
    } catch (TException e) {
      String errorMsg = "Invalid EarlybirdRequest. " + request;
      LOG.warn(errorMsg);
      return createErrorResponse(errorMsg);
    }

    if (request.isSetSearchSegmentId() && request.getSearchSegmentId() <= 0) {
      String errorMsg = "Bad time slice ID: " + request.getSearchSegmentId();
      LOG.warn(errorMsg);
      return createErrorResponse(errorMsg);
    }

    if (request.isSetTermStatisticsRequest()
        && request.getTermStatisticsRequest().isSetHistogramSettings()
        && request.getTermStatisticsRequest().getHistogramSettings().getNumBins() == 0) {

      String errorMsg = "numBins for term statistics histograms request cannot be zero: " + request;
      LOG.warn(errorMsg);
      return createErrorResponse(errorMsg);
    }

    if (!request.isSetSearchQuery()
        || request.getSearchQuery() == null) {
      String errorMsg = "Invalid EarlybirdRequest, no ThriftSearchQuery specified. " + request;
      LOG.warn(errorMsg);
      return createErrorResponse(errorMsg);
    }

    ThriftSearchQuery searchQuery = request.getSearchQuery();

    if (!searchQuery.getCollectorParams().isSetNumResultsToReturn()) {
      String errorMsg = "ThriftSearchQuery.numResultsToReturn not set. " + request;
      LOG.warn(errorMsg);
      return createErrorResponse(errorMsg);
    }

    if (searchQuery.getCollectorParams().getNumResultsToReturn() < 0) {
      String errorMsg = "Invalid ThriftSearchQuery.collectorParams.numResultsToReturn: "
          + searchQuery.getCollectorParams().getNumResultsToReturn() + ". " + request;
      LOG.warn(errorMsg);
      return createErrorResponse(errorMsg);
    }

    if (request.isSetSuccessfulResponseThreshold()) {
      double successfulResponseThreshold = request.getSuccessfulResponseThreshold();
      if (successfulResponseThreshold <= 0) {
        String errorMsg = "Success response threshold is below or equal to 0: "
            + successfulResponseThreshold + " request: " + request;
        LOG.warn(errorMsg);
        INVALID_SUCCESS_RESPONSE_THRESHOLD_TOO_LOW.increment();
        return createErrorResponse(errorMsg);
      } else if (successfulResponseThreshold > 1) {
        String errorMsg = "Success response threshold is above 1: " + successfulResponseThreshold
            + " request: " + request;
        LOG.warn(errorMsg);
        INVALID_SUCCESS_RESPONSE_THRESHOLD_TOO_HIGH.increment();
        return createErrorResponse(errorMsg);
      }
    }

    return null;
  }
}