feat: add ostype filter for device create command

Author: ben-zhang-at-salesforce

messages/device-list.md

@@ -2,6 +2,10 @@
 
 List the available virtual mobile devices for Lightning Web Component development.
 
+# flags.ostype.description
+
+Filter Android devices by operating system type. Use 'default' to show only default OS type devices, or 'all' to show all devices. This flag applies only to Android devices.
+
 # device.list.action
 
 Device List
@@ -14,3 +18,4 @@ generating list of supported devices
 
 - <%= config.bin %> <%= command.id %> -p ios
 - <%= config.bin %> <%= command.id %> -p android
+- <%= config.bin %> <%= command.id %> -p android --ostype default

src/cli/commands/force/lightning/local/device/list.ts

@@ -7,6 +7,7 @@
 
 import chalk from 'chalk';
 import archy from 'archy';
+import { Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { z } from 'zod';
 
@@ -19,7 +20,9 @@ import {
     CommandLineUtils,
     CommonUtils,
     FlagsConfigType,
-    PerformanceMarkers
+    PerformanceMarkers,
+    PlatformConfig,
+    Version
 } from '@salesforce/lwc-dev-mobile-core';
 import { DeviceListSchema } from '../../../../../schema/device.js';
 
@@ -35,7 +38,13 @@ export class List extends BaseCommand {
         ...CommandLineUtils.createFlag(FlagsConfigType.JsonFlag, false),
         ...CommandLineUtils.createFlag(FlagsConfigType.OutputFormatFlag, false),
         ...CommandLineUtils.createFlag(FlagsConfigType.LogLevelFlag, false),
-        ...CommandLineUtils.createFlag(FlagsConfigType.PlatformFlag, true)
+        ...CommandLineUtils.createFlag(FlagsConfigType.PlatformFlag, true),
+        ostype: Flags.string({
+            description: messages.getMessage('flags.ostype.description'),
+            required: false,
+            options: ['default', 'all'],
+            helpValue: 'default|all'
+        })
     };
 
     protected _commandName = 'force:lightning:local:device:list';
@@ -47,6 +56,11 @@ export class List extends BaseCommand {
         return this.flagValues.platform as string;
     }
 
+    private get ostype(): string | undefined {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        return this.flagValues.ostype as string | undefined;
+    }
+
     protected static getOutputSchema(): z.ZodTypeAny {
         return DeviceListSchema;
     }
@@ -62,9 +76,24 @@ export class List extends BaseCommand {
         }
         performance.mark(this.perfMarker.startMarkName);
 
-        const devices = CommandLineUtils.platformFlagIsAndroid(this.platform)
-            ? await new AndroidDeviceManager().enumerateDevices()
-            : await new AppleDeviceManager().enumerateDevices();
+        let devices: AndroidDevice[] | AppleDevice[] = [];
+
+        if (CommandLineUtils.platformFlagIsAndroid(this.platform)) {
+            if (this.ostype === undefined) {
+                devices = await new AndroidDeviceManager().enumerateDevices();
+            } else if (this.ostype === 'all') {
+                devices = await new AndroidDeviceManager().enumerateDevices(null);
+            } else if (this.ostype === 'default') {
+                devices = await new AndroidDeviceManager().enumerateDevices([
+                    {
+                        osType: 'default',
+                        minOSVersion: Version.from(PlatformConfig.androidConfig().minSupportedRuntime)!
+                    }
+                ]);
+            }
+        } else {
+            devices = await new AppleDeviceManager().enumerateDevices();
+        }
 
         performance.mark(this.perfMarker.endMarkName);
         if (!this.jsonEnabled()) {

test/unit/cli/commands/force/lightning/local/device/list.test.ts

@@ -18,6 +18,7 @@ import {
     CommonUtils,
     DeviceType,
     IOSUtils,
+    PlatformConfig,
     Version
 } from '@salesforce/lwc-dev-mobile-core';
 import { expect } from 'chai';
@@ -26,7 +27,7 @@ import { List } from '../../../../../../../../src/cli/commands/force/lightning/l
 describe('Device List Tests', () => {
     const $$ = new TestContext();
 
-    const androidDevice = new AndroidDevice(
+    const androidDeviceGoogleApi = new AndroidDevice(
         'Pixel_5_API_35',
         'Pixel 5 API 35',
         DeviceType.mobile,
@@ -35,6 +36,15 @@ describe('Device List Tests', () => {
         false
     );
 
+    const androidDeviceDefault = new AndroidDevice(
+        'Pixel_Default',
+        'Pixel Default',
+        DeviceType.mobile,
+        'default',
+        new Version(35, 0, 0),
+        false
+    );
+
     const appleDevice = new AppleDevice(
         '3627EBD5-E9EC-4EC4-8E89-C6A0232C920D',
         'iPhone 16',
@@ -59,18 +69,55 @@ describe('Device List Tests', () => {
 
     it('Lists Android emulators for cli mode', async () => {
         const enumerateMock = stubMethod($$.SANDBOX, AndroidDeviceManager.prototype, 'enumerateDevices').resolves([
-            androidDevice
+            androidDeviceGoogleApi
         ]);
         await List.run(['-p', 'android']);
 
         expect(enumerateMock.called).to.be.true;
         expect(startCliActionMock.called).to.be.true;
         expect(stopCliActionMock.called).to.be.true;
+
+        expect(enumerateMock.calledWith()).to.be.true;
+    });
+
+    it('Lists Android emulators with ostype flag set to default for cli mode', async () => {
+        const enumerateMock = stubMethod($$.SANDBOX, AndroidDeviceManager.prototype, 'enumerateDevices').resolves([
+            androidDeviceDefault,
+            androidDeviceGoogleApi
+        ]);
+        await List.run(['-p', 'android', '--ostype', 'default']);
+
+        expect(enumerateMock.called).to.be.true;
+        expect(startCliActionMock.called).to.be.true;
+        expect(stopCliActionMock.called).to.be.true;
+
+        expect(
+            enumerateMock.calledWith([
+                {
+                    osType: 'default',
+                    minOSVersion: Version.from(PlatformConfig.androidConfig().minSupportedRuntime)!
+                }
+            ])
+        ).to.be.true;
+    });
+
+    it('Lists Android emulators with ostype flag set to all for cli mode', async () => {
+        const enumerateMock = stubMethod($$.SANDBOX, AndroidDeviceManager.prototype, 'enumerateDevices').resolves([
+            androidDeviceDefault,
+            androidDeviceGoogleApi
+        ]);
+        await List.run(['-p', 'android', '--ostype', 'all']);
+
+        expect(enumerateMock.called).to.be.true;
+        expect(startCliActionMock.called).to.be.true;
+        expect(stopCliActionMock.called).to.be.true;
+
+        expect(enumerateMock.calledWith(null)).to.be.true;
     });
 
     it('Lists Android emulators for json mode', async () => {
         const enumerateMock = stubMethod($$.SANDBOX, AndroidDeviceManager.prototype, 'enumerateDevices').resolves([
-            androidDevice
+            androidDeviceGoogleApi
         ]);
         await List.run(['-p', 'android', '--json']);