feat: prompt user to select device type (#195)

* chore: some refactoring

* feat: prompt user to select device type

* chore: address PR feadback

Author: maliroteh-sf

messages/prompts.md

@@ -0,0 +1,23 @@
+# site.select
+
+Select a site
+
+# site.confirm-update
+
+An updated site bundle is available for "%s". Do you want to download and apply the update?
+
+# device-type.title
+
+Which device type do you want to use for the preview?
+
+# device-type.choice.desktop
+
+Desktop
+
+# device-type.choice.android
+
+Mobile - Android
+
+# device-type.choice.ios
+
+Mobile - iOS

src/commands/lightning/dev/app.ts

@@ -6,7 +6,7 @@
  */
 
 import path from 'node:path';
-import { Connection, Logger, Messages, SfProject } from '@salesforce/core';
+import { Logger, Messages, SfProject } from '@salesforce/core';
 import {
   AndroidAppPreviewConfig,
   AndroidDevice,
@@ -20,7 +20,7 @@ import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
 import { OrgUtils } from '../../../shared/orgUtils.js';
 import { startLWCServer } from '../../../lwc-dev-server/index.js';
 import { PreviewUtils } from '../../../shared/previewUtils.js';
-import { ConfigUtils, IdentityTokenService } from '../../../shared/configUtils.js';
+import { PromptUtils } from '../../../shared/promptUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.app');
@@ -39,22 +39,6 @@ export const androidSalesforceAppPreviewConfig = {
 
 const maxInt32 = 2_147_483_647; // maximum 32-bit signed integer value
 
-class AppServerIdentityTokenService implements IdentityTokenService {
-  private connection: Connection;
-  public constructor(connection: Connection) {
-    this.connection = connection;
-  }
-
-  public async saveTokenToServer(token: string): Promise<string> {
-    const sobject = this.connection.sobject('UserLocalWebServerIdentity');
-    const result = await sobject.insert({ LocalWebServerIdentityToken: token });
-    if (result.success) {
-      return result.id;
-    }
-    throw new Error('Could not save the token to the server');
-  }
-}
-
 export default class LightningDevApp extends SfCommand<void> {
   public static readonly summary = messages.getMessage('summary');
   public static readonly description = messages.getMessage('description');
@@ -71,7 +55,6 @@ export default class LightningDevApp extends SfCommand<void> {
       summary: messages.getMessage('flags.device-type.summary'),
       char: 't',
       options: [Platform.desktop, Platform.ios, Platform.android] as const,
-      default: Platform.desktop,
     })(),
     'device-id': Flags.string({
       summary: messages.getMessage('flags.device-id.summary'),
@@ -83,9 +66,9 @@ export default class LightningDevApp extends SfCommand<void> {
     const { flags } = await this.parse(LightningDevApp);
     const logger = await Logger.child(this.ctor.name);
 
-    const appName = flags['name'];
-    const platform = flags['device-type'];
     const targetOrg = flags['target-org'];
+    const appName = flags['name'];
+    const platform = flags['device-type'] ?? (await PromptUtils.promptUserToSelectPlatform());
     const deviceId = flags['device-id'];
 
     let sfdxProjectRootPath = '';
@@ -107,8 +90,12 @@ export default class LightningDevApp extends SfCommand<void> {
       return Promise.reject(new Error(sharedMessages.getMessage('error.localdev.not.enabled')));
     }
 
-    const tokenService = new AppServerIdentityTokenService(connection);
-    const token = await ConfigUtils.getOrCreateIdentityToken(username, tokenService);
+    const appServerIdentity = await PreviewUtils.getOrCreateAppServerIdentity(connection);
+    const ldpServerToken = appServerIdentity.identityToken;
+    const ldpServerId = appServerIdentity.usernameToServerEntityIdMap[username];
+    if (!ldpServerId) {
+      return Promise.reject(new Error(messages.getMessage('error.identitydata.entityid')));
+    }
 
     let appId: string | undefined;
     if (appName) {
@@ -132,17 +119,23 @@ export default class LightningDevApp extends SfCommand<void> {
     const ldpServerUrl = PreviewUtils.generateWebSocketUrlForLocalDevServer(platform, serverPorts, logger);
     logger.debug(`Local Dev Server url is ${ldpServerUrl}`);
 
-    const entityId = await PreviewUtils.getEntityId(username);
-
     if (platform === Platform.desktop) {
-      await this.desktopPreview(sfdxProjectRootPath, serverPorts, token, entityId, ldpServerUrl, appId, logger);
+      await this.desktopPreview(
+        sfdxProjectRootPath,
+        serverPorts,
+        ldpServerToken,
+        ldpServerId,
+        ldpServerUrl,
+        appId,
+        logger
+      );
     } else {
       await this.mobilePreview(
         platform,
         sfdxProjectRootPath,
         serverPorts,
-        token,
-        entityId,
+        ldpServerToken,
+        ldpServerId,
         ldpServerUrl,
         appName,
         appId,
@@ -155,8 +148,8 @@ export default class LightningDevApp extends SfCommand<void> {
   private async desktopPreview(
     sfdxProjectRootPath: string,
     serverPorts: { httpPort: number; httpsPort: number },
-    token: string,
-    entityId: string,
+    ldpServerToken: string,
+    ldpServerId: string,
     ldpServerUrl: string,
     appId: string | undefined,
     logger: Logger
@@ -191,13 +184,13 @@ export default class LightningDevApp extends SfCommand<void> {
 
     const launchArguments = PreviewUtils.generateDesktopPreviewLaunchArguments(
       ldpServerUrl,
-      entityId,
+      ldpServerId,
       appId,
       targetOrg
     );
 
     // Start the LWC Dev Server
-    await startLWCServer(logger, sfdxProjectRootPath, token, Platform.desktop, serverPorts);
+    await startLWCServer(logger, sfdxProjectRootPath, ldpServerToken, Platform.desktop, serverPorts);
 
     // Open the browser and navigate to the right page
     await this.config.runCommand('org:open', launchArguments);
@@ -207,8 +200,8 @@ export default class LightningDevApp extends SfCommand<void> {
     platform: Platform.ios | Platform.android,
     sfdxProjectRootPath: string,
     serverPorts: { httpPort: number; httpsPort: number },
-    token: string,
-    entityId: string,
+    ldpServerToken: string,
+    ldpServerId: string,
     ldpServerUrl: string,
     appName: string | undefined,
     appId: string | undefined,
@@ -304,14 +297,13 @@ export default class LightningDevApp extends SfCommand<void> {
       }
 
       // Start the LWC Dev Server
-
-      await startLWCServer(logger, sfdxProjectRootPath, token, platform, serverPorts, certData);
+      await startLWCServer(logger, sfdxProjectRootPath, ldpServerToken, platform, serverPorts, certData);
 
       // Launch the native app for previewing (launchMobileApp will show its own spinner)
       // eslint-disable-next-line camelcase
       appConfig.launch_arguments = PreviewUtils.generateMobileAppPreviewLaunchArguments(
         ldpServerUrl,
-        entityId,
+        ldpServerId,
         appName,
         appId
       );

src/commands/lightning/dev/site.ts

@@ -9,7 +9,7 @@ import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
 import { Messages } from '@salesforce/core';
 import { expDev } from '@lwrjs/api';
 import { OrgUtils } from '../../../shared/orgUtils.js';
-import { PromptUtils } from '../../../shared/prompt.js';
+import { PromptUtils } from '../../../shared/promptUtils.js';
 import { ExperienceSite } from '../../../shared/experience/expSite.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);

src/shared/configUtils.ts

@@ -6,14 +6,10 @@
  */
 
 import { Workspace } from '@lwc/lwc-dev-server';
-import { CryptoUtils, SSLCertificateData } from '@salesforce/lwc-dev-mobile-core';
+import { SSLCertificateData } from '@salesforce/lwc-dev-mobile-core';
 import { Config, ConfigAggregator } from '@salesforce/core';
 import configMeta, { ConfigVars, SerializedSSLCertificateData } from './../configMeta.js';
 
-export type IdentityTokenService = {
-  saveTokenToServer(token: string): Promise<string>;
-};
-
 export const LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT = 8081;
 export const LOCAL_DEV_SERVER_DEFAULT_WORKSPACE = Workspace.SfCli;
 
@@ -44,27 +40,16 @@ export class ConfigUtils {
     return this.#globalConfig;
   }
 
-  public static async getOrCreateIdentityToken(username: string, tokenService: IdentityTokenService): Promise<string> {
-    let identityData = await this.getIdentityData();
-    if (!identityData) {
-      const token = CryptoUtils.generateIdentityToken();
-      const entityId = await tokenService.saveTokenToServer(token);
-      identityData = {
-        identityToken: token,
-        usernameToServerEntityIdMap: {},
-      };
-      identityData.usernameToServerEntityIdMap[username] = entityId;
-      await this.writeIdentityData(identityData);
-      return token;
-    } else {
-      let entityId = identityData.usernameToServerEntityIdMap[username];
-      if (!entityId) {
-        entityId = await tokenService.saveTokenToServer(identityData.identityToken);
-        identityData.usernameToServerEntityIdMap[username] = entityId;
-        await this.writeIdentityData(identityData);
-      }
-      return identityData.identityToken;
+  public static async getIdentityData(): Promise<LocalWebServerIdentityData | undefined> {
+    const config = await ConfigAggregator.create({ customConfigMeta: configMeta });
+    // Need to reload to make sure the values read are decrypted
+    await config.reload();
+    const identityJson = config.getPropertyValue(ConfigVars.LOCAL_WEB_SERVER_IDENTITY_DATA);
+
+    if (identityJson) {
+      return JSON.parse(identityJson as string) as LocalWebServerIdentityData;
     }
+    return undefined;
   }
 
   public static async writeIdentityData(identityData: LocalWebServerIdentityData): Promise<void> {
@@ -117,16 +102,4 @@ export class ConfigUtils {
 
     return configWorkspace;
   }
-
-  public static async getIdentityData(): Promise<LocalWebServerIdentityData | undefined> {
-    const config = await ConfigAggregator.create({ customConfigMeta: configMeta });
-    // Need to reload to make sure the values read are decrypted
-    await config.reload();
-    const identityJson = config.getPropertyValue(ConfigVars.LOCAL_WEB_SERVER_IDENTITY_DATA);
-
-    if (identityJson) {
-      return JSON.parse(identityJson as string) as LocalWebServerIdentityData;
-    }
-    return undefined;
-  }
 }

src/shared/orgUtils.ts

@@ -55,4 +55,20 @@ export class OrgUtils {
     const localDevEnabled = flagValue.toLowerCase().trim() === 'true';
     return localDevEnabled;
   }
+
+  /**
+   * Saves an app server identity token to the UserLocalWebServerIdentity sObject in the org.
+   *
+   * @param connection the connection to the org
+   * @param token the token value to be saved
+   * @returns the id of the saved record
+   */
+  public static async saveAppServerIdentityToken(connection: Connection, token: string): Promise<string> {
+    const sobject = connection.sobject('UserLocalWebServerIdentity');
+    const result = await sobject.insert({ LocalWebServerIdentityToken: token });
+    if (result.success) {
+      return result.id;
+    }
+    throw new Error('Could not save the app server identity token to the org.');
+  }
 }

src/shared/previewUtils.ts

@@ -13,7 +13,7 @@
 import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
-import { Logger, Messages } from '@salesforce/core';
+import { Connection, Logger, Messages } from '@salesforce/core';
 import {
   AndroidDeviceManager,
   AppleDeviceManager,
@@ -27,7 +27,8 @@ import {
 } from '@salesforce/lwc-dev-mobile-core';
 import { Progress, Spinner } from '@salesforce/sf-plugins-core';
 import fetch from 'node-fetch';
-import { ConfigUtils, LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT } from './configUtils.js';
+import { ConfigUtils, LOCAL_DEV_SERVER_DEFAULT_HTTP_PORT, LocalWebServerIdentityData } from './configUtils.js';
+import { OrgUtils } from './orgUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.app');
@@ -111,15 +112,15 @@ export class PreviewUtils {
    * Generates the proper set of arguments to be used for launching desktop browser and navigating to the right location.
    *
    * @param ldpServerUrl The URL for the local dev server
-   * @param entityId Record ID for the identity token
+   * @param ldpServerId Record ID for the identity token
    * @param appId An optional app id for a targeted LEX app
    * @param targetOrg An optional org id
    * @param auraMode An optional Aura Mode (defaults to DEVPREVIEW)
    * @returns Array of arguments to be used by Org:Open command for launching desktop browser
    */
   public static generateDesktopPreviewLaunchArguments(
     ldpServerUrl: string,
-    entityId: string,
+    ldpServerId: string,
     appId?: string,
     targetOrg?: string,
     auraMode = DevPreviewAuraMode
@@ -134,7 +135,7 @@ export class PreviewUtils {
     // we prepend a '0.' to all of the params to ensure they will persist across browser redirects
     const launchArguments = [
       '--path',
-      `${appPath}?0.aura.ldpServerUrl=${ldpServerUrl}&0.aura.ldpServerId=${entityId}&0.aura.mode=${auraMode}`,
+      `${appPath}?0.aura.ldpServerUrl=${ldpServerUrl}&0.aura.ldpServerId=${ldpServerId}&0.aura.mode=${auraMode}`,
     ];
 
     if (targetOrg) {
@@ -148,15 +149,15 @@ export class PreviewUtils {
    * Generates the proper set of arguments to be used for launching a mobile app with custom launch arguments.
    *
    * @param ldpServerUrl The URL for the local dev server
-   * @param entityId Record ID for the identity token
+   * @param ldpServerId Record ID for the identity token
    * @param appName An optional app name for a targeted LEX app
    * @param appId An optional app id for a targeted LEX app
    * @param auraMode An optional Aura Mode (defaults to DEVPREVIEW)
    * @returns Array of arguments to be used as custom launch arguments when launching a mobile app.
    */
   public static generateMobileAppPreviewLaunchArguments(
     ldpServerUrl: string,
-    entityId: string,
+    ldpServerId: string,
     appName?: string,
     appId?: string,
     auraMode = DevPreviewAuraMode
@@ -175,7 +176,7 @@ export class PreviewUtils {
 
     launchArguments.push({ name: 'aura.mode', value: auraMode });
 
-    launchArguments.push({ name: 'aura.ldpServerId', value: entityId });
+    launchArguments.push({ name: 'aura.ldpServerId', value: ldpServerId });
 
     return launchArguments;
   }
@@ -292,18 +293,28 @@ export class PreviewUtils {
     });
   }
 
-  public static async getEntityId(username: string): Promise<string> {
-    const identityData = await ConfigUtils.getIdentityData();
-    let entityId: string | undefined;
+  public static async getOrCreateAppServerIdentity(connection: Connection): Promise<LocalWebServerIdentityData> {
+    const username = connection.getUsername()!;
+
+    let identityData = await ConfigUtils.getIdentityData();
     if (!identityData) {
-      return Promise.reject(new Error(messages.getMessage('error.identitydata')));
+      const token = CryptoUtils.generateIdentityToken();
+      const entityId = await OrgUtils.saveAppServerIdentityToken(connection, token);
+      identityData = {
+        identityToken: token,
+        usernameToServerEntityIdMap: {},
+      };
+      identityData.usernameToServerEntityIdMap[username] = entityId;
+      await ConfigUtils.writeIdentityData(identityData);
     } else {
-      entityId = identityData.usernameToServerEntityIdMap[username];
+      let entityId = identityData.usernameToServerEntityIdMap[username];
       if (!entityId) {
-        return Promise.reject(new Error(messages.getMessage('error.identitydata.entityid')));
+        entityId = await OrgUtils.saveAppServerIdentityToken(connection, identityData.identityToken);
+        identityData.usernameToServerEntityIdMap[username] = entityId;
+        await ConfigUtils.writeIdentityData(identityData);
       }
-      return entityId;
     }
+    return identityData;
   }
 
   private static async doGetNextAvailablePort(startingPort: number): Promise<number> {