Refactor

Author: elnurvl

src/Console/Concerns/InteractsWithDockerComposeServices.php

@@ -41,21 +41,28 @@ protected function buildDockerCompose(array $services)
 
         $compose = file_exists($composePath)
             ? Yaml::parseFile($composePath)
-            : Yaml::parse(str_replace(
-                'APP_SERVICE',
-                $appService,
-                file_get_contents(Sail::baseTemplate())
-            ));
+            : ['services' => [
+                $appService => Yaml::parse(file_get_contents(Sail::appServiceStub()))
+            ]];
+
+        if (!isset($compose['services'][$appService])) {
+            $compose['services'][$appService] = Yaml::parse(file_get_contents(Sail::appServiceStub()));
+        }
 
         // Prepare the installation of the "mariadb-client" package if the MariaDB service is used...
         if (in_array('mariadb', $services)) {
             $compose['services'][$appService]['build']['args']['MYSQL_CLIENT'] = 'mariadb-client';
         }
 
         // Adds the new services as dependencies of the app service...
-        $dependencies = collect($services)->filter(function ($service) {
-            return Sail::isDependedOn($service);
-        })->toArray();
+        $dependencies = collect($services)
+            ->merge(array_keys($compose['services']))
+            ->filter(function ($service) use ($appService) {
+                return $service !== $appService;
+            })
+            ->filter(function ($service) {
+                return Sail::isDependedOn($service);
+            })->toArray();
         if (! array_key_exists($appService, $compose['services'])) {
             $this->warn('Couldn\'t find the '.$appService.' service. Make sure you add ['.implode(',', $dependencies).'] to the depends_on config.');
         } else {
@@ -99,7 +106,13 @@ protected function buildDockerCompose(array $services)
 
         $yaml = Yaml::dump($compose, Yaml::DUMP_OBJECT_AS_MAP);
 
-        $yaml = str_replace('{{PHP_VERSION}}', $this->hasOption('php') ? $this->option('php') : '8.4', $yaml);
+        $yaml = str_replace([
+            '{{PHP_VERSION}}',
+            'APP_SERVICE',
+        ], [
+            $this->hasOption('php') ? $this->option('php') : '8.4',
+            $appService,
+        ], $yaml);
 
         file_put_contents($this->laravel->basePath('docker-compose.yml'), $yaml);
     }

src/Sail.php

@@ -6,12 +6,12 @@
 use Illuminate\Support\Facades\Facade;
 
 /**
- * @method static self setBaseTemplate(string $stub)
+ * @method static self setAppServiceStub(string $stub)
  * @method static self addService(string $service, ?string $stubPath = null, ?bool $persistent = null, ?bool $default = null, ?bool $dependency = null, ?Closure $configuringEnv = null, ?Closure $afterInstall = null)
  * @method static self addNetwork(array $network)
  * @method static self registerInstallHook(Closure $closure)
  * @method static self registerPublishHook(Closure $closure)
- * @method static string baseTemplate()
+ * @method static string appServiceStub()
  * @method static array availableServices(bool $default = false)
  * @method static array networks()
  * @method static string stub(string $service)

src/Services.php

@@ -68,7 +68,7 @@ class Services
      *
      * @var string
      */
-    protected string $composeStub = __DIR__ . '/../stubs/docker-compose.stub';
+    protected string $appStub = __DIR__ . '/../stubs/app.stub';
 
     /**
      * Hooks to be run after all services are configured
@@ -209,26 +209,26 @@ public function __construct()
     }
 
     /**
-     * Set the base Docker Compose template containing a php service named as 'APP_SERVICE'
+     * Set the php service running the application
      *
-     * @param string $stub Path to the base Docker Compose stub
+     * @param string $path Path to the base Docker Compose stub
      * @return $this
      */
-    public function setBaseTemplate(string $stub): self
+    public function setAppServiceStub(string $path): self
     {
-        $this->composeStub = $stub;
+        $this->appStub = $path;
 
         return $this;
     }
 
     /**
-     * Get the path to the base Docker Compose template
+     * Get the path to the php service running the application
      *
      * @return string
      */
-    public function baseTemplate(): string
+    public function appServiceStub(): string
     {
-        return $this->composeStub;
+        return $this->appStub;
     }
 
     /**

stubs/app.stub

@@ -0,0 +1,22 @@
+# For more information: https://laravel.com/docs/sail
+build:
+    context: ./vendor/laravel/sail/runtimes/{{PHP_VERSION}}
+    dockerfile: Dockerfile
+    args:
+        WWWGROUP: '${WWWGROUP}'
+image: sail-{{PHP_VERSION}}/app
+extra_hosts:
+    - 'host.docker.internal:host-gateway'
+ports:
+    - '${APP_PORT:-80}:80'
+    - '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
+environment:
+    WWWUSER: '${WWWUSER}'
+    LARAVEL_SAIL: 1
+    XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
+    XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
+    IGNITION_LOCAL_SITES_PATH: '${PWD}'
+volumes:
+    - '.:/var/www/html'
+networks:
+    - sail