Skip to content

Commit f95cfe5

Browse files
authored
W-21188143: chore: remove --ssr, --get-latest, and --guest flags from site command (#635)
* chore: remove --ssr, --get-latest, and --guest flags from site command Made-with: Cursor * fix: feedback * fix: typo * fix: trigger CI
1 parent a32170b commit f95cfe5

7 files changed

Lines changed: 8 additions & 108 deletions

File tree

.github/workflows/onRelease.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ jobs:
4545
uses: salesforcecli/github-workflows/.github/workflows/npmPublish.yml@main
4646
needs: [getDistTag, getMajorVersion]
4747
with:
48-
#ctc: true
48+
ctc: true
4949
sign: true
5050
# At CLCO, the new patch branch's version will be released as 'prerelease'. After R2b, delete the logic below for 'latest' and update 'prerelease' candidate to 'latest'
5151
tag: ${{ needs.getDistTag.outputs.tag || (needs.getMajorVersion.outputs.major == '4' && 'latest') || (needs.getMajorVersion.outputs.major == '5' && 'prerelease') || 'next' }}

CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,5 @@
22

33
#GUSINFO:Application Fabric Services, Application Fabric Services
44
* @salesforcecli/local-dev @salesforcecli/lex @salesforcecli/mobile-platform-experience
5+
6+
#ECCN:Open Source

README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -259,18 +259,14 @@ _See code: [src/commands/lightning/dev/component.ts](https://github.com/salesfor
259259

260260
```
261261
USAGE
262-
$ sf lightning dev site -o <value> [--flags-dir <value>] [-n <value>] [-l] [--guest] [--ssr] [--api-version <value>]
262+
$ sf lightning dev site -o <value> [--flags-dir <value>] [-n <value>] [--api-version <value>]
263263
264264
FLAGS
265-
-l, --get-latest Download the latest version of the specified site from your org, instead of using any local
266-
cache.
267265
-n, --name=<value> Name of the Experience Builder site to preview. It has to match a site name from the
268266
current org.
269267
-o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
270268
configuration variable is already set.
271269
--api-version=<value> Override the api version used for api requests made by this command
272-
--guest Preview the site as a guest user (rather than an authenticated user).
273-
--ssr Preview the SSR bundle
274270
275271
GLOBAL FLAGS
276272
--flags-dir=<value> Import flag values from a directory.
@@ -302,10 +298,6 @@ EXAMPLES
302298
Preview the site "Partner Central" from the org "myOrg":
303299
304300
$ sf lightning dev site --name "Partner Central" --target-org myOrg
305-
306-
Get and preview the latest version of the "Partner Central" site from the org "myOrg"
307-
308-
$ sf lightning dev site --name "Partner Central" --target-org myOrg --get-latest
309301
```
310302

311303
_See code: [src/commands/lightning/dev/site.ts](https://github.com/salesforcecli/plugin-lightning-dev/blob/6.2.12/src/commands/lightning/dev/site.ts)_

command-snapshot.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
"alias": [],
2020
"command": "lightning:dev:site",
2121
"flagAliases": [],
22-
"flagChars": ["l", "n", "o"],
23-
"flags": ["api-version", "flags-dir", "get-latest", "guest", "name", "ssr", "target-org"],
22+
"flagChars": ["n", "o"],
23+
"flags": ["api-version", "flags-dir", "name", "target-org"],
2424
"plugin": "@salesforce/plugin-lightning-dev"
2525
}
2626
]

messages/lightning.dev.site.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -21,23 +21,9 @@ For more considerations and limitations, see the Lightning Web Components Develo
2121

2222
Name of the Experience Builder site to preview. It has to match a site name from the current org.
2323

24-
# flags.get-latest.summary
25-
26-
Download the latest version of the specified site from your org, instead of using any local cache.
27-
28-
# flags.guest.summary
29-
30-
Preview the site as a guest user (rather than an authenticated user).
31-
32-
# flags.ssr.summary
33-
34-
Preview the SSR bundle
35-
3624
# examples
3725

3826
- Select a site to preview from the org "myOrg":
3927
<%= config.bin %> <%= command.id %> --target-org myOrg
4028
- Preview the site "Partner Central" from the org "myOrg":
4129
<%= config.bin %> <%= command.id %> --name "Partner Central" --target-org myOrg
42-
- Get and preview the latest version of the "Partner Central" site from the org "myOrg"
43-
<%= config.bin %> <%= command.id %> --name "Partner Central" --target-org myOrg --get-latest

src/commands/lightning/dev/app.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export default class LightningDevApp extends SfCommand<void> {
8888
throw new Error(sharedMessages.getMessage('error.no-project', [(error as Error)?.message ?? '']));
8989
}
9090

91-
logger.debug('Initalizing preview connection and configuring local web server identity');
91+
logger.debug('Initializing preview connection and configuring local web server identity');
9292

9393
const connection = targetOrg.getConnection(apiVersion);
9494

src/commands/lightning/dev/site.ts

Lines changed: 1 addition & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
import fs from 'node:fs';
1716
import { SfCommand, Flags } from '@salesforce/sf-plugins-core';
1817
import { Connection, Logger, Messages, SfProject } from '@salesforce/core';
1918
import { Platform } from '@salesforce/lwc-dev-mobile-core';
20-
import { expDev, SitesLocalDevOptions, setupDev } from '@lwrjs/api';
2119
import open from 'open';
2220
import { PromptUtils } from '../../../shared/promptUtils.js';
2321
import { ExperienceSite } from '../../../shared/experience/expSite.js';
@@ -41,18 +39,6 @@ export default class LightningDevSite extends SfCommand<void> {
4139
char: 'n',
4240
}),
4341
'target-org': Flags.requiredOrg(),
44-
'get-latest': Flags.boolean({
45-
summary: messages.getMessage('flags.get-latest.summary'),
46-
char: 'l',
47-
}),
48-
guest: Flags.boolean({
49-
summary: messages.getMessage('flags.guest.summary'),
50-
default: false,
51-
}),
52-
ssr: Flags.boolean({
53-
summary: messages.getMessage('flags.ssr.summary'),
54-
default: false,
55-
}),
5642
'api-version': Flags.orgApiVersion(),
5743
};
5844

@@ -61,10 +47,7 @@ export default class LightningDevSite extends SfCommand<void> {
6147

6248
try {
6349
const org = flags['target-org'];
64-
const getLatest = flags['get-latest'];
6550
const apiVersion = flags['api-version'];
66-
const guest = flags.guest;
67-
const ssr = flags.ssr;
6851
let siteName = flags.name;
6952

7053
const connection = org.getConnection(apiVersion);
@@ -81,76 +64,13 @@ export default class LightningDevSite extends SfCommand<void> {
8164

8265
const selectedSite = new ExperienceSite(org, siteName);
8366

84-
if (!ssr) {
85-
return await this.openPreviewUrl(selectedSite, connection);
86-
}
87-
await this.serveSSRSite(selectedSite, getLatest, siteName, guest);
67+
return await this.openPreviewUrl(selectedSite, connection);
8868
} catch (e) {
8969
this.spinner.stop('failed.');
9070
this.log('Local Development setup failed', e);
9171
}
9272
}
9373

94-
private async serveSSRSite(
95-
selectedSite: ExperienceSite,
96-
getLatest: boolean,
97-
siteName: string,
98-
guest: boolean,
99-
): Promise<void> {
100-
let siteZip: string | undefined;
101-
102-
// If the site is not setup / is not based on the current release / or get-latest is requested ->
103-
// generate and download a new site bundle from the org based on latest builder metadata
104-
if (!selectedSite.isSiteSetup() || getLatest) {
105-
const startTime = Date.now();
106-
this.log(`[local-dev] Initializing: ${siteName}`);
107-
this.spinner.start('[local-dev] Downloading site (this may take a few minutes)');
108-
siteZip = await selectedSite.downloadSite();
109-
110-
// delete oldSitePath recursive
111-
const oldSitePath = selectedSite.getExtractDirectory();
112-
if (fs.existsSync(oldSitePath)) {
113-
fs.rmSync(oldSitePath, { recursive: true });
114-
}
115-
const endTime = Date.now();
116-
const duration = (endTime - startTime) / 1000; // Convert to seconds
117-
this.spinner.stop('done.');
118-
this.log(`[local-dev] Site setup completed in ${duration.toFixed(2)} seconds.`);
119-
}
120-
121-
this.log(`[local-dev] launching browser preview for: ${siteName}`);
122-
123-
// Establish a valid access token for this site
124-
const authToken = guest ? '' : await selectedSite.setupAuth();
125-
126-
// Start the dev server
127-
const port = parseInt(process.env.PORT ?? '3000', 10);
128-
129-
// Internal vs external mode
130-
const internalProject = !fs.existsSync('sfdx-project.json') && fs.existsSync('lwr.config.json');
131-
const logLevel = process.env.LOG_LEVEL ?? 'error';
132-
133-
const startupParams: SitesLocalDevOptions = {
134-
sfCLI: !internalProject,
135-
authToken,
136-
open: process.env.OPEN_BROWSER === 'false' ? false : true,
137-
port,
138-
logLevel,
139-
mode: 'dev',
140-
siteZip,
141-
siteDir: selectedSite.getSiteDirectory(),
142-
};
143-
144-
// Environment variable used to setup the site rather than setup & start server
145-
if (process.env.SETUP_ONLY === 'true') {
146-
await setupDev(startupParams);
147-
this.log('[local-dev] setup complete!');
148-
} else {
149-
await expDev(startupParams);
150-
this.log('[local-dev] watching for file changes... (CTRL-C to stop)');
151-
}
152-
}
153-
15474
private async openPreviewUrl(selectedSite: ExperienceSite, connection: Connection): Promise<void> {
15575
let sfdxProjectRootPath = '';
15676
try {

0 commit comments

Comments
 (0)