feat: add performance mode flag

bpbuch · bpbuch · commit b7bd4acf7757 · 2025-08-26T15:12:14.000-04:00
diff --git a/command-snapshot.json b/command-snapshot.json
@@ -11,16 +11,16 @@
     "alias": [],
     "command": "lightning:dev:component",
     "flagAliases": [],
-    "flagChars": ["c", "n", "o"],
-    "flags": ["client-select", "flags-dir", "json", "name", "target-org"],
+    "flagChars": ["c", "n", "o", "p"],
+    "flags": ["client-select", "flags-dir", "json", "name", "performance", "target-org"],
     "plugin": "@salesforce/plugin-lightning-dev"
   },
   {
     "alias": [],
     "command": "lightning:dev:site",
     "flagAliases": [],
     "flagChars": ["l", "n", "o"],
-    "flags": ["flags-dir", "get-latest", "guest", "name", "target-org", "ssr"],
+    "flags": ["flags-dir", "get-latest", "guest", "name", "ssr", "target-org"],
     "plugin": "@salesforce/plugin-lightning-dev"
   }
 ]
diff --git a/messages/lightning.dev.component.md b/messages/lightning.dev.component.md
@@ -24,6 +24,10 @@ Name of a component to preview.
 
 Launch component preview without selecting a component
 
+# flags.performance.summary
+
+Open the component preview in performance mode
+
 # error.directory
 
 Unable to find components
@@ -40,9 +44,15 @@ Failed to parse component metadata at: %s
 
 Unable to find component with name: %s
 
+# error.performance-client-select-conflict
+
+Cannot use --performance flag when --client-select is enabled
+
 # examples
 
 - Select a component and launch the component preview:
   <%= config.bin %> <%= command.id %>
 - Launch component preview for "myComponent":
   <%= config.bin %> <%= command.id %> --name myComponent
+- Launch component preview for "myComponent" in performance mode:
+  <%= config.bin %> <%= command.id %> --name myComponent --performance
diff --git a/package.json b/package.json
@@ -238,7 +238,7 @@
     ],
     "target": {
       "versionNumber": "66.0",
-      "matchingDevServerVersion": "~13.0.27"
+      "matchingDevServerVersion": "~13.2.2"
     },
     "versionToTagMappings": [
       {
diff --git a/src/commands/lightning/dev/component.ts b/src/commands/lightning/dev/component.ts
@@ -34,6 +34,11 @@ export default class LightningDevComponent extends SfCommand<void> {
       char: 'c',
       default: false,
     }),
+    performance: Flags.boolean({
+      summary: messages.getMessage('flags.performance.summary'),
+      char: 'p',
+      default: false,
+    }),
     'target-org': Flags.requiredOrg(),
   };
 
@@ -53,8 +58,13 @@ export default class LightningDevComponent extends SfCommand<void> {
 
     let componentName = flags['name'];
     const clientSelect = flags['client-select'];
+    const performanceMode = flags['performance'];
     const targetOrg = flags['target-org'];
 
+    if (performanceMode && clientSelect) {
+      throw new Error(messages.getMessage('error.performance-client-select-conflict'));
+    }
+
     const { ldpServerId, ldpServerToken } = await PreviewUtils.initializePreviewConnection(targetOrg);
 
     logger.debug('Determining the next available port for Local Dev Server');
@@ -126,7 +136,8 @@ export default class LightningDevComponent extends SfCommand<void> {
       ldpServerUrl,
       ldpServerId,
       componentName,
-      targetOrgArg
+      targetOrgArg,
+      performanceMode
     );
 
     // Open the browser and navigate to the right page
diff --git a/src/shared/previewUtils.ts b/src/shared/previewUtils.ts
@@ -221,13 +221,15 @@ export class PreviewUtils {
    * @param ldpServerId Record ID for the identity token
    * @param componentName The name of the component to preview
    * @param targetOrg An optional org id
+   * @param performanceMode Whether to enable performance mode
    * @returns Array of arguments to be used by Org:Open command for launching the component preview
    */
   public static generateComponentPreviewLaunchArguments(
     ldpServerUrl: string,
     ldpServerId: string,
     componentName?: string,
-    targetOrg?: string
+    targetOrg?: string,
+    performanceMode?: boolean
   ): string[] {
     let appPath = `lwr/application/e/devpreview/ai/${encodeURIComponent(
       'localdev%2Fpreview'
@@ -236,6 +238,9 @@ export class PreviewUtils {
       // TODO: support other namespaces
       appPath += `&specifier=c/${componentName}`;
     }
+    if (performanceMode) {
+      appPath += '&mode=performance';
+    }
 
     const launchArguments = ['--path', appPath];
 
diff --git a/test/commands/lightning/dev/component.test.ts b/test/commands/lightning/dev/component.test.ts
@@ -4,21 +4,34 @@
  * 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
  */
-import { TestContext } from '@salesforce/core/testSetup';
-// import { expect } from 'chai';
-// import { stubSfCommandUx } from '@salesforce/sf-plugins-core';
+import { Messages } from '@salesforce/core';
+import { MockTestOrgData, TestContext } from '@salesforce/core/testSetup';
+import { stubUx } from '@salesforce/sf-plugins-core';
+import { expect } from 'chai';
+import LightningDevComponent from '../../../../src/commands/lightning/dev/component.js';
+
+Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
 
 describe('lightning single component preview', () => {
+  const messages = Messages.loadMessages('@salesforce/plugin-lightning-dev', 'lightning.dev.component');
   const $$ = new TestContext();
-  // let sfCommandStubs: ReturnType<typeof stubSfCommandUx>;
+  const testOrgData = new MockTestOrgData();
 
-  beforeEach(() => {
-    // sfCommandStubs = stubSfCommandUx($$.SANDBOX);
+  beforeEach(async () => {
+    stubUx($$.SANDBOX);
+    await $$.stubAuths(testOrgData);
   });
 
   afterEach(() => {
     $$.restore();
   });
 
-  it('todo add unit tests', async () => {});
+  it('should throw error when both client-select and performance flags are used', async () => {
+    try {
+      await LightningDevComponent.run(['--client-select', '--performance', '--target-org', testOrgData.orgId]);
+      expect.fail('Expected command to throw an error');
+    } catch (error) {
+      expect((error as Error).message).to.equal(messages.getMessage('error.performance-client-select-conflict'));
+    }
+  });
 });
diff --git a/test/shared/previewUtils.test.ts b/test/shared/previewUtils.test.ts
@@ -273,6 +273,77 @@ describe('previewUtils', () => {
     expect(parsed.values['target-org']).to.be.undefined;
   });
 
+  it('generateComponentPreviewLaunchArguments with performance mode enabled', async () => {
+    const result = PreviewUtils.generateComponentPreviewLaunchArguments(
+      'https://localhost:3333',
+      testLdpServerId,
+      'myTestComponent',
+      'myTargetOrg',
+      true
+    );
+
+    const parsed = parseArgs({
+      args: result,
+      options: {
+        path: { type: 'string' },
+        'target-org': { type: 'string' },
+      },
+    });
+
+    expect(parsed.values.path).to.include('ldpServerUrl=https://localhost:3333');
+    expect(parsed.values.path).to.include(`ldpServerId=${testLdpServerId}`);
+    expect(parsed.values.path).to.include('specifier=c/myTestComponent');
+    expect(parsed.values.path).to.include('mode=performance');
+    expect(parsed.values['target-org']).to.equal('myTargetOrg');
+  });
+
+  it('generateComponentPreviewLaunchArguments with performance mode disabled', async () => {
+    const result = PreviewUtils.generateComponentPreviewLaunchArguments(
+      'https://localhost:3333',
+      testLdpServerId,
+      'myTestComponent',
+      'myTargetOrg',
+      false
+    );
+
+    const parsed = parseArgs({
+      args: result,
+      options: {
+        path: { type: 'string' },
+        'target-org': { type: 'string' },
+      },
+    });
+
+    expect(parsed.values.path).to.include('ldpServerUrl=https://localhost:3333');
+    expect(parsed.values.path).to.include(`ldpServerId=${testLdpServerId}`);
+    expect(parsed.values.path).to.include('specifier=c/myTestComponent');
+    expect(parsed.values.path).to.not.include('mode=performance');
+    expect(parsed.values['target-org']).to.equal('myTargetOrg');
+  });
+
+  it('generateComponentPreviewLaunchArguments with performance mode undefined (default)', async () => {
+    const result = PreviewUtils.generateComponentPreviewLaunchArguments(
+      'https://localhost:3333',
+      testLdpServerId,
+      'myTestComponent',
+      'myTargetOrg'
+    );
+
+    const parsed = parseArgs({
+      args: result,
+      options: {
+        path: { type: 'string' },
+        'target-org': { type: 'string' },
+      },
+    });
+
+    expect(parsed.values.path).to.include('ldpServerUrl=https://localhost:3333');
+    expect(parsed.values.path).to.include(`ldpServerId=${testLdpServerId}`);
+    expect(parsed.values.path).to.include('specifier=c/myTestComponent');
+    expect(parsed.values.path).to.not.include('mode=performance');
+    expect(parsed.values['target-org']).to.equal('myTargetOrg');
+  });
+
   it('getTargetOrgFromArguments finds -o flag', async () => {
     const args = ['command', '-o', 'myOrg', 'otherArg'];
     const result = PreviewUtils.getTargetOrgFromArguments(args);

Original file line number	Diff line number	Diff line change
`@@ -238,7 +238,7 @@`
`238`	`238`	`],`
`239`	`239`	`"target": {`
`240`	`240`	`"versionNumber": "66.0",`
`241`		`- "matchingDevServerVersion": "~13.0.27"`
	`241`	`+ "matchingDevServerVersion": "~13.2.2"`
`242`	`242`	`},`
`243`	`243`	`"versionToTagMappings": [`
`244`	`244`	`{`