Fix 624 - updated the custom hook to use argument and fix minor issues (#629)

Author: shishir-intelli

apigee_edge.api.php

@@ -37,9 +37,12 @@ function hook_apigee_edge_app_listing_page_title_alter(\Drupal\Core\StringTransl
 }
 
 /**
- * Alters the user agent string.
+ * Extends the default user-agent information sent by the API client.
+ *
+ * @param array $user_agent_parts
+ *   The user agent string.
  */
-function hook_user_agent_string_alter() {
+function hook_apigee_edge_user_agent_string_alter(array &$user_agent_parts): void {
 }
 
 /**

apigee_edge.module

@@ -46,8 +46,6 @@ use Drupal\Core\Breadcrumb\Breadcrumb;
 use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
 use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Entity\EntityTypeInterface;
-use Drupal\Core\Extension\InfoParser;
-use Drupal\Core\Extension\InfoParserInterface;
 use Drupal\Core\Field\BaseFieldDefinition;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Link;
@@ -271,21 +269,6 @@ function apigee_edge_system_breadcrumb_alter(Breadcrumb &$breadcrumb, RouteMatch
   }
 }
 
-/**
- * Implements hook_apigee_edge_user_agent_string_alter().
- */
-function apigee_edge_user_agent_string_alter() {
-    $infoParser = new InfoParser();
-    $edge_module_info = $infoParser->parse(\Drupal::service('module_handler')->getModule('apigee_edge')->getPathname());
-
-    if (!isset($edge_module_info['version'])) {
-      $edge_module_info['version'] = '2.x-dev';
-    }
-    $edge_module_info = $edge_module_info['name'] . '/' . $edge_module_info['version'];
-
-    return $edge_module_info;
-}
-
 /**
  * Implements hook_entity_base_field_info().
  */

src/SDKConnector.php

@@ -250,10 +250,19 @@ private function buildCredentials(KeyInterface $key): CredentialsInterface {
    */
   protected function userAgentPrefix(): string {
     if (NULL === self::$userAgentPrefix) {
-      $userAgent = \Drupal::moduleHandler()->invokeAll('user_agent_string_alter');
-      $userAgent = implode('; ', $userAgent);
+      // apigee_edge module info.
+      $edge_module_info = $this->infoParser->parse($this->moduleHandler->getModule('apigee_edge')->getPathname());
+      if (!isset($edge_module_info['version'])) {
+        $edge_module_info['version'] = '2.x-dev';
+      }
+      $user_agent_parts[] = $edge_module_info['name'] . '/' . $edge_module_info['version'];
+      $user_agent_parts[] = 'Drupal/' . \Drupal::VERSION;
+
+      // Get info from other modules.
+      $userAgent = $this->moduleHandler->invokeAll('apigee_edge_user_agent_string_alter', [&$user_agent_parts]);
+      $userAgent = !empty($userAgent) ? implode('; ', $userAgent) : implode('; ', $user_agent_parts);
 
-      self::$userAgentPrefix = $userAgent . '; Drupal/' . \Drupal::VERSION;
+      self::$userAgentPrefix = $userAgent;
     }
 
     return self::$userAgentPrefix;

tests/src/Kernel/UserAgentTest.php

@@ -0,0 +1,88 @@
+<?php
+
+/*
+ * Copyright 2022 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\Tests\apigee_edge\Kernel;
+
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\Core\Extension\InfoParser;
+use Drupal\Core\Extension\InfoParserInterface;
+
+/**
+ * Apigee Useragent tests.
+ *
+ * @group apigee_edge
+ * @group apigee_edge_kernel
+ */
+class UserAgentTest extends KernelTestBase {
+
+  /**
+   * Apigee Edge module info.
+   *
+   * @var string
+   */
+  protected $edgeModuleInfo;
+
+  /**
+   * The info parser.
+   *
+   * @var \Drupal\Core\Extension\InfoParserInterface
+   */
+  protected $infoParser;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'file',
+    'system',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    // Install the apigee edge module.
+    \Drupal::service('module_installer')->install(['apigee_edge']);
+  }
+
+  /**
+   * Test the user agent data without monetization module.
+   *
+   * @throws \Exception
+   */
+  public function testUserAgentWithoutMonetization() {
+    // apigee_edge module info.
+    $infoParser = new InfoParser();
+    $this->edgeModuleInfo = $infoParser->parse(\Drupal::service('module_handler')->getModule('apigee_edge')->getPathname());
+    if (!isset($this->edgeModuleInfo['version'])) {
+      $this->edgeModuleInfo['version'] = '2.x-dev';
+    }
+
+    $user_agent_parts[] = $this->edgeModuleInfo['name'] . '/' . $this->edgeModuleInfo['version'];
+    $user_agent_parts[] = 'Drupal/' . \Drupal::VERSION;
+
+    \Drupal::moduleHandler()->invokeAll('apigee_edge_user_agent_string_alter', [&$user_agent_parts]);
+    $userAgentPrefix = implode('; ', $user_agent_parts);
+
+    $this->assertSame($userAgentPrefix, 'Apigee Edge/2.x-dev;' . ' Drupal/' . \Drupal::VERSION);
+  }
+
+}