google-nomulus/java/google/registry/flows/FlowRunner.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.flows;

import static google.registry.model.ofy.ObjectifyService.ofy;
import static google.registry.xml.XmlTransformer.prettyPrint;

import com.google.common.base.Strings;
import com.google.common.logging.FormattingLogger;
import google.registry.flows.FlowModule.ClientId;
import google.registry.flows.FlowModule.DryRun;
import google.registry.flows.FlowModule.InputXml;
import google.registry.flows.FlowModule.Superuser;
import google.registry.flows.FlowModule.Transactional;
import google.registry.flows.session.LoginFlow;
import google.registry.model.eppcommon.Trid;
import google.registry.model.eppoutput.EppOutput;
import google.registry.monitoring.whitebox.EppMetric;
import java.util.logging.Level;
import javax.inject.Inject;
import javax.inject.Provider;

/** Run a flow, either transactionally or not, with logging and retrying as needed. */
public class FlowRunner {

  /** Log format used by legacy ICANN reporting parsing - DO NOT CHANGE. */
  // TODO(b/20725722): remove this log format entirely once we've transitioned to using the
  //   JSON log line below instead, or change this one to be for human consumption only.
  private static final String COMMAND_LOG_FORMAT = "EPP Command" + Strings.repeat("\n\t%s", 7);

  private static final FormattingLogger logger = FormattingLogger.getLoggerForCallerClass();

  @Inject @ClientId String clientId;
  @Inject TransportCredentials credentials;
  @Inject EppRequestSource eppRequestSource;
  @Inject Provider<Flow> flowProvider;
  @Inject Class<? extends Flow> flowClass;
  @Inject @InputXml byte[] inputXmlBytes;
  @Inject @DryRun boolean isDryRun;
  @Inject @Superuser boolean isSuperuser;
  @Inject @Transactional boolean isTransactional;
  @Inject SessionMetadata sessionMetadata;
  @Inject Trid trid;
  @Inject FlowReporter flowReporter;
  @Inject FlowRunner() {}

  /** Runs the EPP flow, and records metrics on the given builder. */
  public EppOutput run(final EppMetric.Builder eppMetricBuilder) throws EppException {
    String prettyXml = prettyPrint(inputXmlBytes);
    // This log line is very fragile since it's used for ICANN reporting - DO NOT CHANGE.
    // New data to be logged should be added only to the JSON log statement below.
    // TODO(b/20725722): remove this log statement entirely once we've transitioned to using the
    //   log line below instead, or change this one to be for human consumption only.
    if (logger.isLoggable(Level.INFO)) {
      logger.infofmt(
          COMMAND_LOG_FORMAT,
          trid.getServerTransactionId(),
          clientId,
          sessionMetadata,
          prettyXml.replace("\n", "\n\t"),
          credentials,
          eppRequestSource,
          isDryRun ? "DRY_RUN" : "LIVE",
          isSuperuser ? "SUPERUSER" : "NORMAL");
    }
    // Record flow info to the GAE request logs for reporting purposes if it's not a dry run.
    if (!isDryRun) {
      flowReporter.recordToLogs();
    }
    eppMetricBuilder.setCommandNameFromFlow(flowClass.getSimpleName());
    if (!isTransactional) {
      eppMetricBuilder.incrementAttempts();
      EppOutput eppOutput = EppOutput.create(flowProvider.get().run());
      if (flowClass.equals(LoginFlow.class)) {
        // In LoginFlow, clientId isn't known until after the flow executes, so save it then.
        eppMetricBuilder.setClientId(sessionMetadata.getClientId());
      }
      return eppOutput;
    }
    try {
      return ofy()
          .transact(
              () -> {
                eppMetricBuilder.incrementAttempts();
                try {
                  EppOutput output = EppOutput.create(flowProvider.get().run());
                  if (isDryRun) {
                    throw new DryRunException(output);
                  }
                  return output;
                } catch (EppException e) {
                  throw new EppRuntimeException(e);
                }
              });
    } catch (DryRunException e) {
      return e.output;
    } catch (EppRuntimeException e) {
      throw e.getCause();
    }
  }

  /** Exception for canceling a transaction while capturing what the output would have been. */
  private static class DryRunException extends RuntimeException {
    final EppOutput output;

    DryRunException(EppOutput output) {
      this.output = output;
    }
  }

  /** Exception for explicitly propagating an EppException out of the transactional {@code Work}. */
  private static class EppRuntimeException extends RuntimeException {
    EppRuntimeException(EppException cause) {
      super(cause);
    }

    @Override
    public synchronized EppException getCause() {
      return (EppException) super.getCause();
    }
  }
}