Feat: Rename getBrowserStackData to getDevicesAndBrowsers and update related references

Author: ruturaj-browserstack

src/lib/device-cache.ts

@@ -15,44 +15,46 @@ const URLS = {
 /**
  * Fetches and caches both BrowserStack datasets (live + app_live) with a shared TTL.
  */
-export async function getBrowserStackData(
+export async function getDevicesAndBrowsers(
   type: "live" | "app_live",
 ): Promise<any> {
   if (!fs.existsSync(CACHE_DIR)) {
     fs.mkdirSync(CACHE_DIR, { recursive: true });
   }
 
   let cache: any = {};
-  let shouldRefresh = true;
 
   if (fs.existsSync(CACHE_FILE)) {
     const stats = fs.statSync(CACHE_FILE);
     if (Date.now() - stats.mtimeMs < TTL_MS) {
-      cache = JSON.parse(fs.readFileSync(CACHE_FILE, "utf8"));
-      shouldRefresh = false;
+      try {
+        cache = JSON.parse(fs.readFileSync(CACHE_FILE, "utf8"));
+        return cache[type];
+      } catch (error) {
+        console.error("Error parsing cache file:", error);
+        // Continue with fetching fresh data
+      }
     }
   }
 
-  if (shouldRefresh) {
-    const [liveRes, appLiveRes] = await Promise.all([
-      fetch(URLS.live),
-      fetch(URLS.app_live),
-    ]);
+  const [liveRes, appLiveRes] = await Promise.all([
+    fetch(URLS.live),
+    fetch(URLS.app_live),
+  ]);
 
-    if (!liveRes.ok || !appLiveRes.ok) {
-      throw new Error(
-        `Failed to fetch data: live=${liveRes.statusText}, app_live=${appLiveRes.statusText}`,
-      );
-    }
+  if (!liveRes.ok || !appLiveRes.ok) {
+    throw new Error(
+      `Failed to fetch configuration from BrowserStack for try catch around JSON parse.: live=${liveRes.statusText}, app_live=${appLiveRes.statusText}`,
+    );
+  }
 
-    const [liveData, appLiveData] = await Promise.all([
-      liveRes.json(),
-      appLiveRes.json(),
-    ]);
+  const [liveData, appLiveData] = await Promise.all([
+    liveRes.json(),
+    appLiveRes.json(),
+  ]);
 
-    cache = { live: liveData, app_live: appLiveData };
-    fs.writeFileSync(CACHE_FILE, JSON.stringify(cache), "utf8");
-  }
+  cache = { live: liveData, app_live: appLiveData };
+  fs.writeFileSync(CACHE_FILE, JSON.stringify(cache), "utf8");
 
   return cache[type];
 }

src/tools/applive-utils/start-session.ts

@@ -1,6 +1,6 @@
 import childProcess from "child_process";
 import logger from "../../logger";
-import { getBrowserStackData } from "../../lib/device-cache";
+import { getDevicesAndBrowsers } from "../../lib/device-cache";
 import { fuzzySearchDevices } from "./fuzzy-search";
 import { sanitizeUrlParam } from "../../lib/utils";
 import { uploadApp } from "./upload-app";
@@ -30,7 +30,7 @@ export async function startSession(args: StartSessionArgs): Promise<string> {
   const { appPath, desiredPlatform, desiredPhone } = args;
   let { desiredPlatformVersion } = args;
 
-  const data = await getBrowserStackData("app_live");
+  const data = await getDevicesAndBrowsers("app_live");
 
   const allDevices: DeviceEntry[] = data.mobile.flatMap((group: any) =>
     group.devices.map((dev: any) => ({ ...dev, os: group.os })),

src/tools/live-utils/desktop-filter.ts

@@ -1,10 +1,12 @@
-import { getBrowserStackData } from "../../lib/device-cache";
+import { getDevicesAndBrowsers } from "../../lib/device-cache";
 import { resolveVersion } from "./version-resolver";
 import { customFuzzySearch } from "../../lib/fuzzy";
-import { DesktopArgs, DesktopEntry } from "./types";
+import { DesktopSearchArgs, DesktopEntry } from "./types";
 
-export async function filterDesktop(args: DesktopArgs): Promise<DesktopEntry> {
-  const data = await getBrowserStackData("live");
+export async function filterDesktop(
+  args: DesktopSearchArgs,
+): Promise<DesktopEntry> {
+  const data = await getDevicesAndBrowsers("live");
   const allEntries = getAllDesktopEntries(data);
 
   // Filter OS
@@ -114,7 +116,7 @@ function filterByOSVersion(
 
 function addNotes(
   entry: DesktopEntry,
-  args: DesktopArgs,
+  args: DesktopSearchArgs,
   resolvedOS: string,
   resolvedBrowser: string,
 ): void {

src/tools/live-utils/mobile-filter.ts

@@ -1,7 +1,7 @@
-import { getBrowserStackData } from "../../lib/device-cache";
+import { getDevicesAndBrowsers } from "../../lib/device-cache";
 import { resolveVersion } from "./version-resolver";
 import { customFuzzySearch } from "../../lib/fuzzy";
-import { MobileArgs, MobileEntry } from "./types";
+import { MobileSearchArgs, MobileEntry } from "./types";
 
 // Extract all mobile entries from the data
 function getAllMobileEntries(data: any): MobileEntry[] {
@@ -79,8 +79,10 @@ function createVersionNote(
   return "";
 }
 
-export async function filterMobile(args: MobileArgs): Promise<MobileEntry> {
-  const data = await getBrowserStackData("live");
+export async function filterMobile(
+  args: MobileSearchArgs,
+): Promise<MobileEntry> {
+  const data = await getDevicesAndBrowsers("live");
   const allEntries = getAllMobileEntries(data);
 
   const osCandidates = filterByOS(allEntries, args.os);

src/tools/live-utils/start-session.ts

@@ -1,11 +1,10 @@
-import { sanitizeUrlParam } from "../../lib/utils";
 import logger from "../../logger";
 import childProcess from "child_process";
 import { filterDesktop } from "./desktop-filter";
 import { filterMobile } from "./mobile-filter";
 import {
-  DesktopArgs,
-  MobileArgs,
+  DesktopSearchArgs,
+  MobileSearchArgs,
   DesktopEntry,
   MobileEntry,
   PlatformType,
@@ -33,35 +32,39 @@ async function prepareLocalTunnel(url: string): Promise<boolean> {
  * Entrypoint: detects platformType & delegates.
  */
 export async function startBrowserSession(
-  args: DesktopArgs | MobileArgs,
+  args: DesktopSearchArgs | MobileSearchArgs,
 ): Promise<string> {
   const entry =
     args.platformType === PlatformType.DESKTOP
-      ? await filterDesktop(args as DesktopArgs)
-      : await filterMobile(args as MobileArgs);
+      ? await filterDesktop(args as DesktopSearchArgs)
+      : await filterMobile(args as MobileSearchArgs);
 
   const isLocal = await prepareLocalTunnel(args.url);
 
   const url =
     args.platformType === PlatformType.DESKTOP
-      ? buildDesktopUrl(args as DesktopArgs, entry as DesktopEntry, isLocal)
-      : buildMobileUrl(args as MobileArgs, entry as MobileEntry, isLocal);
+      ? buildDesktopUrl(
+          args as DesktopSearchArgs,
+          entry as DesktopEntry,
+          isLocal,
+        )
+      : buildMobileUrl(args as MobileSearchArgs, entry as MobileEntry, isLocal);
 
   openBrowser(url);
   return entry.notes ? `${url}, ${entry.notes}` : url;
 }
 
 function buildDesktopUrl(
-  args: DesktopArgs,
+  args: DesktopSearchArgs,
   e: DesktopEntry,
   isLocal: boolean,
 ): string {
   const params = new URLSearchParams({
-    os: sanitizeUrlParam(e.os),
-    os_version: sanitizeUrlParam(e.os_version),
-    browser: sanitizeUrlParam(e.browser),
-    browser_version: sanitizeUrlParam(e.browser_version),
-    url: sanitizeUrlParam(args.url),
+    os: e.os,
+    os_version: e.os_version,
+    browser: e.browser,
+    browser_version: e.browser_version,
+    url: args.url,
     scale_to_fit: "true",
     resolution: "responsive-mode",
     speed: "1",
@@ -72,7 +75,7 @@ function buildDesktopUrl(
 }
 
 function buildMobileUrl(
-  args: MobileArgs,
+  args: MobileSearchArgs,
   d: MobileEntry,
   isLocal: boolean,
 ): string {
@@ -84,11 +87,11 @@ function buildMobileUrl(
   const os = os_map[d.os as keyof typeof os_map] || d.os;
 
   const params = new URLSearchParams({
-    os: sanitizeUrlParam(os),
-    os_version: sanitizeUrlParam(d.os_version),
+    os: os,
+    os_version: d.os_version,
     device: d.display_name,
-    device_browser: sanitizeUrlParam(args.browser),
-    url: sanitizeUrlParam(args.url),
+    device_browser: args.browser,
+    url: args.url,
     scale_to_fit: "true",
     speed: "1",
     local: isLocal ? "true" : "false",

src/tools/live-utils/types.ts

@@ -1,4 +1,4 @@
-export interface DesktopArgs {
+export interface DesktopSearchArgs {
   platformType: "desktop";
   url: string;
   os: string;
@@ -15,7 +15,7 @@ export interface DesktopEntry {
   notes?: string;
 }
 
-export interface MobileArgs {
+export interface MobileSearchArgs {
   platformType: "mobile";
   url: string;
   os: string;