Fit once during creation

code-asher · code-asher · commit f51684634df9 · 2023-10-20T10:47:10.000-08:00
This does not fix any bugs (that I know of) but we only need to fit once
when the terminal is created, not every time we reconnect.  Granted,
currently we do not support reconnecting without refreshing anyway so it
does not really matter, but this just seems more correct.

Plus now we will not have to pass the fit addon around.
diff --git a/site/src/pages/TerminalPage/TerminalPage.tsx b/site/src/pages/TerminalPage/TerminalPage.tsx
@@ -54,7 +54,6 @@ const TerminalPage: FC = () => {
   const [terminalState, setTerminalState] = useState<
     "connected" | "disconnected" | "initializing"
   >("initializing");
-  const [fitAddon, setFitAddon] = useState<FitAddon | null>(null);
   const [searchParams] = useSearchParams();
   // The reconnection token is a unique token that identifies
   // a terminal session. It's generated by the client to reduce
@@ -125,7 +124,6 @@ const TerminalPage: FC = () => {
       terminal.loadAddon(new CanvasAddon());
     }
     const fitAddon = new FitAddon();
-    setFitAddon(fitAddon);
     terminal.loadAddon(fitAddon);
     terminal.loadAddon(new Unicode11Addon());
     terminal.unicode.activeVersion = "11";
@@ -134,13 +132,21 @@ const TerminalPage: FC = () => {
         handleWebLinkRef.current(uri);
       }),
     );
-    setTerminal(terminal);
+
     terminal.open(xtermRef.current);
-    const listener = () => {
-      // This will trigger a resize event on the terminal.
-      fitAddon.fit();
-    };
+
+    // We have to fit twice here. It's unknown why, but the first fit will
+    // overflow slightly in some scenarios. Applying a second fit resolves this.
+    fitAddon.fit();
+    fitAddon.fit();
+
+    // This will trigger a resize event on the terminal.
+    const listener = () => fitAddon.fit();
     window.addEventListener("resize", listener);
+
+    // Terminal is correctly sized and is ready to be used.
+    setTerminal(terminal);
+
     return () => {
       window.removeEventListener("resize", listener);
       terminal.dispose();
@@ -165,16 +171,10 @@ const TerminalPage: FC = () => {
 
   // Hook up the terminal through a web socket.
   useEffect(() => {
-    if (!terminal || !fitAddon) {
+    if (!terminal) {
       return;
     }
 
-    // We have to fit twice here. It's unknown why, but
-    // the first fit will overflow slightly in some
-    // scenarios. Applying a second fit resolves this.
-    fitAddon.fit();
-    fitAddon.fit();
-
     // The terminal should be cleared on each reconnect
     // because all data is re-rendered from the backend.
     terminal.clear();
@@ -289,7 +289,6 @@ const TerminalPage: FC = () => {
     };
   }, [
     command,
-    fitAddon,
     proxy.preferredPathAppURL,
     reconnectionToken,
     terminal,
