Repository navigation
Expand file tree
/
Copy pathsetup_execution_workflow.ts
More file actions
276 lines (264 loc) · 11.9 KB
/
Copy pathsetup_execution_workflow.ts
File metadata and controls
276 lines (264 loc) · 11.9 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
import { isSafeBranchTree } from '../../../domain/deployment_configuration';
import { PendingPullRequestLinkError, pendingPullRequestParent } from '../../../domain/pull_request_issue_link_state';
import { ApplicationError } from '../../errors/application_error';
import type {
SetupConfigurationQueryPort,
SetupIssueQueryPort,
SetupOrganizationQueryPort,
} from '../../ports/setup_execution_ports';
import { ACTIONS } from '../../../data/model/action_types';
import { restorePreviousBranchState } from '../../../data/model/previous_branch_state_policy';
import { ALL_ISSUE_WORKFLOWS, classifyIssueWorkflow } from '../../../domain/issue_workflow_profile';
import { setGlobalLoggerDebug } from '../../ports/logging_ports';
import type { ExecutionBranchVersionResolution } from './execution_branch_version_resolver';
import { resolveExecutionIssueNumber } from './resolve_execution_issue_number';
import type {
SetupConfigurationPatch,
SetupExecutionContext,
SetupExecutionResult,
SetupExecutionState,
SetupHotfixState,
SetupReleaseState,
} from './setup_execution_contracts';
export interface SetupExecutionDependencies {
readonly issueSetupPort: SetupIssueQueryPort;
readonly organizationSetupPort: SetupOrganizationQueryPort;
readonly configurationPort: SetupConfigurationQueryPort;
readonly branchVersionResolver: ExecutionBranchVersionResolution;
}
export async function runSetupExecution(
context: SetupExecutionContext,
dependencies: SetupExecutionDependencies,
): Promise<SetupExecutionResult> {
setGlobalLoggerDebug(context.debug, context.local);
const tokenUser = await loadTokenUser(context, dependencies.organizationSetupPort);
const issueResolution = await resolveExecutionIssueNumber(context, dependencies.issueSetupPort);
const isRepositorySetup = context.isSingleAction && context.singleAction.currentAction === ACTIONS.INITIAL_SETUP;
const canConfigureUnlinkedPullRequest = context.isPullRequest && !isRepositorySetup
&& positiveIssueNumberOrUndefined(context.pullRequest.number) !== undefined;
if (issueResolution.issueNumber === undefined && !canConfigureUnlinkedPullRequest) {
return { status: 'issue-unresolved', tokenUser, issueResolution };
}
const previousConfiguration = await loadPreviousConfiguration(
context,
issueResolution.issueNumber,
dependencies.configurationPort,
);
const currentIssueLabels = issueResolution.issueNumber === undefined
? []
: await dependencies.issueSetupPort.getLabels(issueResolution.issueNumber);
const liveIssueBody = issueResolution.issueNumber === undefined
? undefined
: await dependencies.issueSetupPort.getDescription(issueResolution.issueNumber);
const liveIssueTitle = issueResolution.issueNumber === undefined
? undefined
: await dependencies.issueSetupPort.getTitle(issueResolution.issueNumber);
const issueAdmission = issueResolution.issueNumber !== undefined
? classifyIssueWorkflow(currentIssueLabels, context.issueWorkflowProfile ?? ALL_ISSUE_WORKFLOWS, {
feature: [context.labelNames.feature, context.labelNames.enhancement],
bugfix: [context.labelNames.bugfix, context.labelNames.bug],
documentation: [context.labelNames.documentation, context.labelNames.docs],
chore: [context.labelNames.chore, context.labelNames.maintenance],
help: [context.labelNames.help ?? 'help', context.labelNames.question ?? 'question'],
hotfix: [context.labelNames.hotfix],
release: [context.labelNames.release],
}, liveIssueBody ?? '')
: undefined;
let release: SetupReleaseState = {
...context.release,
active: currentIssueLabels.includes(context.labelNames.release),
};
let hotfix: SetupHotfixState = {
...context.hotfix,
active: currentIssueLabels.includes(context.labelNames.hotfix),
};
const restored = restorePreviousBranchState(
previousConfiguration,
release.active ? 'release' : hotfix.active ? 'hotfix' : 'default',
context.branches.releaseTree,
context.branches.hotfixTree,
);
release = {
...release,
version: restored.releaseVersion,
branch: restored.releaseBranch,
};
hotfix = {
...hotfix,
baseVersion: restored.hotfixBaseVersion,
baseBranch: restored.hotfixBaseBranch,
version: restored.hotfixVersion,
branch: restored.hotfixBranch,
};
let configuration: SetupConfigurationPatch = {
deploymentOrchestration: previousConfiguration?.deploymentOrchestration,
releaseOriginBranch: previousConfiguration?.releaseOriginBranch,
releaseOriginSha: previousConfiguration?.releaseOriginSha,
hotfixOriginSha: previousConfiguration?.hotfixOriginSha,
parentBranch: restored.parentBranch,
workingBranch: restored.workingBranch,
releaseBranch: restored.releaseBranch,
hotfixOriginBranch: restored.hotfixBaseBranch,
hotfixBranch: restored.hotfixBranch,
};
let currentPullRequestLabels = [...context.currentPullRequestLabels];
let pullRequestParentBranch: string | undefined;
if (context.isIssue && !context.isSingleAction && issueResolution.issueNumber !== undefined && issueAdmission?.status === 'eligible') {
const resolution = await dependencies.branchVersionResolver.resolve({
body: liveIssueBody,
issueWorkflowProfile: context.issueWorkflowProfile,
issueNumber: issueResolution.issueNumber,
release,
hotfix,
branches: {
releaseTree: context.branches.releaseTree,
hotfixTree: context.branches.hotfixTree,
},
configuration,
});
release = resolution.release;
hotfix = resolution.hotfix;
configuration = resolution.configuration;
if (!resolution.completed) {
return {
status: 'version-unresolved',
tokenUser,
issueResolution,
state: setupState(
previousConfiguration,
currentIssueLabels,
currentPullRequestLabels,
release,
hotfix,
configuration,
liveIssueBody,
issueAdmission,
liveIssueTitle,
),
};
}
}
if (context.isPullRequest && !context.isSingleAction) {
const pullRequestBody = await dependencies.issueSetupPort.getDescription(context.pullRequest.number);
const pendingParent = pendingPullRequestParent(pullRequestBody ?? '', context.pullRequest.number,
issueResolution.issueNumber ?? context.pullRequest.number);
// An admitted issue's exact managed head retains parent authority even
// if an older runtime already discarded the pending body record.
const admitted = issueResolution.issueNumber !== undefined && issueAdmission?.status === 'eligible'
&& ['feature', 'bugfix', 'documentation', 'chore'].includes(issueAdmission.kind)
? await dependencies.configurationPort.get(issueResolution.issueNumber) : undefined;
const resolvedHead = issueResolution.pullRequestHeadBranch || context.pullRequest.head;
const admittedParent = admitted?.workingBranch === resolvedHead ? admitted?.parentBranch : undefined;
if (admittedParent && !isSafeBranchTree(admittedParent)) {
throw new ApplicationError('configuration.invalid', 'The admitted managed parent is not a safe branch.');
}
if (pendingParent && admittedParent && pendingParent !== admittedParent) {
throw new PendingPullRequestLinkError('ownership');
}
pullRequestParentBranch = admittedParent;
currentPullRequestLabels = await dependencies.issueSetupPort.getLabels(context.pullRequest.number);
release = {
...release,
active: context.pullRequest.base.includes(`${context.branches.releaseTree}/`),
};
hotfix = {
...hotfix,
active: context.pullRequest.base.includes(`${context.branches.hotfixTree}/`),
};
configuration = {
...configuration,
workingBranch: issueResolution.pullRequestHeadBranch || context.pullRequest.head || configuration.workingBranch,
parentBranch: pendingParent ?? admittedParent ?? (context.pullRequest.base || configuration.parentBranch),
};
}
return {
status: 'configured',
tokenUser,
issueResolution,
branchType: issueAdmission && issueAdmission.status !== 'eligible'
? ''
: resolveIssueType(context, issueAdmission),
state: setupState(
previousConfiguration,
currentIssueLabels,
currentPullRequestLabels,
release,
hotfix,
configuration,
liveIssueBody,
issueAdmission,
liveIssueTitle,
pullRequestParentBranch,
),
};
}
async function loadTokenUser(
context: SetupExecutionContext,
organizationSetupPort: SetupOrganizationQueryPort,
): Promise<string> {
if (context.tokenUser !== undefined) return context.tokenUser;
const tokenUser = await organizationSetupPort.getTokenUser();
if (!tokenUser) {
throw new ApplicationError('authorization.credential-invalid', 'Failed to get user from token.');
}
return tokenUser;
}
async function loadPreviousConfiguration(
context: SetupExecutionContext,
resolvedIssueNumber: number | undefined,
configurationPort: SetupConfigurationQueryPort,
) {
const issueNumber = configurationIssueNumber(context, resolvedIssueNumber);
return issueNumber === undefined ? undefined : configurationPort.get(issueNumber);
}
function configurationIssueNumber(
context: SetupExecutionContext,
resolvedIssueNumber: number | undefined,
): number | undefined {
if (context.isSingleAction || context.isPush) return positiveIssueNumberOrUndefined(resolvedIssueNumber);
if (context.isIssue) return positiveIssueNumberOrUndefined(context.issue.number);
if (context.isPullRequest) return positiveIssueNumberOrUndefined(context.pullRequest.number);
return undefined;
}
function resolveIssueType(
context: SetupExecutionContext,
admission: SetupExecutionState['issueWorkflowAdmission'],
): string {
if (!admission || admission.status !== 'eligible' || admission.kind === 'help') return '';
return ({
feature: context.branches.featureTree,
bugfix: context.branches.bugfixTree,
documentation: context.branches.docsTree,
chore: context.branches.choreTree,
hotfix: context.branches.hotfixTree,
release: context.branches.releaseTree,
})[admission.kind];
}
function setupState(
previousConfiguration: SetupExecutionState['previousConfiguration'],
currentIssueLabels: readonly string[],
currentPullRequestLabels: readonly string[],
release: SetupReleaseState,
hotfix: SetupHotfixState,
configuration: SetupConfigurationPatch,
liveIssueBody?: string,
issueWorkflowAdmission?: SetupExecutionState['issueWorkflowAdmission'],
liveIssueTitle?: string,
pullRequestParentBranch?: string,
): SetupExecutionState {
return {
previousConfiguration,
currentIssueLabels: [...currentIssueLabels],
currentPullRequestLabels: [...currentPullRequestLabels],
release: { ...release },
hotfix: { ...hotfix },
configuration: { ...configuration },
liveIssueBody,
liveIssueTitle,
issueWorkflowAdmission,
pullRequestParentBranch,
};
}
function positiveIssueNumberOrUndefined(value: unknown): number | undefined {
return typeof value === 'number' && value > 0 && Number.isSafeInteger(value) ? value : undefined;
}