From 315f645fce911e89d8b5481d32ea56c8aa1d2a77 Mon Sep 17 00:00:00 2001
From: Alex Finnarn <alex.finnarn@gmail.com>
Date: Thu, 21 Dec 2023 13:25:25 -0500
Subject: [PATCH 1/5] convert hook to event subscriber

---
 composer.json                                 |  4 +-
 .../js/json-schemas-table-filter.js           | 27 ++++----
 .../EventSubscriber/AddJsEventSubscriber.php  | 63 +++++++++++++++++++
 .../custom/va_gov_api/va_gov_api.module       | 18 ------
 .../custom/va_gov_api/va_gov_api.services.yml |  6 ++
 5 files changed, 84 insertions(+), 34 deletions(-)
 create mode 100644 docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
 delete mode 100644 docroot/modules/custom/va_gov_api/va_gov_api.module

diff --git a/composer.json b/composer.json
index 124eba3b14..3fa2887e10 100644
--- a/composer.json
+++ b/composer.json
@@ -227,7 +227,9 @@
         "webmozart/path-util": "^2.3",
         "webonyx/graphql-php": "^14.11",
         "weitzman/drupal-test-traits": "^2.0.1",
-        "zaporylie/composer-drupal-optimizations": "^1.2"
+        "zaporylie/composer-drupal-optimizations": "^1.2",
+        "ext-dom": "*",
+        "ext-libxml": "*"
     },
     "autoload": {
         "psr-4": {
diff --git a/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js b/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js
index 8086755b3b..995f4d6905 100644
--- a/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js
+++ b/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js
@@ -1,21 +1,18 @@
 /**
  * Attach a behavior to filter out unwanted schemas for OpenAPI UI viewing.
  */
-(function ($, Drupal, drupalSettings) {
-  Drupal.behaviors.vaGovJsonSchemasTableFilter = {
-    attach: function (context, settings) {
-      // Get all the rows in the table body.
-      const rows = document.querySelectorAll('#block-vagovclaro-content table tbody tr');
+document.addEventListener('DOMContentLoaded', function () {
+  // Get all the rows in the table body.
+  const rows = document.querySelectorAll('#block-vagovclaro-content table tbody tr');
 
-      rows.forEach(function(row) {
-        // Get the first cell (td) of the row, which contains the schema label.
-        const firstCell = row.cells[0];
+  rows.forEach(function (row) {
+    // Get the first cell (td) of the row, which contains the schema label.
+    const schemaLabel = row.cells[0];
 
-        // Remove all but 'VA.gov JSON:API'.
-        if (firstCell.textContent.trim() !== 'VA.gov JSON:API') {
-          row.remove();
-        }
-      });
+    // Remove all but 'VA.gov JSON:API'.
+    if (schemaLabel.textContent.trim() !== 'VA.gov JSON:API') {
+      row.remove();
     }
-  }
-})(jQuery, Drupal, drupalSettings);
+  });
+});
+
diff --git a/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php b/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
new file mode 100644
index 0000000000..7141dc79b7
--- /dev/null
+++ b/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
@@ -0,0 +1,63 @@
+<?php
+
+namespace Drupal\va_gov_api\EventSubscriber;
+
+use Drupal\Core\Extension\ModuleHandlerInterface;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * Add JS to the OpenAPI UI selector page so only one schema is displayed.
+ */
+class AddJsEventSubscriber implements EventSubscriberInterface {
+
+  private ModuleHandlerInterface $moduleHandler;
+
+  public function __construct(ModuleHandlerInterface $moduleHandler) {
+    $this->moduleHandler = $moduleHandler;
+  }
+
+  public static function getSubscribedEvents(): array {
+    return [
+      KernelEvents::RESPONSE => ['onResponse'],
+    ];
+  }
+
+  /**
+   * Modify response to add JS script.
+   *
+   * @throws \DOMException
+   */
+  public function onResponse(ResponseEvent $event): void {
+    // Only run this code on the OpenAPI UI selector page.
+    $request = $event->getRequest();
+    $path = $request->getPathInfo();
+    if ($event->getRequestType() == HttpKernelInterface::MAIN_REQUEST && $path === '/admin/config/services/openapi') {
+
+      $script = file_get_contents(
+        DRUPAL_ROOT . '/'
+        . $this->moduleHandler->getModule('va_gov_api')->getPath()
+        . '/js/json-schemas-table-filter.js');
+
+      // Create a DOMDocument object and load the response content into it.
+      $responseContent = $event->getResponse()->getContent();
+      $dom = new \DOMDocument();
+      // Need to suppress errors due to <nav> tags.
+      libxml_use_internal_errors(true);
+      $dom->loadHTML($responseContent);
+      libxml_clear_errors();
+
+      // Add the script to the DOMDocument object before the closing body tag.
+      $dom->getElementsByTagName('body')
+        ->item(0)
+        ->appendChild($dom->createElement('script', $script));
+
+      // Save the DOMDocument object back into the response content.
+      $responseContent = $dom->saveHTML();
+      $event->getResponse()->setContent($responseContent);
+    }
+  }
+
+}
diff --git a/docroot/modules/custom/va_gov_api/va_gov_api.module b/docroot/modules/custom/va_gov_api/va_gov_api.module
deleted file mode 100644
index 3251458992..0000000000
--- a/docroot/modules/custom/va_gov_api/va_gov_api.module
+++ /dev/null
@@ -1,18 +0,0 @@
-<?php
-
-/**
- * @file
- * Hooks used by the va_gov_api module.
- */
-
-/**
- * Implements hook_page_attachments().
- *
- * Limit the UI options for OpenAPI documentation.
- */
-function va_gov_api_page_attachments(array &$attachments): void {
-  $current_path = \Drupal::service('path.current')->getPath();
-  if ($current_path == '/admin/config/services/openapi') {
-    $attachments['#attached']['library'][] = 'va_gov_api/json_schemas_table_filter';
-  }
-}
diff --git a/docroot/modules/custom/va_gov_api/va_gov_api.services.yml b/docroot/modules/custom/va_gov_api/va_gov_api.services.yml
index bbdadb0350..5943bf429b 100644
--- a/docroot/modules/custom/va_gov_api/va_gov_api.services.yml
+++ b/docroot/modules/custom/va_gov_api/va_gov_api.services.yml
@@ -1,3 +1,9 @@
 # Increases the # of items in the response for any given jsonapi request.
 parameters:
   next_jsonapi.size_max: 2000
+services:
+  va_gov_api.add_js_to_ui:
+      class: Drupal\va_gov_api\EventSubscriber\AddJsEventSubscriber
+      arguments: ['@module_handler']
+      tags:
+      - { name: event_subscriber }

From 1c71a17e21734081020c356347da517362f5a63b Mon Sep 17 00:00:00 2001
From: Alex Finnarn <alex.finnarn@gmail.com>
Date: Thu, 21 Dec 2023 13:25:55 -0500
Subject: [PATCH 2/5] correct doc block

---
 .../src/EventSubscriber/AddJsEventSubscriber.php      | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php b/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
index 7141dc79b7..5bfbcfa16e 100644
--- a/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
+++ b/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
@@ -13,12 +13,21 @@
  */
 class AddJsEventSubscriber implements EventSubscriberInterface {
 
+  /**
+   * The module handler.
+   */
   private ModuleHandlerInterface $moduleHandler;
 
+  /**
+   * Constructor.
+   */
   public function __construct(ModuleHandlerInterface $moduleHandler) {
     $this->moduleHandler = $moduleHandler;
   }
 
+  /**
+   * {@inheritdoc}
+   */
   public static function getSubscribedEvents(): array {
     return [
       KernelEvents::RESPONSE => ['onResponse'],
@@ -45,7 +54,7 @@ public function onResponse(ResponseEvent $event): void {
       $responseContent = $event->getResponse()->getContent();
       $dom = new \DOMDocument();
       // Need to suppress errors due to <nav> tags.
-      libxml_use_internal_errors(true);
+      libxml_use_internal_errors(TRUE);
       $dom->loadHTML($responseContent);
       libxml_clear_errors();
 

From 8c963854b66b42deca89ab3a3a237302fc89c7b3 Mon Sep 17 00:00:00 2001
From: Alex Finnarn <alex.finnarn@gmail.com>
Date: Thu, 21 Dec 2023 13:34:50 -0500
Subject: [PATCH 3/5] remove libraries definition

---
 .../modules/custom/va_gov_api/va_gov_api.libraries.yml    | 8 --------
 1 file changed, 8 deletions(-)
 delete mode 100644 docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml

diff --git a/docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml b/docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml
deleted file mode 100644
index 01402f7a12..0000000000
--- a/docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml
+++ /dev/null
@@ -1,8 +0,0 @@
-json_schemas_table_filter:
-  version: 1.x
-  js:
-    js/json-schemas-table-filter.js: {}
-  dependencies:
-    - core/jquery
-    - core/drupal
-    - core/drupalSettings

From a60b1207e6b1c8179f97337aaef02de9209983c8 Mon Sep 17 00:00:00 2001
From: Alex Finnarn <alex.finnarn@gmail.com>
Date: Fri, 22 Dec 2023 11:48:33 -0500
Subject: [PATCH 4/5] convert one event subscriber to another

---
 .../js/json-schemas-table-filter.js           | 26 ++++++----
 .../EventSubscriber/AddJsEventSubscriber.php  | 52 +++++--------------
 .../va_gov_api/va_gov_api.libraries.yml       |  8 +++
 .../custom/va_gov_api/va_gov_api.services.yml |  2 +-
 4 files changed, 37 insertions(+), 51 deletions(-)
 create mode 100644 docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml

diff --git a/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js b/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js
index 995f4d6905..c07b77a22f 100644
--- a/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js
+++ b/docroot/modules/custom/va_gov_api/js/json-schemas-table-filter.js
@@ -1,18 +1,22 @@
 /**
  * Attach a behavior to filter out unwanted schemas for OpenAPI UI viewing.
  */
-document.addEventListener('DOMContentLoaded', function () {
-  // Get all the rows in the table body.
-  const rows = document.querySelectorAll('#block-vagovclaro-content table tbody tr');
+(function ($, Drupal, drupalSettings) {
+  Drupal.behaviors.vaGovJsonSchemasTableFilter = {
+    attach: function (context, settings) {
+      // Get all the rows in the table body.
+      const rows = document.querySelectorAll('#block-vagovclaro-content table tbody tr');
 
-  rows.forEach(function (row) {
-    // Get the first cell (td) of the row, which contains the schema label.
-    const schemaLabel = row.cells[0];
+      rows.forEach(function(row) {
+        // Get the first cell (td) of the row, which contains the schema label.
+        const schemaLabel = row.cells[0];
 
-    // Remove all but 'VA.gov JSON:API'.
-    if (schemaLabel.textContent.trim() !== 'VA.gov JSON:API') {
-      row.remove();
+        // Remove all but 'VA.gov JSON:API'.
+        if (schemaLabel.textContent.trim() !== 'VA.gov JSON:API') {
+          row.remove();
+        }
+      });
     }
-  });
-});
+  }
+})(jQuery, Drupal, drupalSettings);
 
diff --git a/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php b/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
index 5bfbcfa16e..c19705d593 100644
--- a/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
+++ b/docroot/modules/custom/va_gov_api/src/EventSubscriber/AddJsEventSubscriber.php
@@ -2,11 +2,10 @@
 
 namespace Drupal\va_gov_api\EventSubscriber;
 
-use Drupal\Core\Extension\ModuleHandlerInterface;
+use Drupal\core_event_dispatcher\Event\Theme\PageAttachmentsEvent;
+use Drupal\core_event_dispatcher\PageHookEvents;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
-use Symfony\Component\HttpKernel\Event\ResponseEvent;
-use Symfony\Component\HttpKernel\HttpKernelInterface;
-use Symfony\Component\HttpKernel\KernelEvents;
+use Symfony\Component\HttpFoundation\RequestStack;
 
 /**
  * Add JS to the OpenAPI UI selector page so only one schema is displayed.
@@ -14,15 +13,15 @@
 class AddJsEventSubscriber implements EventSubscriberInterface {
 
   /**
-   * The module handler.
+   * The request.
    */
-  private ModuleHandlerInterface $moduleHandler;
+  protected RequestStack $requestStack;
 
   /**
    * Constructor.
    */
-  public function __construct(ModuleHandlerInterface $moduleHandler) {
-    $this->moduleHandler = $moduleHandler;
+  public function __construct(RequestStack $requestStack) {
+    $this->requestStack = $requestStack;
   }
 
   /**
@@ -30,42 +29,17 @@ public function __construct(ModuleHandlerInterface $moduleHandler) {
    */
   public static function getSubscribedEvents(): array {
     return [
-      KernelEvents::RESPONSE => ['onResponse'],
+      PageHookEvents::PAGE_ATTACHMENTS => ['onPageAttachments'],
     ];
   }
 
   /**
-   * Modify response to add JS script.
-   *
-   * @throws \DOMException
+   * Modify response to add JS script to a route.
    */
-  public function onResponse(ResponseEvent $event): void {
-    // Only run this code on the OpenAPI UI selector page.
-    $request = $event->getRequest();
-    $path = $request->getPathInfo();
-    if ($event->getRequestType() == HttpKernelInterface::MAIN_REQUEST && $path === '/admin/config/services/openapi') {
-
-      $script = file_get_contents(
-        DRUPAL_ROOT . '/'
-        . $this->moduleHandler->getModule('va_gov_api')->getPath()
-        . '/js/json-schemas-table-filter.js');
-
-      // Create a DOMDocument object and load the response content into it.
-      $responseContent = $event->getResponse()->getContent();
-      $dom = new \DOMDocument();
-      // Need to suppress errors due to <nav> tags.
-      libxml_use_internal_errors(TRUE);
-      $dom->loadHTML($responseContent);
-      libxml_clear_errors();
-
-      // Add the script to the DOMDocument object before the closing body tag.
-      $dom->getElementsByTagName('body')
-        ->item(0)
-        ->appendChild($dom->createElement('script', $script));
-
-      // Save the DOMDocument object back into the response content.
-      $responseContent = $dom->saveHTML();
-      $event->getResponse()->setContent($responseContent);
+  public function onPageAttachments(PageAttachmentsEvent $event): void {
+    if ($this->requestStack->getCurrentRequest()->get('_route') === 'openapi.downloads') {
+      $attachments = &$event->getAttachments();
+      $attachments['#attached']['library'][] = 'va_gov_api/json_schemas_table_filter';
     }
   }
 
diff --git a/docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml b/docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml
new file mode 100644
index 0000000000..01402f7a12
--- /dev/null
+++ b/docroot/modules/custom/va_gov_api/va_gov_api.libraries.yml
@@ -0,0 +1,8 @@
+json_schemas_table_filter:
+  version: 1.x
+  js:
+    js/json-schemas-table-filter.js: {}
+  dependencies:
+    - core/jquery
+    - core/drupal
+    - core/drupalSettings
diff --git a/docroot/modules/custom/va_gov_api/va_gov_api.services.yml b/docroot/modules/custom/va_gov_api/va_gov_api.services.yml
index 5943bf429b..5637378076 100644
--- a/docroot/modules/custom/va_gov_api/va_gov_api.services.yml
+++ b/docroot/modules/custom/va_gov_api/va_gov_api.services.yml
@@ -4,6 +4,6 @@ parameters:
 services:
   va_gov_api.add_js_to_ui:
       class: Drupal\va_gov_api\EventSubscriber\AddJsEventSubscriber
-      arguments: ['@module_handler']
+      arguments: ['@request_stack']
       tags:
       - { name: event_subscriber }

From 331c5d430c21b5d7481396790817bd95ed71fef4 Mon Sep 17 00:00:00 2001
From: Alex Finnarn <alex.finnarn@gmail.com>
Date: Fri, 22 Dec 2023 11:55:53 -0500
Subject: [PATCH 5/5] remove composer requirements no longer needed

---
 composer.json | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/composer.json b/composer.json
index 57613570f6..2f1b57cd95 100644
--- a/composer.json
+++ b/composer.json
@@ -227,9 +227,7 @@
         "webmozart/path-util": "^2.3",
         "webonyx/graphql-php": "^14.11",
         "weitzman/drupal-test-traits": "^2.0.1",
-        "zaporylie/composer-drupal-optimizations": "^1.2",
-        "ext-dom": "*",
-        "ext-libxml": "*"
+        "zaporylie/composer-drupal-optimizations": "^1.2"
     },
     "autoload": {
         "psr-4": {