Separate core and contrib api.php file scanning (#774)

* Add new parameters - checkCoreDeprecatedHooksInApiFiles: bool, checkContribDeprecatedHooksInApiFiles: bool

* Deprecate checkDeprecatedHooksInApiFiles and make sure defaults of new parameters are set based on old one

* Code now checks if a module is a core module to decide if it will load the api.php files.

* Add new options to extentions.neon

* Set core api.php check to true by default in bleedingEdge.neon

* revert default true to check core api.php files as per original design

* Update bleedingEdge.neon to enable all features

* Update bleedingEdge.neon so you don't get deprecation warnings when using the defaults.

* Check extension origin

---------

Co-authored-by: Matt Glaman <[email protected]>

Author: bbrala

bleedingEdge.neon

@@ -1,7 +1,9 @@
 parameters:
 	drupal:
 		bleedingEdge:
-			checkDeprecatedHooksInApiFiles: true
+			checkDeprecatedHooksInApiFiles: false
+			checkCoreDeprecatedHooksInApiFiles: true
+			checkContribDeprecatedHooksInApiFiles: true
 		rules:
 			testClassSuffixNameRule: true
 			dependencySerializationTraitPropertyRule: true

extension.neon

@@ -19,6 +19,8 @@ parameters:
 		drupal_root: '%currentWorkingDirectory%'
 		bleedingEdge:
 			checkDeprecatedHooksInApiFiles: false
+			checkCoreDeprecatedHooksInApiFiles: false
+			checkContribDeprecatedHooksInApiFiles: false
 		rules:
 			testClassSuffixNameRule: false
 			dependencySerializationTraitPropertyRule: false
@@ -242,6 +244,8 @@ parametersSchema:
 		drupal_root: string()
 		bleedingEdge: structure([
 			checkDeprecatedHooksInApiFiles: boolean()
+			checkCoreDeprecatedHooksInApiFiles: boolean()
+			checkContribDeprecatedHooksInApiFiles: boolean()
 		])
 		rules: structure([
 			testClassSuffixNameRule: boolean()

src/Drupal/DrupalAutoloader.php

@@ -84,7 +84,7 @@ class DrupalAutoloader
     public function register(Container $container): void
     {
         /**
-         * @var array{drupal_root: string, bleedingEdge: array{checkDeprecatedHooksInApiFiles: bool}} $drupalParams
+         * @var array{drupal_root: string, bleedingEdge: array{checkDeprecatedHooksInApiFiles: bool, checkCoreDeprecatedHooksInApiFiles: bool, checkContribDeprecatedHooksInApiFiles: bool}} $drupalParams
          */
         $drupalParams = $container->getParameter('drupal');
         $drupalRoot = realpath($drupalParams['drupal_root']);
@@ -127,7 +127,14 @@ public function register(Container $container): void
         $this->addThemeNamespaces();
         $this->registerPs4Namespaces($this->namespaces);
         $this->loadLegacyIncludes();
-        $checkDeprecatedHooksInApiFiles =  $drupalParams['bleedingEdge']['checkDeprecatedHooksInApiFiles'];
+
+        // Trigger deprecation error if checkDeprecatedHooksInApiFiles is enabled.
+        if ($drupalParams['bleedingEdge']['checkDeprecatedHooksInApiFiles']) {
+            trigger_error('The bleedingEdge.checkDeprecatedHooksInApiFiles parameter is deprecated and will be removed in a future release.', E_USER_DEPRECATED);
+        }
+        $checkDeprecatedHooksInApiFiles = $drupalParams['bleedingEdge']['checkDeprecatedHooksInApiFiles'];
+        $checkCoreDeprecatedHooksInApiFiles = $drupalParams['bleedingEdge']['checkCoreDeprecatedHooksInApiFiles'] || $checkDeprecatedHooksInApiFiles;
+        $checkContribDeprecatedHooksInApiFiles = $drupalParams['bleedingEdge']['checkContribDeprecatedHooksInApiFiles'] || $checkDeprecatedHooksInApiFiles;
 
         foreach ($this->moduleData as $extension) {
             $this->loadExtension($extension);
@@ -145,8 +152,13 @@ public function register(Container $container): void
             if (file_exists($module_dir . '/' . $module_name . '.post_update.php')) {
                 $this->loadAndCatchErrors($module_dir . '/' . $module_name . '.post_update.php');
             }
-            // Add .api.php
-            if ($checkDeprecatedHooksInApiFiles && file_exists($module_dir . '/' . $module_name . '.api.php')) {
+
+            // Add .api.php for core modules
+            if ($checkCoreDeprecatedHooksInApiFiles && $extension->origin === 'core' && file_exists($module_dir . '/' . $module_name . '.api.php')) {
+                $this->loadAndCatchErrors($module_dir . '/' . $module_name . '.api.php');
+            }
+            // Add .api.php for contrib modules
+            if ($checkContribDeprecatedHooksInApiFiles && $extension->origin !== 'core' && file_exists($module_dir . '/' . $module_name . '.api.php')) {
                 $this->loadAndCatchErrors($module_dir . '/' . $module_name . '.api.php');
             }
             // Add misc .inc that are magically allowed via hook_hook_info.