cms_content_sync-3.0.x-dev/src/Exception/SyncException.php

<?php

namespace Drupal\cms_content_sync\Exception;

/**
 * Class SyncException, thrown if anything goes wrong during pull / push
 * of entities for Content Sync. Will be caught by the Flow
 * synchronization class, saved to the logs, presented to the user and returned
 * to Sync Core.
 */
class SyncException extends \Exception {
  /**
   * @var string CODE_ENTITY_API_FAILURE
   *             The entity API returned an unexpected error at some point, e.g. when
   *             saving an entity. More information is available at
   *             {@see SyncException::$parentException}.
   */
  public const CODE_ENTITY_API_FAILURE = 'ENTITY_API_FAILURE';

  /**
   * @var string CODE_UNEXPECTED_EXCEPTION
   *             Any unexpected exception was thrown during synchronization. The exception
   *             is available via {@see SyncException::$parentException}.
   */
  public const CODE_UNEXPECTED_EXCEPTION = 'UNEXPECTED_EXCEPTION';

  /**
   * @var string CODE_PUSH_REQUEST_FAILED
   *             The push request to the Sync Core backend failed. The request failure
   *             exception is available via {@see SyncException::$parentException}.
   */
  public const CODE_PUSH_REQUEST_FAILED = 'EXPORT_REQUEST_FAILED';

  /**
   * @var string CODE_INVALID_PULL_REQUEST
   *             The pull request from Sync Core was invalid.
   */
  public const CODE_INVALID_PULL_REQUEST = 'INVALID_REQUEST';

  /**
   * @var string CODE_INTERNAL_ERROR
   *             An internal error occurred while processing the request.
   */
  public const CODE_INTERNAL_ERROR = 'INTERNAL_ERROR';

  /**
   * @var string CODE_UPDATE_LOCK
   *             Another update is still running.
   */
  public const CODE_UPDATE_LOCK = 'CODE_UPDATE_LOCK';

  /**
   * @var float
   *             The timestamp of the error.
   */
  public $timestamp;

  /**
   * @var string
   *             The error code constant (see below)
   */
  public $errorCode;

  /**
   * @var \Exception
   *                 The parent exception that caused this exception, if any
   */
  public $parentException;

  /**
   * SyncException constructor.
   *
   * @param string $errorCode
   *   See SyncException::CODE_*.
   * @param \Exception $parentException
   *   {@see SyncException::$parentException}.
   * @param string $message
   *   Optional message to describe the error in more detail.
   */
  public function __construct($errorCode, ?\Exception $parentException = NULL, $message = NULL) {
    parent::__construct($message ? $message : $errorCode);

    $this->errorCode = $errorCode;
    $this->parentException = $parentException;
    $this->timestamp = microtime(TRUE);
  }

  /**
   * @param bool $nested
   *
   * @return null|\Exception
   */
  public function getRootException($nested = FALSE) {
    if ($this->parentException) {
      if ($this->parentException instanceof SyncException) {
        return $this->parentException->getRootException(TRUE);
      }

      return $this->parentException;
    }

    if ($nested) {
      return $this;
    }

    return NULL;
  }

  /**
   *
   */
  public function getSyncExceptionMessage() {
    $message = $this->parentException ? $this->parentException->getMessage() : ($this->errorCode == $this->getMessage() ? '' : $this->getMessage());

    if ($message) {
      return t('Internal error @code: @message', [
        '@code' => $this->errorCode,
        '@message' => $message,
      ])->render();
    }

    return t('Internal error @code', [
      '@code' => $this->errorCode,
    ])->render();
  }

  /**
   * Serialize the exception to print at the REST interfaces to the Sync Core.
   * This is only intended for use with *authorized* requests. Anonymouse
   * users must not see these messages.
   *
   * @return array
   */
  public function serialize() {
    $result = [
      'message' => 'SyncException: ' . $this->getSyncExceptionMessage(),
      'code' => $this->errorCode,
      'stack' => $this->getTraceAsString(),
      'timestamp' => round($this->timestamp * 1_000),
    ];

    if ($this->parentException) {
      if ($this->parentException instanceof SyncException) {
        $result['parent'] = $this->parentException->serialize();
      }
      else {
        $result['parent'] = [
          'message' => $this->parentException->getMessage(),
          'stack' => $this->parentException->getTraceAsString(),
        ];
      }
    }

    return $result;
  }

}