Fail build when settings search build id generation fails (#47359)

* Ensure that settings search build id handling fail will cause the build to fail

* Move some settings search build ID computation to util.ts

* Bump version number for test

* Add unit tests for util.ts additions

* Revert version number change

* Make versionStringToNumber throw if it fails

* Add missing import

build/gulpfile.vscode.js

@@ -275,7 +275,7 @@ function packageTask(platform, arch, opts) {
 		const packageJsonStream = gulp.src(['package.json'], { base: '.' })
 			.pipe(json({ name, version }));
 
-		const settingsSearchBuildId = getBuildNumber();
+		const settingsSearchBuildId = getSettingsSearchBuildId(packageJson);
 		const date = new Date().toISOString();
 		const productJsonStream = gulp.src(['product.json'], { base: '.' })
 			.pipe(json({ commit, date, checksums, settingsSearchBuildId }));
@@ -481,14 +481,12 @@ gulp.task('upload-vscode-configuration', ['generate-vscode-configuration'], () =
 	}
 
 	if (!fs.existsSync(allConfigDetailsPath)) {
-		console.error(`configuration file at ${allConfigDetailsPath} does not exist`);
-		return;
+		throw new Error(`configuration file at ${allConfigDetailsPath} does not exist`);
 	}
 
-	const settingsSearchBuildId = getBuildNumber();
+	const settingsSearchBuildId = getSettingsSearchBuildId(packageJson);
 	if (!settingsSearchBuildId) {
-		console.error('Failed to compute build number');
-		return;
+		throw new Error('Failed to compute build number');
 	}
 
 	return gulp.src(allConfigDetailsPath)
@@ -500,76 +498,18 @@ gulp.task('upload-vscode-configuration', ['generate-vscode-configuration'], () =
 		}));
 });
 
-function getBuildNumber() {
-	const previous = getPreviousVersion(packageJson.version);
-	if (!previous) {
-		return 0;
-	}
+function getSettingsSearchBuildId(packageJson) {
+	const previous = util.getPreviousVersion(packageJson.version);
 
 	try {
 		const out = cp.execSync(`git rev-list ${previous}..HEAD --count`);
 		const count = parseInt(out.toString());
-		return versionStringToNumber(packageJson.version) * 1e4 + count;
+		return util.versionStringToNumber(packageJson.version) * 1e4 + count;
 	} catch (e) {
-		console.error('Could not determine build number: ' + e.toString());
-		return 0;
-	}
-}
-
-/**
- * Given 1.17.2, return 1.17.1
- * 1.18.0 => 1.17.2.
- * 2.0.0 => 1.18.0 (or the highest 1.x)
- */
-function getPreviousVersion(versionStr) {
-	function tagExists(tagName) {
-		try {
-			cp.execSync(`git rev-parse ${tagName}`, { stdio: 'ignore' });
-			return true;
-		} catch (e) {
-			return false;
-		}
-	}
-
-	function getLastTagFromBase(semverArr, componentToTest) {
-		const baseVersion = semverArr.join('.');
-		if (!tagExists(baseVersion)) {
-			console.error('Failed to find tag for base version, ' + baseVersion);
-			return null;
-		}
-
-		let goodTag;
-		do {
-			goodTag = semverArr.join('.');
-			semverArr[componentToTest]++;
-		} while (tagExists(semverArr.join('.')));
-
-		return goodTag;
-	}
-
-	const semverArr = versionStr.split('.');
-	if (semverArr[2] > 0) {
-		semverArr[2]--;
-		return semverArr.join('.');
-	} else if (semverArr[1] > 0) {
-		semverArr[1]--;
-		return getLastTagFromBase(semverArr, 2);
-	} else {
-		semverArr[0]--;
-		return getLastTagFromBase(semverArr, 1);
+		throw new Error('Could not determine build number: ' + e.toString());
 	}
 }
 
-function versionStringToNumber(versionStr) {
-	const semverRegex = /(\d+)\.(\d+)\.(\d+)/;
-	const match = versionStr.match(semverRegex);
-	if (!match) {
-		return 0;
-	}
-
-	return parseInt(match[1], 10) * 1e4 + parseInt(match[2], 10) * 1e2 + parseInt(match[3], 10);
-}
-
 // This task is only run for the MacOS build
 gulp.task('generate-vscode-configuration', () => {
 	return new Promise((resolve, reject) => {
@@ -601,8 +541,5 @@ gulp.task('generate-vscode-configuration', () => {
 			clearTimeout(timer);
 			reject(err);
 		});
-	}).catch(e => {
-		// Don't fail the build
-		console.error(e.toString());
 	});
 });

build/lib/test/util.test.js

+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+var assert = require("assert");
+var util = require("../util");
+function getMockTagExists(tags) {
+    return function (tag) { return tags.indexOf(tag) >= 0; };
+}
+suite('util tests', function () {
+    test('getPreviousVersion - patch', function () {
+        assert.equal(util.getPreviousVersion('1.2.3', getMockTagExists(['1.2.2', '1.2.1', '1.2.0', '1.1.0'])), '1.2.2');
+    });
+    test('getPreviousVersion - patch invalid', function () {
+        try {
+            util.getPreviousVersion('1.2.2', getMockTagExists(['1.2.0', '1.1.0']));
+        }
+        catch (e) {
+            // expected
+            return;
+        }
+        throw new Error('Expected an exception');
+    });
+    test('getPreviousVersion - minor', function () {
+        assert.equal(util.getPreviousVersion('1.2.0', getMockTagExists(['1.1.0', '1.1.1', '1.1.2', '1.1.3'])), '1.1.3');
+        assert.equal(util.getPreviousVersion('1.2.0', getMockTagExists(['1.1.0', '1.0.0'])), '1.1.0');
+    });
+    test('getPreviousVersion - minor gap', function () {
+        assert.equal(util.getPreviousVersion('1.2.0', getMockTagExists(['1.1.0', '1.1.1', '1.1.3'])), '1.1.1');
+    });
+    test('getPreviousVersion - minor invalid', function () {
+        try {
+            util.getPreviousVersion('1.2.0', getMockTagExists(['1.0.0']));
+        }
+        catch (e) {
+            // expected
+            return;
+        }
+        throw new Error('Expected an exception');
+    });
+    test('getPreviousVersion - major', function () {
+        assert.equal(util.getPreviousVersion('2.0.0', getMockTagExists(['1.0.0', '1.1.0', '1.2.0', '1.2.1', '1.2.2'])), '1.2.2');
+    });
+    test('getPreviousVersion - major invalid', function () {
+        try {
+            util.getPreviousVersion('3.0.0', getMockTagExists(['1.0.0']));
+        }
+        catch (e) {
+            // expected
+            return;
+        }
+        throw new Error('Expected an exception');
+    });
+});

build/lib/test/util.test.ts

+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import assert = require('assert');
+import util = require('../util');
+
+function getMockTagExists(tags: string[]) {
+	return (tag: string) => tags.indexOf(tag) >= 0;
+}
+
+suite('util tests', () => {
+	test('getPreviousVersion - patch', () => {
+		assert.equal(
+			util.getPreviousVersion('1.2.3', getMockTagExists(['1.2.2', '1.2.1', '1.2.0', '1.1.0'])),
+			'1.2.2'
+		);
+	});
+
+	test('getPreviousVersion - patch invalid', () => {
+		try {
+			util.getPreviousVersion('1.2.2', getMockTagExists(['1.2.0', '1.1.0']));
+		} catch (e) {
+			// expected
+			return;
+		}
+
+		throw new Error('Expected an exception');
+	});
+
+	test('getPreviousVersion - minor', () => {
+		assert.equal(
+			util.getPreviousVersion('1.2.0', getMockTagExists(['1.1.0', '1.1.1', '1.1.2', '1.1.3'])),
+			'1.1.3'
+		);
+
+		assert.equal(
+			util.getPreviousVersion('1.2.0', getMockTagExists(['1.1.0', '1.0.0'])),
+			'1.1.0'
+		);
+	});
+
+	test('getPreviousVersion - minor gap', () => {
+		assert.equal(
+			util.getPreviousVersion('1.2.0', getMockTagExists(['1.1.0', '1.1.1', '1.1.3'])),
+			'1.1.1'
+		);
+	});
+
+	test('getPreviousVersion - minor invalid', () => {
+		try {
+			util.getPreviousVersion('1.2.0', getMockTagExists(['1.0.0']));
+		} catch (e) {
+			// expected
+			return;
+		}
+
+		throw new Error('Expected an exception');
+	});
+
+	test('getPreviousVersion - major', () => {
+		assert.equal(
+			util.getPreviousVersion('2.0.0', getMockTagExists(['1.0.0', '1.1.0', '1.2.0', '1.2.1', '1.2.2'])),
+			'1.2.2'
+		);
+	});
+
+	test('getPreviousVersion - major invalid', () => {
+		try {
+			util.getPreviousVersion('3.0.0', getMockTagExists(['1.0.0']));
+		} catch (e) {
+			// expected
+			return;
+		}
+
+		throw new Error('Expected an exception');
+	});
+});

build/lib/util.js

@@ -14,6 +14,7 @@ var fs = require("fs");
 var _rimraf = require("rimraf");
 var git = require("./git");
 var VinylFile = require("vinyl");
+var cp = require("child_process");
 var NoCancellationToken = { isCancellationRequested: function () { return false; } };
 function incremental(streamProvider, initial, supportsCancellation) {
     var input = es.through();
@@ -210,3 +211,68 @@ function filter(fn) {
     return result;
 }
 exports.filter = filter;
+function tagExists(tagName) {
+    try {
+        cp.execSync("git rev-parse " + tagName, { stdio: 'ignore' });
+        return true;
+    }
+    catch (e) {
+        return false;
+    }
+}
+/**
+ * Returns the version previous to the given version. Throws if a git tag for that version doesn't exist.
+ * Given 1.17.2, return 1.17.1
+ * 1.18.0 => 1.17.2. (or the highest 1.17.x)
+ * 2.0.0 => 1.18.0 (or the highest 1.x)
+ */
+function getPreviousVersion(versionStr, _tagExists) {
+    if (_tagExists === void 0) { _tagExists = tagExists; }
+    function getLatestTagFromBase(semverArr, componentToTest) {
+        var baseVersion = semverArr.join('.');
+        if (!_tagExists(baseVersion)) {
+            throw new Error('Failed to find git tag for base version, ' + baseVersion);
+        }
+        var goodTag;
+        do {
+            goodTag = semverArr.join('.');
+            semverArr[componentToTest]++;
+        } while (_tagExists(semverArr.join('.')));
+        return goodTag;
+    }
+    var semverArr = versionStringToNumberArray(versionStr);
+    if (semverArr[2] > 0) {
+        semverArr[2]--;
+        var previous = semverArr.join('.');
+        if (!_tagExists(previous)) {
+            throw new Error('Failed to find git tag for previous version, ' + previous);
+        }
+        return previous;
+    }
+    else if (semverArr[1] > 0) {
+        semverArr[1]--;
+        return getLatestTagFromBase(semverArr, 2);
+    }
+    else {
+        semverArr[0]--;
+        // Find 1.x.0 for latest x
+        var latestMinorVersion = getLatestTagFromBase(semverArr, 1);
+        // Find 1.x.y for latest y
+        return getLatestTagFromBase(versionStringToNumberArray(latestMinorVersion), 2);
+    }
+}
+exports.getPreviousVersion = getPreviousVersion;
+function versionStringToNumberArray(versionStr) {
+    return versionStr
+        .split('.')
+        .map(function (s) { return parseInt(s); });
+}
+function versionStringToNumber(versionStr) {
+    var semverRegex = /(\d+)\.(\d+)\.(\d+)/;
+    var match = versionStr.match(semverRegex);
+    if (!match) {
+        throw new Error('Version string is not properly formatted: ' + versionStr);
+    }
+    return parseInt(match[1], 10) * 1e4 + parseInt(match[2], 10) * 1e2 + parseInt(match[3], 10);
+}
+exports.versionStringToNumber = versionStringToNumber;

build/lib/util.ts

@@ -17,6 +17,7 @@ import * as git from './git';
 import * as VinylFile from 'vinyl';
 import { ThroughStream } from 'through';
 import * as sm from 'source-map';
+import * as cp from 'child_process';
 
 export interface ICancellationToken {
 	isCancellationRequested(): boolean;
@@ -268,4 +269,74 @@ export function filter(fn: (data: any) => boolean): FilterStream {
 
 	result.restore = es.through();
 	return result;
-}
\ No newline at end of file
+}
+
+function tagExists(tagName: string): boolean {
+	try {
+		cp.execSync(`git rev-parse ${tagName}`, { stdio: 'ignore' });
+		return true;
+	} catch (e) {
+		return false;
+	}
+}
+
+/**
+ * Returns the version previous to the given version. Throws if a git tag for that version doesn't exist.
+ * Given 1.17.2, return 1.17.1
+ * 1.18.0 => 1.17.2. (or the highest 1.17.x)
+ * 2.0.0 => 1.18.0 (or the highest 1.x)
+ */
+export function getPreviousVersion(versionStr: string, _tagExists = tagExists) {
+	function getLatestTagFromBase(semverArr: number[], componentToTest: number): string {
+		const baseVersion = semverArr.join('.');
+		if (!_tagExists(baseVersion)) {
+			throw new Error('Failed to find git tag for base version, ' + baseVersion);
+		}
+
+		let goodTag;
+		do {
+			goodTag = semverArr.join('.');
+			semverArr[componentToTest]++;
+		} while (_tagExists(semverArr.join('.')));
+
+		return goodTag;
+	}
+
+	const semverArr = versionStringToNumberArray(versionStr);
+	if (semverArr[2] > 0) {
+		semverArr[2]--;
+		const previous = semverArr.join('.');
+		if (!_tagExists(previous)) {
+			throw new Error('Failed to find git tag for previous version, ' + previous);
+		}
+
+		return previous;
+	} else if (semverArr[1] > 0) {
+		semverArr[1]--;
+		return getLatestTagFromBase(semverArr, 2);
+	} else {
+		semverArr[0]--;
+
+		// Find 1.x.0 for latest x
+		const latestMinorVersion = getLatestTagFromBase(semverArr, 1);
+
+		// Find 1.x.y for latest y
+		return getLatestTagFromBase(versionStringToNumberArray(latestMinorVersion), 2);
+	}
+}
+
+function versionStringToNumberArray(versionStr: string): number[] {
+	return versionStr
+		.split('.')
+		.map(s => parseInt(s));
+}
+
+export function versionStringToNumber(versionStr: string) {
+	const semverRegex = /(\d+)\.(\d+)\.(\d+)/;
+	const match = versionStr.match(semverRegex);
+	if (!match) {
+		throw new Error('Version string is not properly formatted: ' + versionStr);
+	}
+
+	return parseInt(match[1], 10) * 1e4 + parseInt(match[2], 10) * 1e2 + parseInt(match[3], 10);
+}