temp changes

Author: nrkruk

src/commands/lightning/dev/site.ts

@@ -6,12 +6,12 @@
  */
 import fs from 'node:fs';
 import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
-import { Messages } from '@salesforce/core';
+import { Logger, Messages } from '@salesforce/core';
 import { expDev, SitesLocalDevOptions, setupDev } from '@lwrjs/api';
 import { OrgUtils } from '../../../shared/orgUtils.js';
 import { PromptUtils } from '../../../shared/promptUtils.js';
 import { ExperienceSite } from '../../../shared/experience/expSite.js';
-import 'dotenv/config';
+import { getExperienceSiteConfig } from '../../../shared/experience/expSiteConfig.js';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.site');
@@ -37,6 +37,7 @@ export default class LightningDevSite extends SfCommand<void> {
 
   public async run(): Promise<void> {
     const { flags } = await this.parse(LightningDevSite);
+    const logger = await Logger.child(this.ctor.name);
 
     try {
       const org = flags['target-org'];
@@ -52,6 +53,9 @@ export default class LightningDevSite extends SfCommand<void> {
 
       OrgUtils.ensureMatchingAPIVersion(connection);
 
+      // Load up any environment configuration
+      const config = getExperienceSiteConfig();
+
       // If user doesn't specify a site, prompt the user for one
       if (!siteName) {
         const allSites = await ExperienceSite.getAllExpSites(org);
@@ -85,24 +89,20 @@ export default class LightningDevSite extends SfCommand<void> {
       // Establish a valid access token for this site
       const authToken = await selectedSite.setupAuth();
 
-      // Start the dev server
-      const port = parseInt(process.env.PORT ?? '3000', 10);
-
-      const logLevel = process.env.LOG_LEVEL ?? 'error';
-
+      // Start the dev server w/ configured parameters
       const startupParams: SitesLocalDevOptions = {
-        sfCLI: process.env.INTERNAL_DEVELOPER_MODE !== 'true',
+        sfCLI: !config.lwcConfigEnabled,
         authToken,
-        open: process.env.OPEN_BROWSER === 'false' ? false : true,
-        port,
-        logLevel,
+        open: config.openBrowser,
+        port: config.port,
+        logLevel: config.logLevel,
         mode: 'dev',
         siteZip,
         siteDir: selectedSite.getSiteDirectory(),
       };
 
       // Environment variable used to setup the site rather than setup & start server
-      if (process.env.SETUP_ONLY === 'true') {
+      if (config.setupOnly) {
         await setupDev(startupParams);
         this.log('[local-dev] setup complete!');
       } else {
@@ -111,7 +111,7 @@ export default class LightningDevSite extends SfCommand<void> {
       }
     } catch (e) {
       this.spinner.stop('failed.');
-      this.log('Local Development setup failed', e);
+      logger.error('Local Development setup failed', e);
     }
   }
 }

src/shared/experience/expSite.ts

@@ -314,6 +314,8 @@ export class ExperienceSite {
     this.logger.debug('Checking if site is set up');
     const ssrJsPath = path.join(this.getExtractDirectory(), 'ssr.js');
 
+    // Verifies that we have an extracted site at the expected location
+    // Verifies that our site metadata is the latest
     if (fs.existsSync(ssrJsPath)) {
       this.logger.debug('ssr.js file exists, checking metadata');
       const metadata = await this.getLocalMetadata();
@@ -686,7 +688,7 @@ export class ExperienceSite {
     this.logger.debug(`Resource will be saved to: ${resourcePath}`);
 
     try {
-      const apiUrl = `${instanceUrl}/services/data/${this.config.apiVersion}/sites/${siteIdMinus3}/preview${this.apiQueryParams}`;
+      const apiUrl = `${instanceUrl}/services/data/v${conn.version}/sites/${siteIdMinus3}/preview${this.apiQueryParams}`;
       this.logger.debug(`API URL: ${apiUrl}`);
 
       this.logger.debug('Sending API request');

src/shared/experience/expSiteConfig.ts

@@ -4,22 +4,48 @@
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
+/* eslint-disable no-console */
+// import { Logger } from '@salesforce/core';
 import 'dotenv/config';
 
 export type ExperienceSiteConfig = {
   previewUser: string;
   previewToken: string;
   apiStaticMode: boolean;
   apiBundlingGroups: boolean;
-  apiVersion: string;
   apiSiteVersion: string;
+  logLevel: string;
+  port: number;
+  openBrowser: boolean;
+  lwcConfigEnabled: boolean;
+  setupOnly: boolean;
 };
 
+/**
+ * Environment variables that are considered experimental
+ */
+const EXPERIMENTAL_ENV_VARS = [
+  'PREVIEW_USER',
+  'SID_TOKEN',
+  'API_STATIC_MODE',
+  'API_BUNDLING_GROUPS',
+  'API_SITE_VERSION',
+  'SETUP_ONLY',
+  'LWC_CONFIG_ENABLED',
+];
+
+/**
+ * Experimental configuration options for Experience Sites local development
+ *
+ */
 export class ExperienceSiteConfigManager {
   private static instance: ExperienceSiteConfigManager;
   private config: ExperienceSiteConfig;
 
   private constructor() {
+    // Show a warning
+    checkExperimentalConfig();
+
     // Backwards Compat
     if (process.env.SITE_GUEST_ACCESS === 'true') {
       process.env.PREVIEW_USER = 'Guest';
@@ -28,13 +54,29 @@ export class ExperienceSiteConfigManager {
       process.env.PREVIEW_USER = 'Custom';
     }
 
+    // Experimental configuration values
     this.config = {
-      previewUser: process.env.PREVIEW_USER ?? 'Admin',
-      previewToken: process.env.SID_TOKEN ?? '',
-      apiStaticMode: process.env.API_STATIC_MODE === 'true' ? true : false,
-      apiBundlingGroups: process.env.API_BUNDLING_GROUPS === 'true' ? true : false,
-      apiVersion: process.env.API_VERSION ?? 'v64.0',
-      apiSiteVersion: process.env.API_SITE_VERSION ?? 'published',
+      // what user to preview site with
+      previewUser: process.env.PREVIEW_USER ?? 'Admin', // Default: Admin
+      // Override the authentication token for this user
+      previewToken: process.env.SID_TOKEN ?? '', // Default: No Override (empty string)
+      // download from static resources instead of the API
+      apiStaticMode: process.env.API_STATIC_MODE === 'true' ? true : false, // Default: false
+      // use bundling groups or not - testing purposes only
+      apiBundlingGroups: process.env.API_BUNDLING_GROUPS === 'true' ? true : false, // Default: false
+      // What version of the API to use
+      apiSiteVersion: process.env.API_SITE_VERSION ?? 'published', // Default: published
+      // Log level supplied to the LWR server
+      logLevel: process.env.LOG_LEVEL ?? 'error', // Default: error
+      // Port to run the LWR server
+      port: parseInt(process.env.PORT ?? '3000', 10), // Default: 3000
+      // Should we automatically open the browser?
+      openBrowser: process.env.OPEN_BROWSER === 'false' ? false : true, // Default: true
+      // Enable lwc module resolution outside the context of SFDX
+      lwcConfigEnabled: process.env.LWC_CONFIG_ENABLED === 'true' ? true : false, // Default: false
+      // Skip running the server, just setup the site
+      setupOnly: process.env.SETUP_ONLY === 'true' ? true : false, // Default: false
+      // TODO Add option for running the site in preview only mode (no local changes included)
     };
   }
 
@@ -80,3 +122,21 @@ export class ExperienceSiteConfigManager {
 export function getExperienceSiteConfig(): ExperienceSiteConfig {
   return ExperienceSiteConfigManager.getInstance().getConfig();
 }
+
+/**
+ * Checks if any experimental environment variables are set and logs a warning if so.
+ * The warning is only shown once per command execution.
+ */
+export function checkExperimentalConfig(): void {
+  // Check if any experimental env vars are set
+  const usedEnvVars = EXPERIMENTAL_ENV_VARS.filter((envVar) => process.env[envVar] !== undefined);
+
+  if (usedEnvVars.length > 0) {
+    // Log a warning
+    console.warn('\x1b[33m%s\x1b[0m', '⚠️ EXPERIMENTAL CONFIGURATION OPTIONS DETECTED ⚠️');
+    console.warn(
+      '\x1b[33m%s\x1b[0m',
+      'These configuration options are experimental and may change without notice. Please refer to the official documentation for supported options.'
+    );
+  }
+}

src/shared/logUtils.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2024, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+/* eslint-disable no-console */
+
+class Logger {
+  public static info(message: unknown): void {
+    console.log(Logger.formatMessage('36', 'ℹ️ INFO:', message)); // Cyan
+  }
+
+  public static warn(message: unknown): void {
+    console.warn(Logger.formatMessage('33', '⚠️ WARN:', message)); // Yellow
+  }
+
+  public static error(message: unknown): void {
+    console.error(Logger.formatMessage('31', '❌ ERROR:', message)); // Red
+  }
+
+  public static debug(message: unknown): void {
+    console.debug(Logger.formatMessage('2', '🐛 DEBUG:', message)); // Dim
+  }
+
+  public static success(message: unknown): void {
+    console.log(Logger.formatMessage('32', '✅ SUCCESS:', message)); // Green
+  }
+
+  private static formatMessage(color: string, label: string, message: unknown): string {
+    return `\x1b[${color}m${label} ${message}\x1b[0m`;
+  }
+}
+
+export default Logger;