feat: recent devices sort

Author: thymikee

packages/plugin-platform-apple/src/lib/commands/build/createBuild.ts

@@ -31,7 +31,12 @@ export const createBuild = async (
   normalizeArgs(args, xcodeProject);
 
   const { scheme, mode } = args.interactive
-    ? await selectFromInteractiveMode(xcodeProject, args.scheme, args.mode)
+    ? await selectFromInteractiveMode(
+        xcodeProject,
+        sourceDir,
+        args.scheme,
+        args.mode
+      )
     : await getConfiguration(
         xcodeProject,
         sourceDir,

packages/plugin-platform-apple/src/lib/commands/run/createRun.ts

@@ -20,6 +20,7 @@ import { selectFromInteractiveMode } from '../../utils/selectFromInteractiveMode
 import { outro, spinner } from '@clack/prompts';
 import { runOnMac } from './runOnMac.js';
 import { runOnMacCatalyst } from './runOnMacCatalyst.js';
+import { cacheRecentDevice } from './recentDevices.js';
 
 export const createRun = async (
   platformName: ApplePlatform,
@@ -40,7 +41,12 @@ export const createRun = async (
   normalizeArgs(args, projectRoot, xcodeProject);
 
   const { scheme, mode } = args.interactive
-    ? await selectFromInteractiveMode(xcodeProject, args.scheme, args.mode)
+    ? await selectFromInteractiveMode(
+        xcodeProject,
+        sourceDir,
+        args.scheme,
+        args.mode
+      )
     : await getConfiguration(
         xcodeProject,
         sourceDir,
@@ -75,9 +81,10 @@ export const createRun = async (
     );
   }
   loader.stop('Found available devices and simulators.');
-  const device = await selectDevice(devices, args, platformName);
+  const device = await selectDevice(devices, args, platformName, projectRoot);
 
   if (device) {
+    cacheRecentDevice(device, projectRoot, platformName);
     if (device.type === 'simulator') {
       await runOnSimulator(
         device,
@@ -108,8 +115,13 @@ export const createRun = async (
     if (bootedSimulators.length === 0) {
       // fallback to present all devices when no device is selected
       if (isInteractive()) {
-        const simulator = await promptForDeviceSelection(devices);
+        const simulator = await promptForDeviceSelection(
+          devices,
+          projectRoot,
+          platformName
+        );
         bootedSimulators.push(simulator);
+        cacheRecentDevice(simulator, projectRoot, platformName);
       } else {
         logger.debug(
           'No booted devices or simulators found. Launching first available simulator...'
@@ -146,12 +158,13 @@ export const createRun = async (
 async function selectDevice(
   devices: Device[],
   args: RunFlags,
-  platform: ApplePlatform
+  platform: ApplePlatform,
+  projectRoot: string
 ) {
   const { simulator, udid, interactive } = args;
   let device;
   if (interactive) {
-    device = await promptForDeviceSelection(devices);
+    device = await promptForDeviceSelection(devices, projectRoot, platform);
   } else if (udid) {
     device = devices.find((d) => d.udid === udid);
   } else if (args.device) {

packages/plugin-platform-apple/src/lib/commands/run/recentDevices.ts

@@ -0,0 +1,57 @@
+import path from 'node:path';
+import fs from 'node:fs';
+import { ApplePlatform, Device } from '../../types/index.js';
+import { cacheManager, logger } from '@callstack/rnef-tools';
+
+function getProjectNameFromPackageJson(projectRoot: string) {
+  const packageJsonPath = path.join(projectRoot, 'package.json');
+  return JSON.parse(fs.readFileSync(packageJsonPath, 'utf-8')).name;
+}
+
+export function cacheRecentDevice(
+  device: Device,
+  projectRoot: string,
+  platform: ApplePlatform
+) {
+  const cacheKey = 'recentDevicesUDID-' + platform;
+  const name = getProjectNameFromPackageJson(projectRoot);
+  try {
+    const recentDevices = getRecentDevices(projectRoot, platform);
+    const newRecentDevices = [device.udid, ...recentDevices];
+    const uniqueDevices = Array.from(new Set(newRecentDevices)).slice(0, 5);
+    cacheManager.set(name, cacheKey, JSON.stringify(uniqueDevices));
+  } catch (error) {
+    logger.debug(
+      `Failed to cache recent device ${device.name} with UDID ${device.udid}. ${error}`
+    );
+  }
+}
+
+function getRecentDevices(
+  projectRoot: string,
+  platform: ApplePlatform
+): string[] {
+  const cacheKey = 'recentDevicesUDID-' + platform;
+  const name = getProjectNameFromPackageJson(projectRoot);
+  const recentDevicesString = cacheManager.get(name, cacheKey);
+  try {
+    return recentDevicesString ? JSON.parse(recentDevicesString) : [];
+  } catch (error) {
+    logger.debug(`Failed to read recent devices from cache. ${error}`);
+    return [];
+  }
+}
+
+export function sortByRecentDevices(
+  devices: Device[],
+  projectRoot: string,
+  platform: ApplePlatform
+) {
+  const recentDevices = getRecentDevices(projectRoot, platform);
+  const udids = Array.from(
+    new Set([...recentDevices, ...devices.map(({ udid }) => udid)])
+  );
+  return udids
+    .map((udid) => devices.find((device) => device.udid === udid))
+    .filter(Boolean) as Device[];
+}

packages/plugin-platform-apple/src/lib/utils/__tests__/selectFromInteractiveMode.test.ts

@@ -49,6 +49,7 @@ describe('selectFromInteractiveMode', () => {
     };
     const result = await selectFromInteractiveMode(
       xcodeInfo,
+      '/path/to/TestApp/ios',
       'TestScheme',
       'Debug'
     );
@@ -75,6 +76,7 @@ describe('selectFromInteractiveMode', () => {
     };
     const result = await selectFromInteractiveMode(
       xcodeInfo,
+      '/path/to/TestApp/ios',
       'TestScheme',
       'Debug'
     );
@@ -103,6 +105,7 @@ describe('selectFromInteractiveMode', () => {
     };
     const result = await selectFromInteractiveMode(
       xcodeInfo,
+      '/path/to/TestApp/ios',
       'TestScheme',
       'Debug'
     );
@@ -130,6 +133,7 @@ describe('selectFromInteractiveMode', () => {
     };
     const result = await selectFromInteractiveMode(
       xcodeInfo,
+      '/path/to/TestApp/ios',
       'TestScheme',
       'Debug'
     );
@@ -150,23 +154,4 @@ describe('selectFromInteractiveMode', () => {
       `Automatically selected ${bold('Debug')} configuration.`
     );
   });
-
-  it('should handle undefined scheme and mode', async () => {
-    const result = await selectFromInteractiveMode({
-      scheme: undefined,
-      mode: undefined,
-      info: {
-        schemes: ['Scheme1', 'Scheme2'],
-        configurations: ['Debug', 'Release'],
-        name: 'TestApp',
-      },
-    });
-
-    expect(result).toEqual({
-      scheme: undefined,
-      mode: undefined,
-    });
-    expect(promptForSchemeSelection).not.toHaveBeenCalled();
-    expect(promptForConfigurationSelection).not.toHaveBeenCalled();
-  });
 });

packages/plugin-platform-apple/src/lib/utils/prompts.ts

@@ -1,7 +1,8 @@
 import { select } from '@clack/prompts';
 import color from 'picocolors';
 import { checkCancelPrompt } from '@callstack/rnef-tools';
-import { Device } from '../types/index.js';
+import { ApplePlatform, Device } from '../types/index.js';
+import { sortByRecentDevices } from '../commands/run/recentDevices.js';
 
 export async function promptForSchemeSelection(schemes: string[]) {
   return checkCancelPrompt<string>(
@@ -29,11 +30,16 @@ export async function promptForConfigurationSelection(
   );
 }
 
-export async function promptForDeviceSelection(devices: Device[]) {
+export async function promptForDeviceSelection(
+  devices: Device[],
+  projectRoot: string,
+  platformName: ApplePlatform
+) {
+  const sortedDevices = sortByRecentDevices(devices, projectRoot, platformName);
   return checkCancelPrompt<Device>(
     await select({
       message: 'Select the device / simulator you want to use',
-      options: devices.map((d) => {
+      options: sortedDevices.map((d) => {
         const markDevice = d.type === 'device' ? ` - (physical device)` : '';
         return {
           label: `${d.name} ${color.dim(`(${d.version})${markDevice}`)}`,

packages/plugin-platform-apple/src/lib/utils/selectFromInteractiveMode.ts

@@ -9,12 +9,12 @@ import { getInfo } from './getInfo.js';
 
 export async function selectFromInteractiveMode(
   xcodeProject: XcodeProjectInfo,
+  sourceDir: string,
   scheme: string,
   mode: string
 ): Promise<{ scheme: string; mode: string }> {
   let newScheme = scheme;
   let newMode = mode;
-  const sourceDir = process.cwd();
   const info = await getInfo(xcodeProject, sourceDir);
 
   const schemes = info?.schemes;