src/java/com/twitter/search/earlybird/common/ClientIdUtil.java - main - githubmirror/the-algorithm

src/java/com/twitter/search/earlybird/common/ClientIdUtil.java
85 строк3 KB
twitter-team
Twitter Recommendation Algorithm
01 апр 2023, 01:36
01 апр 2023, 01:36ef4c5eb
package com.twitter.search.earlybird.common;

import java.util.Optional;

import com.twitter.common.optional.Optionals;
import com.twitter.search.common.util.FinagleUtil;
import com.twitter.search.earlybird.thrift.EarlybirdRequest;
import com.twitter.strato.opcontext.Attribution;
import com.twitter.strato.opcontext.HttpEndpoint;

public final class ClientIdUtil {
  // Blenders should always set the EarlybirdRequest.clientId field. It should be set to the Finagle
  // client ID of the client that caused the blender to send this request to the roots. If the
  // Finagle ID of the blender's client cannot be determined, it will be set to "unknown" (see
  // com.twitter.search.common.util.FinagleUtil.UNKNOWN_CLIENT_NAME). However, other services that
  // send requests to roots might not set EarlybirdRequest.clientId.
  //
  // So an "unset" clientId means: EarlybirdRequest.clientId was null.
  // An "unknown" clientId means: the client that sent us the request
  // tried setting EarlybirdRequest.clientId, but couldn't figure out a good value for it.
  public static final String UNSET_CLIENT_ID = "unset";

  private static final String CLIENT_ID_FOR_UNKNOWN_CLIENTS = "unknown_client_id";

  private static final String CLIENT_ID_PREFIX = "client_id_";

  private static final String FINAGLE_CLIENT_ID_AND_CLIENT_ID_PATTERN =
      "finagle_id_%s_and_client_id_%s";

  private static final String CLIENT_ID_AND_REQUEST_TYPE = "client_id_%s_and_type_%s";

  private ClientIdUtil() {
  }

  /** Returns the ID of the client that initiated this request or UNSET_CLIENT_ID if not set. */
  public static String getClientIdFromRequest(EarlybirdRequest request) {
    return Optional
        .ofNullable(request.getClientId())
        .map(String::toLowerCase)
        .orElse(UNSET_CLIENT_ID);
  }

  /**
   * Returns the Strato http endpoint attribution as an Optional.
   */
  public static Optional<String> getClientIdFromHttpEndpointAttribution() {
    return Optionals
        .optional(Attribution.httpEndpoint())
        .map(HttpEndpoint::name)
        .map(String::toLowerCase);
  }

  /** Formats the given clientId into a string that can be used for stats. */
  public static String formatClientId(String clientId) {
    return CLIENT_ID_PREFIX + clientId;
  }

  /**
   * Formats the given Finagle clientId and the given clientId into a single string that can be used
   * for stats, or other purposes where the two IDs need to be combined.
   */
  public static String formatFinagleClientIdAndClientId(String finagleClientId, String clientId) {
    return String.format(FINAGLE_CLIENT_ID_AND_CLIENT_ID_PATTERN, finagleClientId, clientId);
  }

  /**
   * Formats the given clientId and requestType into a single string that can be used
   * for stats or other purposes.
   */
  public static String formatClientIdAndRequestType(
      String clientId, String requestType) {
    return String.format(CLIENT_ID_AND_REQUEST_TYPE, clientId, requestType);
  }

  /**
   * Format the quota client id
   */
  public static String getQuotaClientId(String clientId) {
    if (FinagleUtil.UNKNOWN_CLIENT_NAME.equals(clientId) || UNSET_CLIENT_ID.equals(clientId)) {
      return CLIENT_ID_FOR_UNKNOWN_CLIENTS;
    }

    return clientId;
  }
}