hydephp /
develop
| Total Complexity | 52 |
| Total Lines | 272 |
| Duplicated Lines | 0 % |
| Changes | 1 | ||
| Bugs | 0 | Features | 0 |
Complex classes like ServeCommand often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ServeCommand, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class ServeCommand extends Command |
||
| 32 | { |
||
| 33 | /** @var string */ |
||
| 34 | protected $signature = 'serve |
||
| 35 | {--host= : <comment>[default: "localhost"]</comment>}} |
||
| 36 | {--port= : <comment>[default: 8080]</comment>} |
||
| 37 | {--save-preview= : Should the served page be saved to disk? (Overrides config setting)} |
||
| 38 | {--dashboard= : Enable the realtime compiler dashboard. (Overrides config setting)} |
||
| 39 | {--pretty-urls= : Enable pretty URLs. (Overrides config setting)} |
||
| 40 | {--play-cdn= : Enable the Tailwind Play CDN. (Overrides config setting)} |
||
| 41 | {--open=false : Open the site preview in the browser.} |
||
| 42 | {--vite : Enable Vite for Hot Module Replacement (HMR)} |
||
| 43 | '; |
||
| 44 | |||
| 45 | /** @var string */ |
||
| 46 | protected $description = 'Start the realtime compiler server'; |
||
| 47 | |||
| 48 | protected ConsoleOutput $console; |
||
| 49 | |||
| 50 | protected InvokedProcess $server; |
||
| 51 | protected ?InvokedProcess $vite = null; |
||
| 52 | |||
| 53 | public function safeHandle(): int |
||
| 54 | { |
||
| 55 | $this->configureOutput(); |
||
| 56 | $this->printStartMessage(); |
||
| 57 | |||
| 58 | if ($this->option('open') !== 'false') { |
||
| 59 | $this->openInBrowser((string) $this->option('open')); |
||
| 60 | } |
||
| 61 | |||
| 62 | if ($this->option('vite')) { |
||
| 63 | $this->runViteProcess(); |
||
| 64 | } |
||
| 65 | |||
| 66 | $this->runServerProcess(sprintf('php -S %s:%d %s', |
||
| 67 | $this->getHostSelection(), |
||
| 68 | $this->getPortSelection(), |
||
| 69 | escapeshellarg($this->getExecutablePath()), |
||
| 70 | )); |
||
| 71 | |||
| 72 | $this->handleRunningProcesses(); |
||
| 73 | |||
| 74 | if ($this->option('vite')) { |
||
| 75 | $this->cleanupViteHotFile(); |
||
| 76 | } |
||
| 77 | |||
| 78 | return Command::SUCCESS; |
||
| 79 | } |
||
| 80 | |||
| 81 | protected function getHostSelection(): string |
||
| 82 | { |
||
| 83 | return (string) $this->option('host') ?: Config::getString('hyde.server.host', 'localhost'); |
||
| 84 | } |
||
| 85 | |||
| 86 | protected function getPortSelection(): int |
||
| 87 | { |
||
| 88 | return (int) ($this->option('port') ?: Config::getInt('hyde.server.port', 8080)); |
||
| 89 | } |
||
| 90 | |||
| 91 | protected function getExecutablePath(): string |
||
| 92 | { |
||
| 93 | return Hyde::path('vendor/hyde/realtime-compiler/bin/server.php'); |
||
|
Bug
introduced
by
|
|||
| 94 | } |
||
| 95 | |||
| 96 | protected function runServerProcess(string $command): void |
||
| 97 | { |
||
| 98 | $this->server = Process::forever()->env($this->getEnvironmentVariables())->start($command, $this->getOutputHandler()); |
||
| 99 | } |
||
| 100 | |||
| 101 | protected function getEnvironmentVariables(): array |
||
| 102 | { |
||
| 103 | return Arr::whereNotNull([ |
||
| 104 | 'HYDE_SERVER_REQUEST_OUTPUT' => ! $this->option('no-ansi'), |
||
| 105 | 'HYDE_SERVER_SAVE_PREVIEW' => $this->parseEnvironmentOption('save-preview'), |
||
| 106 | 'HYDE_SERVER_DASHBOARD' => $this->parseEnvironmentOption('dashboard'), |
||
| 107 | 'HYDE_PRETTY_URLS' => $this->parseEnvironmentOption('pretty-urls'), |
||
| 108 | 'HYDE_PLAY_CDN' => $this->parseEnvironmentOption('play-cdn'), |
||
| 109 | ]); |
||
| 110 | } |
||
| 111 | |||
| 112 | protected function configureOutput(): void |
||
| 113 | { |
||
| 114 | if (! $this->useBasicOutput()) { |
||
| 115 | $this->console = new ConsoleOutput($this->output->isVerbose()); |
||
| 116 | } |
||
| 117 | } |
||
| 118 | |||
| 119 | protected function printStartMessage(): void |
||
| 120 | { |
||
| 121 | $this->useBasicOutput() |
||
| 122 | ? $this->output->writeln('<info>Starting the HydeRC server...</info> Use Ctrl+C to stop') |
||
| 123 | : $this->console->printStartMessage($this->getHostSelection(), $this->getPortSelection(), $this->getEnvironmentVariables(), $this->option('vite')); |
||
| 124 | } |
||
| 125 | |||
| 126 | protected function getOutputHandler(): Closure |
||
| 127 | { |
||
| 128 | return $this->useBasicOutput() ? function (string $type, string $line): void { |
||
| 129 | $this->output->write($line); |
||
| 130 | } : $this->console->getFormatter(); |
||
| 131 | } |
||
| 132 | |||
| 133 | protected function useBasicOutput(): bool |
||
| 134 | { |
||
| 135 | return $this->option('no-ansi') || ! class_exists(ConsoleOutput::class); |
||
| 136 | } |
||
| 137 | |||
| 138 | protected function parseEnvironmentOption(string $name): ?string |
||
| 139 | { |
||
| 140 | $value = $this->option($name) ?? $this->checkArgvForOption($name); |
||
| 141 | |||
| 142 | if ($value !== null) { |
||
| 143 | return match ($value) { |
||
| 144 | 'true', '' => 'enabled', |
||
| 145 | 'false' => 'disabled', |
||
| 146 | default => throw new InvalidArgumentException(sprintf('Invalid boolean value for --%s option.', $name)) |
||
| 147 | }; |
||
| 148 | } |
||
| 149 | |||
| 150 | return null; |
||
| 151 | } |
||
| 152 | |||
| 153 | /** Fallback check so that an environment option without a value is acknowledged as true. */ |
||
| 154 | protected function checkArgvForOption(string $name): ?string |
||
| 155 | { |
||
| 156 | if (isset($_SERVER['argv'])) { |
||
| 157 | if (in_array("--$name", $_SERVER['argv'], true)) { |
||
| 158 | return 'true'; |
||
| 159 | } |
||
| 160 | } |
||
| 161 | |||
| 162 | return null; |
||
| 163 | } |
||
| 164 | |||
| 165 | protected function openInBrowser(string $path = '/'): void |
||
| 166 | { |
||
| 167 | $binary = $this->getOpenCommand(PHP_OS_FAMILY); |
||
| 168 | |||
| 169 | $command = sprintf('%s http://%s:%d', $binary, $this->getHostSelection(), $this->getPortSelection()); |
||
| 170 | $command = rtrim("$command/$path", '/'); |
||
| 171 | |||
| 172 | $process = $binary ? Process::command($command)->run() : null; |
||
| 173 | |||
| 174 | if (! $process || $process->failed()) { |
||
| 175 | $this->warn('Unable to open the site preview in the browser on your system:'); |
||
| 176 | $this->line(sprintf(' %s', str_replace("\n", "\n ", $process ? $process->errorOutput() : "Missing suitable 'open' binary."))); |
||
| 177 | $this->newLine(); |
||
| 178 | } |
||
| 179 | } |
||
| 180 | |||
| 181 | protected function getOpenCommand(string $osFamily): ?string |
||
| 188 | }; |
||
| 189 | } |
||
| 190 | |||
| 191 | protected function runViteProcess(): void |
||
| 192 | { |
||
| 193 | if (! $this->isPortAvailable(5173)) { |
||
| 194 | throw new InvalidArgumentException( |
||
| 195 | 'Unable to start Vite server: Port 5173 is already in use. '. |
||
| 196 | 'Please stop any other Vite processes and try again.' |
||
| 197 | ); |
||
| 198 | } |
||
| 199 | |||
| 200 | $this->ensureNodeModulesAvailable(); |
||
| 201 | |||
| 202 | Filesystem::touch('app/storage/framework/runtime/vite.hot'); |
||
| 203 | |||
| 204 | try { |
||
| 205 | $this->vite = Process::forever()->start('npm run dev'); |
||
| 206 | } catch (Exception $exception) { |
||
| 207 | throw new InvalidArgumentException( |
||
| 208 | 'Unable to start Vite server: '.$exception->getMessage() |
||
| 209 | ); |
||
| 210 | } |
||
| 211 | } |
||
| 212 | |||
| 213 | protected function handleRunningProcesses(): void |
||
| 214 | { |
||
| 215 | while ($this->server->running()) { |
||
| 216 | $this->handleViteOutput(); |
||
| 217 | |||
| 218 | Sleep::for(100)->milliseconds(); |
||
| 219 | } |
||
| 220 | } |
||
| 221 | |||
| 222 | protected function handleViteOutput(): void |
||
| 223 | { |
||
| 224 | if ($this->vite?->running()) { |
||
| 225 | $output = $this->vite->latestOutput(); |
||
| 226 | |||
| 227 | if ($output) { |
||
| 228 | $this->output->write($output); |
||
| 229 | } |
||
| 230 | } |
||
| 231 | } |
||
| 232 | |||
| 233 | /** @experimental This feature may be removed before the final release. */ |
||
| 234 | protected function isPortAvailable(int $port): bool |
||
| 235 | { |
||
| 236 | $addresses = ['localhost', '127.0.0.1']; |
||
| 237 | |||
| 238 | foreach ($addresses as $address) { |
||
| 239 | $socket = @fsockopen($address, $port, $errno, $errstr, 1); |
||
| 240 | if ($socket !== false) { |
||
| 241 | fclose($socket); |
||
| 242 | |||
| 243 | return false; |
||
| 244 | } |
||
| 245 | } |
||
| 246 | |||
| 247 | return true; |
||
| 248 | } |
||
| 249 | |||
| 250 | protected function cleanupViteHotFile(): void |
||
| 251 | { |
||
| 252 | $hotFile = 'app/storage/framework/runtime/vite.hot'; |
||
| 253 | |||
| 254 | if (Filesystem::exists($hotFile)) { |
||
| 255 | Filesystem::unlinkIfExists($hotFile); |
||
| 256 | } |
||
| 257 | } |
||
| 258 | |||
| 259 | protected function ensureNodeModulesAvailable(): void |
||
| 260 | { |
||
| 261 | if (! $this->nodeModulesInstalled()) { |
||
| 262 | if ($this->input->isInteractive()) { |
||
| 263 | $this->warn('Node modules are not installed. Vite requires Node dependencies to function.'); |
||
| 264 | |||
| 265 | if ($this->confirm('Would you like to install them now?', true)) { |
||
| 266 | $this->installNodeModules(); |
||
| 267 | } else { |
||
| 268 | throw new InvalidArgumentException( |
||
| 269 | 'The --vite flag cannot be used if Vite is not installed. Please run "npm install" first.' |
||
| 270 | ); |
||
| 271 | } |
||
| 272 | } else { |
||
| 273 | throw new InvalidArgumentException( |
||
| 274 | 'Node modules are not installed. The --vite flag cannot be used if Vite is not installed. Please run "npm install" first.' |
||
| 275 | ); |
||
| 276 | } |
||
| 277 | } |
||
| 278 | } |
||
| 279 | |||
| 280 | protected function nodeModulesInstalled(): bool |
||
| 281 | { |
||
| 282 | return Filesystem::exists(Hyde::path('node_modules')) |
||
| 283 | && Filesystem::exists(Hyde::path('package.json')); |
||
| 284 | } |
||
| 285 | |||
| 286 | protected function installNodeModules(): void |
||
| 303 | ); |
||
| 304 | } |
||
| 305 | } |
||
| 306 | } |
||
| 307 |
Loading history...