Added Platform info to the result of roDeviceInfo.getModelDetails() (#414)

* Added `Platform` info to the result of `roDeviceInfo.getModelDetails()`

* Replaced usage of deprecated property `navigator.platform`

* Optimized code

Author: lvcabral

docs/customization.md

@@ -49,12 +49,40 @@ By default, the feature `simulation_engine` is defined internally in the library
 
 ## App Manifest
 
-There is also a way BrightScript apps can change the behavior of the simulation engine, by using custom `manifest` entries. Currently the only custom option is:
+There is also a way BrightScript apps can change the behavior of the simulation engine, by using special `manifest` entries. Currently the only option is:
 
 - `multi_key_events=1`: If this flag is defined, will inform the simulator to handle multiple key events in parallel, instead of the default Roku behavior, that is handling one key at a time.
 
-Note: custom `manifest` entries are ignored by Roku Devices.
+Note: this special `manifest` entry is ignored by Roku Devices.
 
 ## Control Mapping
 
 It is also possible to customize the Remote Control mapping for the Keyboard and Game Pad, either by sending the custom mapping in the `Options` parameter when running `initialize()` method, or by using `setCustomKeys()` and `setCustomPadButtons()` later on. Check the details in the [engine API documentation](engine-api.md). To know the default mapping please check the source code at `src/api/control.ts`.
+
+## Platform Details
+
+The engine will also extend the results of the method `roDeviceInfo.getModelDetails()` with several attributes giving information about the platform the app is being executed:
+
+```brs
+brs> di = createObject("roDeviceInfo")
+
+brs> print di.getModelDetails()
+<Component: roAssociativeArray> =
+{
+    Manufacturer: ""
+    ModelNumber: "3930X"
+    VendorName: "Roku"
+    VendorUSBName: "Roku"
+    inAndroid: false
+    inBrowser: false
+    inChromeOS: false
+    inChromium: false
+    inElectron: false
+    inFirefox: false
+    inIOS: false
+    inLinux: false
+    inMacOS: true
+    inSafari: false
+    inWindows: false
+}
+```

src/api/control.ts

@@ -5,8 +5,15 @@
  *
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { SubscribeCallback, context } from "./util";
-import { DataType, RemoteType, DebugCommand, keyBufferSize, keyArraySpots } from "../worker/common";
+import { SubscribeCallback } from "./util";
+import {
+    DataType,
+    RemoteType,
+    DebugCommand,
+    keyBufferSize,
+    keyArraySpots,
+    platform,
+} from "../worker/common";
 /// #if BROWSER
 import gameControl, { GCGamepad, EventName } from "esm-gamecontroller.js";
 /// #endif
@@ -174,7 +181,7 @@ keysMap.set("Shift+Escape", "home");
 keysMap.set("Control+Escape", "home");
 keysMap.set("Backspace", "instantreplay");
 keysMap.set("End", "play");
-if (context.inApple) {
+if (platform.inIOS || platform.inMacOS) {
     keysMap.set("Command+Backspace", "backspace");
     keysMap.set("Command+Enter", "play");
     keysMap.set("Command+ArrowLeft", "rev");

src/api/display.ts

@@ -6,7 +6,8 @@
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
 import { player, subscribeVideo } from "./video";
-import { SubscribeCallback, context } from "./util";
+import { SubscribeCallback } from "./util";
+import { platform } from "../worker/common";
 import Stats from "stats.js";
 
 // Simulation Display
@@ -264,7 +265,7 @@ export function showDisplay() {
 // Clear Display and Buffer
 export function clearDisplay() {
     window.cancelAnimationFrame(lastFrameReq);
-    if (ctx && context.inSafari) {
+    if (ctx && platform.inSafari) {
         ctx.fillStyle = "black";
         ctx.fillRect(0, 0, ctx.canvas.width, ctx.canvas.height);
     } else if (ctx) {

src/api/index.ts

@@ -5,7 +5,7 @@
  *
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { SubscribeCallback, getNow, getWorkerLibPath, context, saveDataBuffer } from "./util";
+import { SubscribeCallback, getNow, getWorkerLibPath, saveDataBuffer } from "./util";
 
 import {
     AppExitReason,
@@ -19,6 +19,7 @@ import {
     getExitReason,
     isAppData,
     isNDKStart,
+    platform,
 } from "../worker/common";
 
 import {
@@ -113,7 +114,7 @@ export function initialize(customDeviceInfo?: Partial<DeviceInfo>, options: any
             "videoFormats",
             "fonts",
             "password",
-            "runContext",
+            "platform",
         ];
         invalidKeys.forEach((key) => {
             if (key in customDeviceInfo) {
@@ -474,7 +475,7 @@ function workerCallback(event: MessageEvent) {
         updateBuffer(event.data);
     } else if (event.data instanceof Map) {
         deviceData.registry = event.data;
-        if (context.inBrowser) {
+        if (platform.inBrowser) {
             const storage: Storage = window.localStorage;
             deviceData.registry.forEach(function (value: string, key: string) {
                 storage.setItem(key, value);
@@ -483,13 +484,13 @@ function workerCallback(event: MessageEvent) {
         notifyAll("registry", event.data);
     } else if (event.data instanceof Array) {
         addSoundPlaylist(event.data);
-    } else if (event.data.audioPath && context.inBrowser) {
+    } else if (event.data.audioPath && platform.inBrowser) {
         addSound(event.data.audioPath, event.data.audioFormat, new Blob([event.data.audioData]));
-    } else if (event.data.videoPlaylist && context.inBrowser) {
+    } else if (event.data.videoPlaylist && platform.inBrowser) {
         if (event.data.videoPlaylist instanceof Array) {
             addVideoPlaylist(event.data.videoPlaylist);
         }
-    } else if (event.data.videoPath && context.inBrowser) {
+    } else if (event.data.videoPath && platform.inBrowser) {
         addVideo(event.data.videoPath, new Blob([event.data.videoData], { type: "video/mp4" }));
     } else if (isAppData(event.data)) {
         notifyAll("launch", { app: event.data.id, params: event.data.params ?? new Map() });

src/api/package.ts

@@ -6,7 +6,7 @@
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
 import { drawSplashScreen, clearDisplay, drawIconAsSplash } from "./display";
-import { bufferToBase64, parseCSV, SubscribeCallback, context } from "./util";
+import { bufferToBase64, parseCSV, SubscribeCallback } from "./util";
 import { unzipSync, zipSync, strFromU8, strToU8, Zippable, Unzipped } from "fflate";
 import { addSound, audioCodecs } from "./sound";
 import { addVideo, videoFormats } from "./video";
@@ -20,6 +20,7 @@ import {
     AppData,
     AppExitReason,
     DeviceInfo,
+    platform,
 } from "../worker/common";
 import models from "../worker/libraries/common/models.csv";
 import packageInfo from "../../package.json";
@@ -29,7 +30,6 @@ export const deviceData: DeviceInfo = Object.assign(defaultDeviceInfo, {
     models: parseCSV(models),
     audioCodecs: audioCodecs(),
     videoFormats: videoFormats(),
-    runContext: context,
 });
 
 // App Data
@@ -114,9 +114,9 @@ function processFile(relativePath: string, fileData: Uint8Array) {
         paths.push({ id: 0, url: relativePath, type: "pcode" });
     } else if (lcasePath === "source/var") {
         paths.push({ id: 1, url: relativePath, type: "pcode" });
-    } else if (context.inBrowser && audioExt.has(ext)) {
+    } else if (platform.inBrowser && audioExt.has(ext)) {
         addSound(`pkg:/${relativePath}`, ext, new Blob([fileData]));
-    } else if (context.inBrowser && videoExt.has(ext)) {
+    } else if (platform.inBrowser && videoExt.has(ext)) {
         addVideo(`pkg:/${relativePath}`, new Blob([fileData], { type: "video/mp4" }));
     }
 }
@@ -148,7 +148,7 @@ function processManifest(content: string): number {
     if (icon?.slice(0, 5) === "pkg:/") {
         iconFile = currentZip[icon.slice(5)];
         if (iconFile) {
-            if (context.inBrowser) {
+            if (platform.inBrowser) {
                 bufferToBase64(iconFile).then(function (iconBase64: string) {
                     notifyAll("icon", iconBase64);
                 });

src/api/util.ts

@@ -5,7 +5,7 @@
  *
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { RunContext, dataBufferIndex, dataBufferSize } from "../worker/common";
+import { dataBufferIndex, dataBufferSize } from "../worker/common";
 import packageInfo from "../../package.json";
 
 // Module callback function definition
@@ -37,42 +37,6 @@ export function getWorkerLibPath(): string {
     return libPath;
 }
 
-// Check the context where the library is running
-export const context = getContext();
-function getContext(): RunContext {
-    let inElectron = false;
-    let inChromium = false;
-    let inBrowser = false;
-    let inSafari = false;
-    let inApple = false;
-    let inIOS = false;
-    if (typeof window !== "undefined") {
-        inBrowser = true;
-        inChromium =
-            ("chrome" in window || (window.Intl && "v8BreakIterator" in Intl)) && "CSS" in window;
-    }
-    if (typeof navigator !== "undefined" && typeof navigator.userAgent === "string") {
-        inElectron = navigator.userAgent.indexOf("Electron") >= 0;
-        inApple = /(Mac|iPhone|iPad|iPod)/i.test(navigator.platform);
-        inSafari = /^((?!chrome|android).)*safari/i.test(navigator.userAgent);
-        inIOS =
-            /iPad|iPhone|iPod/.test(navigator.platform) ||
-            (typeof navigator.maxTouchPoints !== "undefined" &&
-                navigator.maxTouchPoints > 2 &&
-                /MacIntel/.test(navigator.platform));
-    } else {
-        inApple = process.platform === "darwin";
-    }
-    return {
-        inElectron: inElectron,
-        inChromium: inChromium,
-        inBrowser: inBrowser,
-        inSafari: inSafari,
-        inApple: inApple,
-        inIOS: inIOS,
-    };
-}
-
 export function saveDataBuffer(sharedArray: Int32Array, data: string) {
     // Store string on SharedArrayBuffer
     data = data.trim();

src/api/video.ts

@@ -5,8 +5,8 @@
  *
  *  Licensed under the MIT License. See LICENSE in the repository root for license information.
  *--------------------------------------------------------------------------------------------*/
-import { SubscribeCallback, context, saveDataBuffer } from "./util";
-import { BufferType, DataType, MediaEvent } from "../worker/common";
+import { SubscribeCallback, saveDataBuffer } from "./util";
+import { BufferType, DataType, MediaEvent, platform } from "../worker/common";
 import Hls from "hls.js";
 
 // Video Objects
@@ -172,7 +172,7 @@ export function switchVideoState(play: boolean) {
 export function videoFormats() {
     const codecs: string[] = [];
     const containers: string[] = [];
-    if (context.inBrowser) {
+    if (platform.inBrowser) {
         // Mime and Codecs browser test page
         // https://cconcolato.github.io/media-mime-support/
         const formats = new Map([
@@ -198,7 +198,7 @@ export function videoFormats() {
         if (player.canPlayType("video/mp2t") !== "") {
             containers.push("ts");
         }
-        if (context.inChromium) {
+        if (platform.inChromium) {
             containers.push("mkv");
         }
     }

src/worker/brsTypes/components/RoDeviceInfo.ts

@@ -5,6 +5,7 @@ import { Callable, StdlibArgument } from "../Callable";
 import { Interpreter } from "../../interpreter";
 import { RoAssociativeArray, AAMember } from "./RoAssociativeArray";
 import { RoArray } from "./RoArray";
+import { isPlatform } from "../../common";
 import { v4 as uuidv4 } from "uuid";
 import * as crypto from "crypto";
 /// #if !BROWSER
@@ -167,7 +168,12 @@ export class RoDeviceInfo extends BrsComponent implements BrsValue {
             });
             result.push({ name: new BrsString("VendorName"), value: new BrsString("Roku") });
             result.push({ name: new BrsString("VendorUSBName"), value: new BrsString("Roku") });
-            // TODO: Add the engine host platform info here
+            const platform = interpreter.deviceInfo.get("platform");
+            if (isPlatform(platform)) {
+                for (const [key, value] of Object.entries(platform)) {
+                    result.push({ name: new BrsString(key), value: BrsBoolean.from(value) });
+                }
+            }
             return new RoAssociativeArray(result);
         },
     });