Skip to content

[FrameworkBundle] Add --watch option to cache:clear command #32764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

[FrameworkBundle] Add --watch option to cache:clear command #32764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions src/Symfony/Bundle/FrameworkBundle/Command/CacheClearCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Style\OutputStyle;
use Symfony\Component\Console\Style\SymfonyStyle;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\Filesystem\Exception\IOException;
Expand Down Expand Up @@ -56,6 +57,7 @@ protected function configure()
->setDefinition([
new InputOption('no-warmup', '', InputOption::VALUE_NONE, 'Do not warm up the cache'),
new InputOption('no-optional-warmers', '', InputOption::VALUE_NONE, 'Skip optional cache warmers (faster)'),
new InputOption('watch', '', InputOption::VALUE_NONE, 'Watch files and recompile whenever they change'),
])
->setDescription('Clears the cache')
->setHelp(<<<'EOF'
Expand Down Expand Up @@ -175,6 +177,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
}

$io->success(sprintf('Cache for the "%s" environment (debug=%s) was successfully cleared.', $kernel->getEnvironment(), var_export($kernel->isDebug(), true)));

if ($input->getOption('watch')) {
$this->watch($kernel->getContainer()->getParameter('kernel.project_dir'), $realCacheDir, $io);
}
}

private function warmup(string $warmupDir, string $realCacheDir, bool $enableOptionalWarmers = true)
Expand Down Expand Up @@ -204,4 +210,52 @@ private function warmup(string $warmupDir, string $realCacheDir, bool $enableOpt
}
}
}

private function watch(string $projectDir, string $realCacheDir, OutputStyle $io)
{
if (!\function_exists('inotify_init')) {
throw new \RuntimeException('The "inotify" extension is required for watching the project files.');
}

$io->comment('Preparing for watching...');

$watchers = [];
$inotify = inotify_init();
$baseMask = IN_CREATE | IN_ATTRIB | IN_MODIFY | IN_MOVE | IN_MOVE_SELF | IN_DELETE | IN_DELETE_SELF;
$watchers[inotify_add_watch($inotify, $projectDir, $baseMask)] = $projectDir;
foreach (Finder::create()->in($projectDir)->directories()->exclude([substr($realCacheDir, \strlen($projectDir) + 1), 'vendor'])->sortByName() as $dir) { // FIXME ignoreVCSIgnored(true) does not work here
$watchers[inotify_add_watch($inotify, $dir->getRealPath(), $baseMask)] = $dir;
}

$io->comment(sprintf('Watching %s (%s subdirs)', $projectDir, \count($watchers)));

while ($events = inotify_read($inotify)) {
$paths = [];
foreach ($events as $e) {
$path = rtrim($watchers[$e['wd']].'/'.$e['name'], '/');
$paths[$path] = ($paths[$path] ?? 0) | $e['mask'];
}

$warmup = false;
foreach ($paths as $path => $mask) {
if ($mask & IN_CREATE && is_dir($path)) {
$watchers[inotify_add_watch($inotify, $path, $baseMask)] = $path;
$io->write(substr($path, \strlen($projectDir) + 1).' ');
}
if ($mask & $baseMask) {
$warmup = true;
$io->write(substr($path, \strlen($projectDir) + 1).' ');
}
}

if ($warmup) {
try {
$this->warmup($realCacheDir, $realCacheDir);
$io->writeln('<info>ok</info>');
} catch (\Exception $e) {
$io->writeln(sprintf('<comment>%s</comment>', $e->getMessage()));
}
}
}
}
}
1 change: 1 addition & 0 deletions src/Symfony/Bundle/FrameworkBundle/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@
},
"suggest": {
"ext-apcu": "For best performance of the system caches",
"ext-inotify": "For watching files and recompiling whenever they change",
"symfony/console": "For using the console commands",
"symfony/form": "For using forms",
"symfony/serializer": "For using the serializer service",
Expand Down