Repository navigation
Expand file tree
/
Copy pathinstall.ts
More file actions
292 lines (267 loc) · 10.7 KB
/
Copy pathinstall.ts
File metadata and controls
292 lines (267 loc) · 10.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/*
* Copyright 2026, Salesforce, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {
Flags,
loglevel,
orgApiVersionFlagWithDeprecations,
requiredOrgFlagWithDeprecations,
SfCommand,
} from '@salesforce/sf-plugins-core';
import { Connection, Lifecycle, Messages, SfError, SfProject } from '@salesforce/core';
import { Duration } from '@salesforce/kit';
import {
PackageEvents,
PackageInstallCreateRequest,
PackageInstallOptions,
PackagingSObjects,
SubscriberPackageVersion,
} from '@salesforce/packaging';
import { Report } from './install/report.js';
export type PackageInstallRequest = PackagingSObjects.PackageInstallRequest;
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_install');
// maps of command flag values to PackageInstallRequest values
const securityType = { AllUsers: 'full', AdminsOnly: 'none' };
const upgradeType = { Delete: 'delete-only', DeprecateOnly: 'deprecate-only', Mixed: 'mixed-mode' };
export class Install extends SfCommand<PackageInstallRequest> {
public static readonly summary = messages.getMessage('summary');
public static readonly description = messages.getMessage('description');
public static readonly examples = messages.getMessages('examples');
public static readonly deprecateAliases = true;
public static readonly aliases = ['force:package:install'];
public static readonly flags = {
loglevel,
'target-org': requiredOrgFlagWithDeprecations,
'api-version': orgApiVersionFlagWithDeprecations,
wait: Flags.duration({
unit: 'minutes',
char: 'w',
summary: messages.getMessage('flags.wait.summary'),
default: Duration.minutes(0),
}),
'installation-key': Flags.string({
char: 'k',
deprecateAliases: true,
aliases: ['installationkey'],
summary: messages.getMessage('flags.installation-key.summary'),
}),
'publish-wait': Flags.duration({
unit: 'minutes',
char: 'b',
deprecateAliases: true,
aliases: ['publishwait'],
summary: messages.getMessage('flags.publish-wait.summary'),
default: Duration.minutes(0),
}),
'no-prompt': Flags.boolean({
char: 'r',
deprecateAliases: true,
aliases: ['noprompt'],
summary: messages.getMessage('flags.no-prompt.summary'),
description: messages.getMessage('flags.no-prompt.description'),
}),
package: Flags.string({
char: 'p',
summary: messages.getMessage('flags.package.summary'),
required: true,
}),
'apex-compile': Flags.custom<PackageInstallCreateRequest['ApexCompileType']>({
options: ['all', 'package'],
})({
char: 'a',
deprecateAliases: true,
aliases: ['apexcompile'],
summary: messages.getMessage('flags.apex-compile.summary'),
description: messages.getMessage('flags.apex-compile.description'),
default: 'all',
}),
'security-type': Flags.custom<'AllUsers' | 'AdminsOnly'>({
options: ['AllUsers', 'AdminsOnly'],
})({
char: 's',
deprecateAliases: true,
aliases: ['securitytype'],
summary: messages.getMessage('flags.security-type.summary'),
default: 'AdminsOnly',
}),
'upgrade-type': Flags.custom<'DeprecateOnly' | 'Mixed' | 'Delete'>({
options: ['DeprecateOnly', 'Mixed', 'Delete'],
})({
char: 't',
deprecateAliases: true,
aliases: ['upgradetype'],
summary: messages.getMessage('flags.upgrade-type.summary'),
description: messages.getMessage('flags.upgrade-type.description'),
default: 'Mixed',
}),
'skip-handlers': Flags.string({
multiple: true,
options: ['FeatureEnforcement'],
char: 'l',
summary: messages.getMessage('flags.skip-handlers.summary'),
description: messages.getMessage('flags.skip-handlers.description'),
hidden: true,
}),
};
private connection!: Connection;
private subscriberPackageVersion!: SubscriberPackageVersion;
public async run(): Promise<PackageInstallRequest> {
const { flags } = await this.parse(Install);
const noPrompt = flags['no-prompt'];
this.connection = flags['target-org'].getConnection(flags['api-version']);
const apiVersion = parseInt(this.connection.getApiVersion(), 10);
if (apiVersion < 36) {
throw messages.createError('apiVersionTooLow');
}
let packageId = flags.package;
try {
const project = SfProject.getInstance();
packageId = project.getPackageIdFromAlias(flags.package) ?? flags.package;
} catch {
// not in a project directory; use the value as-is
}
this.subscriberPackageVersion = new SubscriberPackageVersion({
connection: this.connection,
aliasOrId: packageId,
password: flags['installation-key'],
});
const request: PackageInstallCreateRequest = {
SubscriberPackageVersionKey: await this.subscriberPackageVersion.getId(),
Password: flags['installation-key'],
ApexCompileType: flags['apex-compile'],
SecurityType: securityType[flags['security-type']] as PackageInstallCreateRequest['SecurityType'],
SkipHandlers: flags['skip-handlers']?.join(','),
UpgradeType: upgradeType[flags['upgrade-type']] as PackageInstallCreateRequest['UpgradeType'],
};
// eslint-disable-next-line @typescript-eslint/require-await
Lifecycle.getInstance().on(PackageEvents.install.warning, async (warningMsg: string) => {
this.warn(warningMsg);
});
if (flags['publish-wait']?.milliseconds > 0) {
let timeThen = Date.now();
// waiting for publish to finish
let remainingTime = flags['publish-wait'];
Lifecycle.getInstance().on(
PackageEvents.install['subscriber-status'],
// eslint-disable-next-line @typescript-eslint/require-await
async (publishStatus: PackagingSObjects.InstallValidationStatus) => {
const elapsedTime = Duration.milliseconds(Date.now() - timeThen);
timeThen = Date.now();
remainingTime = Duration.milliseconds(remainingTime.milliseconds - elapsedTime.milliseconds);
const status =
publishStatus === 'NO_ERRORS_DETECTED'
? messages.getMessage('availableForInstallation')
: messages.getMessage('unavailableForInstallation');
this.spinner.status = messages.getMessage('packagePublishWaitingStatus', [remainingTime.minutes, status]);
}
);
this.spinner.start(
messages.getMessage('packagePublishWaitingStatus', [remainingTime.minutes, 'Querying Status'])
);
await this.subscriberPackageVersion.waitForPublish({
publishTimeout: flags['publish-wait'],
publishFrequency: Duration.seconds(10),
installationKey: flags['installation-key'],
});
// need to stop the spinner to avoid weird behavior with the prompts below
this.spinner.stop();
}
// If the user has specified --upgradetype Delete, then prompt for confirmation
// unless the noprompt option has been included.
if (flags['upgrade-type'] === 'Delete') {
await this.confirmUpgradeType(noPrompt);
}
// If the package has external sites, ask the user for permission to enable them
// unless the noprompt option has been included.
await this.confirmExternalSites(request, noPrompt);
let installOptions: PackageInstallOptions | undefined;
if (flags.wait) {
installOptions = {
pollingTimeout: flags.wait,
pollingFrequency: Duration.seconds(2),
};
let remainingTime = flags.wait;
let timeThen = Date.now();
this.spinner.start(messages.getMessage('packageInstallWaiting', [remainingTime.minutes]));
// waiting for package install to finish
Lifecycle.getInstance().on(
PackageEvents.install.status,
// eslint-disable-next-line @typescript-eslint/require-await
async (piRequest: PackageInstallRequest) => {
const elapsedTime = Duration.milliseconds(Date.now() - timeThen);
timeThen = Date.now();
remainingTime = Duration.milliseconds(remainingTime.milliseconds - elapsedTime.milliseconds);
this.spinner.status = messages.getMessage('packageInstallWaitingStatus', [
remainingTime.minutes,
piRequest.Status,
]);
}
);
}
let pkgInstallRequest: PackageInstallRequest | undefined;
try {
pkgInstallRequest = await this.subscriberPackageVersion.install(request, installOptions);
this.spinner.stop();
} catch (error: unknown) {
if (error instanceof SfError && error.data) {
pkgInstallRequest = error.data as PackageInstallRequest;
this.spinner.stop(messages.getMessage('packageInstallPollingTimeout'));
} else {
throw error;
}
} finally {
if (pkgInstallRequest) {
this.log(
Report.parseStatus(
this.config.bin,
pkgInstallRequest,
flags['target-org'].getUsername() as string,
flags.package
)
);
}
}
return pkgInstallRequest;
}
protected async finally(err?: Error): Promise<void> {
// Remove all the event listeners or they will still handle events
Lifecycle.getInstance().removeAllListeners(PackageEvents.install.warning);
Lifecycle.getInstance().removeAllListeners(PackageEvents.install.status);
Lifecycle.getInstance().removeAllListeners(PackageEvents.install['subscriber-status']);
await super.finally(err);
}
private async confirmUpgradeType(noPrompt: boolean): Promise<void> {
if ((await this.subscriberPackageVersion.getPackageType()) === 'Unlocked' && !noPrompt) {
const promptMsg = messages.getMessage('prompt-upgrade-type');
if (!(await this.confirm({ message: promptMsg }))) {
throw messages.createError('promptUpgradeTypeDeny');
}
}
}
private async confirmExternalSites(request: PackageInstallCreateRequest, noPrompt: boolean): Promise<void> {
const extSites = await this.subscriberPackageVersion.getExternalSites();
if (extSites) {
let enableRss = true;
if (!noPrompt) {
const promptMsg = messages.getMessage('promptEnableRss', [extSites.join('\n')]);
enableRss = await this.confirm({ message: promptMsg });
}
if (enableRss) {
request.EnableRss = enableRss;
}
}
}
}