#591 - console

app/Http/Controllers/ConsoleController.php

@@ -7,15 +7,27 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Validation\Rule;
+use Inertia\Inertia;
+use Inertia\Response;
 use Spatie\RouteAttributes\Attributes\Get;
 use Spatie\RouteAttributes\Attributes\Middleware;
 use Spatie\RouteAttributes\Attributes\Post;
+use Spatie\RouteAttributes\Attributes\Prefix;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 
-#[Middleware('auth')]
+#[Prefix('servers/{server}/console')]
+#[Middleware(['auth', 'has-project'])]
 class ConsoleController extends Controller
 {
-    #[Post('servers/{server}/console/run', name: 'servers.console.run')]
+    #[Get('/', name: 'console')]
+    public function index(Server $server): Response
+    {
+        $this->authorize('update', $server);
+
+        return Inertia::render('console/index');
+    }
+
+    #[Post('/run', name: 'console.run')]
     public function run(Server $server, Request $request): StreamedResponse
     {
         $this->authorize('update', $server);
@@ -61,7 +73,7 @@ function () use ($server, $request, $ssh, $log, $currentDir): void {
         );
     }
 
-    #[Get('servers/{server}/console/working-dir', name: 'servers.console.working-dir')]
+    #[Get('/working-dir', name: 'console.working-dir')]
     public function workingDir(Server $server): JsonResponse
     {
         return response()->json([

app/Http/Middleware/HandleInertiaRequests.php

@@ -89,6 +89,7 @@ public function share(Request $request): array
                 ...(new Ziggy)->toArray(),
                 'location' => $request->url(),
             ],
+            'csrf_token' => csrf_token(),
             'sidebarOpen' => ! $request->hasCookie('sidebar_state') || $request->cookie('sidebar_state') === 'true',
             'flash' => [
                 'success' => fn () => $request->session()->get('success'),

resources/js/components/log-output.tsx

@@ -3,8 +3,9 @@ import { ReactNode, useRef, useEffect, useState } from 'react';
 import { Button } from '@/components/ui/button';
 import { ArrowDown, ClockArrowDownIcon } from 'lucide-react';
 import { Tooltip, TooltipContent, TooltipTrigger } from '@/components/ui/tooltip';
+import { cn } from '@/lib/utils';
 
-export default function LogOutput({ children }: { children: ReactNode }) {
+export default function LogOutput({ className, children }: { className?: string; children: ReactNode }) {
   const scrollRef = useRef<HTMLDivElement>(null);
   const endRef = useRef<HTMLDivElement>(null);
   const [autoScroll, setAutoScroll] = useState(false);
@@ -23,16 +24,19 @@ export default function LogOutput({ children }: { children: ReactNode }) {
     <div className="relative w-full">
       <ScrollArea
         ref={scrollRef}
-        className="bg-accent/50 text-accent-foreground relative h-[500px] w-full overflow-auto p-4 font-mono text-sm break-all whitespace-pre-wrap"
+        className={cn(
+          'bg-accent/50 text-accent-foreground relative h-[500px] w-full overflow-auto p-4 font-mono text-sm break-all whitespace-pre-wrap',
+          className,
+        )}
       >
         <div>{children}</div>
-        <div ref={endRef} className="h-20" />
+        <div ref={endRef} />
         <ScrollBar orientation="vertical" />
       </ScrollArea>
       <Button
         variant="outline"
         size="icon"
-        className="bg-accent! absolute right-4 bottom-4"
+        className="bg-accent! absolute right-4 bottom-4 z-10"
         onClick={toggleAutoScroll}
         title={autoScroll ? 'Disable auto-scroll' : 'Enable auto-scroll'}
       >

resources/js/layouts/server/layout.tsx

@@ -1,7 +1,7 @@
 import { type NavItem } from '@/types';
 import {
   ArrowLeftIcon,
-  ChartPieIcon,
+  ChartLineIcon,
   ClockIcon,
   CloudIcon,
   CloudUploadIcon,
@@ -14,6 +14,7 @@ import {
   LogsIcon,
   MousePointerClickIcon,
   RocketIcon,
+  TerminalSquareIcon,
   UsersIcon,
 } from 'lucide-react';
 import { ReactNode } from 'react';
@@ -123,14 +124,15 @@ export default function ServerLayout({ children }: { children: ReactNode }) {
     {
       title: 'Monitoring',
       href: route('monitoring', { server: page.props.server.id }),
-      icon: ChartPieIcon,
+      icon: ChartLineIcon,
+      isDisabled: isMenuDisabled,
+    },
+    {
+      title: 'Console',
+      href: route('console', { server: page.props.server.id }),
+      icon: TerminalSquareIcon,
       isDisabled: isMenuDisabled,
     },
-    // {
-    //   title: 'Console',
-    //   href: '#',
-    //   icon: TerminalSquareIcon,
-    // },
     {
       title: 'Logs',
       href: route('logs', { server: page.props.server.id }),

resources/js/pages/console/index.tsx

@@ -0,0 +1,258 @@
+import { Head, usePage } from '@inertiajs/react';
+import { Server } from '@/types/server';
+import ServerLayout from '@/layouts/server/layout';
+import HeaderContainer from '@/components/header-container';
+import Heading from '@/components/heading';
+import { Button } from '@/components/ui/button';
+import { BookOpenIcon, Trash2, Square, LoaderCircleIcon } from 'lucide-react';
+import Container from '@/components/container';
+import { useState, useRef, FormEvent, useCallback } from 'react';
+import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from '@/components/ui/select';
+import { Input } from '@/components/ui/input';
+import LogOutput from '@/components/log-output';
+
+export default function Console() {
+  const page = usePage<{
+    server: Server;
+  }>();
+
+  const [user, setUser] = useState(page.props.server.ssh_user);
+  const [running, setRunning] = useState(false);
+  const [dir, setDir] = useState('~');
+  const [command, setCommand] = useState('');
+  const [output, setOutput] = useState('');
+  const [shellPrefix, setShellPrefix] = useState('');
+  const [clearAfterCommand] = useState(false);
+  const [initialized, setInitialized] = useState(false);
+
+  const outputRef = useRef<HTMLDivElement>(null);
+  const commandRef = useRef<HTMLInputElement>(null);
+
+  const updateShellPrefix = useCallback(
+    (currentUser: string, currentDir: string) => {
+      setShellPrefix(`${currentUser}@${page.props.server.name}:${currentDir}$`);
+    },
+    [page.props.server.name],
+  );
+
+  const focusCommand = () => {
+    commandRef.current?.focus();
+  };
+
+  const getWorkingDir = useCallback(
+    async (currentUser: string) => {
+      try {
+        const response = await fetch(route('console.working-dir', { server: page.props.server.id }));
+        if (response.ok) {
+          const data = await response.json();
+          setDir(data.dir);
+          updateShellPrefix(currentUser, data.dir);
+          return data.dir;
+        }
+      } catch (error) {
+        console.error('Failed to get working directory:', error);
+      }
+      return dir;
+    },
+    [page.props.server.id, dir, updateShellPrefix],
+  );
+
+  const scrollToBottom = () => {
+    setTimeout(() => {
+      if (outputRef.current) {
+        outputRef.current.scrollTop = outputRef.current.scrollHeight;
+      }
+    }, 100);
+  };
+
+  const clearOutput = useCallback(() => {
+    if (!running) {
+      setOutput('');
+    }
+  }, [running]);
+
+  const initialize = useCallback(async () => {
+    if (initialized) return;
+
+    const currentDir = await getWorkingDir(user);
+    updateShellPrefix(user, currentDir);
+    focusCommand();
+
+    const handleKeydown = (event: KeyboardEvent) => {
+      if (event.ctrlKey && event.key === 'l') {
+        event.preventDefault();
+        if (!running) {
+          clearOutput();
+        }
+      }
+    };
+
+    const handleMouseUp = () => {
+      if (window.getSelection()?.toString()) {
+        return;
+      }
+      focusCommand();
+    };
+
+    document.addEventListener('keydown', handleKeydown);
+    outputRef.current?.addEventListener('mouseup', handleMouseUp);
+
+    setInitialized(true);
+
+    return () => {
+      document.removeEventListener('keydown', handleKeydown);
+      outputRef.current?.removeEventListener('mouseup', handleMouseUp);
+    };
+  }, [user, updateShellPrefix, initialized, running, clearOutput, getWorkingDir]);
+
+  const handleUserChange = async (newUser: string) => {
+    setUser(newUser);
+    const currentDir = await getWorkingDir(newUser);
+    updateShellPrefix(newUser, currentDir);
+  };
+
+  const run = async () => {
+    if (!command.trim() || running) return;
+
+    setRunning(true);
+    const commandOutput = `${shellPrefix} ${command}\n`;
+    const cancelled = false;
+
+    if (clearAfterCommand) {
+      setOutput(commandOutput);
+    } else {
+      setOutput((prev) => prev + commandOutput);
+    }
+
+    scrollToBottom();
+
+    try {
+      const response = await fetch(route('console.run', { server: page.props.server.id }), {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+          'X-CSRF-TOKEN': page.props.csrf_token as string,
+        },
+        body: JSON.stringify({
+          user,
+          command,
+        }),
+      });
+
+      setCommand('');
+
+      if (response.body) {
+        const reader = response.body.getReader();
+        const decoder = new TextDecoder('utf-8');
+
+        while (true) {
+          if (cancelled) {
+            await reader.cancel();
+            setOutput((prev) => prev + '\nStopped!');
+            break;
+          }
+
+          const { value, done } = await reader.read();
+          if (done) break;
+
+          const textChunk = decoder.decode(value, { stream: true });
+          setOutput((prev) => prev + textChunk);
+          scrollToBottom();
+        }
+      }
+
+      setOutput((prev) => prev + '\n');
+      await getWorkingDir(user);
+    } catch (error) {
+      console.error('Command execution failed:', error);
+      setOutput((prev) => prev + '\nError executing command\n');
+    } finally {
+      setRunning(false);
+      setTimeout(() => focusCommand(), 100);
+    }
+  };
+
+  const stop = () => {
+    setRunning(false);
+  };
+
+  const handleSubmit = (e: FormEvent) => {
+    e.preventDefault();
+    run();
+  };
+
+  // Initialize on first render
+  if (!initialized) {
+    initialize();
+  }
+
+  return (
+    <ServerLayout>
+      <Head title={`Console - ${page.props.server.name}`} />
+
+      <Container className="max-w-5xl">
+        <HeaderContainer>
+          <Heading title="Headless Console" description="Here you can run console commands on your server" />
+          <div className="flex items-center gap-2">
+            <a href="https://vitodeploy.com/docs/servers/console" target="_blank">
+              <Button variant="outline">
+                <BookOpenIcon />
+                <span className="hidden lg:block">Docs</span>
+              </Button>
+            </a>
+            <Select value={user} onValueChange={handleUserChange} disabled={running}>
+              <SelectTrigger className="w-20">
+                <SelectValue />
+              </SelectTrigger>
+              <SelectContent>
+                {page.props.server.ssh_users.map((sshUser) => (
+                  <SelectItem key={sshUser} value={sshUser}>
+                    {sshUser}
+                  </SelectItem>
+                ))}
+              </SelectContent>
+            </Select>
+            {!running && (
+              <Button variant="outline" onClick={clearOutput}>
+                <Trash2 className="h-4 w-4" />
+                <span className="ml-2 hidden lg:block">Clear</span>
+              </Button>
+            )}
+            {running && (
+              <Button variant="outline" onClick={stop}>
+                <Square className="h-4 w-4" />
+                <span className="ml-2 hidden lg:block">Stop</span>
+              </Button>
+            )}
+          </div>
+        </HeaderContainer>
+
+        <div className="relative">
+          <div ref={outputRef}>
+            <LogOutput className="rounded-xl border pb-12 shadow-xs">{output}</LogOutput>
+          </div>
+
+          <div className="absolute right-0 bottom-0 left-0 p-4">
+            {!running ? (
+              <form onSubmit={handleSubmit} className="flex w-full items-center">
+                <span className="flex-none">{shellPrefix}</span>
+                <Input
+                  ref={commandRef}
+                  type="text"
+                  value={command}
+                  onChange={(e) => setCommand(e.target.value)}
+                  className="ml-2 h-auto flex-grow border-0 bg-transparent! p-0 shadow-none ring-0 outline-none focus:ring-0 focus:outline-none focus-visible:ring-0"
+                  autoComplete="off"
+                  autoFocus
+                />
+                <button type="submit" className="hidden" />
+              </form>
+            ) : (
+              <LoaderCircleIcon className="text-muted-foreground animate-spin" />
+            )}
+          </div>
+        </div>
+      </Container>
+    </ServerLayout>
+  );
+}

tests/Feature/ConsoleTest.php

@@ -3,8 +3,8 @@
 namespace Tests\Feature;
 
 use App\Facades\SSH;
-use App\Web\Pages\Servers\Console\Index;
 use Illuminate\Foundation\Testing\RefreshDatabase;
+use Inertia\Testing\AssertableInertia;
 use Tests\TestCase;
 
 class ConsoleTest extends TestCase
@@ -15,9 +15,9 @@ public function test_see_console(): void
     {
         $this->actingAs($this->user);
 
-        $this->get(Index::getUrl(['server' => $this->server]))
+        $this->get(route('console', $this->server))
             ->assertSuccessful()
-            ->assertSeeText('Headless Console');
+            ->assertInertia(fn (AssertableInertia $page) => $page->component('console/index'));
     }
 
     public function test_run(): void
@@ -26,7 +26,7 @@ public function test_run(): void
 
         $this->actingAs($this->user);
 
-        $this->post(route('servers.console.run', $this->server), [
+        $this->post(route('console.run', $this->server), [
             'user' => 'vito',
             'command' => 'ls -la',
         ])->assertStreamedContent('fake output');
@@ -36,11 +36,11 @@ public function test_run_validation_error(): void
     {
         $this->actingAs($this->user);
 
-        $this->post(route('servers.console.run', $this->server), [
+        $this->post(route('console.run', $this->server), [
             'user' => 'vito',
         ])->assertSessionHasErrors('command');
 
-        $this->post(route('servers.console.run', $this->server), [
+        $this->post(route('console.run', $this->server), [
             'command' => 'ls -la',
         ])->assertSessionHasErrors('user');
     }