com.datastrato.gravitino.StringIdentifier Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2023 Datastrato Pvt Ltd.
 * This software is licensed under the Apache License version 2.
 */
package com.datastrato.gravitino;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableMap;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.tuple.Pair;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class StringIdentifier {

  private static final Logger LOG = LoggerFactory.getLogger(StringIdentifier.class);

  public static final String ID_KEY = "gravitino.identifier";

  @VisibleForTesting static final int CURRENT_FORMAT_VERSION = 1;

  @VisibleForTesting static final String CURRENT_FORMAT = "gravitino.v%d.uid%d";

  private static final String STRING_COMMENT = "From Gravitino, DO NOT EDIT: ";
  private static final String STRING_COMMENT_FORMAT = "%s(%s%s)";

  private static final Pattern CURRENT_FORMAT_REGEX =
      Pattern.compile("gravitino\\.v(\\d+)\\.uid(\\d+)");

  private static final Map> SUPPORTED_FORMAT =
      ImmutableMap.>builder()
          .put(CURRENT_FORMAT_VERSION, Pair.of(CURRENT_FORMAT, CURRENT_FORMAT_REGEX))
          .build();

  private final long id;

  private StringIdentifier(long id) {
    this.id = id;
  }

  public static StringIdentifier fromId(long id) {
    return new StringIdentifier(id);
  }

  public static StringIdentifier fromString(String idString) {
    Preconditions.checkArgument(
        StringUtils.isNotBlank(idString), "Input id string cannot be null or empty");

    for (Map.Entry> entry : SUPPORTED_FORMAT.entrySet()) {
      int supportedVersion = entry.getKey();
      Pair format = entry.getValue();
      Pattern pattern = format.getRight();

      Matcher m = pattern.matcher(idString);
      if (m.matches()) {
        int version = Integer.parseInt(m.group(1));
        long id = Long.parseLong(m.group(2));

        if (version != supportedVersion) {
          continue;
        }

        return new StringIdentifier(id);
      }
    }

    throw new IllegalArgumentException("Invalid string identifier format: " + idString);
  }

  public long id() {
    return id;
  }

  @Override
  public String toString() {
    return String.format(CURRENT_FORMAT, CURRENT_FORMAT_VERSION, id);
  }

  /**
   * Helper methods to set/get StringIdentifier to/from different places
   *
   * @param stringId the string identifier to add to the properties
   * @param properties the properties to add the string identifier to
   * @return the properties with the string identifier added
   */
  public static Map addToProperties(
      StringIdentifier stringId, Map properties) {
    if (properties == null) {
      return ImmutableMap.of(ID_KEY, stringId.toString());
    }

    if (properties.containsKey(ID_KEY)) {
      LOG.warn(
          "Property {}:{} already existed in the properties, this is unexpected, we will "
              + "ignore adding the identifier to the properties",
          ID_KEY,
          properties.get(ID_KEY));
      return properties;
    }

    return ImmutableMap.builder()
        .putAll(properties)
        .put(ID_KEY, stringId.toString())
        .build();
  }

  public static StringIdentifier fromProperties(Map properties) {
    if (properties == null) {
      return null;
    }

    String idString = properties.get(ID_KEY);
    if (StringUtils.isBlank(idString)) {
      return null;
    }

    return fromString(idString);
  }

  public static String addToComment(StringIdentifier stringId, String comment) {
    if (StringUtils.isBlank(comment)) {
      return String.format(STRING_COMMENT_FORMAT, "", STRING_COMMENT, stringId.toString());
    }

    return String.format(STRING_COMMENT_FORMAT, comment + " ", STRING_COMMENT, stringId.toString());
  }

  public static StringIdentifier fromComment(String comment) {
    if (StringUtils.isBlank(comment)) {
      return null;
    }

    int index = comment.lastIndexOf('(');
    if (index == -1) {
      return null;
    }

    String idString = comment.substring(index + STRING_COMMENT.length() + 1, comment.length() - 1);
    return fromString(idString);
  }

  public static String removeIdFromComment(String comment) {
    if (StringUtils.isBlank(comment)) {
      return comment;
    }

    StringIdentifier identifier = fromComment(comment);
    if (identifier != null) {
      String format = String.format(STRING_COMMENT_FORMAT, " ", STRING_COMMENT, identifier);
      int indexOf = comment.indexOf(format);

      if (indexOf == -1) {
        format = String.format(STRING_COMMENT_FORMAT, "", STRING_COMMENT, identifier);
        indexOf = comment.indexOf(format);
      }

      if (indexOf != -1) {
        return comment.substring(0, indexOf);
      }
    }
    return comment;
  }
}