Fix 587 - throw exception when change the email address using PUT /developers for ApigeeX (#598)

* Issue 587 - Throw exception when changing the email address using PUT /developers for ApigeeX

Author: shishir-intelli

apigee_edge.module

@@ -31,6 +31,7 @@ use Drupal\apigee_edge\Element\StatusPropertyElement;
 use Drupal\apigee_edge\Entity\ApiProduct;
 use Drupal\apigee_edge\Entity\AppInterface;
 use Drupal\apigee_edge\Entity\Developer;
+use Drupal\apigee_edge\Exception\DeveloperUpdateFailedException;
 use Drupal\apigee_edge\Exception\UserDeveloperConversionNoStorageFormatterFoundException;
 use Drupal\apigee_edge\Exception\UserDeveloperConversionUserFieldDoesNotExistException;
 use Drupal\apigee_edge\Form\DeveloperSettingsForm;
@@ -1371,6 +1372,14 @@ function apigee_edge_user_presave(UserInterface $account) {
           $logger->error("Unable to save @developer developer's developer id on user.", $context);
         }
       }
+      elseif ($previous->getEdgeErrorCode() === Developer::APIGEE_HYBRID_ERROR_CODE_DEVELOPER_EMAIL_MISMATCH) {
+        // Apigee X and Hybrid runtime v1.5.0 and v1.5.1 a call to change the developer's
+        // email address will not work so need to prevent user email update on
+        // Drupal as well.
+        // @see https://github.com/apigee/apigee-client-php/issues/153
+        // @see https://github.com/apigee/apigee-edge-drupal/issues/587
+        throw new DeveloperUpdateFailedException($account->getEmail(), "Developer @email profile cannot be updated. " . $previous->getMessage());
+      }
     }
     else {
       $context += Error::decodeException($exception);

src/Entity/Developer.php

@@ -65,6 +65,13 @@ class Developer extends EdgeEntityBase implements DeveloperInterface {
    */
   const APIGEE_EDGE_ERROR_CODE_DEVELOPER_DOES_NOT_EXISTS = 'developer.service.DeveloperDoesNotExist';
 
+  /**
+   * Resource name in the url doesnot match with the name in the request payload.
+   *
+   * @var string
+   */
+  const APIGEE_HYBRID_ERROR_CODE_DEVELOPER_EMAIL_MISMATCH = 'rest.interceptor.name_mismatch';
+
   /**
    * The decorated SDK entity.
    *

src/Exception/DeveloperUpdateFailedException.php

@@ -0,0 +1,64 @@
+<?php
+
+/**
+ * Copyright 2021 Google Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 2 as published by the
+ * Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+namespace Drupal\apigee_edge\Exception;
+
+use Apigee\Edge\Exception\ApiException;
+
+/**
+ * This exception is thrown when the developer profile update fails.
+ */
+final class DeveloperUpdateFailedException extends ApiException implements ApigeeEdgeExceptionInterface {
+
+  /**
+   * Email address of the developer.
+   *
+   * @var string
+   */
+  private $email;
+
+  /**
+   * DeveloperUpdateFailedException constructor.
+   *
+   * @param string $email
+   *   Developer email.
+   * @param string $message
+   *   Exception message.
+   * @param int $code
+   *   Error code.
+   * @param \Throwable|null $previous
+   *   Previous exception.
+   */
+  public function __construct(string $email, string $message = 'Developer @email profile update failed.', int $code = 0, \Throwable $previous = NULL) {
+    $this->email = $email;
+    $message = strtr($message, ['@email' => $email]);
+    parent::__construct($message, $code, $previous);
+  }
+
+  /**
+   * Email address of the developer.
+   *
+   * @return string
+   *   Email address.
+   */
+  public function getEmail(): string {
+    return $this->email;
+  }
+
+}