Automatically set ice ips

src/libs/blueos.ts

@@ -73,3 +73,23 @@ export const setKeyDataOnCockpitVehicleStorage = async (
 
   await setCockpitStorageOnVehicle(vehicleAddress, newVehicleStorage)
 }
+
+/* eslint-disable jsdoc/require-jsdoc */
+type RawIpInfo = { ip: string; service_type: string; interface_type: string }
+type IpInfo = { ipv4Address: string; interfaceType: string }
+/* eslint-enable jsdoc/require-jsdoc */
+
+export const getIpsInformationFromVehicle = async (vehicleAddress: string): Promise<IpInfo[]> => {
+  try {
+    const response = await fetch(`http://${vehicleAddress}/beacon/v1.0/services`)
+    if (!(await response.ok)) {
+      throw new Error(await response.text())
+    }
+    const rawIpsInfo: RawIpInfo[] = await response.json()
+    return rawIpsInfo
+      .filter((ipInfo) => ipInfo['service_type'] === '_http')
+      .map((ipInfo) => ({ ipv4Address: ipInfo.ip, interfaceType: ipInfo.interface_type }))
+  } catch (error) {
+    throw new Error(`Could not get information about IPs on BlueOS. ${error}`)
+  }
+}

src/stores/video.ts

@@ -9,6 +9,7 @@ import { computed, ref, watch } from 'vue'
 import adapter from 'webrtc-adapter'
 
 import { WebRTCManager } from '@/composables/webRTC'
+import { getIpsInformationFromVehicle } from '@/libs/blueos'
 import { datalogger } from '@/libs/sensors-logging'
 import { isEqual } from '@/libs/utils'
 import { useMainVehicleStore } from '@/stores/mainVehicle'
@@ -17,7 +18,7 @@ import type { StreamData } from '@/types/video'
 
 export const useVideoStore = defineStore('video', () => {
   const { missionName } = useMissionStore()
-  const { rtcConfiguration, webRTCSignallingURI } = useMainVehicleStore()
+  const { globalAddress, rtcConfiguration, webRTCSignallingURI } = useMainVehicleStore()
   console.debug('[WebRTC] Using webrtc-adapter for', adapter.browserDetails)
 
   const allowedIceIps = useStorage<string[]>('cockpit-allowed-stream-ips', [])
@@ -230,30 +231,61 @@ export const useVideoStore = defineStore('video', () => {
   })
 
   // Routine to make sure the user has chosen the allowed ICE candidate IPs, so the stream works as expected
-  const iceIpCheckInterval = setInterval(() => {
-    // Pass if there are no available IPs yet or if the user has already set the allowed ones
-    if (availableIceIps.value === undefined || !allowedIceIps.value.isEmpty()) {
+  let warningTimeout: NodeJS.Timeout | undefined = undefined
+  const iceIpCheckInterval = setInterval(async (): Promise<void> => {
+    // Pass if there are no available IPs yet
+    if (availableIceIps.value === undefined) return
+
+    // Cancel the check if the user has already set the allowed ICE IPs
+    if (!allowedIceIps.value.isEmpty()) {
+      clearInterval(iceIpCheckInterval)
+      clearTimeout(warningTimeout)
       return
     }
-    // If there's more than one IP candidate available, send a warning an clear the check routine
+
+    // If there's more than one IP candidate available, try getting information about them from BlueOS. If not
+    // available, send a warning an clear the check routine.
     if (availableIceIps.value.length >= 1) {
-      Swal.fire({
-        html: `
-          <p>Cockpit detected more than one IP address being used to route the video streaming. This often
-          leads to video stuttering, especially if one of the IPs is from a non-wired connection.</p>
-          </br>
-          <p>To prevent issues and achieve an optimal streaming experience, please:</p>
-          <ol>
-            <li>1. Open the video configuration page (Main-menu > Configuration > Video).</li>
-            <li>2. Select the IP address that should be used for the video streaming.</li>
-          </ol>
-        `,
-        icon: 'warning',
-        customClass: {
-          htmlContainer: 'text-left',
-        },
-      })
-      clearInterval(iceIpCheckInterval)
+      try {
+        const ipsInfo = await getIpsInformationFromVehicle(globalAddress)
+        ipsInfo.forEach((ipInfo) => {
+          const isIceIp = availableIceIps.value.includes(ipInfo.ipv4Address)
+          const alreadyAllowedIp = allowedIceIps.value.includes(ipInfo.ipv4Address)
+          if (ipInfo.interfaceType !== 'WIRED' || alreadyAllowedIp || !isIceIp) return
+          console.info(`Adding the wired address '${ipInfo.ipv4Address}' to the list of allowed ICE IPs.`)
+          allowedIceIps.value.push(ipInfo.ipv4Address)
+        })
+        if (!allowedIceIps.value.isEmpty()) {
+          clearInterval(iceIpCheckInterval)
+          clearTimeout(warningTimeout)
+          return
+        }
+      } catch (error) {
+        console.log(error)
+      }
+
+      if (warningTimeout) return
+      warningTimeout = setTimeout(() => {
+        console.info('No ICE IPs selected for the allowed list. Warning user.')
+        Swal.fire({
+          html: `
+            <p>Cockpit detected more than one IP address being used to route the video streaming. This often
+            leads to video stuttering, especially if one of the IPs is from a non-wired connection.</p>
+            </br>
+            <p>To prevent issues and achieve an optimal streaming experience, please:</p>
+            <ol>
+              <li>1. Open the video configuration page (Main-menu > Configuration > Video).</li>
+              <li>2. Select the IP address that should be used for the video streaming.</li>
+            </ol>
+          `,
+          icon: 'warning',
+          customClass: {
+            htmlContainer: 'text-left',
+          },
+        })
+        clearInterval(iceIpCheckInterval)
+        return
+      }, 5000)
     }
   }, 5000)