feat: config

nrkruk · nrkruk · commit f31cddddc484 · 2025-03-12T08:13:46.000-04:00
diff --git a/messages/prompts.md b/messages/prompts.md
@@ -6,6 +6,14 @@ Which Experience Cloud Site would you like to preview (Use arrow keys)
 
 An updated site bundle is available for "%s". Do you want to download and apply the update?
 
+# site.auth.prompt
+
+Please enter your authentication token:
+
+# site.auth.error
+
+Authentication token cannot be empty
+
 # lightning-experience-app.title
 
 Which Lightning Experience App do you want to use for the preview?
diff --git a/package.json b/package.json
@@ -16,6 +16,7 @@
     "@salesforce/lwc-dev-mobile-core": "4.0.0-alpha.9",
     "@salesforce/sf-plugins-core": "^11.2.4",
     "axios": "^1.7.9",
+    "dotenv": "^16.4.7",
     "glob": "^10.4.5",
     "lwc": "~8.12.5",
     "node-fetch": "^3.3.2"
diff --git a/src/commands/lightning/dev/site.ts b/src/commands/lightning/dev/site.ts
@@ -11,6 +11,7 @@ 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';
 
 Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.site');
@@ -87,12 +88,10 @@ export default class LightningDevSite extends SfCommand<void> {
       // Start the dev server
       const port = parseInt(process.env.PORT ?? '3000', 10);
 
-      // Internal vs external mode
-      const internalProject = !fs.existsSync('sfdx-project.json') && fs.existsSync('lwr.config.json');
       const logLevel = process.env.LOG_LEVEL ?? 'error';
 
       const startupParams: SitesLocalDevOptions = {
-        sfCLI: !internalProject,
+        sfCLI: process.env.INTERNAL_DEVELOPER_MODE !== 'true',
         authToken,
         open: process.env.OPEN_BROWSER === 'false' ? false : true,
         port,
diff --git a/src/shared/experience/expSite.ts b/src/shared/experience/expSite.ts
@@ -8,7 +8,28 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { Org, SfError } from '@salesforce/core';
 import axios from 'axios';
+import { PromptUtils } from '../promptUtils.js';
 
+// TODO this format is what we want to be storing for each site
+export type NewSiteMetadata = {
+  name: string;
+  siteZip: string; // TODO do we want to store a list of ordered zip files we've downloaded? or just the most recent
+  lastModified: Date;
+  coreVersion: string;
+  needsUpdate: boolean;
+  users: AuthUserMap;
+};
+
+export type AuthUserMap = {
+  [username: string]: AuthToken;
+};
+
+export type AuthToken = {
+  token: string;
+  issued: Date;
+};
+
+// This is what we have been storing in the sites.json
 export type SiteMetadata = {
   bundleName: string;
   bundleLastModified: string;
@@ -33,16 +54,95 @@ export class ExperienceSite {
   public siteName: string;
   private org: Org;
   private metadataCache: SiteMetadataCache = {};
+  private config;
 
   public constructor(org: Org, siteName: string) {
     this.org = org;
     this.siteDisplayName = siteName.trim();
     this.siteName = this.siteDisplayName.replace(' ', '_');
     // Replace any special characters in site name with underscore
     this.siteName = this.siteName.replace(/[^a-zA-Z0-9]/g, '_');
+
+    // Backwards Compat
+    if (process.env.SITE_GUEST_ACCESS === 'true') {
+      process.env.PREVIEW_USER = 'Guest';
+    }
+    if (process.env.SID_TOKEN && !process.env.PREVIEW_USER) {
+      process.env.PREVIEW_USER = 'Custom';
+    }
+
+    // TODO the config handling code should move into its own file
+    // Store variables in consumable config to limit use of env variables
+    // Eventually these will be part of CLI interface or scrapped in favor of config
+    // once they are no longer experimental
+    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',
+    };
+  }
+
+  public get apiQueryParams(): string {
+    const retVal = [];
+
+    // Preview is default. If we specify another mode, add it as a query parameter
+    if (this.config.apiSiteVersion !== 'preview') {
+      retVal.push(this.config.apiSiteVersion);
+    }
+
+    // Bundling groups are off by default. Only add if enabled
+    if (this.config.apiBundlingGroups) {
+      retVal.push('bundlingGroups');
+    }
+
+    // Metrics - TODO
+
+    // If we have query parameters, return them
+    if (retVal.length) {
+      return '?' + retVal.join('&');
+    }
+
+    // Otherwise just return an empty string
+    return '';
   }
 
   /**
+   * TODO this should use the connect api `{{orgInstance}}/services/data/v{{version}}/connect/communities`
+   * Returns array of sites like:
+   * communities[
+   *   {
+            "allowChatterAccessWithoutLogin": true,
+            "allowMembersToFlag": false,
+            "builderBasedSnaEnabled": true,
+            "builderUrl": "https://orgfarm-656f3290cc.test1.my.pc-rnd.salesforce.com/sfsites/picasso/core/config/commeditor.jsp?siteId=0DMSG000001lhVa",
+            "contentSpaceId": "0ZuSG000001n1la0AA",
+            "description": "D2C Codecept Murazik",
+            "guestMemberVisibilityEnabled": false,
+            "id": "0DBSG000001huWE4AY",
+            "imageOptimizationCDNEnabled": true,
+            "invitationsEnabled": false,
+            "knowledgeableEnabled": false,
+            "loginUrl": "https://orgfarm-656f3290cc.test1.my.pc-rnd.site.com/d2cbernadette/login",
+            "memberVisibilityEnabled": false,
+            "name": "D2C Codecept Murazik",
+            "nicknameDisplayEnabled": true,
+            "privateMessagesEnabled": false,
+            "reputationEnabled": false,
+            "sendWelcomeEmail": true,
+            "siteAsContainerEnabled": true,
+            "siteUrl": "https://orgfarm-656f3290cc.test1.my.pc-rnd.site.com/d2cbernadette",
+            "status": "Live",
+            "templateName": "D2C Commerce (LWR)",
+            "url": "/services/data/v64.0/connect/communities/0DBSG000001huWE4AY",
+            "urlPathPrefix": "d2cbernadettevforcesite"
+        },
+        ...
+        ]
+   * 
+   * 
    * Fetches all current experience sites
    *
    * @param {Connection} conn - Salesforce connection object.
@@ -66,25 +166,37 @@ export class ExperienceSite {
    * @returns sid token for proxied site requests
    */
   public async setupAuth(): Promise<string> {
-    let sidToken = '';
-    // Default to guest user access if specified
-    if (process.env.SITE_GUEST_ACCESS === 'true') return sidToken;
+    const previewUser = this.config.previewUser.toLocaleLowerCase();
 
-    // Use a provided token if specified in environment variables
-    if (process.env.SID_TOKEN) return process.env.SID_TOKEN;
+    // Preview as Guest User (no token)
+    if (previewUser === 'guest') return '';
 
-    // Otherwise attempt to generate one based on the currently authenticated admin user
-    try {
-      const networkId = await this.getNetworkId();
-      sidToken = await this.getNewSidToken(networkId);
-    } catch (e) {
-      // eslint-disable-next-line no-console
-      console.error('Failed to establish authentication for site', e);
+    // Preview with supplied user token
+    if (this.config.previewToken) return this.config.previewToken;
+
+    // Preview as CLI Admin user (Default)
+    if (previewUser === 'admin') {
+      try {
+        const networkId = await this.getNetworkId();
+        const sidToken = await this.getNewSidToken(networkId);
+        return sidToken;
+      } catch (e) {
+        // eslint-disable-next-line no-console
+        console.error('Failed to establish authentication for site', e);
+      }
     }
 
+    // TODO Check local metadata for token, if it doesn't exist, prompt the user
+
+    // Prompt user for token or re-use token already saved for the site
+    const sidToken = await PromptUtils.promptUserForAuthToken();
+
+    // TODO If are supplied a token, we should store it in the local metadata to reuse later on
+
     return sidToken;
   }
 
+  // TODO this doesn't work anymore, we should consider alternative strategies
   public async isUpdateAvailable(): Promise<boolean> {
     const localMetadata = this.getLocalMetadata();
     if (!localMetadata) {
@@ -148,6 +260,7 @@ export class ExperienceSite {
     return siteJson;
   }
 
+  // TODO rename to getStaticResourceMetadata()
   public async getRemoteMetadata(): Promise<SiteMetadata | undefined> {
     if (this.metadataCache.remoteMetadata) return this.metadataCache.remoteMetadata;
     const result = await this.org
@@ -197,7 +310,7 @@ export class ExperienceSite {
    */
   public async downloadSite(): Promise<string> {
     let retVal;
-    if (process.env.STATIC_MODE !== 'true') {
+    if (!this.config.apiStaticMode) {
       // Use sites API to download the site bundle on demand
       retVal = await this.downloadSiteApi();
     } else {
@@ -225,6 +338,8 @@ export class ExperienceSite {
 
     // Download the site via API
     const conn = this.org.getConnection();
+
+    // TODO update to the new metadata format
     const metadata = {
       bundleName: theSite.Name,
       bundleLastModified: theSite.LastModifiedDate,
@@ -239,12 +354,7 @@ export class ExperienceSite {
     }
     const resourcePath = this.getSiteZipPath(metadata);
     try {
-      // Limit API to published sites for now until we have a patch for the issues with unpublished sites
-      // TODO switch api back to preview mode after issues are addressed
-      let apiUrl = `${instanceUrl}/services/data/v63.0/sites/${siteIdMinus3}/preview?published`;
-      if (process.env.SITE_API_MODE === 'preview') {
-        apiUrl = `${instanceUrl}/services/data/v63.0/sites/${siteIdMinus3}/preview`;
-      }
+      const apiUrl = `${instanceUrl}/services/data/${this.config.apiVersion}/sites/${siteIdMinus3}/preview${this.apiQueryParams}`;
 
       const response = await axios.get(apiUrl, {
         headers: {
diff --git a/src/shared/experience/expSiteConfig.ts b/src/shared/experience/expSiteConfig.ts
@@ -0,0 +1,80 @@
+/*
+ * 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
+ */
+export type ExperienceSiteConfig = {
+  previewUser: string;
+  previewToken: string;
+  apiStaticMode: boolean;
+  apiBundlingGroups: boolean;
+  apiVersion: string;
+  apiSiteVersion: string;
+};
+
+export class ExperienceSiteConfigManager {
+  private static instance: ExperienceSiteConfigManager;
+  private config: ExperienceSiteConfig;
+
+  private constructor() {
+    // Backwards Compat
+    if (process.env.SITE_GUEST_ACCESS === 'true') {
+      process.env.PREVIEW_USER = 'Guest';
+    }
+    if (process.env.SID_TOKEN && !process.env.PREVIEW_USER) {
+      process.env.PREVIEW_USER = 'Custom';
+    }
+
+    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',
+    };
+  }
+
+  public static getInstance(): ExperienceSiteConfigManager {
+    if (!ExperienceSiteConfigManager.instance) {
+      ExperienceSiteConfigManager.instance = new ExperienceSiteConfigManager();
+    }
+    return ExperienceSiteConfigManager.instance;
+  }
+
+  public getConfig(): ExperienceSiteConfig {
+    return { ...this.config };
+  }
+
+  public updateConfig(partialConfig: Partial<ExperienceSiteConfig>): void {
+    this.config = { ...this.config, ...partialConfig };
+  }
+
+  public getApiQueryParams(): string {
+    const retVal = [];
+
+    // Preview is default. If we specify another mode, add it as a query parameter
+    if (this.config.apiSiteVersion !== 'preview') {
+      retVal.push(this.config.apiSiteVersion);
+    }
+
+    // Bundling groups are off by default. Only add if enabled
+    if (this.config.apiBundlingGroups) {
+      retVal.push('bundlingGroups');
+    }
+
+    // If we have query parameters, return them
+    if (retVal.length) {
+      return '?' + retVal.join('&');
+    }
+
+    // Otherwise just return an empty string
+    return '';
+  }
+}
+
+// Export a convenience function to get the config
+export function getExperienceSiteConfig(): ExperienceSiteConfig {
+  return ExperienceSiteConfigManager.getInstance().getConfig();
+}
diff --git a/src/shared/promptUtils.ts b/src/shared/promptUtils.ts
@@ -5,7 +5,7 @@
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 import select from '@inquirer/select';
-import { confirm } from '@inquirer/prompts';
+import { confirm, input } from '@inquirer/prompts';
 import { Connection, Logger, Messages } from '@salesforce/core';
 import {
   AndroidDeviceManager,
@@ -30,6 +30,22 @@ export class PromptUtils {
     return response;
   }
 
+  // Add this method to the PromptUtils class
+  public static async promptUserForAuthToken(defaultToken?: string): Promise<string> {
+    const response = await input({
+      message: messages.getMessage('site.auth.prompt'),
+      default: defaultToken,
+      validate: (value) => {
+        if (!value.trim()) {
+          return messages.getMessage('site.auth.error');
+        }
+        return true;
+      },
+    });
+
+    return response;
+  }
+
   public static async promptUserToConfirmUpdate(siteName: string): Promise<boolean> {
     return confirm({
       message: messages.getMessage('site.confirm-update', [siteName]),
diff --git a/yarn.lock b/yarn.lock
@@ -5566,6 +5566,11 @@ dot-prop@^5.1.0:
   dependencies:
     is-obj "^2.0.0"
 
+dotenv@^16.4.7:
+  version "16.4.7"
+  resolved "https://registry.yarnpkg.com/dotenv/-/dotenv-16.4.7.tgz#0e20c5b82950140aa99be360a8a5f52335f53c26"
+  integrity sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==
+
 eastasianwidth@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb"
