Implemented roDeviceInfo.getExternalIP() (#397)

* Implemented `roDeviceInfo.getExternalIP()`

* Simplify `isValidIP`

src/worker/brsTypes/components/RoDeviceInfo.ts

@@ -7,6 +7,9 @@ import { RoAssociativeArray, AAMember } from "./RoAssociativeArray";
 import { RoArray } from "./RoArray";
 import { v4 as uuidv4 } from "uuid";
 import * as crypto from "crypto";
+/// #if !BROWSER
+import { XMLHttpRequest } from "../../polyfill/XMLHttpRequest";
+/// #endif
 
 export class RoDeviceInfo extends BrsComponent implements BrsValue {
     readonly kind = ValueKind.Object;
@@ -914,7 +917,32 @@ export class RoDeviceInfo extends BrsComponent implements BrsValue {
             args: [],
             returns: ValueKind.String,
         },
-        impl: (_interpreter) => {
+        impl: (interpreter: Interpreter) => {
+            const url = "https://api.ipify.org";
+            try {
+                const xhr = new XMLHttpRequest();
+                xhr.open("GET", url, false); // Note: synchronous
+                xhr.responseType = "text";
+                xhr.send();
+                if (xhr.status !== 200) {
+                    if (interpreter.isDevMode) {
+                        interpreter.stderr.write(
+                            `warning,[getExternalIp] Error getting ${url}: status ${xhr.status} - ${xhr.statusText}`
+                        );
+                    }
+                    return new BrsString("");
+                }
+                const ip = xhr.responseText;
+                if (interpreter.isValidIp(ip)) {
+                    return new BrsString(ip);
+                }
+            } catch (err: any) {
+                if (interpreter.isDevMode) {
+                    interpreter.stderr.write(
+                        `warning,[getExternalIp] Error getting ${url}: ${err.message}`
+                    );
+                }
+            }
             return new BrsString("");
         },
     });

src/worker/interpreter/index.ts

@@ -2116,6 +2116,22 @@ export class Interpreter implements Expr.Visitor<BrsType>, Stmt.Visitor<BrsType>
         throw err;
     }
 
+    /**
+     * Method to evaluate if a string is a valid IP address
+     * @param ip the string to evaluate
+     * @returns whether the string is a valid IP address
+     */
+    public isValidIp(ip: string): boolean {
+        const parts = ip.split(".");
+        return (
+            parts.length === 4 &&
+            parts.every((part) => {
+                const num = Number(part);
+                return !isNaN(num) && num >= 0 && num <= 255;
+            })
+        );
+    }
+
     private formatErrorVariable(err: BrsError) {
         const btArray = this.formatBacktrace(err.location, false, err.backTrace) as RoArray;
         let errDetail = RuntimeErrorDetail.Internal;

test/brsTypes/components/RoDeviceInfo.test.js

@@ -394,7 +394,9 @@ describe("RoDeviceInfo", () => {
                 let method = deviceInfo.getMethod("getExternalIp");
 
                 expect(method).toBeTruthy();
-                expect(method.call(interpreter)).toEqual(new BrsString(""));
+                let result = method.call(interpreter);
+                expect(result).toBeInstanceOf(BrsString);
+                expect(interpreter.isValidIp(result.value)).toBe(true);
             });
         });
         describe("getIPAddrs", () => {

test/e2e/BrsComponents.test.js

@@ -429,7 +429,7 @@ describe("end to end brightscript functions", () => {
             "true",
             "true",
             "WiredConnection",
-            "",
+            "true",
             " 1",
             " 3",
             "HDTV",

test/e2e/resources/components/roDeviceInfo.brs

@@ -40,7 +40,7 @@ sub main()
     print deviceInfo.getLinkStatus()
     print deviceInfo.enableLinkStatusEvent(true)
     print deviceInfo.getConnectionType()
-    print deviceInfo.getExternalIp()
+    print isValidIP(deviceInfo.getExternalIp())
     print deviceInfo.getIPAddrs().count()
     print deviceInfo.getConnectionInfo().count()
     print deviceInfo.getDisplayType()
@@ -65,3 +65,16 @@ sub main()
     print deviceInfo.enableAudioGuideChangedEvent(true)
 
 end sub
+
+function isValidIP(ip as String) as Boolean
+    ' Regular expression pattern for a valid IPv4 address
+    ipPattern = "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"
+    ' Create a regex object
+    regex = CreateObject("roRegex", ipPattern)
+    ' Check if the IP matches the pattern
+    if regex.IsMatch(ip)
+        return true
+    else
+        return false
+    end if
+end function