generated from salesforcecli/plugin-template
-
Notifications
You must be signed in to change notification settings - Fork 18
/
deploy.ts
164 lines (139 loc) · 5.67 KB
/
deploy.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
/*
* 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 { EOL } from 'os';
import { Flags } from '@oclif/core';
import { fs, Messages } from '@salesforce/core';
import { Env } from '@salesforce/kit';
import { Deployable, Deployer, generateTableChoices, Prompter, SfCommand, SfHook } from '@salesforce/sf-plugins-core';
import { exec } from 'shelljs';
Messages.importMessagesDirectory(__dirname);
const messages = Messages.loadMessages('@salesforce/plugin-deploy-retrieve', 'deploy');
export const DEPLOY_OPTIONS_FILE = 'deploy-options.json';
export default class Deploy extends SfCommand<void> {
public static summary = messages.getMessage('summary');
public static description = messages.getMessage('description');
public static examples = messages.getMessages('examples');
public static enableJsonFlag = false;
public static flags = {
interactive: Flags.boolean({
summary: messages.getMessage('flags.interactive.summary'),
}),
};
public async run(): Promise<void> {
process.setMaxListeners(new Env().getNumber('SF_MAX_EVENT_LISTENERS') || 1000);
const { flags } = await this.parse(Deploy);
flags.interactive = await this.isInteractive(flags.interactive);
const options = await this.readOptions();
this.log('Analyzing project');
if (!flags.interactive) {
this.log(`Using options found in ${DEPLOY_OPTIONS_FILE}`);
}
const hookResults = await SfHook.run(this.config, 'sf:deploy', options);
let deployers = hookResults.successes.flatMap((s) => s.result);
if (deployers.length === 0) {
this.log('Found nothing in the project to deploy');
} else {
if (flags.interactive) {
deployers = await this.selectDeployers(deployers);
} else {
deployers = deployers.filter((d) => !!options[d.getName()]);
}
if (deployers.length === 0) {
this.log('Nothing was selected to deploy.');
}
const deployOptions: Record<string, Deployer.Options> = {};
for (const deployer of deployers) {
const opts = options[deployer.getName()] ?? {};
deployOptions[deployer.getName()] = await deployer.setup(flags, opts);
}
if (flags.interactive && (await this.askToSave())) {
await fs.writeJson(DEPLOY_OPTIONS_FILE, deployOptions);
this.log();
this.log(`Your deploy options have been saved to ${DEPLOY_OPTIONS_FILE}`);
if (await this.shouldCommit()) {
await this.commit();
this.log(`We added ${DEPLOY_OPTIONS_FILE} to the .gitignore for you.`);
}
}
for (const deployer of deployers) {
await deployer.deploy();
}
}
}
/**
* If the deploy file exists, we do not want the command to be interactive. But if the file
* does not exist then we want to force the command to be interactive.
*/
public async isInteractive(interactive: boolean): Promise<boolean> {
if (interactive) return true;
const deployFileExists = await fs.fileExists(DEPLOY_OPTIONS_FILE);
return deployFileExists ? false : true;
}
public async readOptions(): Promise<Record<string, Deployer.Options>> {
if (await fs.fileExists(DEPLOY_OPTIONS_FILE)) {
return fs.readJsonMap<Record<string, Deployer.Options>>(DEPLOY_OPTIONS_FILE);
} else {
return {};
}
}
public async commit(): Promise<void> {
const gitignore = await fs.readFile('.gitignore', 'utf-8');
if (!gitignore.includes(DEPLOY_OPTIONS_FILE)) {
const addition = `${EOL}${EOL}# Deploy Options${EOL}${DEPLOY_OPTIONS_FILE}${EOL}`;
await fs.writeFile('.gitignore', `${gitignore}${addition}`);
}
exec('git add .gitignore', { silent: true });
exec(`git commit -am "Add ${DEPLOY_OPTIONS_FILE} to .gitignore"`, { silent: true });
}
public async shouldCommit(): Promise<boolean> {
return (await fs.fileExists('.git')) && (await fs.fileExists('functions'));
}
public async askToSave(): Promise<boolean> {
const prompter = new Prompter();
const { save } = await prompter.prompt<{ save: boolean }>({
name: 'save',
message: 'Would you like to save these deploy options for future runs?',
type: 'confirm',
});
return save;
}
public async selectDeployers(deployers: Deployer[]): Promise<Deployer[]> {
const deployables: Deployable[] = deployers.reduce((x, y) => x.concat(y.deployables), [] as Deployable[]);
const columns = { name: 'APP OR PACKAGE', type: 'TYPE', path: 'PATH' };
const options = deployables.map((deployable) => ({
name: deployable.getName(),
type: deployable.getType(),
path: deployable.getPath(),
value: deployable,
}));
const prompter = new Prompter();
const responses = await prompter.prompt<{ deployables: Deployable[] }>([
{
name: 'deployables',
message: 'Select apps and packages to deploy:',
type: 'checkbox',
choices: generateTableChoices<Deployable>(columns, options),
},
]);
const chosenDeployers: Map<Deployer, Deployable[]> = new Map();
for (const deployable of responses.deployables) {
const parent = deployable.getParent();
if (chosenDeployers.has(parent)) {
const existing = chosenDeployers.get(parent) || [];
chosenDeployers.set(parent, [...existing, deployable]);
} else {
chosenDeployers.set(parent, [deployable]);
}
}
const final: Deployer[] = [];
for (const [parent, children] of Array.from(chosenDeployers.entries())) {
parent.selectDeployables(children);
final.push(parent);
}
return final;
}
}