ReleasePipeline.ts

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See LICENSE in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { GitHub, GitHubIssue } from '../api/api';
import { loadLatestRelease, Release, safeLog } from '../common/utils';

export class ReleasePipeline {
	constructor(
		private github: GitHub,
		private notYetReleasedLabel: string,
		private insidersReleasedLabel: string,
	) {}

	async run() {
		const latestRelease = await loadLatestRelease('insider');
		if (!latestRelease) throw Error('Error loading latest release');

		const query = `is:closed label:${this.notYetReleasedLabel}`;

		for await (const page of this.github.query({ q: query })) {
			for (const issue of page) {
				const issueData = await issue.getIssue();
				if (!issueData) continue;

				if (issueData.labels.includes(this.notYetReleasedLabel) && issueData.open === false) {
					await this.update(issue, latestRelease);
					await new Promise((resolve) => setTimeout(resolve, 1000));
				} else {
					safeLog('Query returned an invalid issue:' + issueData.number);
				}
			}
		}
	}

	private async commentUnableToFindCommitMessage(issue: GitHubIssue) {
		const key = `<!-- UNABLE_TO_LOCATE_COMMIT_MESSAGE -->`;

		for await (const page of issue.getComments()) {
			for (const comment of page) {
				if (comment.body.includes(key)) {
					return;
				}
			}
		}

		await issue.postComment(
			`${key}\nIssue marked as unreleased but unable to locate closing commit in issue timeline. You can manually reference a commit by commenting \`\\closedWith someCommitSha\`, or directly add the \`${this.insidersReleasedLabel}\` label if you know this has already been released`,
		);
	}

	private async update(issue: GitHubIssue, latestRelease: Release) {
		const closingHash = (await issue.getClosingInfo())?.hash;

		if (!closingHash) {
			await issue.removeLabel(this.notYetReleasedLabel);
			await this.commentUnableToFindCommitMessage(issue);
			return;
		}

		const releaseContainsCommit = await issue
			.releaseContainsCommit(latestRelease.version, closingHash)
			.catch(() => 'unknown' as const);

		if (releaseContainsCommit === 'yes') {
			await issue.removeLabel(this.notYetReleasedLabel);
			await issue.addLabel(this.insidersReleasedLabel);
		} else if (releaseContainsCommit === 'no') {
			await issue.removeLabel(this.insidersReleasedLabel);
			await issue.addLabel(this.notYetReleasedLabel);
		} else {
			const ghIssue = await issue.getIssue();
			if (ghIssue && ghIssue.labels.includes(this.notYetReleasedLabel)) {
				await issue.removeLabel(this.notYetReleasedLabel);
				await this.commentUnableToFindCommitMessage(issue);
			}
		}
	}
}

export const enrollIssue = async (issue: GitHubIssue, notYetReleasedLabel: string) => {
	const closingHash = (await issue.getClosingInfo())?.hash;
	if (closingHash) {
		await issue.addLabel(notYetReleasedLabel);
		// Get the milestone linked to the current release and set it if the issue doesn't have one
		const releaseMilestone = (await issue.getIssue())?.milestone
			? undefined
			: await issue.getCurrentRepoMilestone();
		if (releaseMilestone !== undefined) {
			await issue.setMilestone(releaseMilestone);
		}
	}
};

export const unenrollIssue = async (
	issue: GitHubIssue,
	notYetReleasedLabel: string,
	insidersReleasedLabel: string,
) => {
	await issue.removeLabel(insidersReleasedLabel);
	await issue.removeLabel(notYetReleasedLabel);
};