generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 15
/
start.ts
284 lines (262 loc) · 10.9 KB
/
start.ts
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
/*
* Copyright (c) 2021, salesforce.com, inc.
* All rights reserved.
* 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 ansis from 'ansis';
import { EnvironmentVariable, Lifecycle, Messages, OrgConfigProperties, SfError } from '@salesforce/core';
import { DeployVersionData } from '@salesforce/source-deploy-retrieve';
import { Duration } from '@salesforce/kit';
import { SfCommand, toHelpSection, Flags } from '@salesforce/sf-plugins-core';
import { SourceConflictError } from '@salesforce/source-tracking';
import { AsyncDeployResultFormatter } from '../../../formatters/asyncDeployResultFormatter.js';
import { DeployResultFormatter } from '../../../formatters/deployResultFormatter.js';
import { DeployProgress } from '../../../utils/progressBar.js';
import { DeployResultJson, TestLevel } from '../../../utils/types.js';
import { executeDeploy, resolveApi, validateTests, determineExitCode } from '../../../utils/deploy.js';
import { DeployCache } from '../../../utils/deployCache.js';
import { DEPLOY_STATUS_CODES_DESCRIPTIONS } from '../../../utils/errorCodes.js';
import { ConfigVars } from '../../../configMeta.js';
import { coverageFormattersFlag, fileOrDirFlag, testLevelFlag, testsFlag } from '../../../utils/flags.js';
import { writeConflictTable } from '../../../utils/conflicts.js';
import { getOptionalProject } from '../../../utils/project.js';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy.metadata');
const exclusiveFlags = ['manifest', 'source-dir', 'metadata', 'metadata-dir'];
const mdapiFormatFlags = 'Metadata API Format';
const sourceFormatFlags = 'Source Format';
const testFlags = 'Test';
const destructiveFlags = 'Delete';
export default class DeployMetadata extends SfCommand<DeployResultJson> {
public static readonly description = messages.getMessage('description');
public static readonly summary = messages.getMessage('summary');
public static readonly examples = messages.getMessages('examples');
public static readonly aliases = ['deploy:metadata'];
public static readonly deprecateAliases = true;
public static readonly flags = {
'api-version': Flags.orgApiVersion({
char: 'a',
summary: messages.getMessage('flags.api-version.summary'),
description: messages.getMessage('flags.api-version.description'),
}),
async: Flags.boolean({
summary: messages.getMessage('flags.async.summary'),
description: messages.getMessage('flags.async.description'),
exclusive: ['wait'],
}),
concise: Flags.boolean({
summary: messages.getMessage('flags.concise.summary'),
exclusive: ['verbose'],
}),
'dry-run': Flags.boolean({
summary: messages.getMessage('flags.dry-run.summary'),
default: false,
}),
'ignore-conflicts': Flags.boolean({
char: 'c',
summary: messages.getMessage('flags.ignore-conflicts.summary'),
description: messages.getMessage('flags.ignore-conflicts.description'),
default: false,
}),
'ignore-errors': Flags.boolean({
char: 'r',
summary: messages.getMessage('flags.ignore-errors.summary'),
description: messages.getMessage('flags.ignore-errors.description'),
default: false,
}),
'ignore-warnings': Flags.boolean({
char: 'g',
summary: messages.getMessage('flags.ignore-warnings.summary'),
description: messages.getMessage('flags.ignore-warnings.description'),
default: false,
}),
manifest: Flags.file({
char: 'x',
description: messages.getMessage('flags.manifest.description'),
summary: messages.getMessage('flags.manifest.summary'),
exclusive: exclusiveFlags.filter((f) => f !== 'manifest'),
exists: true,
helpGroup: sourceFormatFlags,
}),
metadata: Flags.string({
char: 'm',
summary: messages.getMessage('flags.metadata.summary'),
multiple: true,
exclusive: exclusiveFlags.filter((f) => f !== 'metadata'),
helpGroup: sourceFormatFlags,
}),
'metadata-dir': fileOrDirFlag({
summary: messages.getMessage('flags.metadata-dir.summary'),
exclusive: exclusiveFlags.filter((f) => f !== 'metadata-dir'),
exists: true,
helpGroup: mdapiFormatFlags,
}),
'single-package': Flags.boolean({
summary: messages.getMessage('flags.single-package.summary'),
dependsOn: ['metadata-dir'],
helpGroup: mdapiFormatFlags,
}),
'source-dir': Flags.string({
char: 'd',
description: messages.getMessage('flags.source-dir.description'),
summary: messages.getMessage('flags.source-dir.summary'),
multiple: true,
exclusive: exclusiveFlags.filter((f) => f !== 'source-dir'),
helpGroup: sourceFormatFlags,
}),
'target-org': Flags.requiredOrg(),
tests: testsFlag({ helpGroup: testFlags }),
'test-level': testLevelFlag({
description: messages.getMessage('flags.test-level.description'),
summary: messages.getMessage('flags.test-level.summary'),
options: [TestLevel.NoTestRun, TestLevel.RunSpecifiedTests, TestLevel.RunLocalTests, TestLevel.RunAllTestsInOrg],
helpGroup: testFlags,
}),
verbose: Flags.boolean({
summary: messages.getMessage('flags.verbose.summary'),
exclusive: ['concise'],
}),
wait: Flags.duration({
char: 'w',
summary: messages.getMessage('flags.wait.summary'),
description: messages.getMessage('flags.wait.description'),
unit: 'minutes',
default: Duration.minutes(33),
helpValue: '<minutes>',
min: 1,
exclusive: ['async'],
}),
'purge-on-delete': Flags.boolean({
summary: messages.getMessage('flags.purge-on-delete.summary'),
relationships: [
{ type: 'some', flags: ['pre-destructive-changes', 'manifest', 'metadata-dir', 'post-destructive-changes'] },
],
helpGroup: destructiveFlags,
}),
'pre-destructive-changes': Flags.file({
summary: messages.getMessage('flags.pre-destructive-changes.summary'),
dependsOn: ['manifest'],
helpGroup: destructiveFlags,
}),
'post-destructive-changes': Flags.file({
summary: messages.getMessage('flags.post-destructive-changes.summary'),
dependsOn: ['manifest'],
helpGroup: destructiveFlags,
}),
'coverage-formatters': coverageFormattersFlag({ helpGroup: testFlags }),
junit: Flags.boolean({
summary: messages.getMessage('flags.junit.summary'),
helpGroup: testFlags,
}),
'results-dir': Flags.directory({
relationships: [{ type: 'some', flags: ['coverage-formatters', 'junit'] }],
summary: messages.getMessage('flags.results-dir.summary'),
helpGroup: testFlags,
}),
};
public static configurationVariablesSection = toHelpSection(
'CONFIGURATION VARIABLES',
OrgConfigProperties.TARGET_ORG,
OrgConfigProperties.ORG_API_VERSION,
ConfigVars.ORG_METADATA_REST_DEPLOY
);
public static envVariablesSection = toHelpSection(
'ENVIRONMENT VARIABLES',
EnvironmentVariable.SF_TARGET_ORG,
EnvironmentVariable.SF_USE_PROGRESS_BAR
);
public static errorCodes = toHelpSection('ERROR CODES', DEPLOY_STATUS_CODES_DESCRIPTIONS);
public async run(): Promise<DeployResultJson> {
const { flags } = await this.parse(DeployMetadata);
const project = await getOptionalProject();
if (
project?.getSfProjectJson().getContents()['pushPackageDirectoriesSequentially'] &&
// flag exclusivity is handled correctly above - but to avoid short-circuiting the check, we need to check all of them
!flags.manifest &&
!flags.metadata &&
!flags['source-dir']
) {
// if pushPackageDirectoriesSequentially = true, and they're not using any of the flags that would modify their deploy
// e.g. they're recreating a `source:push` command, which is the only one that respects this config value, warn them about it not working like it used to
this.warn(messages.getMessage('pushPackageDirsWarning'));
}
if (!validateTests(flags['test-level'], flags.tests)) {
throw messages.createError('error.NoTestsSpecified');
}
const api = await resolveApi(this.configAggregator);
const username = flags['target-org'].getUsername();
const action = flags['dry-run'] ? 'Deploying (dry-run)' : 'Deploying';
// eslint-disable-next-line @typescript-eslint/require-await
Lifecycle.getInstance().on('apiVersionDeploy', async (apiData: DeployVersionData) => {
this.log(
messages.getMessage('apiVersionMsgDetailed', [
action,
// technically manifestVersion can be undefined, but only on raw mdapi deployments.
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
flags['metadata-dir'] ? '<version specified in manifest>' : `v${apiData.manifestVersion}`,
username,
apiData.apiVersion,
apiData.webService,
])
);
});
const { deploy } = await executeDeploy(
{
...flags,
'target-org': username,
api,
},
project
);
if (!deploy) {
this.log('No changes to deploy');
return { status: 'Nothing to deploy', files: [] };
}
if (!deploy.id) {
throw new SfError('The deploy id is not available.');
}
this.log(`Deploy ID: ${ansis.bold(deploy.id)}`);
if (flags.async) {
if (flags['coverage-formatters']) {
this.warn(messages.getMessage('asyncCoverageJunitWarning'));
}
const asyncFormatter = new AsyncDeployResultFormatter(deploy.id);
if (!this.jsonEnabled()) asyncFormatter.display();
return asyncFormatter.getJson();
}
new DeployProgress(deploy, this.jsonEnabled()).start();
const result = await deploy.pollStatus({ timeout: flags.wait });
process.exitCode = determineExitCode(result);
const formatter = new DeployResultFormatter(result, flags);
if (!this.jsonEnabled()) {
formatter.display();
if (flags['dry-run']) this.logSuccess('Dry-run complete.');
}
await DeployCache.update(deploy.id, { status: result.response.status });
return formatter.getJson();
}
protected catch(error: Error | SfError): Promise<never> {
if (error instanceof SourceConflictError && error.data) {
if (!this.jsonEnabled()) {
writeConflictTable(error.data);
// set the message and add plugin-specific actions
return super.catch({
...error,
message: messages.getMessage('error.Conflicts'),
actions: messages.getMessages('error.Conflicts.Actions'),
});
}
}
if (error.message.includes('client has timed out')) {
const err = messages.createError('error.ClientTimeout');
return super.catch({
...error,
name: err.name,
message: err.message,
...(typeof err.code === 'string' || typeof err.code === 'number' ? { code: err.code } : {}),
});
}
return super.catch(error);
}
}