Add reload option to services (#920)

Author: saeedvaziry

app/Actions/Service/Manage.php

@@ -56,6 +56,22 @@ public function restart(Service $service): void
         })->onQueue('ssh');
     }
 
+    public function reload(Service $service): void
+    {
+        $this->validate($service);
+        $service->status = ServiceStatus::RELOADING;
+        $service->save();
+        dispatch(function () use ($service): void {
+            $status = $service->server->systemd()->reload($service->handler()->unit());
+            if (str($status)->contains('Active: active')) {
+                $service->status = ServiceStatus::READY;
+            } else {
+                $service->status = ServiceStatus::FAILED;
+            }
+            $service->save();
+        })->onQueue('ssh');
+    }
+
     public function enable(Service $service): void
     {
         $this->validate($service);

app/Enums/ServiceStatus.php

@@ -14,6 +14,7 @@ enum ServiceStatus: string implements VitoEnum
     case STARTING = 'starting';
     case STOPPING = 'stopping';
     case RESTARTING = 'restarting';
+    case RELOADING = 'reloading';
     case STOPPED = 'stopped';
     case ENABLING = 'enabling';
     case DISABLING = 'disabling';
@@ -28,6 +29,7 @@ public function getColor(): string
             self::UNINSTALLING,
             self::STOPPING,
             self::RESTARTING,
+            self::RELOADING,
             self::ENABLING,
             self::DISABLING => 'warning',
             self::INSTALLATION_FAILED,

app/Http/Controllers/API/ServiceController.php

@@ -76,6 +76,18 @@ public function restart(Project $project, Server $server, Service $service): \Il
         return response()->noContent();
     }
 
+    #[Post('{service}/reload', name: 'api.projects.servers.services.reload', middleware: 'ability:write')]
+    public function reload(Project $project, Server $server, Service $service): \Illuminate\Http\Response
+    {
+        $this->authorize('update', [$service, $server]);
+
+        $this->validateRoute($project, $server, $service);
+
+        app(Manage::class)->reload($service);
+
+        return response()->noContent();
+    }
+
     #[Post('{service}/enable', name: 'api.projects.servers.services.enable', middleware: 'ability:write')]
     public function enable(Project $project, Server $server, Service $service): \Illuminate\Http\Response
     {

app/Http/Controllers/ServiceController.php

@@ -89,6 +89,18 @@ public function restart(Server $server, Service $service): RedirectResponse
         ]));
     }
 
+    #[Post('/{service}/reload', name: 'services.reload')]
+    public function reload(Server $server, Service $service): RedirectResponse
+    {
+        $this->authorize('reload', $service);
+
+        app(Manage::class)->reload($service);
+
+        return back()->with('success', __(':service is being reloaded.', [
+            'service' => $service->name,
+        ]));
+    }
+
     #[Post('/{service}/stop', name: 'services.stop')]
     public function stop(Server $server, Service $service): RedirectResponse
     {

app/Models/Service.php

@@ -102,6 +102,11 @@ public function restart(): void
         $this->handler()->unit() && app(Manage::class)->restart($this);
     }
 
+    public function reload(): void
+    {
+        $this->handler()->unit() && app(Manage::class)->reload($this);
+    }
+
     public function enable(): void
     {
         $this->handler()->unit() && app(Manage::class)->enable($this);

app/Policies/ServicePolicy.php

@@ -59,6 +59,11 @@ public function restart(User $user, Service $service): bool
         return $this->update($user, $service);
     }
 
+    public function reload(User $user, Service $service): bool
+    {
+        return $this->update($user, $service);
+    }
+
     public function disable(User $user, Service $service): bool
     {
         return $this->update($user, $service);

app/SSH/OS/Systemd.php

@@ -93,11 +93,11 @@ public function disable(string $unit): string
      */
     public function reload(string $unit): string
     {
-        $command = <<<'EOD'
+        $command = <<<EOD
             sudo systemctl reload $unit
             sudo systemctl status $unit | cat
         EOD;
 
-        return $this->server->ssh()->exec($command, 'reload-'.$unit);
+        return $this->server->ssh()->exec($command, sprintf('reload-%s', $unit));
     }
 }

public/api-docs/openapi/services.yaml

@@ -363,6 +363,58 @@ paths:
               schema:
                 $ref: './openapi/schemas/ErrorResponse.yaml'
 
+  /api/projects/{project}/servers/{server}/services/{service}/reload:
+    post:
+      summary: Reload service
+      description: Reload a service to apply configuration changes without fully restarting
+      tags:
+        - Services
+      security:
+        - bearerAuth: []
+      parameters:
+        - name: project
+          in: path
+          required: true
+          description: Project ID
+          schema:
+            type: integer
+            example: 1
+        - name: server
+          in: path
+          required: true
+          description: Server ID
+          schema:
+            type: integer
+            example: 1
+        - name: service
+          in: path
+          required: true
+          description: Service ID
+          schema:
+            type: integer
+            example: 1
+      responses:
+        '204':
+          description: Service reloaded successfully
+        '401':
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: './openapi/schemas/ErrorResponse.yaml'
+        '403':
+          description: Forbidden
+          content:
+            application/json:
+              schema:
+                $ref: './openapi/schemas/ErrorResponse.yaml'
+        '404':
+          description: Service not found
+          content:
+            application/json:
+              schema:
+                $ref: './openapi/schemas/ErrorResponse.yaml'
+
   /api/projects/{project}/servers/{server}/services/{service}/enable:
     post:
       summary: Enable service

resources/js/pages/php/components/columns.tsx

@@ -72,6 +72,7 @@ export const columns: ColumnDef<Service>[] = [
               <Action type="start" service={row.original} />
               <Action type="stop" service={row.original} />
               <Action type="restart" service={row.original} />
+              <Action type="reload" service={row.original} />
               <Action type="enable" service={row.original} />
               <Action type="disable" service={row.original} />
               <DropdownMenuSeparator />

resources/js/pages/services/components/action.tsx

@@ -17,7 +17,7 @@ import { LoaderCircleIcon } from 'lucide-react';
 import FormSuccessful from '@/components/form-successful';
 import InputError from '@/components/ui/input-error';
 
-export function Action({ type, service }: { type: 'start' | 'stop' | 'restart' | 'enable' | 'disable'; service: Service }) {
+export function Action({ type, service }: { type: 'start' | 'stop' | 'restart' | 'reload' | 'enable' | 'disable'; service: Service }) {
   const [open, setOpen] = useState(false);
   const form = useForm();