chore: cleanup code

Author: nrkruk

src/commands/lightning/dev/site.ts

@@ -64,15 +64,12 @@ export default class LightningDevSite extends SfCommand<void> {
         }
       }
 
-      // Pass the org auth token so LWR can make authenticated requests to core
-      const authToken = org.getConnection().accessToken ?? '';
-
-      const networkId = await selectedSite.getNetworkIdByName();
-      const sidToken = await selectedSite.getNewSidToken(networkId);
+      // Establish a valid access token for this site
+      const authToken = await selectedSite.setupAuth();
 
       // Start the dev server
       await expDev({
-        authToken: sidToken || authToken,
+        authToken,
         open: true,
         port: 3000,
         logLevel: 'error',

src/shared/experience/expSite.ts

@@ -95,6 +95,26 @@ export class ExperienceSite {
     return experienceSites;
   }
 
+  /**
+   * Steps to init:
+   * 1) Verify the site is an actual site within this organization
+   * 2) Verify and output specific message if wrong site type is selected
+   * 2) Verify that site has been published with Local Dev perm enabled (i.e. a static resource exists for this site name)
+   * 3) Establish sid token for proxied requests
+   */
+  // public async init(): Promise<void> {}
+
+  /**
+   * Esablish a valid token for this local development session
+   *
+   * @returns sid token for proxied site requests
+   */
+  public async setupAuth(): Promise<string> {
+    const networkId = await this.getNetworkId();
+    const sidToken = await this.getNewSidToken(networkId);
+    return sidToken;
+  }
+
   public async isUpdateAvailable(): Promise<boolean> {
     const localMetadata = this.getLocalMetadata();
     if (!localMetadata) {
@@ -227,10 +247,8 @@ export class ExperienceSite {
     return resourcePath;
   }
 
-  // TODO cleanup
-  public async getNetworkIdByName(): Promise<string> {
+  public async getNetworkId(): Promise<string> {
     const conn = this.org.getConnection();
-    // try {
     // Query the Network object for the network with the given site name
     const result = await conn.query<{ Id: string }>(`SELECT Id FROM Network WHERE Name = '${this.siteDisplayName}'`);
 
@@ -243,48 +261,30 @@ export class ExperienceSite {
     } else {
       throw new Error(`Network with name '${this.siteDisplayName}' not found`);
     }
-    // } catch (error) {
-    //   // console.error('Error fetching Network ID:', error);
-    //   throw error;
-    // }
   }
 
   public async getNewSidToken(networkId: string): Promise<string> {
     // Get the connection and access token from the org
     const conn = this.org.getConnection();
-    const identity = await conn.identity();
-    if (identity.user_id) {
-      // do something
-    }
     const orgId = this.org.getOrgId();
+
+    // Not sure if we need to do this
     const orgIdMinus3 = orgId.substring(0, orgId.length - 3);
-    const accessToken = conn.accessToken;
-    const instanceUrl = conn.instanceUrl;
+    const accessToken = conn.accessToken; // TODO should we be refreshing before use?
+    const instanceUrl = conn.instanceUrl; // Org URL
 
-    // Construct the switch URL
+    // Call out to the servlet to establish a session
     const switchUrl = `${instanceUrl}/servlet/networks/switch?networkId=${networkId}`;
 
-    // try {
     // Make the GET request without following redirects
     if (accessToken) {
-      const cookies = [
-        `sid=${accessToken}`,
-        `oid=${orgIdMinus3}`,
-        // 'sid_Client=s000000uuCPw000000I7xV',
-        // Include other essential cookies if necessary
-        // For example:
-        // `oid=${conn.getAuthInfoFields().orgId}`,
-        // `sid_Client=${conn.userInfo.id}`,
-        // Add any other cookies that might be required
-      ]
-        .join('; ')
-        .trim();
+      // TODO should we always refreshAuth?
+      // await conn.refreshAuth();
+
+      const cookies = [`sid=${accessToken}`, `oid=${orgIdMinus3}`].join('; ').trim();
       let response = await axios.get(switchUrl, {
         headers: {
           Cookie: cookies,
-          // Include other headers if necessary
-          // 'User-Agent': 'Your User Agent String',
-          // 'Referer': 'Referer URL if required',
         },
         withCredentials: true,
         maxRedirects: 0, // Prevent axios from following redirects
@@ -294,32 +294,15 @@ export class ExperienceSite {
       // Extract the Location header
       // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       const locationHeader = response.headers['location'];
-
       if (locationHeader) {
         // Parse the URL to extract the 'sid' parameter
         // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
         const urlObj = new URL(locationHeader);
         const sid = urlObj.searchParams.get('sid') ?? '';
-        const cookies2 = [
-          '__Secure-has-sid=1',
-          `sid=${sid}`,
-          `oid=${orgIdMinus3}`,
-          // 'sid_Client=s000000uuCPw000000I7xV',
-          // Include other essential cookies if necessary
-          // For example:
-          // `oid=${conn.getAuthInfoFields().orgId}`,
-          // `sid_Client=${conn.userInfo.id}`,
-          // Add any other cookies that might be required
-        ]
-          .join('; ')
-          .trim();
-
+        const cookies2 = ['__Secure-has-sid=1', `sid=${sid}`, `oid=${orgIdMinus3}`].join('; ').trim();
         response = await axios.get(urlObj.toString(), {
           headers: {
             Cookie: cookies2,
-            // Include other headers if necessary
-            // 'User-Agent': 'Your User Agent String',
-            // 'Referer': 'Referer URL if required',
           },
           withCredentials: true,
           maxRedirects: 0, // Prevent axios from following redirects
@@ -330,7 +313,6 @@ export class ExperienceSite {
           // 'set-cookie' can be an array if multiple cookies are set
           // Find the 'sid' cookie in the set-cookie header
           const sidCookie = setCookieHeader.find((cookieStr: string) => cookieStr.startsWith('sid='));
-
           if (sidCookie) {
             // Extract the sid value from the cookie string
             const sidMatch = sidCookie.match(/sid=([^;]+)/);
@@ -339,26 +321,21 @@ export class ExperienceSite {
               return sidToken;
             }
           }
-        } else {
-          // eslint-disable-next-line no-console
-          console.log('error couldnt find set-cookie header for sid token');
-        }
-
-        if (sid) {
-          return sid;
-        } else {
-          throw new Error('SID token not found in Location header');
         }
-      } else {
-        throw new Error('Location header not found in response');
       }
+      // eslint-disable-next-line no-console
+      console.warn(
+        `Warning: could not establish valid auth token for your site '${this.siteDisplayName}'.` +
+          'Local Dev proxied requests to your site may fail or return data from the guest user context.'
+      );
+
+      return accessToken;
     }
+    // eslint-disable-next-line no-console
+    console.warn(
+      'Warning: sf cli org connection missing accessToken. Local Dev proxied requests to your site may fail or return data from the guest user context.'
+    );
     return '';
-    // } catch (error) {
-    //   // Handle errors (e.g., network issues, HTTP errors)
-    //   // console.error('Error obtaining new SID token:', error);
-    //   throw error;
-    // }
   }
 }