feat: prompt to enable local dev @W-20406426 #595 (#597)

* feat: prompt to enable local dev

* fix: re-added environment variable for VSCode command

* feat: prompt for app and site, added coverage

* fix: addressed review comments

* fix: api version missing

* fix: cookie disable separated

* fix: refactored connections so they are defined once

---------

Co-authored-by: Nicolas Kruk <nicolaskruk@gmail.com>

Author: jhefferman-sfdc

command-snapshot.json

@@ -4,7 +4,7 @@
     "command": "lightning:dev:app",
     "flagAliases": [],
     "flagChars": ["i", "n", "o", "t"],
-    "flags": ["device-id", "device-type", "flags-dir", "name", "target-org"],
+    "flags": ["api-version", "device-id", "device-type", "flags-dir", "name", "target-org"],
     "plugin": "@salesforce/plugin-lightning-dev"
   },
   {
@@ -20,7 +20,7 @@
     "command": "lightning:dev:site",
     "flagAliases": [],
     "flagChars": ["l", "n", "o"],
-    "flags": ["flags-dir", "get-latest", "guest", "name", "ssr", "target-org"],
+    "flags": ["api-version", "flags-dir", "get-latest", "guest", "name", "ssr", "target-org"],
     "plugin": "@salesforce/plugin-lightning-dev"
   }
 ]

messages/prompts.md

@@ -37,3 +37,7 @@ Unable to enumerate a list of available devices.
 # component.select
 
 Which Lightning Web Component would you like to preview (Use arrow keys)
+
+# component.enable-local-dev
+
+Local Dev isn't enabled for this org. Enable it?

messages/shared.utils.md

@@ -26,6 +26,10 @@ The SSL certificate data to be used by the local dev server for secure connectio
 
 You must provide valid SSL certificate data
 
+# localdev.enabled
+
+Local dev has been enabled for this org.
+
 # error.localdev.not.enabled
 
 Local Dev is not enabled for your org. See https://developer.salesforce.com/docs/platform/lwc/guide/get-started-test-components.html for more information on enabling and using Local Dev.

src/commands/lightning/dev/app.ts

@@ -29,6 +29,7 @@ import { Flags, SfCommand } from '@salesforce/sf-plugins-core';
 import { startLWCServer } from '../../../lwc-dev-server/index.js';
 import { PreviewUtils } from '../../../shared/previewUtils.js';
 import { PromptUtils } from '../../../shared/promptUtils.js';
+import { MetaUtils } from '../../../shared/metaUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.app');
@@ -68,6 +69,7 @@ export default class LightningDevApp extends SfCommand<void> {
       summary: messages.getMessage('flags.device-id.summary'),
       char: 'i',
     }),
+    'api-version': Flags.orgApiVersion(),
   };
 
   public async run(): Promise<void> {
@@ -77,6 +79,7 @@ export default class LightningDevApp extends SfCommand<void> {
     const targetOrg = flags['target-org'];
     const appName = flags['name'];
     const deviceId = flags['device-id'];
+    const apiVersion = flags['api-version'];
 
     let sfdxProjectRootPath = '';
     try {
@@ -86,7 +89,14 @@ export default class LightningDevApp extends SfCommand<void> {
     }
 
     logger.debug('Initalizing preview connection and configuring local web server identity');
-    const { connection, ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(targetOrg);
+
+    const connection = targetOrg.getConnection(apiVersion);
+
+    if (await MetaUtils.handleLocalDevEnablement(connection)) {
+      this.log(sharedMessages.getMessage('localdev.enabled'));
+    }
+
+    const { ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(connection);
 
     const platform = flags['device-type'] ?? (await PromptUtils.promptUserToSelectPlatform());
 

src/commands/lightning/dev/component.ts

@@ -75,17 +75,13 @@ export default class LightningDevComponent extends SfCommand<ComponentPreviewRes
     const targetOrg = flags['target-org'];
     const apiVersion = flags['api-version'];
 
-    // Auto enable local dev
-    if (process.env.AUTO_ENABLE_LOCAL_DEV === 'true') {
-      try {
-        await MetaUtils.ensureLightningPreviewEnabled(targetOrg.getConnection(undefined));
-        await MetaUtils.ensureFirstPartyCookiesNotRequired(targetOrg.getConnection(undefined));
-      } catch (error) {
-        this.log('Error autoenabling local dev', error);
-      }
+    const connection = targetOrg.getConnection(apiVersion);
+
+    if (await MetaUtils.handleLocalDevEnablement(connection)) {
+      this.log(sharedMessages.getMessage('localdev.enabled'));
     }
 
-    const { ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(targetOrg);
+    const { ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(connection);
 
     logger.debug('Determining the next available port for Local Dev Server');
     const serverPorts = await PreviewUtils.getNextAvailablePorts();
@@ -171,9 +167,6 @@ export default class LightningDevComponent extends SfCommand<ComponentPreviewRes
       targetOrgArg
     );
 
-    // Construct and log the full URL that will be opened
-    const connection = targetOrg.getConnection(apiVersion);
-
     // strip trailing slashes
     const instanceUrl = connection.instanceUrl.replace(/\/$/, '');
 

src/commands/lightning/dev/site.ts

@@ -24,6 +24,7 @@ import { PromptUtils } from '../../../shared/promptUtils.js';
 import { ExperienceSite } from '../../../shared/experience/expSite.js';
 import { PreviewUtils } from '../../../shared/previewUtils.js';
 import { startLWCServer } from '../../../lwc-dev-server/index.js';
+import { MetaUtils } from '../../../shared/metaUtils.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.site');
@@ -53,6 +54,7 @@ export default class LightningDevSite extends SfCommand<void> {
       summary: messages.getMessage('flags.ssr.summary'),
       default: false,
     }),
+    'api-version': Flags.orgApiVersion(),
   };
 
   public async run(): Promise<void> {
@@ -61,15 +63,15 @@ export default class LightningDevSite extends SfCommand<void> {
     try {
       const org = flags['target-org'];
       const getLatest = flags['get-latest'];
+      const apiVersion = flags['api-version'];
       const guest = flags.guest;
       const ssr = flags.ssr;
       let siteName = flags.name;
 
-      const connection = org.getConnection(undefined);
+      const connection = org.getConnection(apiVersion);
 
-      const localDevEnabled = await OrgUtils.isLocalDevEnabled(connection);
-      if (!localDevEnabled) {
-        throw new Error(sharedMessages.getMessage('error.localdev.not.enabled'));
+      if (await MetaUtils.handleLocalDevEnablement(connection)) {
+        this.log(sharedMessages.getMessage('localdev.enabled'));
       }
 
       OrgUtils.ensureMatchingAPIVersion(connection);

src/shared/metaUtils.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import { Connection, Logger } from '@salesforce/core';
+import { Connection, Logger, Messages } from '@salesforce/core';
+import { PromptUtils } from './promptUtils.js';
 
 type LightningExperienceSettingsMetadata = {
   [key: string]: unknown;
@@ -34,6 +35,8 @@ type MetadataUpdateResult = {
   errors?: Array<{ message: string }>;
 };
 
+const sharedMessages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'shared.utils');
+
 /**
  * Utility class for managing Salesforce metadata settings related to Lightning Development.
  */
@@ -199,25 +202,6 @@ export class MetaUtils {
     this.logger.debug('Successfully updated first-party cookie requirement');
   }
 
-  /**
-   * Ensures Lightning Preview is enabled for the org. If it's not enabled, this method will enable it.
-   *
-   * @param connection the connection to the org
-   * @returns boolean indicating whether Lightning Preview was already enabled (true) or had to be enabled (false)
-   */
-  public static async ensureLightningPreviewEnabled(connection: Connection): Promise<boolean> {
-    const isEnabled = await this.isLightningPreviewEnabled(connection);
-
-    if (!isEnabled) {
-      this.logger.info('Lightning Preview is not enabled. Enabling it now...');
-      await this.setLightningPreviewEnabled(connection, true);
-      return false;
-    }
-
-    this.logger.debug('Lightning Preview is already enabled');
-    return true;
-  }
-
   /**
    * Ensures first-party cookies are not required for the org. If they are required, this method will disable the requirement.
    *
@@ -236,4 +220,38 @@ export class MetaUtils {
     this.logger.debug('First-party cookies are not required');
     return true;
   }
+
+  /**
+   * Enables local dev if required and permitted. If executed via VSCode command
+   * the user's response is already assigned to AUTO_ENABLE_LOCAL_DEV and it will be used.
+   * If executed via command line, this method will prompt the user.
+   *
+   * @param connection the connection to the org
+   * @returns true if enabled
+   * @throws local dev not enabled error if not enabled
+   */
+  public static async handleLocalDevEnablement(connection: Connection): Promise<boolean | undefined> {
+    const isLightningPreviewEnabled = await this.isLightningPreviewEnabled(connection);
+    const isAutoEnableLocalDevDefined = process.env.AUTO_ENABLE_LOCAL_DEV !== undefined;
+    const autoEnableLocalDev = process.env.AUTO_ENABLE_LOCAL_DEV === 'true';
+
+    // Cookies changes are only needed for VSCode
+    if (autoEnableLocalDev) {
+      await this.ensureFirstPartyCookiesNotRequired(connection);
+    }
+    if (!isLightningPreviewEnabled) {
+      // If executed via VSCode command, autoEnableLocalDev will contain the users choice, provided via UI.
+      // Else, prompt the user on the command line.
+      const enableLocalDev = isAutoEnableLocalDevDefined
+        ? autoEnableLocalDev
+        : await PromptUtils.promptUserToEnableLocalDev();
+
+      if (enableLocalDev) {
+        await this.setLightningPreviewEnabled(connection, true);
+        return true;
+      } else {
+        throw new Error(sharedMessages.getMessage('error.localdev.not.enabled'));
+      }
+    }
+  }
 }

src/shared/previewUtils.ts

@@ -22,7 +22,7 @@
 import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
-import { Connection, Logger, Messages, Org } from '@salesforce/core';
+import { Connection, Logger, Messages } from '@salesforce/core';
 import {
   AndroidDeviceManager,
   AppleDeviceManager,
@@ -426,18 +426,12 @@ export class PreviewUtils {
     });
   }
 
-  public static async initializePreviewConnection(targetOrg: Org): Promise<PreviewConnection> {
-    const connection = targetOrg.getConnection(undefined);
+  public static async initializePreviewConnection(connection: Connection): Promise<PreviewConnection> {
     const username = connection.getUsername();
     if (!username) {
       return Promise.reject(new Error(sharedMessages.getMessage('error.username')));
     }
 
-    const localDevEnabled = await OrgUtils.isLocalDevEnabled(connection);
-    if (!localDevEnabled) {
-      return Promise.reject(new Error(sharedMessages.getMessage('error.localdev.not.enabled')));
-    }
-
     OrgUtils.ensureMatchingAPIVersion(connection);
 
     const appServerIdentity = await PreviewUtils.getOrCreateAppServerIdentity(connection);

src/shared/promptUtils.ts

@@ -114,6 +114,13 @@ export class PromptUtils {
     return response;
   }
 
+  public static async promptUserToEnableLocalDev(): Promise<boolean> {
+    return confirm({
+      message: messages.getMessage('component.enable-local-dev'),
+      default: true,
+    });
+  }
+
   // returns the shorthand version of a Version object (eg. 17.0.0 => 17, 17.4.0 => 17.4, 17.4.1 => 17.4.1)
   private static getShortVersion(version: Version | string): string {
     // TODO: consider making this function part of the Version class in @lwc-dev-mobile-core