feat: prompt for app and site, added coverage

Author: jhefferman-sfdc

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');
@@ -86,6 +87,11 @@ export default class LightningDevApp extends SfCommand<void> {
     }
 
     logger.debug('Initalizing preview connection and configuring local web server identity');
+
+    if (await MetaUtils.handleLocalDevEnablement(targetOrg.getConnection(undefined))) {
+      this.log(sharedMessages.getMessage('localdev.enabled'));
+    }
+
     const { connection, ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(targetOrg);
 
     const platform = flags['device-type'] ?? (await PromptUtils.promptUserToSelectPlatform());

src/commands/lightning/dev/component.ts

@@ -75,29 +75,8 @@ export default class LightningDevComponent extends SfCommand<ComponentPreviewRes
     const targetOrg = flags['target-org'];
     const apiVersion = flags['api-version'];
 
-    // If local dev is not enabled, prompt the user to enable local dev
-    const setupConnection = targetOrg.getConnection(undefined);
-    const isLightningPreviewEnabled = await MetaUtils.isLightningPreviewEnabled(setupConnection);
-
-    if (!isLightningPreviewEnabled) {
-      const autoEnableLocalDev = process.env.AUTO_ENABLE_LOCAL_DEV;
-
-      // If executed via VSCode command, autoEnableLocalDev will contain the users choice, provided via UI.
-      // Else, prompt the user on the command line.
-      const enableLocalDev =
-        autoEnableLocalDev !== undefined
-          ? autoEnableLocalDev === 'true'
-          : await PromptUtils.promptUserToEnableLocalDev();
-
-      if (enableLocalDev) {
-        try {
-          await MetaUtils.setLightningPreviewEnabled(setupConnection, true);
-          await MetaUtils.ensureFirstPartyCookiesNotRequired(setupConnection);
-          this.log('Local dev has been enabled for this org.');
-        } catch (error) {
-          this.log('Error autoenabling local dev', error);
-        }
-      }
+    if (await MetaUtils.handleLocalDevEnablement(targetOrg.getConnection(undefined))) {
+      this.log(sharedMessages.getMessage('localdev.enabled'));
     }
 
     const { ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(targetOrg);

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');
@@ -67,9 +68,8 @@ export default class LightningDevSite extends SfCommand<void> {
 
       const connection = org.getConnection(undefined);
 
-      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.
  */
@@ -217,4 +220,36 @@ 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);
+
+    if (!isLightningPreviewEnabled) {
+      const autoEnableLocalDev = process.env.AUTO_ENABLE_LOCAL_DEV;
+
+      // If executed via VSCode command, autoEnableLocalDev will contain the users choice, provided via UI.
+      // Else, prompt the user on the command line.
+      const enableLocalDev =
+        autoEnableLocalDev !== undefined
+          ? autoEnableLocalDev === 'true'
+          : await PromptUtils.promptUserToEnableLocalDev();
+
+      if (enableLocalDev) {
+        await this.setLightningPreviewEnabled(connection, true);
+        await this.ensureFirstPartyCookiesNotRequired(connection);
+        return true;
+      } else {
+        throw new Error(sharedMessages.getMessage('error.localdev.not.enabled'));
+      }
+    }
+  }
 }

src/shared/previewUtils.ts

@@ -433,11 +433,6 @@ export class PreviewUtils {
       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);