Helper cache

system/Common.php

@@ -636,6 +636,8 @@ function function_usable(string $functionName): bool
 	 */
 	function helper($filenames)
 	{
+		static $loaded = [];
+
 		$loader = Services::locator(true);
 
 		if (! is_array($filenames))
@@ -659,6 +661,12 @@ function helper($filenames)
 				$filename .= '_helper';
 			}
 
+			// Check if this helper has already been loaded
+			if (in_array($filename, $loaded))
+			{
+				continue;
+			}
+
 			// If the file is namespaced, we'll just grab that
 			// file and not search for any others
 			if (strpos($filename, '\\') !== false)
@@ -671,6 +679,7 @@ function helper($filenames)
 				}
 
 				$includes[] = $path;
+				$loaded[]   = $filename;
 			}
 
 			// No namespaces, so search in all available locations
@@ -695,6 +704,7 @@ function helper($filenames)
 						else
 						{
 							$localIncludes[] = $path;
+							$loaded[]        = $filename;
 						}
 					}
 				}
@@ -704,6 +714,7 @@ function helper($filenames)
 				{
 					// @codeCoverageIgnoreStart
 					$includes[] = $appHelper;
+					$loaded[]   = $filename;
 					// @codeCoverageIgnoreEnd
 				}
 
@@ -714,6 +725,7 @@ function helper($filenames)
 				if (! empty($systemHelper))
 				{
 					$includes[] = $systemHelper;
+					$loaded[]   = $filename;
 				}
 			}
 		}

system/Config/BaseService.php

@@ -171,7 +171,7 @@ public static function locator(bool $getShared = true)
 				static::$instances['locator'] = new FileLocator(static::autoloader());
 			}
 
-			return static::$instances['locator'];
+			return static::$mocks['locator'] ?? static::$instances['locator'];
 		}
 
 		return new FileLocator(static::autoloader());

tests/_support/Autoloader/FatalLocator.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace Tests\Support\Autoloader;
+
+use CodeIgniter\Autoloader\FileLocator;
+use RuntimeException;
+
+/**
+ * Class FatalLocator
+ *
+ * A locator replacement designed to throw
+ * exceptions when used to indicate when
+ * a lookup actually happens.
+ */
+class FatalLocator extends FileLocator
+{
+
+	/**
+	 * Throws.
+	 *
+	 * @param string $file   The namespaced file to locate
+	 * @param string $folder The folder within the namespace that we should look for the file.
+	 * @param string $ext    The file extension the file should have.
+	 *
+	 * @return string|false The path to the file, or false if not found.
+	 */
+	public function locateFile(string $file, string $folder = null, string $ext = 'php')
+	{
+		$folder = $folder ?? 'null';
+		throw new RuntimeException("locateFile({$file}, {$folder}, {$ext})");
+	}
+
+	//--------------------------------------------------------------------
+
+	/**
+	 * Searches through all of the defined namespaces looking for a file.
+	 * Returns an array of all found locations for the defined file.
+	 *
+	 * Example:
+	 *
+	 *  $locator->search('Config/Routes.php');
+	 *  // Assuming PSR4 namespaces include foo and bar, might return:
+	 *  [
+	 *      'app/Modules/foo/Config/Routes.php',
+	 *      'app/Modules/bar/Config/Routes.php',
+	 *  ]
+	 *
+	 * @param string  $path
+	 * @param string  $ext
+	 * @param boolean $prioritizeApp
+	 *
+	 * @return array
+	 */
+	public function search(string $path, string $ext = 'php', bool $prioritizeApp = true): array
+	{
+		$prioritizeApp = $prioritizeApp ? 'true' : 'false';
+		throw new RuntimeException("search({$path}, {$ext}, {$prioritizeApp})");
+	}
+}

tests/_support/Helpers/baguette_helper.php

@@ -0,0 +1,2 @@
+<?php
+// You did it!

tests/system/CommonFunctionsTest.php

@@ -12,6 +12,7 @@
 use CodeIgniter\Test\TestLogger;
 use Config\App;
 use Config\Logger;
+use Tests\Support\Autoloader\FatalLocator;
 use Tests\Support\Models\JobModel;
 
 /**
@@ -507,4 +508,49 @@ public function dirtyPathsProvider()
 			],
 		];
 	}
+
+	//--------------------------------------------------------------------
+
+	public function testHelperWithFatalLocatorThrowsException()
+	{
+		// Replace the locator with one that will fail if it is called
+		$locator = new FatalLocator(Services::autoloader());
+		Services::injectMock('locator', $locator);
+
+		try
+		{
+			helper('baguette');
+			$exception = false;
+		}
+		catch (\RuntimeException $e)
+		{
+			$exception = true;
+		}
+
+		$this->assertTrue($exception);
+		Services::reset();
+	}
+
+	public function testHelperLoadsOnce()
+	{
+		// Load it the first time
+		helper('baguette');
+
+		// Replace the locator with one that will fail if it is called
+		$locator = new FatalLocator(Services::autoloader());
+		Services::injectMock('locator', $locator);
+
+		try
+		{
+			helper('baguette');
+			$exception = false;
+		}
+		catch (\RuntimeException $e)
+		{
+			$exception = true;
+		}
+
+		$this->assertFalse($exception);
+		Services::reset();
+	}
 }