feat: add getLatest flag / delete unused code

Author: nrkruk

src/commands/lightning/dev/site.ts

@@ -39,6 +39,7 @@ export default class LightningDevSite extends SfCommand<void> {
 
     try {
       const org = flags['target-org'];
+      const getLatest = flags['get-latest'];
       let siteName = flags.name;
 
       const connection = org.getConnection(undefined);
@@ -59,26 +60,23 @@ export default class LightningDevSite extends SfCommand<void> {
       const selectedSite = new ExperienceSite(org, siteName);
       let siteZip: string | undefined;
 
-      if (!selectedSite.isSiteSetup()) {
-        this.log(`[local-dev] initializing: ${siteName}`);
+      // TODO if locally cached site is 252 site, we should trigger an update also
+      if (!selectedSite.isSiteSetup() || getLatest) {
+        this.log(`[local-dev] initializing: '${siteName}'`);
+        this.spinner.start('[local-dev] Downloading site (this may take a few minutes)');
         siteZip = await selectedSite.downloadSite();
-      } else {
-        // If local-dev is already setup, check if an updated site has been published to download
-        const updateAvailable = await selectedSite.isUpdateAvailable();
-        if (updateAvailable) {
-          const shouldUpdate = await PromptUtils.promptUserToConfirmUpdate(siteName);
-          if (shouldUpdate) {
-            this.log(`[local-dev] updating: ${siteName}`);
-            siteZip = await selectedSite.downloadSite();
-            // delete oldSitePath recursive
-            const oldSitePath = selectedSite.getExtractDirectory();
-            if (fs.existsSync(oldSitePath)) {
-              fs.rmSync(oldSitePath, { recursive: true });
-            }
-          }
+
+        // delete oldSitePath recursive
+        this.spinner.status = '[local-dev] cleaning up site cache';
+        const oldSitePath = selectedSite.getExtractDirectory();
+        if (fs.existsSync(oldSitePath)) {
+          fs.rmSync(oldSitePath, { recursive: true });
         }
+        this.spinner.stop('[local-dev] setup complete');
       }
 
+      this.log(`[local-dev] launching browser preview for: ${siteName}`);
+
       // Establish a valid access token for this site
       const authToken = await selectedSite.setupAuth();
 
@@ -100,6 +98,7 @@ export default class LightningDevSite extends SfCommand<void> {
         await setupDev(startupParams);
       } else {
         await expDev(startupParams);
+        this.log('[local-dev] watching for file changes... (CTRL-C to stop)');
       }
     } catch (e) {
       this.log('Local Development setup failed', e);

src/shared/experience/expSite.ts

@@ -41,44 +41,6 @@ export class ExperienceSite {
     this.siteName = this.siteName.replace(/[^a-zA-Z0-9]/g, '_');
   }
 
-  /**
-   * Get an experience site bundle by site name.
-   *
-   * @param conn - Salesforce connection object.
-   * @param siteName - The name of the experience site.
-   * @returns - The experience site.
-   *
-   * @param siteName
-   * @returns
-   */
-  public static getLocalExpSite(siteName: string): ExperienceSite {
-    const siteJsonPath = path.join('.localdev', siteName.trim().replace(' ', '_'), 'site.json');
-    const siteJson = fs.readFileSync(siteJsonPath, 'utf8');
-    const site = JSON.parse(siteJson) as ExperienceSite;
-    return site;
-  }
-
-  /**
-   * Fetches all experience site bundles that are published to MRT.
-   *
-   * @param {Connection} conn - Salesforce connection object.
-   * @returns {Promise<ExperienceSite[]>} - List of experience sites.
-   */
-  public static async getAllPublishedExpSites(org: Org): Promise<ExperienceSite[]> {
-    const result = await org
-      .getConnection()
-      .query<{ Id: string; Name: string; LastModifiedDate: string }>(
-        "SELECT Id, Name, LastModifiedDate FROM StaticResource WHERE Name LIKE 'MRT%_'"
-      );
-
-    // Example of creating ExperienceSite instances
-    const experienceSites: ExperienceSite[] = result.records.map(
-      (record) => new ExperienceSite(org, getSiteNameFromStaticResource(record.Name))
-    );
-
-    return experienceSites;
-  }
-
   /**
    * Fetches all current experience sites
    *
@@ -227,32 +189,12 @@ export class ExperienceSite {
    */
   public async downloadSite(): Promise<string> {
     if (process.env.STATIC_MODE !== 'true') {
-      const retVal = await this.downloadSiteV2();
+      // Use sites API to download the site bundle on demand
+      const retVal = await this.downloadSiteApi();
       return retVal;
     } else {
-      const remoteMetadata = await this.getRemoteMetadata();
-      if (!remoteMetadata) {
-        throw new SfError(`No published site found for: ${this.siteDisplayName}`);
-      }
-
-      // Download the site from static resources
-      // eslint-disable-next-line no-console
-      console.log('[local-dev] Downloading site...'); // TODO spinner
-      const resourcePath = this.getSiteZipPath(remoteMetadata);
-      const staticresource = await this.org.getConnection().metadata.read('StaticResource', remoteMetadata.bundleName);
-      if (staticresource?.content) {
-        // Save the static resource
-        fs.mkdirSync(this.getSiteDirectory(), { recursive: true });
-        const buffer = Buffer.from(staticresource.content, 'base64');
-        fs.writeFileSync(resourcePath, buffer);
-
-        // Save the site's metadata
-        this.saveMetadata(remoteMetadata);
-      } else {
-        throw new SfError(`Error occurred downloading your site: ${this.siteDisplayName}`);
-      }
-
-      return resourcePath;
+      const retVal = await this.downloadSiteStaticResources();
+      return retVal;
     }
   }
 
@@ -261,7 +203,7 @@ export class ExperienceSite {
    *
    * @returns path of downloaded site zip
    */
-  public async downloadSiteV2(): Promise<string> {
+  public async downloadSiteApi(): Promise<string> {
     const remoteMetadata = await this.org
       .getConnection()
       .query<{ Id: string; Name: string; LastModifiedDate: string; MasterLabel: string }>(
@@ -273,8 +215,6 @@ export class ExperienceSite {
     const theSite = remoteMetadata.records[0];
 
     // Download the site via API
-    // eslint-disable-next-line no-console
-    console.log('[local-dev] Downloading site...'); // TODO spinner
     const conn = this.org.getConnection();
     const metadata = {
       bundleName: theSite.Name,
@@ -290,8 +230,8 @@ 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 set the api version dynamically based on CLI input
-      const apiUrl = `${instanceUrl}/services/data/v63.0/sites/${siteIdMinus3}/preview?published`;
+      // TODO use preview api when fixed
+      const apiUrl = `${instanceUrl}/services/data/v63.0/sites/${siteIdMinus3}/preview`;
       const response = await axios.get(apiUrl, {
         headers: {
           Authorization: `Bearer ${accessToken}`,
@@ -318,6 +258,32 @@ export class ExperienceSite {
     return resourcePath;
   }
 
+  // Deprecated. Only used internally now for testing. Customer sites will no longer be stored in static resources
+  // and are only available via the API.
+  public async downloadSiteStaticResources(): Promise<string> {
+    // This is for testing purposes only now - not an officially supported external path
+    const remoteMetadata = await this.getRemoteMetadata();
+    if (!remoteMetadata) {
+      throw new SfError(`No published site found for: ${this.siteDisplayName}`);
+    }
+
+    // Download the site from static resources
+    const resourcePath = this.getSiteZipPath(remoteMetadata);
+    const staticresource = await this.org.getConnection().metadata.read('StaticResource', remoteMetadata.bundleName);
+    if (staticresource?.content) {
+      // Save the static resource
+      fs.mkdirSync(this.getSiteDirectory(), { recursive: true });
+      const buffer = Buffer.from(staticresource.content, 'base64');
+      fs.writeFileSync(resourcePath, buffer);
+
+      // Save the site's metadata
+      this.saveMetadata(remoteMetadata);
+    } else {
+      throw new SfError(`Error occurred downloading your site: ${this.siteDisplayName}`);
+    }
+    return resourcePath;
+  }
+
   private async getNetworkId(): Promise<string> {
     const conn = this.org.getConnection();
     // Query the Network object for the network with the given site name
@@ -334,6 +300,7 @@ export class ExperienceSite {
     }
   }
 
+  // TODO
   private async getNewSidToken(networkId: string): Promise<string> {
     // Get the connection and access token from the org
     const conn = this.org.getConnection();
@@ -346,9 +313,6 @@ export class ExperienceSite {
 
     // Make the GET request without following redirects
     if (accessToken) {
-      // TODO should we try and refresh auth here?
-      // await conn.refreshAuth();
-
       // Call out to the switcher servlet to establish a session
       const switchUrl = `${instanceUrl}/servlet/networks/switch?networkId=${networkId}`;
       const cookies = [`sid=${accessToken}`, `oid=${orgIdMinus3}`].join('; ').trim();
@@ -411,17 +375,3 @@ export class ExperienceSite {
     return '';
   }
 }
-
-/**
- * Return the site name given the name of its static resource bundle
- *
- * @param staticResourceName the static resource bundle name
- * @returns the name of the site
- */
-function getSiteNameFromStaticResource(staticResourceName: string): string {
-  const parts = staticResourceName.split('_');
-  if (parts.length < 5) {
-    throw new Error(`Unexpected static resource name: ${staticResourceName}`);
-  }
-  return parts.slice(4).join(' ');
-}