feat(core): support booting in phar (#1672)

Co-authored-by: Brent Roose <[email protected]>

Author: aazsamir

packages/console/src/Highlight/TempestConsoleLanguage/Injections/FileInjection.php

@@ -8,6 +8,7 @@
 use Tempest\Highlight\Injection;
 use Tempest\Highlight\ParsedInjection;
 use Tempest\Highlight\Themes\TerminalStyle;
+use Tempest\Support\Filesystem;
 
 use function Tempest\root_path;
 use function Tempest\Support\str;
@@ -21,9 +22,9 @@ public function parse(string $content, Highlighter $highlighter): ParsedInjectio
             pattern: '/(?<match>\<file=(?<quote>[\"\'])(?<file>.+)\k<quote>\s*\/?>)/',
             callback: function (array $matches) {
                 $href = $matches['file'];
-                $exists = realpath($href) !== false;
+                $exists = Filesystem\normalize_path($href) !== null;
                 $file = $exists
-                    ? str(realpath($href))->replace('\\', '/')->stripStart(root_path())->stripStart('/')
+                    ? str(Filesystem\normalize_path($href))->replace('\\', '/')->stripStart(root_path())->stripStart('/')
                     : $href;
 
                 return TerminalStyle::UNDERLINE((string) $file);

packages/core/src/Commands/DiscoveryStatusCommand.php

@@ -10,6 +10,7 @@
 use Tempest\Core\DiscoveryCache;
 use Tempest\Core\DiscoveryCacheStrategy;
 use Tempest\Core\Kernel;
+use Tempest\Support\Filesystem;
 
 use function Tempest\root_path;
 use function Tempest\Support\str;
@@ -62,7 +63,7 @@ public function __invoke(
                 $this->console->writeln();
 
                 foreach ($this->kernel->discoveryLocations as $discoveryLocation) {
-                    $path = str(realpath($discoveryLocation->path))
+                    $path = str(Filesystem\normalize_path($discoveryLocation->path))
                         ->replaceStart(root_path(), '.')
                         ->toString();
 

packages/core/src/DiscoveryConfig.php

@@ -2,6 +2,8 @@
 
 namespace Tempest\Core;
 
+use Tempest\Support\Filesystem;
+
 final class DiscoveryConfig
 {
     private array $skipDiscovery = [];
@@ -25,9 +27,9 @@ public function skipPaths(string ...$paths): self
         foreach ($paths as $path) {
             $path = str_replace(['\\', '/'], DIRECTORY_SEPARATOR, $path);
 
-            $realpath = realpath($path);
+            $realpath = Filesystem\normalize_path($path);
 
-            if ($realpath === false) {
+            if ($realpath === null) {
                 continue;
             }
 

packages/core/src/FrameworkKernel.php

@@ -18,6 +18,7 @@
 use Tempest\EventBus\EventBus;
 use Tempest\Process\GenericProcessExecutor;
 use Tempest\Router\Exceptions\HttpExceptionHandler;
+use Tempest\Support\Filesystem;
 
 final class FrameworkKernel implements Kernel
 {
@@ -34,14 +35,20 @@ public function __construct(
         /** @var \Tempest\Discovery\DiscoveryLocation[] $discoveryLocations */
         public array $discoveryLocations = [],
         ?Container $container = null,
+        ?string $internalStorage = null,
     ) {
         $this->container = $container ?? $this->createContainer();
+
+        if ($internalStorage !== null) {
+            $this->internalStorage = $internalStorage;
+        }
     }
 
     public static function boot(
         string $root,
         array $discoveryLocations = [],
         ?Container $container = null,
+        ?string $internalStorage = null,
     ): self {
         if (! defined('TEMPEST_START')) {
             define('TEMPEST_START', value: hrtime(true));
@@ -51,6 +58,7 @@ public static function boot(
             root: $root,
             discoveryLocations: $discoveryLocations,
             container: $container,
+            internalStorage: $internalStorage,
         )
             ->validateRoot()
             ->loadEnv()
@@ -68,7 +76,7 @@ public static function boot(
 
     public function validateRoot(): self
     {
-        $root = realpath($this->root);
+        $root = Filesystem\normalize_path($this->root);
 
         if (! is_dir($root)) {
             throw new RuntimeException('The specified root directory is not valid.');
@@ -175,7 +183,7 @@ public function loadConfig(): self
 
     public function registerInternalStorage(): self
     {
-        $path = $this->root . '/.tempest';
+        $path = isset($this->internalStorage) ? $this->internalStorage : $this->root . '/.tempest';
 
         if (! is_dir($path)) {
             if (file_exists($path)) {
@@ -189,7 +197,7 @@ public function registerInternalStorage(): self
             throw CouldNotRegisterInternalStorage::noPermission($path);
         }
 
-        $this->internalStorage = realpath($path);
+        $this->internalStorage = Filesystem\normalize_path($path);
 
         return $this;
     }

packages/core/src/Kernel/LoadConfig.php

@@ -8,6 +8,7 @@
 use Tempest\Core\ConfigCache;
 use Tempest\Core\Kernel;
 use Tempest\Support\Arr\MutableArray;
+use Tempest\Support\Filesystem;
 use Tempest\Support\Str;
 
 /** @internal */
@@ -85,10 +86,10 @@ public function find(): array
      */
     private function scan(string $path, MutableArray $configPaths): void
     {
-        $input = realpath($path);
+        $input = Filesystem\normalize_path($path);
 
         // Make sure the path is valid
-        if ($input === false) {
+        if ($input === null) {
             return;
         }
 

packages/core/src/Kernel/LoadDiscoveryClasses.php

@@ -16,6 +16,7 @@
 use Tempest\Discovery\DiscoveryLocation;
 use Tempest\Discovery\SkipDiscovery;
 use Tempest\Reflection\ClassReflector;
+use Tempest\Support\Filesystem;
 use Throwable;
 
 /** @internal */
@@ -105,10 +106,10 @@ private function discover(array $discoveries): void
      */
     private function scan(DiscoveryLocation $location, array $discoveries, string $path): void
     {
-        $input = realpath($path);
+        $input = Filesystem\normalize_path($path);
 
         // Make sure the path is valid
-        if ($input === false) {
+        if ($input === null) {
             return;
         }
 

packages/core/src/Tempest.php

@@ -12,13 +12,15 @@ public static function boot(
         ?string $root = null,
         /** @var \Tempest\Discovery\DiscoveryLocation[] $discoveryLocations */
         array $discoveryLocations = [],
+        ?string $internalStorage = null,
     ): Container {
         $root ??= getcwd();
 
         // Kernel
         return FrameworkKernel::boot(
             root: $root,
             discoveryLocations: $discoveryLocations,
+            internalStorage: $internalStorage,
         )->container;
     }
 }

packages/discovery/composer.json

@@ -5,7 +5,8 @@
     "minimum-stability": "dev",
     "require": {
         "php": "^8.4",
-        "tempest/reflection": "dev-main"
+        "tempest/reflection": "dev-main",
+        "tempest/support": "dev-main"
     },
     "autoload": {
         "psr-4": {

packages/discovery/src/DiscoveryLocation.php

@@ -4,6 +4,8 @@
 
 namespace Tempest\Discovery;
 
+use Tempest\Support\Filesystem;
+
 final class DiscoveryLocation
 {
     public readonly string $namespace;
@@ -18,7 +20,7 @@ public function __construct(
         string $path,
     ) {
         $this->namespace = $namespace;
-        $this->path = realpath(rtrim($path, '\\/'));
+        $this->path = Filesystem\normalize_path(rtrim($path, '\\/'));
     }
 
     public function isVendor(): bool

packages/support/src/Filesystem/functions.php

@@ -503,3 +503,15 @@ function read_symbolic_link(string $path): string
 
     return $result;
 }
+
+/**
+ * Returns the real path for the specified $path or null if it doesn't exist.
+ */
+function normalize_path(string $path): ?string
+{
+    if (class_exists(\Phar::class) && \Phar::running(false) !== '' && str_starts_with($path, 'phar:')) {
+        return $path;
+    }
+
+    return realpath($path) ?: null;
+}