mirror of https://github.com/jetkvm/kvm.git
refactor: Update WebRTC connection handling and overlays (#320)
* refactor: Update WebRTC connection handling and overlays * fix: Update comments for WebRTC connection handling in KvmIdRoute * chore: Clean up import statements in devices.$id.tsx
This commit is contained in:
parent
1a26431147
commit
8268b20f32
|
@ -36,7 +36,7 @@ export default function DashboardNavbar({
|
||||||
picture,
|
picture,
|
||||||
kvmName,
|
kvmName,
|
||||||
}: NavbarProps) {
|
}: NavbarProps) {
|
||||||
const peerConnectionState = useRTCStore(state => state.peerConnectionState);
|
const peerConnection = useRTCStore(state => state.peerConnection);
|
||||||
const setUser = useUserStore(state => state.setUser);
|
const setUser = useUserStore(state => state.setUser);
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const onLogout = useCallback(async () => {
|
const onLogout = useCallback(async () => {
|
||||||
|
@ -82,14 +82,14 @@ export default function DashboardNavbar({
|
||||||
<div className="hidden items-center gap-x-2 md:flex">
|
<div className="hidden items-center gap-x-2 md:flex">
|
||||||
<div className="w-[159px]">
|
<div className="w-[159px]">
|
||||||
<PeerConnectionStatusCard
|
<PeerConnectionStatusCard
|
||||||
state={peerConnectionState}
|
state={peerConnection?.connectionState}
|
||||||
title={kvmName}
|
title={kvmName}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
<div className="hidden w-[159px] md:block">
|
<div className="hidden w-[159px] md:block">
|
||||||
<USBStateStatus
|
<USBStateStatus
|
||||||
state={usbState}
|
state={usbState}
|
||||||
peerConnectionState={peerConnectionState}
|
peerConnectionState={peerConnection?.connectionState}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -30,7 +30,7 @@ export default function USBStateStatus({
|
||||||
peerConnectionState,
|
peerConnectionState,
|
||||||
}: {
|
}: {
|
||||||
state: USBStates;
|
state: USBStates;
|
||||||
peerConnectionState: RTCPeerConnectionState | null;
|
peerConnectionState?: RTCPeerConnectionState | null;
|
||||||
}) {
|
}) {
|
||||||
const StatusCardProps: StatusProps = {
|
const StatusCardProps: StatusProps = {
|
||||||
configured: {
|
configured: {
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
import React from "react";
|
import React from "react";
|
||||||
import { ExclamationTriangleIcon } from "@heroicons/react/24/solid";
|
import { ExclamationTriangleIcon } from "@heroicons/react/24/solid";
|
||||||
import { ArrowRightIcon } from "@heroicons/react/16/solid";
|
import { ArrowPathIcon, ArrowRightIcon } from "@heroicons/react/16/solid";
|
||||||
import { motion, AnimatePresence } from "framer-motion";
|
import { motion, AnimatePresence } from "framer-motion";
|
||||||
import { LuPlay } from "react-icons/lu";
|
import { LuPlay } from "react-icons/lu";
|
||||||
|
|
||||||
|
@ -25,12 +25,12 @@ interface LoadingOverlayProps {
|
||||||
show: boolean;
|
show: boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
export function LoadingOverlay({ show }: LoadingOverlayProps) {
|
export function LoadingVideoOverlay({ show }: LoadingOverlayProps) {
|
||||||
return (
|
return (
|
||||||
<AnimatePresence>
|
<AnimatePresence>
|
||||||
{show && (
|
{show && (
|
||||||
<motion.div
|
<motion.div
|
||||||
className="absolute inset-0 aspect-video h-full w-full"
|
className="aspect-video h-full w-full"
|
||||||
initial={{ opacity: 0 }}
|
initial={{ opacity: 0 }}
|
||||||
animate={{ opacity: 1 }}
|
animate={{ opacity: 1 }}
|
||||||
exit={{ opacity: 0 }}
|
exit={{ opacity: 0 }}
|
||||||
|
@ -55,21 +55,59 @@ export function LoadingOverlay({ show }: LoadingOverlayProps) {
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
interface ConnectionErrorOverlayProps {
|
interface LoadingConnectionOverlayProps {
|
||||||
show: boolean;
|
show: boolean;
|
||||||
|
text: string;
|
||||||
}
|
}
|
||||||
|
export function LoadingConnectionOverlay({ show, text }: LoadingConnectionOverlayProps) {
|
||||||
export function ConnectionErrorOverlay({ show }: ConnectionErrorOverlayProps) {
|
|
||||||
return (
|
return (
|
||||||
<AnimatePresence>
|
<AnimatePresence>
|
||||||
{show && (
|
{show && (
|
||||||
<motion.div
|
<motion.div
|
||||||
className="absolute inset-0 z-10 aspect-video h-full w-full"
|
className="aspect-video h-full w-full"
|
||||||
initial={{ opacity: 0 }}
|
initial={{ opacity: 0 }}
|
||||||
animate={{ opacity: 1 }}
|
animate={{ opacity: 1 }}
|
||||||
exit={{ opacity: 0 }}
|
exit={{ opacity: 0, transition: { duration: 0 } }}
|
||||||
transition={{
|
transition={{
|
||||||
duration: 0.3,
|
duration: 0.4,
|
||||||
|
ease: "easeInOut",
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<OverlayContent>
|
||||||
|
<div className="flex flex-col items-center justify-center gap-y-1">
|
||||||
|
<div className="animate flex h-12 w-12 items-center justify-center">
|
||||||
|
<LoadingSpinner className="h-8 w-8 text-blue-800 dark:text-blue-200" />
|
||||||
|
</div>
|
||||||
|
<p className="text-center text-sm text-slate-700 dark:text-slate-300">
|
||||||
|
{text}
|
||||||
|
</p>
|
||||||
|
</div>
|
||||||
|
</OverlayContent>
|
||||||
|
</motion.div>
|
||||||
|
)}
|
||||||
|
</AnimatePresence>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ConnectionErrorOverlayProps {
|
||||||
|
show: boolean;
|
||||||
|
setupPeerConnection: () => Promise<void>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function ConnectionErrorOverlay({
|
||||||
|
show,
|
||||||
|
setupPeerConnection,
|
||||||
|
}: ConnectionErrorOverlayProps) {
|
||||||
|
return (
|
||||||
|
<AnimatePresence>
|
||||||
|
{show && (
|
||||||
|
<motion.div
|
||||||
|
className="aspect-video h-full w-full"
|
||||||
|
initial={{ opacity: 0 }}
|
||||||
|
animate={{ opacity: 1 }}
|
||||||
|
exit={{ opacity: 0, transition: { duration: 0 } }}
|
||||||
|
transition={{
|
||||||
|
duration: 0.4,
|
||||||
ease: "easeInOut",
|
ease: "easeInOut",
|
||||||
}}
|
}}
|
||||||
>
|
>
|
||||||
|
@ -87,14 +125,21 @@ export function ConnectionErrorOverlay({ show }: ConnectionErrorOverlayProps) {
|
||||||
<li>Try restarting both the device and your computer</li>
|
<li>Try restarting both the device and your computer</li>
|
||||||
</ul>
|
</ul>
|
||||||
</div>
|
</div>
|
||||||
<div>
|
<div className="flex items-center gap-x-2">
|
||||||
<LinkButton
|
<LinkButton
|
||||||
to={"https://jetkvm.com/docs/getting-started/troubleshooting"}
|
to={"https://jetkvm.com/docs/getting-started/troubleshooting"}
|
||||||
theme="light"
|
theme="primary"
|
||||||
text="Troubleshooting Guide"
|
text="Troubleshooting Guide"
|
||||||
TrailingIcon={ArrowRightIcon}
|
TrailingIcon={ArrowRightIcon}
|
||||||
size="SM"
|
size="SM"
|
||||||
/>
|
/>
|
||||||
|
<Button
|
||||||
|
onClick={() => setupPeerConnection()}
|
||||||
|
LeadingIcon={ArrowPathIcon}
|
||||||
|
text="Try again"
|
||||||
|
size="SM"
|
||||||
|
theme="light"
|
||||||
|
/>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
@ -19,9 +19,8 @@ import { useJsonRpc } from "@/hooks/useJsonRpc";
|
||||||
|
|
||||||
import {
|
import {
|
||||||
HDMIErrorOverlay,
|
HDMIErrorOverlay,
|
||||||
|
LoadingVideoOverlay,
|
||||||
NoAutoplayPermissionsOverlay,
|
NoAutoplayPermissionsOverlay,
|
||||||
ConnectionErrorOverlay,
|
|
||||||
LoadingOverlay,
|
|
||||||
} from "./VideoOverlay";
|
} from "./VideoOverlay";
|
||||||
|
|
||||||
export default function WebRTCVideo() {
|
export default function WebRTCVideo() {
|
||||||
|
@ -46,15 +45,13 @@ export default function WebRTCVideo() {
|
||||||
|
|
||||||
// RTC related states
|
// RTC related states
|
||||||
const peerConnection = useRTCStore(state => state.peerConnection);
|
const peerConnection = useRTCStore(state => state.peerConnection);
|
||||||
const peerConnectionState = useRTCStore(state => state.peerConnectionState);
|
|
||||||
|
|
||||||
// HDMI and UI states
|
// HDMI and UI states
|
||||||
const hdmiState = useVideoStore(state => state.hdmiState);
|
const hdmiState = useVideoStore(state => state.hdmiState);
|
||||||
const hdmiError = ["no_lock", "no_signal", "out_of_range"].includes(hdmiState);
|
const hdmiError = ["no_lock", "no_signal", "out_of_range"].includes(hdmiState);
|
||||||
const isLoading = !hdmiError && !isPlaying;
|
const isVideoLoading = !isPlaying;
|
||||||
const isConnectionError = ["error", "failed", "disconnected", "closed"].includes(
|
|
||||||
peerConnectionState || "",
|
// console.log("peerConnection?.connectionState", peerConnection?.connectionState);
|
||||||
);
|
|
||||||
|
|
||||||
// Keyboard related states
|
// Keyboard related states
|
||||||
const { setIsNumLockActive, setIsCapsLockActive, setIsScrollLockActive } =
|
const { setIsNumLockActive, setIsCapsLockActive, setIsScrollLockActive } =
|
||||||
|
@ -379,25 +376,52 @@ export default function WebRTCVideo() {
|
||||||
}
|
}
|
||||||
}, []);
|
}, []);
|
||||||
|
|
||||||
|
const addStreamToVideoElm = useCallback(
|
||||||
|
(mediaStream: MediaStream) => {
|
||||||
|
if (!videoElm.current) return;
|
||||||
|
const videoElmRefValue = videoElm.current;
|
||||||
|
console.log("Adding stream to video element", videoElmRefValue);
|
||||||
|
videoElmRefValue.srcObject = mediaStream;
|
||||||
|
updateVideoSizeStore(videoElmRefValue);
|
||||||
|
},
|
||||||
|
[updateVideoSizeStore],
|
||||||
|
);
|
||||||
|
|
||||||
|
useEffect(
|
||||||
|
function updateVideoStreamOnNewTrack() {
|
||||||
|
if (!peerConnection) return;
|
||||||
|
const abortController = new AbortController();
|
||||||
|
const signal = abortController.signal;
|
||||||
|
|
||||||
|
peerConnection.addEventListener(
|
||||||
|
"track",
|
||||||
|
(e: RTCTrackEvent) => {
|
||||||
|
console.log("Adding stream to video element");
|
||||||
|
addStreamToVideoElm(e.streams[0]);
|
||||||
|
},
|
||||||
|
{ signal },
|
||||||
|
);
|
||||||
|
|
||||||
|
return () => {
|
||||||
|
abortController.abort();
|
||||||
|
};
|
||||||
|
},
|
||||||
|
[addStreamToVideoElm, peerConnection],
|
||||||
|
);
|
||||||
|
|
||||||
useEffect(
|
useEffect(
|
||||||
function updateVideoStream() {
|
function updateVideoStream() {
|
||||||
if (!mediaStream) return;
|
if (!mediaStream) return;
|
||||||
if (!videoElm.current) return;
|
console.log("Updating video stream from mediaStream");
|
||||||
if (peerConnection?.iceConnectionState !== "connected") return;
|
// We set the as early as possible
|
||||||
|
addStreamToVideoElm(mediaStream);
|
||||||
setTimeout(() => {
|
|
||||||
if (videoElm?.current) {
|
|
||||||
videoElm.current.srcObject = mediaStream;
|
|
||||||
}
|
|
||||||
}, 0);
|
|
||||||
updateVideoSizeStore(videoElm.current);
|
|
||||||
},
|
},
|
||||||
[
|
[
|
||||||
setVideoClientSize,
|
setVideoClientSize,
|
||||||
setVideoSize,
|
|
||||||
mediaStream,
|
mediaStream,
|
||||||
updateVideoSizeStore,
|
updateVideoSizeStore,
|
||||||
peerConnection?.iceConnectionState,
|
peerConnection,
|
||||||
|
addStreamToVideoElm,
|
||||||
],
|
],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
@ -474,6 +498,8 @@ export default function WebRTCVideo() {
|
||||||
const local = resetMousePosition;
|
const local = resetMousePosition;
|
||||||
window.addEventListener("blur", local, { signal });
|
window.addEventListener("blur", local, { signal });
|
||||||
document.addEventListener("visibilitychange", local, { signal });
|
document.addEventListener("visibilitychange", local, { signal });
|
||||||
|
const preventContextMenu = (e: MouseEvent) => e.preventDefault();
|
||||||
|
videoElmRefValue.addEventListener("contextmenu", preventContextMenu, { signal });
|
||||||
|
|
||||||
return () => {
|
return () => {
|
||||||
abortController.abort();
|
abortController.abort();
|
||||||
|
@ -517,17 +543,17 @@ export default function WebRTCVideo() {
|
||||||
);
|
);
|
||||||
|
|
||||||
const hasNoAutoPlayPermissions = useMemo(() => {
|
const hasNoAutoPlayPermissions = useMemo(() => {
|
||||||
if (peerConnectionState !== "connected") return false;
|
if (peerConnection?.connectionState !== "connected") return false;
|
||||||
if (isPlaying) return false;
|
if (isPlaying) return false;
|
||||||
if (hdmiError) return false;
|
if (hdmiError) return false;
|
||||||
if (videoHeight === 0 || videoWidth === 0) return false;
|
if (videoHeight === 0 || videoWidth === 0) return false;
|
||||||
return true;
|
return true;
|
||||||
}, [peerConnectionState, isPlaying, hdmiError, videoHeight, videoWidth]);
|
}, [peerConnection?.connectionState, isPlaying, hdmiError, videoHeight, videoWidth]);
|
||||||
|
|
||||||
return (
|
return (
|
||||||
<div className="grid h-full w-full grid-rows-layout">
|
<div className="grid h-full w-full grid-rows-layout">
|
||||||
<div className="min-h-[39.5px]">
|
<div className="min-h-[39.5px]">
|
||||||
<fieldset disabled={peerConnectionState !== "connected"}>
|
<fieldset disabled={peerConnection?.connectionState !== "connected"}>
|
||||||
<Actionbar
|
<Actionbar
|
||||||
requestFullscreen={async () =>
|
requestFullscreen={async () =>
|
||||||
videoElm.current?.requestFullscreen({
|
videoElm.current?.requestFullscreen({
|
||||||
|
@ -575,28 +601,29 @@ export default function WebRTCVideo() {
|
||||||
"cursor-none":
|
"cursor-none":
|
||||||
settings.mouseMode === "absolute" &&
|
settings.mouseMode === "absolute" &&
|
||||||
settings.isCursorHidden,
|
settings.isCursorHidden,
|
||||||
"opacity-0": isLoading || isConnectionError || hdmiError,
|
"opacity-0": isVideoLoading || hdmiError,
|
||||||
"animate-slideUpFade border border-slate-800/30 opacity-0 shadow dark:border-slate-300/20":
|
"animate-slideUpFade border border-slate-800/30 opacity-0 shadow dark:border-slate-300/20":
|
||||||
isPlaying,
|
isPlaying,
|
||||||
},
|
},
|
||||||
)}
|
)}
|
||||||
/>
|
/>
|
||||||
<div
|
{peerConnection?.connectionState == "connected" && (
|
||||||
style={{ animationDuration: "500ms" }}
|
<div
|
||||||
className="pointer-events-none absolute inset-0 flex animate-slideUpFade items-center justify-center opacity-0"
|
style={{ animationDuration: "500ms" }}
|
||||||
>
|
className="pointer-events-none absolute inset-0 flex animate-slideUpFade items-center justify-center opacity-0"
|
||||||
<div className="relative h-full max-h-[720px] w-full max-w-[1280px] rounded-md">
|
>
|
||||||
<LoadingOverlay show={isLoading} />
|
<div className="relative h-full max-h-[720px] w-full max-w-[1280px] rounded-md">
|
||||||
<ConnectionErrorOverlay show={isConnectionError} />
|
<LoadingVideoOverlay show={isVideoLoading} />
|
||||||
<HDMIErrorOverlay show={hdmiError} hdmiState={hdmiState} />
|
<HDMIErrorOverlay show={hdmiError} hdmiState={hdmiState} />
|
||||||
<NoAutoplayPermissionsOverlay
|
<NoAutoplayPermissionsOverlay
|
||||||
show={hasNoAutoPlayPermissions}
|
show={hasNoAutoPlayPermissions}
|
||||||
onPlayClick={() => {
|
onPlayClick={() => {
|
||||||
videoElm.current?.play();
|
videoElm.current?.play();
|
||||||
}}
|
}}
|
||||||
/>
|
/>
|
||||||
|
</div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
)}
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
<VirtualKeyboard />
|
<VirtualKeyboard />
|
||||||
|
|
|
@ -6,7 +6,7 @@ import LogoBlue from "@/assets/logo-blue.svg";
|
||||||
import LogoWhite from "@/assets/logo-white.svg";
|
import LogoWhite from "@/assets/logo-white.svg";
|
||||||
|
|
||||||
interface ContextType {
|
interface ContextType {
|
||||||
connectWebRTC: () => Promise<void>;
|
setupPeerConnection: () => Promise<void>;
|
||||||
}
|
}
|
||||||
/* TODO: Migrate to using URLs instead of the global state. To simplify the refactoring, we'll keep the global state for now. */
|
/* TODO: Migrate to using URLs instead of the global state. To simplify the refactoring, we'll keep the global state for now. */
|
||||||
|
|
||||||
|
@ -16,7 +16,7 @@ export default function OtherSessionRoute() {
|
||||||
|
|
||||||
// Function to handle closing the modal
|
// Function to handle closing the modal
|
||||||
const handleClose = () => {
|
const handleClose = () => {
|
||||||
outletContext?.connectWebRTC().then(() => navigate(".."));
|
outletContext?.setupPeerConnection().then(() => navigate(".."));
|
||||||
};
|
};
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
|
|
@ -45,6 +45,10 @@ import Modal from "../components/Modal";
|
||||||
import { useDeviceUiNavigation } from "../hooks/useAppNavigation";
|
import { useDeviceUiNavigation } from "../hooks/useAppNavigation";
|
||||||
import { FeatureFlagProvider } from "../providers/FeatureFlagProvider";
|
import { FeatureFlagProvider } from "../providers/FeatureFlagProvider";
|
||||||
import notifications from "../notifications";
|
import notifications from "../notifications";
|
||||||
|
import {
|
||||||
|
ConnectionErrorOverlay,
|
||||||
|
LoadingConnectionOverlay,
|
||||||
|
} from "../components/VideoOverlay";
|
||||||
|
|
||||||
import { SystemVersionInfo } from "./devices.$id.settings.general.update";
|
import { SystemVersionInfo } from "./devices.$id.settings.general.update";
|
||||||
import { DeviceStatus } from "./welcome-local";
|
import { DeviceStatus } from "./welcome-local";
|
||||||
|
@ -126,8 +130,6 @@ export default function KvmIdRoute() {
|
||||||
|
|
||||||
const setIsTurnServerInUse = useRTCStore(state => state.setTurnServerInUse);
|
const setIsTurnServerInUse = useRTCStore(state => state.setTurnServerInUse);
|
||||||
const peerConnection = useRTCStore(state => state.peerConnection);
|
const peerConnection = useRTCStore(state => state.peerConnection);
|
||||||
const peerConnectionState = useRTCStore(state => state.peerConnectionState);
|
|
||||||
const setPeerConnectionState = useRTCStore(state => state.setPeerConnectionState);
|
|
||||||
const setMediaMediaStream = useRTCStore(state => state.setMediaStream);
|
const setMediaMediaStream = useRTCStore(state => state.setMediaStream);
|
||||||
const setPeerConnection = useRTCStore(state => state.setPeerConnection);
|
const setPeerConnection = useRTCStore(state => state.setPeerConnection);
|
||||||
const setDiskChannel = useRTCStore(state => state.setDiskChannel);
|
const setDiskChannel = useRTCStore(state => state.setDiskChannel);
|
||||||
|
@ -135,78 +137,55 @@ export default function KvmIdRoute() {
|
||||||
const setTransceiver = useRTCStore(state => state.setTransceiver);
|
const setTransceiver = useRTCStore(state => state.setTransceiver);
|
||||||
const location = useLocation();
|
const location = useLocation();
|
||||||
|
|
||||||
const [connectionAttempts, setConnectionAttempts] = useState(0);
|
|
||||||
|
|
||||||
const [startedConnectingAt, setStartedConnectingAt] = useState<Date | null>(null);
|
|
||||||
const [connectedAt, setConnectedAt] = useState<Date | null>(null);
|
|
||||||
|
|
||||||
const [connectionFailed, setConnectionFailed] = useState(false);
|
const [connectionFailed, setConnectionFailed] = useState(false);
|
||||||
|
|
||||||
const navigate = useNavigate();
|
const navigate = useNavigate();
|
||||||
const { otaState, setOtaState, setModalView } = useUpdateStore();
|
const { otaState, setOtaState, setModalView } = useUpdateStore();
|
||||||
|
|
||||||
|
const [loadingMessage, setLoadingMessage] = useState("Connecting to device...");
|
||||||
const closePeerConnection = useCallback(
|
const closePeerConnection = useCallback(
|
||||||
function closePeerConnection() {
|
function closePeerConnection() {
|
||||||
|
console.log("Closing peer connection");
|
||||||
|
|
||||||
|
setConnectionFailed(true);
|
||||||
|
connectionFailedRef.current = true;
|
||||||
|
|
||||||
peerConnection?.close();
|
peerConnection?.close();
|
||||||
// "closed" is a valid RTCPeerConnection state according to the WebRTC spec
|
signalingAttempts.current = 0;
|
||||||
// https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/connectionState#closed
|
|
||||||
// However, the onconnectionstatechange event doesn't fire when close() is called manually
|
|
||||||
// So we need to explicitly update our state to maintain consistency
|
|
||||||
// I don't know why this is happening, but this is the best way I can think of to handle it
|
|
||||||
// ALSO, this will render the connection error overlay linking to docs
|
|
||||||
setPeerConnectionState("closed");
|
|
||||||
},
|
},
|
||||||
[peerConnection, setPeerConnectionState],
|
[peerConnection],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// We need to track connectionFailed in a ref to avoid stale closure issues
|
||||||
|
// This is necessary because syncRemoteSessionDescription is a callback that captures
|
||||||
|
// the connectionFailed value at creation time, but we need the latest value
|
||||||
|
// when the function is actually called. Without this ref, the function would use
|
||||||
|
// a stale value of connectionFailed in some conditions.
|
||||||
|
//
|
||||||
|
// We still need the state variable for UI rendering, so we sync the ref with the state.
|
||||||
|
// This pattern is a workaround for what useEvent hook would solve more elegantly
|
||||||
|
// (which would give us a callback that always has access to latest state without re-creation).
|
||||||
|
const connectionFailedRef = useRef(false);
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
const connectionAttemptsThreshold = 30;
|
connectionFailedRef.current = connectionFailed;
|
||||||
if (connectionAttempts > connectionAttemptsThreshold) {
|
}, [connectionFailed]);
|
||||||
console.log(`Connection failed after ${connectionAttempts} attempts.`);
|
|
||||||
setConnectionFailed(true);
|
|
||||||
closePeerConnection();
|
|
||||||
}
|
|
||||||
}, [connectionAttempts, closePeerConnection]);
|
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
// Skip if already connected
|
|
||||||
if (connectedAt) return;
|
|
||||||
|
|
||||||
// Skip if connection is declared as failed
|
|
||||||
if (connectionFailed) return;
|
|
||||||
|
|
||||||
const interval = setInterval(() => {
|
|
||||||
console.log("Checking connection status");
|
|
||||||
|
|
||||||
// Skip if connection hasn't started
|
|
||||||
if (!startedConnectingAt) return;
|
|
||||||
|
|
||||||
const elapsedTime = Math.floor(
|
|
||||||
new Date().getTime() - startedConnectingAt.getTime(),
|
|
||||||
);
|
|
||||||
|
|
||||||
// Fail connection if it's been over X seconds since we started connecting
|
|
||||||
if (elapsedTime > 60 * 1000) {
|
|
||||||
console.error(`Connection failed after ${elapsedTime} ms.`);
|
|
||||||
setConnectionFailed(true);
|
|
||||||
closePeerConnection();
|
|
||||||
}
|
|
||||||
}, 1000);
|
|
||||||
|
|
||||||
return () => clearInterval(interval);
|
|
||||||
}, [closePeerConnection, connectedAt, connectionFailed, startedConnectingAt]);
|
|
||||||
|
|
||||||
const sdp = useCallback(
|
|
||||||
async (event: RTCPeerConnectionIceEvent, pc: RTCPeerConnection) => {
|
|
||||||
if (!pc) return;
|
|
||||||
if (event.candidate !== null) return;
|
|
||||||
|
|
||||||
|
const signalingAttempts = useRef(0);
|
||||||
|
const syncRemoteSessionDescription = useCallback(
|
||||||
|
async function syncRemoteSessionDescription(pc: RTCPeerConnection) {
|
||||||
try {
|
try {
|
||||||
|
if (!pc) return;
|
||||||
|
|
||||||
const sd = btoa(JSON.stringify(pc.localDescription));
|
const sd = btoa(JSON.stringify(pc.localDescription));
|
||||||
|
|
||||||
const sessionUrl = isOnDevice
|
const sessionUrl = isOnDevice
|
||||||
? `${DEVICE_API}/webrtc/session`
|
? `${DEVICE_API}/webrtc/session`
|
||||||
: `${CLOUD_API}/webrtc/session`;
|
: `${CLOUD_API}/webrtc/session`;
|
||||||
|
|
||||||
|
console.log("Trying to get remote session description");
|
||||||
|
setLoadingMessage(
|
||||||
|
`Getting remote session description... ${signalingAttempts.current > 0 ? `(attempt ${signalingAttempts.current + 1})` : ""}`,
|
||||||
|
);
|
||||||
const res = await api.POST(sessionUrl, {
|
const res = await api.POST(sessionUrl, {
|
||||||
sd,
|
sd,
|
||||||
// When on device, we don't need to specify the device id, as it's already known
|
// When on device, we don't need to specify the device id, as it's already known
|
||||||
|
@ -214,73 +193,109 @@ export default function KvmIdRoute() {
|
||||||
});
|
});
|
||||||
|
|
||||||
const json = await res.json();
|
const json = await res.json();
|
||||||
|
if (res.status === 401) return navigate(isOnDevice ? "/login-local" : "/login");
|
||||||
if (isOnDevice) {
|
if (!res.ok) {
|
||||||
if (res.status === 401) {
|
console.error("Error getting SDP", { status: res.status, json });
|
||||||
return navigate("/login-local");
|
throw new Error("Error getting SDP");
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
if (isInCloud) {
|
console.log("Successfully got Remote Session Description. Setting.");
|
||||||
// The cloud API returns a 401 if the user is not logged in
|
setLoadingMessage("Setting remote session description...");
|
||||||
// Most likely the session has expired
|
|
||||||
if (res.status === 401) return navigate("/login");
|
|
||||||
|
|
||||||
// If can be a few things
|
const decodedSd = atob(json.sd);
|
||||||
// - In cloud mode, the cloud api would return a 404, if the device hasn't contacted the cloud yet
|
const parsedSd = JSON.parse(decodedSd);
|
||||||
// - In device mode, the device api would timeout, the fetch would throw an error, therefore the catch block would be hit
|
pc.setRemoteDescription(new RTCSessionDescription(parsedSd));
|
||||||
// Regardless, we should close the peer connection and let the useInterval handle reconnecting
|
|
||||||
if (!res.ok) {
|
|
||||||
closePeerConnection();
|
|
||||||
console.error(`Error setting SDP - Status: ${res.status}}`, json);
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
pc.setRemoteDescription(
|
await new Promise((resolve, reject) => {
|
||||||
new RTCSessionDescription(JSON.parse(atob(json.sd))),
|
console.log("Waiting for remote description to be set");
|
||||||
).catch(e => console.log(`Error setting remote description: ${e}`));
|
const maxAttempts = 10;
|
||||||
|
const interval = 1000;
|
||||||
|
let attempts = 0;
|
||||||
|
|
||||||
|
const checkInterval = setInterval(() => {
|
||||||
|
attempts++;
|
||||||
|
// When vivaldi has disabled "Broadcast IP for Best WebRTC Performance", this never connects
|
||||||
|
if (pc.sctp?.state === "connected") {
|
||||||
|
console.log("Remote description set");
|
||||||
|
clearInterval(checkInterval);
|
||||||
|
resolve(true);
|
||||||
|
} else if (attempts >= maxAttempts) {
|
||||||
|
console.log(
|
||||||
|
`Failed to get remote description after ${maxAttempts} attempts`,
|
||||||
|
);
|
||||||
|
closePeerConnection();
|
||||||
|
clearInterval(checkInterval);
|
||||||
|
reject(
|
||||||
|
new Error(
|
||||||
|
`Failed to get remote description after ${maxAttempts} attempts`,
|
||||||
|
),
|
||||||
|
);
|
||||||
|
} else {
|
||||||
|
console.log("Waiting for remote description to be set");
|
||||||
|
}
|
||||||
|
}, interval);
|
||||||
|
});
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
console.error(`Error setting SDP: ${error}`);
|
console.error("Error getting SDP", { error });
|
||||||
closePeerConnection();
|
console.log("Connection failed", connectionFailedRef.current);
|
||||||
|
if (connectionFailedRef.current) return;
|
||||||
|
if (signalingAttempts.current < 5) {
|
||||||
|
signalingAttempts.current++;
|
||||||
|
await new Promise(resolve => setTimeout(resolve, 500));
|
||||||
|
console.log("Attempting to get SDP again", signalingAttempts.current);
|
||||||
|
syncRemoteSessionDescription(pc);
|
||||||
|
} else {
|
||||||
|
closePeerConnection();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
[closePeerConnection, navigate, params.id],
|
[closePeerConnection, navigate, params.id],
|
||||||
);
|
);
|
||||||
|
|
||||||
const connectWebRTC = useCallback(async () => {
|
const setupPeerConnection = useCallback(async () => {
|
||||||
console.log("Attempting to connect WebRTC");
|
console.log("Setting up peer connection");
|
||||||
|
setConnectionFailed(false);
|
||||||
// Track connection status to detect failures and show error overlay
|
setLoadingMessage("Connecting to device...");
|
||||||
setConnectionAttempts(x => x + 1);
|
|
||||||
setStartedConnectingAt(new Date());
|
|
||||||
setConnectedAt(null);
|
|
||||||
|
|
||||||
let pc: RTCPeerConnection;
|
let pc: RTCPeerConnection;
|
||||||
try {
|
try {
|
||||||
|
console.log("Creating peer connection");
|
||||||
|
setLoadingMessage("Creating peer connection...");
|
||||||
pc = new RTCPeerConnection({
|
pc = new RTCPeerConnection({
|
||||||
// We only use STUN or TURN servers if we're in the cloud
|
// We only use STUN or TURN servers if we're in the cloud
|
||||||
...(isInCloud && iceConfig?.iceServers
|
...(isInCloud && iceConfig?.iceServers
|
||||||
? { iceServers: [iceConfig?.iceServers] }
|
? { iceServers: [iceConfig?.iceServers] }
|
||||||
: {}),
|
: {}),
|
||||||
});
|
});
|
||||||
|
console.log("Peer connection created", pc);
|
||||||
|
setLoadingMessage("Peer connection created");
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
console.error(`Error creating peer connection: ${e}`);
|
console.error(`Error creating peer connection: ${e}`);
|
||||||
closePeerConnection();
|
setTimeout(() => {
|
||||||
|
closePeerConnection();
|
||||||
|
}, 1000);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Set up event listeners and data channels
|
// Set up event listeners and data channels
|
||||||
pc.onconnectionstatechange = () => {
|
pc.onconnectionstatechange = () => {
|
||||||
// If the connection state is connected, we reset the connection attempts.
|
console.log("Connection state changed", pc.connectionState);
|
||||||
if (pc.connectionState === "connected") {
|
|
||||||
setConnectionAttempts(0);
|
|
||||||
setConnectedAt(new Date());
|
|
||||||
}
|
|
||||||
setPeerConnectionState(pc.connectionState);
|
|
||||||
};
|
};
|
||||||
|
|
||||||
pc.onicecandidate = event => sdp(event, pc);
|
pc.onicegatheringstatechange = event => {
|
||||||
|
const pc = event.currentTarget as RTCPeerConnection;
|
||||||
|
console.log("ICE Gathering State Changed", pc.iceGatheringState);
|
||||||
|
if (pc.iceGatheringState === "complete") {
|
||||||
|
console.log("ICE Gathering completed");
|
||||||
|
setLoadingMessage("ICE Gathering completed");
|
||||||
|
|
||||||
|
// We can now start the https/ws connection to get the remote session description from the KVM device
|
||||||
|
syncRemoteSessionDescription(pc);
|
||||||
|
} else if (pc.iceGatheringState === "gathering") {
|
||||||
|
console.log("ICE Gathering Started");
|
||||||
|
setLoadingMessage("Gathering ICE candidates...");
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
pc.ontrack = function (event) {
|
pc.ontrack = function (event) {
|
||||||
setMediaMediaStream(event.streams[0]);
|
setMediaMediaStream(event.streams[0]);
|
||||||
|
@ -298,56 +313,32 @@ export default function KvmIdRoute() {
|
||||||
setDiskChannel(diskDataChannel);
|
setDiskChannel(diskDataChannel);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
setPeerConnection(pc);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
const offer = await pc.createOffer();
|
const offer = await pc.createOffer();
|
||||||
await pc.setLocalDescription(offer);
|
await pc.setLocalDescription(offer);
|
||||||
setPeerConnection(pc);
|
|
||||||
} catch (e) {
|
} catch (e) {
|
||||||
console.error(`Error creating offer: ${e}`);
|
console.error(`Error creating offer: ${e}`, new Date().toISOString());
|
||||||
closePeerConnection();
|
closePeerConnection();
|
||||||
}
|
}
|
||||||
}, [
|
}, [
|
||||||
closePeerConnection,
|
closePeerConnection,
|
||||||
iceConfig?.iceServers,
|
iceConfig?.iceServers,
|
||||||
sdp,
|
|
||||||
setDiskChannel,
|
setDiskChannel,
|
||||||
setMediaMediaStream,
|
setMediaMediaStream,
|
||||||
setPeerConnection,
|
setPeerConnection,
|
||||||
setPeerConnectionState,
|
|
||||||
setRpcDataChannel,
|
setRpcDataChannel,
|
||||||
setTransceiver,
|
setTransceiver,
|
||||||
|
syncRemoteSessionDescription,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
useEffect(() => {
|
|
||||||
console.log("Attempting to connect WebRTC");
|
|
||||||
|
|
||||||
// If we're in an other session, we don't need to connect
|
|
||||||
if (location.pathname.includes("other-session")) return;
|
|
||||||
|
|
||||||
// If we're already connected or connecting, we don't need to connect
|
|
||||||
// We have to use the state from the store, because the peerConnection.connectionState doesnt trigger a value change, if called manually from .close()
|
|
||||||
if (["connected", "connecting", "new"].includes(peerConnectionState ?? "")) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
// In certain cases, we want to never connect again. This happens when we've tried for a long time and failed
|
|
||||||
if (connectionFailed) {
|
|
||||||
console.log("Connection failed. We won't attempt to connect again.");
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
|
|
||||||
const interval = setInterval(() => {
|
|
||||||
connectWebRTC();
|
|
||||||
}, 3000);
|
|
||||||
return () => clearInterval(interval);
|
|
||||||
}, [connectWebRTC, connectionFailed, location.pathname, peerConnectionState]);
|
|
||||||
|
|
||||||
// On boot, if the connection state is undefined, we connect to the WebRTC
|
// On boot, if the connection state is undefined, we connect to the WebRTC
|
||||||
useEffect(() => {
|
useEffect(() => {
|
||||||
if (peerConnection?.connectionState === undefined) {
|
if (peerConnection?.connectionState === undefined) {
|
||||||
connectWebRTC();
|
setupPeerConnection();
|
||||||
}
|
}
|
||||||
}, [connectWebRTC, peerConnection?.connectionState]);
|
}, [setupPeerConnection, peerConnection?.connectionState]);
|
||||||
|
|
||||||
// Cleanup effect
|
// Cleanup effect
|
||||||
const clearInboundRtpStats = useRTCStore(state => state.clearInboundRtpStats);
|
const clearInboundRtpStats = useRTCStore(state => state.clearInboundRtpStats);
|
||||||
|
@ -601,7 +592,27 @@ export default function KvmIdRoute() {
|
||||||
kvmName={deviceName || "JetKVM Device"}
|
kvmName={deviceName || "JetKVM Device"}
|
||||||
/>
|
/>
|
||||||
|
|
||||||
<div className="flex h-full overflow-hidden">
|
<div className="flex h-full w-full overflow-hidden">
|
||||||
|
<div className="pointer-events-none fixed inset-0 isolate z-50 flex h-full w-full items-center justify-center">
|
||||||
|
<div className="my-2 h-full max-h-[720px] w-full max-w-[1280px] rounded-md">
|
||||||
|
<LoadingConnectionOverlay
|
||||||
|
show={
|
||||||
|
!connectionFailed &&
|
||||||
|
(["connecting", "new"].includes(
|
||||||
|
peerConnection?.connectionState || "",
|
||||||
|
) ||
|
||||||
|
peerConnection === null) &&
|
||||||
|
!location.pathname.includes("other-session")
|
||||||
|
}
|
||||||
|
text={loadingMessage}
|
||||||
|
/>
|
||||||
|
<ConnectionErrorOverlay
|
||||||
|
show={connectionFailed && !location.pathname.includes("other-session")}
|
||||||
|
setupPeerConnection={setupPeerConnection}
|
||||||
|
/>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
<WebRTCVideo />
|
<WebRTCVideo />
|
||||||
<SidebarContainer sidebarView={sidebarView} />
|
<SidebarContainer sidebarView={sidebarView} />
|
||||||
</div>
|
</div>
|
||||||
|
@ -618,7 +629,7 @@ export default function KvmIdRoute() {
|
||||||
>
|
>
|
||||||
<Modal open={outlet !== null} onClose={onModalClose}>
|
<Modal open={outlet !== null} onClose={onModalClose}>
|
||||||
{/* The 'used by other session' modal needs to have access to the connectWebRTC function */}
|
{/* The 'used by other session' modal needs to have access to the connectWebRTC function */}
|
||||||
<Outlet context={{ connectWebRTC }} />
|
<Outlet context={{ setupPeerConnection }} />
|
||||||
</Modal>
|
</Modal>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue