google-nomulus/java/google/registry/model/billing/BillingEvent.java

// Copyright 2016 The Domain Registry 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.billing;

import static com.google.common.base.MoreObjects.firstNonNull;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static google.registry.util.CollectionUtils.nullToEmptyImmutableCopy;
import static google.registry.util.CollectionUtils.union;
import static google.registry.util.DateTimeUtils.END_OF_TIME;

import com.google.common.base.Optional;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import com.googlecode.objectify.Key;
import com.googlecode.objectify.Ref;
import com.googlecode.objectify.annotation.Entity;
import com.googlecode.objectify.annotation.Id;
import com.googlecode.objectify.annotation.IgnoreSave;
import com.googlecode.objectify.annotation.Index;
import com.googlecode.objectify.annotation.OnLoad;
import com.googlecode.objectify.annotation.Parent;
import com.googlecode.objectify.condition.IfNull;
import google.registry.model.Buildable;
import google.registry.model.ImmutableObject;
import google.registry.model.common.TimeOfYear;
import google.registry.model.domain.GracePeriod;
import google.registry.model.domain.rgp.GracePeriodStatus;
import google.registry.model.reporting.HistoryEntry;
import google.registry.model.transfer.TransferData.TransferServerApproveEntity;
import java.util.Objects;
import java.util.Set;
import org.joda.money.Money;
import org.joda.time.DateTime;

/** A billable event in a domain's lifecycle. */
public abstract class BillingEvent extends ImmutableObject
    implements Buildable, TransferServerApproveEntity {

  /** The reason for the bill. */
  public enum Reason {
    CREATE,
    TRANSFER,
    RENEW,
    // TODO(b/27777398): Drop Reason.AUTO_RENEW after migration to Flag.AUTO_RENEW.
    AUTO_RENEW,
    RESTORE,
    SERVER_STATUS,
    ERROR
  }

  /** Set of flags that can be applied to billing events. */
  public enum Flag {
    ALLOCATION,
    ANCHOR_TENANT,
    AUTO_RENEW,
    LANDRUSH,
    SUNRISE,
    /**
     * This flag will be added to any {@link OneTime} events that are created via, e.g., an
     * automated process to expand {@link Recurring} events.
     */
    SYNTHETIC
  }

  /** Entity id. */
  @Id
  long id;

  @Parent
  Key<HistoryEntry> parent;

  /** The registrar to bill. */
  @Index
  String clientId;

  /** When this event was created. For recurring events, this is also the recurrence start time. */
  @Index
  DateTime eventTime;

  /** The reason for the bill. */
  Reason reason;

  /** The fully qualified domain name of the domain that the bill is for. */
  String targetId;

  Set<Flag> flags;

  public String getClientId() {
    return clientId;
  }

  public DateTime getEventTime() {
    return eventTime;
  }

  public long getId() {
    return id;
  }

  public Reason getReason() {
    return reason;
  }

  public String getTargetId() {
    return targetId;
  }

  public Key<HistoryEntry> getParentKey() {
    return parent;
  }

  public ImmutableSet<Flag> getFlags() {
    return nullToEmptyImmutableCopy(flags);
  }

  /** Override Buildable.asBuilder() to give this method stronger typing. */
  @Override
  public abstract Builder<?, ?> asBuilder();

  /** An abstract builder for {@link BillingEvent}. */
  public abstract static class Builder<T extends BillingEvent, B extends Builder<?, ?>>
      extends GenericBuilder<T, B> {

    protected Builder() {}

    protected Builder(T instance) {
      super(instance);
    }

    public B setReason(Reason reason) {
      getInstance().reason = reason;
      return thisCastToDerived();
    }

    public B setId(Long id) {
      getInstance().id = id;
      return thisCastToDerived();
    }

    public B setClientId(String clientId) {
      getInstance().clientId = clientId;
      return thisCastToDerived();
    }

    public B setEventTime(DateTime eventTime) {
      getInstance().eventTime = eventTime;
      return thisCastToDerived();
    }

    public B setTargetId(String targetId) {
      getInstance().targetId = targetId;
      return thisCastToDerived();
    }

    public B setFlags(ImmutableSet<Flag> flags) {
      getInstance().flags = flags;
      return thisCastToDerived();
    }

    public B setParent(HistoryEntry parent) {
      getInstance().parent = Key.create(parent);
      return thisCastToDerived();
    }

    public B setParent(Key<HistoryEntry> parentKey) {
      getInstance().parent = parentKey;
      return thisCastToDerived();
    }

    @Override
    public T build() {
      T instance = getInstance();
      checkNotNull(instance.reason);
      checkNotNull(instance.clientId);
      checkNotNull(instance.eventTime);
      checkNotNull(instance.targetId);
      checkNotNull(instance.parent);
      return super.build();
    }
  }

  /** A one-time billable event. */
  @Entity
  public static class OneTime extends BillingEvent {

    /** The billable value. */
    Money cost;

    /** When the cost should be billed. */
    @Index
    DateTime billingTime;

    /**
     * The period in years of the action being billed for, if applicable, otherwise null.
     * Used for financial reporting.
     */
    @IgnoreSave(IfNull.class)
    Integer periodYears = null;

    /**
     * For {@link Flag#SYNTHETIC} events, when this event was persisted to datastore (i.e. the
     * cursor position at the time the recurrence expansion job was last run). In the event a job
     * needs to be undone, a query on this field will return the complete set of potentially bad
     * events.
     */
    @Index
    DateTime syntheticCreationTime;

    /**
     * For {@link Flag#SYNTHETIC} events, a {@link Key} to the {@link BillingEvent} from which this
     * OneTime was created. This is needed in order to properly match billing events against
     * {@link Cancellation}s.
     */
    Key<? extends BillingEvent> cancellationMatchingBillingEvent;

    public Money getCost() {
      return cost;
    }

    public DateTime getBillingTime() {
      return billingTime;
    }

    public Integer getPeriodYears() {
      return periodYears;
    }

    public DateTime getSyntheticCreationTime() {
      return syntheticCreationTime;
    }

    public Key<? extends BillingEvent> getCancellationMatchingBillingEvent() {
      return cancellationMatchingBillingEvent;
    }

    @Override
    public Builder asBuilder() {
      return new Builder(clone(this));
    }

    /** A builder for {@link OneTime} since it is immutable. */
    public static class Builder extends BillingEvent.Builder<OneTime, Builder> {

      public Builder() {}

      private Builder(OneTime instance) {
        super(instance);
      }

      public Builder setCost(Money cost) {
        getInstance().cost = cost;
        return this;
      }

      public Builder setPeriodYears(Integer periodYears) {
        checkNotNull(periodYears);
        checkArgument(periodYears > 0);
        getInstance().periodYears = periodYears;
        return this;
      }

      public Builder setBillingTime(DateTime billingTime) {
        getInstance().billingTime = billingTime;
        return this;
      }

      public Builder setSyntheticCreationTime(DateTime syntheticCreationTime) {
        getInstance().syntheticCreationTime = syntheticCreationTime;
        return this;
      }

      public Builder setCancellationMatchingBillingEvent(
          Key<? extends BillingEvent> cancellationMatchingBillingEvent) {
        getInstance().cancellationMatchingBillingEvent = cancellationMatchingBillingEvent;
        return this;
      }

      @Override
      public OneTime build() {
        OneTime instance = getInstance();
        checkNotNull(instance.billingTime);
        checkNotNull(instance.cost);
        checkState(!instance.cost.isNegative(), "Costs should be non-negative.");
        ImmutableSet<Reason> reasonsWithPeriods =
            Sets.immutableEnumSet(Reason.CREATE, Reason.RENEW, Reason.TRANSFER);
        checkState(
            reasonsWithPeriods.contains(instance.reason) == (instance.periodYears != null),
            "Period years must be set if and only if reason is CREATE, RENEW, or TRANSFER.");
        checkState(
            instance.getFlags().contains(Flag.SYNTHETIC)
                == (instance.syntheticCreationTime != null),
            "Synthetic creation time must be set if and only if the SYNTHETIC flag is set.");
        checkState(
            instance.getFlags().contains(Flag.SYNTHETIC)
                == (instance.cancellationMatchingBillingEvent != null),
            "Cancellation matching billing event must be set if and only if the SYNTHETIC flag "
                + "is set.");
        return super.build();
      }
    }
  }

  /**
   * A recurring billable event.
   *
   * <p>Unlike {@link OneTime} events, these do not store an explicit cost, since the cost of the
   * recurring event might change and each time we bill for it we need to bill at the current cost,
   * not the value that was in use at the time the recurrence was created.
   */
  @Entity
  public static class Recurring extends BillingEvent {

    // TODO(b/27777398): Remove after migration is complete and Reason.AUTO_RENEW is removed.
    @OnLoad
    void setAutorenewFlag() {
      if (Reason.AUTO_RENEW.equals(reason)) {
        reason = Reason.RENEW;
        flags = union(getFlags(), Flag.AUTO_RENEW);
      }
    }

    /**
     * The billing event recurs every year between {@link #eventTime} and this time on the
     * [month, day, time] specified in {@link #recurrenceTimeOfYear}.
     */
    @Index
    DateTime recurrenceEndTime;

    /**
     * The eventTime recurs every year on this [month, day, time] between {@link #eventTime} and
     * {@link #recurrenceEndTime}, inclusive of the start but not of the end.
     *
     * <p>This field is denormalized from {@link #eventTime} to allow for an efficient index, but it
     * always has the same data as that field.
     *
     * <p>Note that this is a recurrence of the event time, not the billing time. The billing time
     * can be calculated by adding the relevant grace period length to this date. The reason for
     * this requirement is that the event time recurs on a {@link org.joda.time.Period} schedule
     * (same day of year, which can be 365 or 366 days later) which is what {@link TimeOfYear} can
     * model, whereas the billing time is a fixed {@link org.joda.time.Duration} later.
     */
    @Index
    TimeOfYear recurrenceTimeOfYear;

    public DateTime getRecurrenceEndTime() {
      return recurrenceEndTime;
    }

    public TimeOfYear getRecurrenceTimeOfYear() {
      return recurrenceTimeOfYear;
    }

    @Override
    public Builder asBuilder() {
      return new Builder(clone(this));
    }

    /** A builder for {@link Recurring} since it is immutable. */
    public static class Builder extends BillingEvent.Builder<Recurring, Builder> {

      public Builder() {}

      private Builder(Recurring instance) {
        super(instance);
      }

      public Builder setRecurrenceEndTime(DateTime recurrenceEndTime) {
        getInstance().recurrenceEndTime = recurrenceEndTime;
        return this;
      }

      @Override
      public Recurring build() {
        Recurring instance = getInstance();
        checkNotNull(instance.eventTime);
        checkNotNull(instance.reason);
        instance.recurrenceTimeOfYear = TimeOfYear.fromDateTime(instance.eventTime);
        instance.recurrenceEndTime =
            Optional.fromNullable(instance.recurrenceEndTime).or(END_OF_TIME);
        return super.build();
      }
    }
  }

  /**
   * An event representing a cancellation of one of the other two billable event types.
   *
   * <p>This is implemented as a separate event rather than a bit on BillingEvent in order to
   * preserve the immutability of billing events.
   */
  @Entity
  public static class Cancellation extends BillingEvent {

    /** The billing time of the charge that is being cancelled. */
    @Index
    DateTime billingTime;

    /** The one-time billing event to cancel, or null for autorenew cancellations. */
    @IgnoreSave(IfNull.class)
    Ref<BillingEvent.OneTime> refOneTime = null;

    /** The recurring billing event to cancel, or null for non-autorenew cancellations. */
    @IgnoreSave(IfNull.class)
    Ref<BillingEvent.Recurring> refRecurring = null;

    public DateTime getBillingTime() {
      return billingTime;
    }

    public Ref<? extends BillingEvent> getEventRef() {
      return firstNonNull(refOneTime, refRecurring);
    }

    /** The mapping from billable grace period types to originating billing event reasons. */
    static final ImmutableMap<GracePeriodStatus, Reason> GRACE_PERIOD_TO_REASON =
        ImmutableMap.of(
            GracePeriodStatus.ADD, Reason.CREATE,
            GracePeriodStatus.AUTO_RENEW, Reason.RENEW,
            GracePeriodStatus.RENEW, Reason.RENEW,
            GracePeriodStatus.TRANSFER, Reason.TRANSFER);

    /**
     * Creates a cancellation billing event (parented on the provided history entry, and with the
     * history entry's event time) that will cancel out the provided grace period's billing event,
     * using the supplied targetId and deriving other metadata (clientId, billing time, and the
     * cancellation reason) from the grace period.
     */
    public static BillingEvent.Cancellation forGracePeriod(
        GracePeriod gracePeriod, HistoryEntry historyEntry, String targetId) {
      checkArgument(gracePeriod.hasBillingEvent(),
          "Cannot create cancellation for grace period without billing event");
      BillingEvent.Cancellation.Builder builder = new BillingEvent.Cancellation.Builder()
          .setReason(checkNotNull(GRACE_PERIOD_TO_REASON.get(gracePeriod.getType())))
          .setTargetId(targetId)
          .setClientId(gracePeriod.getClientId())
          .setEventTime(historyEntry.getModificationTime())
          // The charge being cancelled will take place at the grace period's expiration time.
          .setBillingTime(gracePeriod.getExpirationTime())
          .setParent(historyEntry);
      // Set the grace period's billing event using the appropriate Cancellation builder method.
      if (gracePeriod.getOneTimeBillingEvent() != null) {
        builder.setOneTimeEventRef(gracePeriod.getOneTimeBillingEvent());
      } else if (gracePeriod.getRecurringBillingEvent() != null) {
        builder.setRecurringEventRef(gracePeriod.getRecurringBillingEvent());
      }
      return builder.build();
    }

    @Override
    public Builder asBuilder() {
      return new Builder(clone(this));
    }

    /** A builder for {@link Cancellation} since it is immutable. */
    public static class Builder extends BillingEvent.Builder<Cancellation, Builder> {

      public Builder() {}

      private Builder(Cancellation instance) {
        super(instance);
      }

      public Builder setBillingTime(DateTime billingTime) {
        getInstance().billingTime = billingTime;
        return this;
      }

      public Builder setOneTimeEventRef(Ref<BillingEvent.OneTime> eventRef) {
        getInstance().refOneTime = eventRef;
        return this;
      }

      public Builder setRecurringEventRef(Ref<BillingEvent.Recurring> eventRef) {
        getInstance().refRecurring = eventRef;
        return this;
      }

      @Override
      public Cancellation build() {
        Cancellation instance = getInstance();
        checkNotNull(instance.billingTime);
        checkNotNull(instance.reason);
        checkState((instance.refOneTime == null) != (instance.refRecurring == null),
            "Cancellations must have exactly one billing event ref set");
        return super.build();
      }
    }
  }

  /**
   * An event representing a modification of an existing one-time billing event.
   */
  @Entity
  public static class Modification extends BillingEvent {

    /** The change in cost that should be applied to the original billing event. */
    Money cost;

    /** The one-time billing event to modify. */
    Ref<BillingEvent.OneTime> eventRef;

    /**
     * Description of the modification (and presumably why it was issued). This text may appear as a
     * line item on an invoice or report about such modifications.
     */
    String description;

    public Money getCost() {
      return cost;
    }

    public Ref<BillingEvent.OneTime> getEventRef() {
      return eventRef;
    }

    public String getDescription() {
      return description;
    }

    @Override
    public Builder asBuilder() {
      return new Builder(clone(this));
    }

    /**
     * Create a new Modification billing event which is a refund of the given OneTime billing event
     * and that is parented off the given HistoryEntry.
     *
     * <p>Note that this method may appear to be unused most of the time, but it is kept around
     * because it is needed by one-off scrap tools that need to make billing adjustments.
     */
    public static Modification createRefundFor(
        OneTime billingEvent, HistoryEntry historyEntry, String description) {
      return new Builder()
          .setClientId(billingEvent.getClientId())
          .setFlags(billingEvent.getFlags())
          .setReason(billingEvent.getReason())
          .setTargetId(billingEvent.getTargetId())
          .setEventRef(Ref.create(billingEvent))
          .setEventTime(historyEntry.getModificationTime())
          .setDescription(description)
          .setCost(billingEvent.getCost().negated())
          .setParent(historyEntry)
          .build();
    }

    /** A builder for {@link Modification} since it is immutable. */
    public static class Builder extends BillingEvent.Builder<Modification, Builder> {

      public Builder() {}

      private Builder(Modification instance) {
        super(instance);
      }

      public Builder setCost(Money cost) {
        getInstance().cost = cost;
        return this;
      }

      public Builder setEventRef(Ref<BillingEvent.OneTime> eventRef) {
        getInstance().eventRef = eventRef;
        return this;
      }

      public Builder setDescription(String description) {
        getInstance().description = description;
        return this;
      }

      @Override
      @SuppressWarnings("unchecked")
      public Modification build() {
        Modification instance = getInstance();
        checkNotNull(instance.reason);
        checkNotNull(instance.eventRef);
        BillingEvent.OneTime billingEvent = instance.eventRef.get();
        checkArgument(Objects.equals(
            instance.cost.getCurrencyUnit(),
            billingEvent.cost.getCurrencyUnit()),
            "Referenced billing event is in a different currency");
        return super.build();
      }
    }
  }
}