google-nomulus/java/google/registry/model/ofy/TimestampInversionException.java

// Copyright 2017 The Nomulus Authors. All Rights Reserved.
//
// 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 google.registry.model.ofy;

import com.google.common.base.Joiner;
import com.google.common.base.Predicate;
import com.google.common.collect.FluentIterable;
import com.googlecode.objectify.Key;
import com.googlecode.objectify.Objectify;
import google.registry.model.BackupGroupRoot;
import java.util.Map;
import org.joda.time.DateTime;

/**
 * Exception when trying to write to Datastore with a timestamp that is inconsistent with a partial
 * ordering on transactions that touch the same entities.
 */
class TimestampInversionException extends RuntimeException {

  static String getFileAndLine(StackTraceElement callsite) {
    return callsite.getFileName() + ":" + callsite.getLineNumber();
  }

  TimestampInversionException(
      DateTime transactionTime, Map<Key<BackupGroupRoot>, DateTime> problematicRoots) {
    this(transactionTime, "entities rooted under:\n" + problematicRoots);
  }

  TimestampInversionException(DateTime transactionTime, DateTime updateTimestamp) {
    this(transactionTime, String.format("update timestamp (%s)", updateTimestamp));
  }

  private TimestampInversionException(DateTime transactionTime, String problem) {
    super(Joiner.on('\n').join(
        String.format(
            "Timestamp inversion between transaction time (%s) and %s",
            transactionTime,
            problem),
        getFileAndLine(FluentIterable.from(new Exception().getStackTrace())
          .firstMatch(new Predicate<StackTraceElement>() {
            @Override
            public boolean apply(StackTraceElement element) {
              return !element.getClassName().startsWith(Objectify.class.getPackage().getName())
                  && !element.getClassName().startsWith(Ofy.class.getName());
            }}).get())));
  }
}