Improved packaging speed for command phar:build. (#7040)

Author: zoujingli

src/Ast/Visitor/RewriteConfigVisitor.php

@@ -17,7 +17,7 @@
 
 class RewriteConfigVisitor extends NodeVisitorAbstract
 {
-    public function leaveNode(Node $node)
+    public function leaveNode(Node $node): Node|Node\Stmt\Expression
     {
         if ($node instanceof Node\Stmt\Return_) {
             $result = new Node\Expr\Variable('result');

src/Ast/Visitor/UnshiftCodeStringVisitor.php

@@ -27,7 +27,7 @@ public function __construct(public string $code)
         $this->astParser = $parserFactory->create(ParserFactory::ONLY_PHP7);
     }
 
-    public function beforeTraverse(array $nodes)
+    public function beforeTraverse(array $nodes): ?array
     {
         $stmt = $this->astParser->parse($this->code);
         foreach ($nodes as $i => $node) {

src/BuildCommand.php

@@ -26,7 +26,7 @@ public function __construct(protected ContainerInterface $container)
         parent::__construct('phar:build');
     }
 
-    public function configure()
+    public function configure(): void
     {
         $this->setDescription('Pack your project into a Phar package.')
             ->addOption('name', '', InputOption::VALUE_OPTIONAL, 'This is the name of the Phar package, and if it is not passed in, the project name is used by default')
@@ -36,7 +36,7 @@ public function configure()
             ->addOption('mount', 'M', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY, 'The mount path or dir.');
     }
 
-    public function handle()
+    public function handle(): void
     {
         $this->assertWritable();
         $name = $this->input->getOption('name');
@@ -68,7 +68,7 @@ public function handle()
     /**
      * check readonly.
      */
-    public function assertWritable()
+    public function assertWritable(): void
     {
         if (ini_get('phar.readonly') === '1') {
             throw new UnexpectedValueException('Your configuration disabled writing phar files (phar.readonly = On), please update your configuration');
@@ -84,7 +84,6 @@ public function getPharBuilder(string $path): PharBuilder
             throw new InvalidArgumentException(sprintf('The given path %s is not a readable file', $path));
         }
         $pharBuilder = new PharBuilder($path, $this->container->get(LoggerInterface::class));
-
         $vendorPath = $pharBuilder->getPackage()->getVendorAbsolutePath();
         if (! is_dir($vendorPath)) {
             throw new RuntimeException('The project has not been initialized, please manually execute the command `composer install` to install the dependencies');

src/CustomPhar.php

@@ -0,0 +1,119 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * This file is part of Hyperf.
+ *
+ * @link     https://www.hyperf.io
+ * @document https://hyperf.wiki
+ * @contact  group@hyperf.io
+ * @license  https://github.com/hyperf/hyperf/blob/master/LICENSE
+ */
+
+namespace Hyperf\Phar;
+
+use FilesystemIterator;
+use Phar;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use RuntimeException;
+use SplFileInfo;
+
+class CustomPhar extends Phar
+{
+    private string $tempDir;
+
+    public function __construct(string $filename, int $flags = FilesystemIterator::SKIP_DOTS | FilesystemIterator::UNIX_PATHS, ?string $alias = null)
+    {
+        parent::__construct($filename, $flags, $alias);
+        $this->tempDir = sys_get_temp_dir() . '/phar_cache_' . uniqid();
+        $this->createDirectory($this->tempDir);
+    }
+
+    public function addFile(string $filename, ?string $localName = null): void
+    {
+        $localName = $localName ?? basename($filename);
+        $relativePath = $this->tempDir . '/' . $localName;
+        $this->createDirectory(dirname($relativePath));
+        copy($filename, $relativePath);
+    }
+
+    public function addFromString(string $localName, string $contents): void
+    {
+        $relativePath = $this->tempDir . '/' . $localName;
+        $this->createDirectory(dirname($relativePath));
+        file_put_contents($relativePath, $contents);
+    }
+
+    public function buildFromDirectory(string $directory, ?string $pattern = null): array
+    {
+        $this->recursiveCopy($directory, $this->tempDir, $pattern);
+        return [];
+    }
+
+    public function buildFromIterator($iterator, ?string $baseDirectory = null): array
+    {
+        foreach ($iterator as $fileInfo) {
+            /** @var SplFileInfo $fileInfo */
+            $relativePath = $baseDirectory ? str_replace(rtrim($baseDirectory, '/\\') . '/', '', $fileInfo->getRealPath()) : $fileInfo->getFilename();
+            $this->addFile($fileInfo->getRealPath(), $relativePath);
+        }
+        return [];
+    }
+
+    /**
+     * 批量保存文件.
+     */
+    public function save(): void
+    {
+        parent::buildFromDirectory($this->tempDir);
+        $this->clearTempDir();
+    }
+
+    /**
+     * 资源文件复制.
+     */
+    private function recursiveCopy(string $source, string $destination, ?string $pattern = null): void
+    {
+        $iterator = new RecursiveIteratorIterator(
+            new RecursiveDirectoryIterator($source, FilesystemIterator::SKIP_DOTS),
+            RecursiveIteratorIterator::SELF_FIRST
+        );
+
+        foreach ($iterator as $item) {
+            $targetPath = $destination . '/' . substr($item->getRealPath(), strlen($source) + 1);
+            if ($item->isDir()) {
+                $this->createDirectory($targetPath);
+            } elseif (! $pattern || preg_match($pattern, $item->getFilename())) {
+                copy($item->getRealPath(), $targetPath);
+            }
+        }
+    }
+
+    /**
+     * 创建目录结构.
+     */
+    private function createDirectory(string $dir): void
+    {
+        if (! is_dir($dir) && ! mkdir($dir, 0777, true) && ! is_dir($dir)) {
+            throw new RuntimeException("Directory {$dir} was not created");
+        }
+    }
+
+    /**
+     * 清理临时目录.
+     */
+    private function clearTempDir(): void
+    {
+        $files = new RecursiveIteratorIterator(
+            new RecursiveDirectoryIterator($this->tempDir, FilesystemIterator::SKIP_DOTS),
+            RecursiveIteratorIterator::CHILD_FIRST
+        );
+
+        foreach ($files as $fileinfo) {
+            ($fileinfo->isDir() ? 'rmdir' : 'unlink')($fileinfo->getRealPath());
+        }
+
+        rmdir($this->tempDir);
+    }
+}

src/PharBuilder.php

@@ -230,7 +230,7 @@ public function getMountLinkCode(): string
     /**
      * Compile the code into the Phar file.
      */
-    public function build()
+    public function build(): void
     {
         $this->logger->info('Creating phar <info>' . $this->getTarget() . '</info>');
         $time = microtime(true);
@@ -248,7 +248,7 @@ public function build()
 
         $main = $this->getMain();
 
-        $targetPhar = new TargetPhar(new Phar($tmp), $this);
+        $targetPhar = new TargetPhar(new CustomPhar($tmp), $this);
         $this->logger->info('Adding main package "' . $this->package->getName() . '"');
         $finder = Finder::create()
             ->files()
@@ -333,8 +333,10 @@ public function build()
         $this->logger->info('Adding main file "' . $main . '"');
         $this->rewriteMainWithMountLinkCode($targetPhar, $main);
 
+        $this->logger->info('Packaging all cache files into the PHAR archive.');
+        $targetPhar->save();
+
         $this->logger->info('Setting stub');
-        // Add the default stub.
         $targetPhar->setStub($targetPhar->createDefaultStub($main));
         $this->logger->info('Setting default stub <info>' . $main . '</info>.');
 
@@ -357,7 +359,7 @@ public function build()
     /**
      * Find the scan_cacheable configuration and force it to open.
      */
-    protected function enableScanCacheable(TargetPhar $targetPhar)
+    protected function enableScanCacheable(TargetPhar $targetPhar): void
     {
         $configPath = 'config/config.php';
         $absPath = $this->package->getDirectory() . $configPath;
@@ -372,7 +374,7 @@ protected function enableScanCacheable(TargetPhar $targetPhar)
     /**
      * Replace the method in the Config component to get the true path to the configuration file.
      */
-    protected function replaceConfigFactoryReadPaths(TargetPhar $targetPhar, string $vendorPath)
+    protected function replaceConfigFactoryReadPaths(TargetPhar $targetPhar, string $vendorPath): void
     {
         $configPath = 'hyperf/config/src/ConfigFactory.php';
         $absPath = $vendorPath . $configPath;
@@ -407,10 +409,8 @@ private function loadJson(string $path): array
 
     /**
      * Get file size.
-     *
-     * @param PharBuilder|string $path
      */
-    private function getSize($path): string
+    private function getSize(PharBuilder|string $path): string
     {
         return round(filesize((string) $path) / 1024, 1) . ' KiB';
     }

src/TargetPhar.php

@@ -12,14 +12,13 @@
 
 namespace Hyperf\Phar;
 
-use Phar;
 use Stringable;
 use Symfony\Component\Finder\Finder;
 use Traversable;
 
 class TargetPhar implements Stringable
 {
-    public function __construct(private Phar $phar, private PharBuilder $pharBuilder)
+    public function __construct(private readonly CustomPhar $phar, private readonly PharBuilder $pharBuilder)
     {
         $phar->startBuffering();
     }
@@ -98,4 +97,12 @@ public function addFromString(string $local, string $contents): void
     {
         $this->phar->addFromString($local, $contents);
     }
+
+    /**
+     * 保存文件.
+     */
+    public function save(): void
+    {
+        $this->phar->save();
+    }
 }