fix: refactored connections so they are defined once

Author: jhefferman-sfdc

src/commands/lightning/dev/app.ts

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

src/commands/lightning/dev/component.ts

@@ -75,11 +75,13 @@ export default class LightningDevComponent extends SfCommand<ComponentPreviewRes
     const targetOrg = flags['target-org'];
     const apiVersion = flags['api-version'];
 
-    if (await MetaUtils.handleLocalDevEnablement(targetOrg.getConnection(apiVersion))) {
+    const connection = targetOrg.getConnection(apiVersion);
+
+    if (await MetaUtils.handleLocalDevEnablement(connection)) {
       this.log(sharedMessages.getMessage('localdev.enabled'));
     }
 
-    const { ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(targetOrg, apiVersion);
+    const { ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(connection);
 
     logger.debug('Determining the next available port for Local Dev Server');
     const serverPorts = await PreviewUtils.getNextAvailablePorts();
@@ -165,9 +167,6 @@ export default class LightningDevComponent extends SfCommand<ComponentPreviewRes
       targetOrgArg
     );
 
-    // Construct and log the full URL that will be opened
-    const connection = targetOrg.getConnection(apiVersion);
-
     // strip trailing slashes
     const instanceUrl = connection.instanceUrl.replace(/\/$/, '');
 

src/shared/previewUtils.ts

@@ -22,7 +22,7 @@
 import fs from 'node:fs';
 import os from 'node:os';
 import path from 'node:path';
-import { Connection, Logger, Messages, Org } from '@salesforce/core';
+import { Connection, Logger, Messages } from '@salesforce/core';
 import {
   AndroidDeviceManager,
   AppleDeviceManager,
@@ -426,8 +426,7 @@ export class PreviewUtils {
     });
   }
 
-  public static async initializePreviewConnection(targetOrg: Org, apiVersion?: string): Promise<PreviewConnection> {
-    const connection = targetOrg.getConnection(apiVersion);
+  public static async initializePreviewConnection(connection: Connection): Promise<PreviewConnection> {
     const username = connection.getUsername();
     if (!username) {
       return Promise.reject(new Error(sharedMessages.getMessage('error.username')));

test/shared/previewUtils.test.ts

@@ -31,7 +31,7 @@ import {
   SSLCertificateData,
   Version,
 } from '@salesforce/lwc-dev-mobile-core';
-import { AuthInfo, Connection, Logger, Messages, Org } from '@salesforce/core';
+import { AuthInfo, Connection, Logger, Messages } from '@salesforce/core';
 import { PreviewUtils as LwcDevMobileCorePreviewUtils } from '@salesforce/lwc-dev-mobile-core';
 import {
   ConfigUtils,
@@ -331,163 +331,57 @@ describe('previewUtils', () => {
     expect(generateWebSocketUrlStub.calledOnceWith(platform, ports, {} as Logger)).to.be.true;
   });
 
-  it('initializePreviewConnection succeeds with valid org', async () => {
+  it('initializePreviewConnection succeeds with valid connection', async () => {
     const mockConnection = {
       getUsername: () => testUsername,
-    };
-    const getConnectionStub = $$.SANDBOX.stub().returns(mockConnection);
-    const mockOrg = {
-      getConnection: getConnectionStub,
-    } as unknown as Org;
-
-    $$.SANDBOX.stub(OrgUtils, 'isLocalDevEnabled').resolves(true);
-    $$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
-    $$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').resolves(testIdentityData);
-
-    const result = await PreviewUtils.initializePreviewConnection(mockOrg);
-
-    expect(result.ldpServerId).to.equal(testLdpServerId);
-    expect(result.ldpServerToken).to.equal(testLdpServerToken);
-    expect(result.connection).to.exist;
-    expect(getConnectionStub.calledWith(undefined)).to.be.true;
-  });
-
-  it('initializePreviewConnection succeeds with valid org and apiVersion', async () => {
-    const testApiVersion = '67.0';
-    const mockConnection = {
-      getUsername: () => testUsername,
-    };
-    const getConnectionStub = $$.SANDBOX.stub().returns(mockConnection);
-    const mockOrg = {
-      getConnection: getConnectionStub,
-    } as unknown as Org;
+    } as unknown as Connection;
 
     $$.SANDBOX.stub(OrgUtils, 'isLocalDevEnabled').resolves(true);
     $$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
     $$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').resolves(testIdentityData);
 
-    const result = await PreviewUtils.initializePreviewConnection(mockOrg, testApiVersion);
+    const result = await PreviewUtils.initializePreviewConnection(mockConnection);
 
     expect(result.ldpServerId).to.equal(testLdpServerId);
     expect(result.ldpServerToken).to.equal(testLdpServerToken);
-    expect(result.connection).to.exist;
-    expect(getConnectionStub.calledWith(testApiVersion)).to.be.true;
+    expect(result.connection).to.equal(mockConnection);
   });
 
   it('initializePreviewConnection rejects when username is not found', async () => {
     const mockConnection = {
       getUsername: () => undefined,
-    };
-    const mockOrg = {
-      getConnection: $$.SANDBOX.stub().returns(mockConnection),
-    } as unknown as Org;
-
-    try {
-      await PreviewUtils.initializePreviewConnection(mockOrg);
-      expect.fail('Should have thrown an error');
-    } catch (error) {
-      expect((error as Error).message).to.include('Org must have a valid user');
-    }
-  });
-
-  it('initializePreviewConnection rejects when username is not found with apiVersion', async () => {
-    const testApiVersion = '67.0';
-    const mockConnection = {
-      getUsername: () => undefined,
-    };
-    const getConnectionStub = $$.SANDBOX.stub().returns(mockConnection);
-    const mockOrg = {
-      getConnection: getConnectionStub,
-    } as unknown as Org;
+    } as unknown as Connection;
 
     try {
-      await PreviewUtils.initializePreviewConnection(mockOrg, testApiVersion);
+      await PreviewUtils.initializePreviewConnection(mockConnection);
       expect.fail('Should have thrown an error');
     } catch (error) {
       expect((error as Error).message).to.include('Org must have a valid user');
-      expect(getConnectionStub.calledWith(testApiVersion)).to.be.true;
     }
   });
 
   it('initializePreviewConnection rejects when local dev is not enabled', async () => {
     const mockConnection = {
       getUsername: () => testUsername,
-    };
-    const mockOrg = {
-      getConnection: $$.SANDBOX.stub().returns(mockConnection),
-    } as unknown as Org;
-
-    $$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
-    $$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').rejects(
-      new Error(sharedMessages.getMessage('error.localdev.not.enabled'))
-    );
-
-    try {
-      await PreviewUtils.initializePreviewConnection(mockOrg);
-      expect.fail('Should have thrown an error');
-    } catch (error) {
-      expect((error as Error).message).to.include('Local Dev is not enabled');
-    }
-  });
-
-  it('initializePreviewConnection rejects when local dev is not enabled with apiVersion', async () => {
-    const testApiVersion = '67.0';
-    const mockConnection = {
-      getUsername: () => testUsername,
-    };
-    const getConnectionStub = $$.SANDBOX.stub().returns(mockConnection);
-    const mockOrg = {
-      getConnection: getConnectionStub,
-    } as unknown as Org;
+    } as unknown as Connection;
 
     $$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
     $$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').rejects(
       new Error(sharedMessages.getMessage('error.localdev.not.enabled'))
     );
 
     try {
-      await PreviewUtils.initializePreviewConnection(mockOrg, testApiVersion);
+      await PreviewUtils.initializePreviewConnection(mockConnection);
       expect.fail('Should have thrown an error');
     } catch (error) {
       expect((error as Error).message).to.include('Local Dev is not enabled');
-      expect(getConnectionStub.calledWith(testApiVersion)).to.be.true;
     }
   });
 
   it('initializePreviewConnection rejects when ldpServerId is not found', async () => {
     const mockConnection = {
       getUsername: () => testUsername,
-    };
-    const mockOrg = {
-      getConnection: $$.SANDBOX.stub().returns(mockConnection),
-    } as unknown as Org;
-
-    const identityDataWithoutEntityId = {
-      identityToken: testLdpServerToken,
-      usernameToServerEntityIdMap: {},
-    };
-
-    $$.SANDBOX.stub(OrgUtils, 'isLocalDevEnabled').resolves(true);
-    $$.SANDBOX.stub(OrgUtils, 'ensureMatchingAPIVersion').returns();
-    $$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').resolves(identityDataWithoutEntityId);
-
-    try {
-      await PreviewUtils.initializePreviewConnection(mockOrg);
-      expect.fail('Should have thrown an error');
-    } catch (error) {
-      expect((error as Error).message).to.include('entity ID');
-    }
-  });
-
-  it('initializePreviewConnection rejects when ldpServerId is not found with apiVersion', async () => {
-    const testApiVersion = '67.0';
-    const mockConnection = {
-      getUsername: () => testUsername,
-    };
-    const getConnectionStub = $$.SANDBOX.stub().returns(mockConnection);
-    const mockOrg = {
-      getConnection: getConnectionStub,
-    } as unknown as Org;
+    } as unknown as Connection;
 
     const identityDataWithoutEntityId = {
       identityToken: testLdpServerToken,
@@ -499,11 +393,10 @@ describe('previewUtils', () => {
     $$.SANDBOX.stub(PreviewUtils, 'getOrCreateAppServerIdentity').resolves(identityDataWithoutEntityId);
 
     try {
-      await PreviewUtils.initializePreviewConnection(mockOrg, testApiVersion);
+      await PreviewUtils.initializePreviewConnection(mockConnection);
       expect.fail('Should have thrown an error');
     } catch (error) {
       expect((error as Error).message).to.include('entity ID');
-      expect(getConnectionStub.calledWith(testApiVersion)).to.be.true;
     }
   });
 });