feat: allow downloading server versions (#304)

Author: connor4312

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-### Unreleased
+### 2.5.1 | 2024-04-07
+
+- Allow downloading server versions
+
+### 2.5.0 | 2024-02-04
 
 - Fix deleting old Insiders in electron not working
 

lib/download.ts

@@ -20,6 +20,7 @@ import {
 	insidersDownloadDirMetadata,
 	insidersDownloadDirToExecutablePath,
 	isDefined,
+	isPlatformCLI,
 	isSubdirectory,
 	onceWithoutRejections,
 	streamToBuffer,
@@ -348,6 +349,7 @@ async function unzipVSCode(
 ) {
 	const stagingFile = path.join(tmpdir(), `vscode-test-${Date.now()}.zip`);
 	const checksum = validateStream(stream, length, sha256);
+	const stripComponents = isPlatformCLI(platform) ? 0 : 1;
 
 	if (format === 'zip') {
 		try {
@@ -366,11 +368,14 @@ async function unzipVSCode(
 				// extract file with jszip
 				for (const filename of Object.keys(content.files)) {
 					const file = content.files[filename];
-					const filepath = path.join(extractDir, filename);
 					if (file.dir) {
 						continue;
 					}
 
+					const filepath = stripComponents
+						? path.join(extractDir, filename.split(/[/\\]/g).slice(stripComponents).join(path.sep))
+						: path.join(extractDir, filename);
+
 					// vscode update zips are trusted, but check for zip slip anyway.
 					if (!isSubdirectory(extractDir, filepath)) {
 						throw new Error(`Invalid zip file: ${filename}`);
@@ -388,6 +393,17 @@ async function unzipVSCode(
 				await fs.promises.mkdir(extractDir, { recursive: true });
 
 				await spawnDecompressorChild('unzip', ['-q', stagingFile, '-d', extractDir]);
+
+				// unzip has no --strip-components equivalent
+				if (stripComponents) {
+					const files = await fs.promises.readdir(extractDir);
+					for (const file of files) {
+						const dirPath = path.join(extractDir, file);
+						const children = await fs.promises.readdir(dirPath);
+						await Promise.all(children.map((c) => fs.promises.rename(path.join(dirPath, c), path.join(extractDir, c))));
+						await fs.promises.rmdir(dirPath);
+					}
+				}
 			}
 		} finally {
 			fs.unlink(stagingFile, () => undefined);
@@ -399,8 +415,11 @@ async function unzipVSCode(
 		}
 
 		// The CLI is a singular binary that doesn't have a wrapper component to remove
-		const s = platform.includes('cli-') ? 0 : 1;
-		await spawnDecompressorChild('tar', ['-xzf', '-', `--strip-components=${s}`, '-C', extractDir], stream);
+		await spawnDecompressorChild(
+			'tar',
+			['-xzf', '-', `--strip-components=${stripComponents}`, '-C', extractDir],
+			stream,
+		);
 		await checksum;
 	}
 }
@@ -472,7 +491,11 @@ export async function download(options: Partial<DownloadOptions> = {}): Promise<
 	if (fs.existsSync(path.join(downloadedPath, COMPLETE_FILE_NAME))) {
 		if (version.isInsiders) {
 			reporter.report({ stage: ProgressReportStage.FetchingInsidersMetadata });
-			const { version: currentHash, date: currentDate } = insidersDownloadDirMetadata(downloadedPath, platform);
+			const { version: currentHash, date: currentDate } = insidersDownloadDirMetadata(
+				downloadedPath,
+				platform,
+				reporter,
+			);
 
 			const { version: latestHash, timestamp: latestTimestamp } =
 				version.id === 'insiders' // not qualified with a date

lib/util.ts

@@ -14,11 +14,14 @@ import { URL } from 'url';
 import { DownloadOptions, DownloadPlatform, defaultCachePath, downloadAndUnzipVSCode } from './download';
 import * as request from './request';
 import { TestOptions } from './runTest';
+import { ProgressReporter } from './progress';
 
 export let systemDefaultPlatform: DownloadPlatform;
 
-const windowsPlatforms = new Set<DownloadPlatform>(['win32-x64-archive', 'win32-arm64-archive']);
-const darwinPlatforms = new Set<DownloadPlatform>(['darwin-arm64', 'darwin']);
+export const isPlatformWindows = (platform: string) => platform.includes('win32');
+export const isPlatformDarwin = (platform: string) => platform.includes('darwin');
+export const isPlatformServer = (platform: string) => platform.includes('server');
+export const isPlatformCLI = (platform: string) => platform.includes('cli-');
 
 switch (process.platform) {
 	case 'darwin':
@@ -44,7 +47,10 @@ export class Version {
 		return new Version(version, !unreleased);
 	}
 
-	constructor(public readonly id: string, public readonly isReleased = true) {}
+	constructor(
+		public readonly id: string,
+		public readonly isReleased = true,
+	) {}
 
 	public get isCommit() {
 		return /^[0-9a-f]{40}$/.test(this.id);
@@ -102,40 +108,57 @@ export function urlToOptions(url: string): https.RequestOptions {
 }
 
 export function downloadDirToExecutablePath(dir: string, platform: DownloadPlatform) {
-	if (windowsPlatforms.has(platform)) {
-		return path.resolve(dir, 'Code.exe');
-	} else if (darwinPlatforms.has(platform)) {
+	if (isPlatformWindows(platform)) {
+		return isPlatformServer(platform) ? path.resolve(dir, 'bin', 'code-server.cmd') : path.resolve(dir, 'Code.exe');
+	} else if (isPlatformServer(platform)) {
+		return path.resolve(dir, 'bin', 'code-server');
+	} else if (isPlatformDarwin(platform)) {
 		return path.resolve(dir, 'Visual Studio Code.app/Contents/MacOS/Electron');
 	} else {
 		return path.resolve(dir, 'code');
 	}
 }
 
 export function insidersDownloadDirToExecutablePath(dir: string, platform: DownloadPlatform) {
-	if (windowsPlatforms.has(platform)) {
-		return path.resolve(dir, 'Code - Insiders.exe');
-	} else if (darwinPlatforms.has(platform)) {
+	if (isPlatformWindows(platform)) {
+		return isPlatformServer(platform)
+			? path.resolve(dir, 'bin', 'code-server-insiders.cmd')
+			: path.resolve(dir, 'Code - Insiders.exe');
+	} else if (isPlatformServer(platform)) {
+		return path.resolve(dir, 'bin', 'code-server-insiders');
+	} else if (isPlatformDarwin(platform)) {
 		return path.resolve(dir, 'Visual Studio Code - Insiders.app/Contents/MacOS/Electron');
 	} else {
 		return path.resolve(dir, 'code-insiders');
 	}
 }
 
-export function insidersDownloadDirMetadata(dir: string, platform: DownloadPlatform) {
+export function insidersDownloadDirMetadata(dir: string, platform: DownloadPlatform, reporter: ProgressReporter) {
 	let productJsonPath;
-	if (windowsPlatforms.has(platform)) {
+	if (isPlatformServer(platform)) {
+		productJsonPath = path.resolve(dir, 'product.json');
+	} else if (isPlatformWindows(platform)) {
 		productJsonPath = path.resolve(dir, 'resources/app/product.json');
-	} else if (darwinPlatforms.has(platform)) {
+	} else if (isPlatformDarwin(platform)) {
 		productJsonPath = path.resolve(dir, 'Visual Studio Code - Insiders.app/Contents/Resources/app/product.json');
 	} else {
 		productJsonPath = path.resolve(dir, 'resources/app/product.json');
 	}
-	const productJson = JSON.parse(readFileSync(productJsonPath, 'utf-8'));
 
-	return {
-		version: productJson.commit,
-		date: new Date(productJson.date),
-	};
+	try {
+		const productJson = JSON.parse(readFileSync(productJsonPath, 'utf-8'));
+
+		return {
+			version: productJson.commit,
+			date: new Date(productJson.date),
+		};
+	} catch (e) {
+		reporter.error(`Error reading product.json (${e}) will download again`);
+		return {
+			version: 'unknown',
+			date: new Date(0),
+		};
+	}
 }
 
 export interface IUpdateMetadata {
@@ -165,18 +188,18 @@ export async function getLatestInsidersMetadata(platform: string, released: bool
  */
 export function resolveCliPathFromVSCodeExecutablePath(
 	vscodeExecutablePath: string,
-	platform: DownloadPlatform = systemDefaultPlatform
+	platform: DownloadPlatform = systemDefaultPlatform,
 ) {
 	if (platform === 'win32-archive') {
 		throw new Error('Windows 32-bit is no longer supported');
 	}
-	if (windowsPlatforms.has(platform)) {
+	if (isPlatformWindows(platform)) {
 		if (vscodeExecutablePath.endsWith('Code - Insiders.exe')) {
 			return path.resolve(vscodeExecutablePath, '../bin/code-insiders.cmd');
 		} else {
 			return path.resolve(vscodeExecutablePath, '../bin/code.cmd');
 		}
-	} else if (darwinPlatforms.has(platform)) {
+	} else if (isPlatformDarwin(platform)) {
 		return path.resolve(vscodeExecutablePath, '../../../Contents/Resources/app/bin/code');
 	} else {
 		if (vscodeExecutablePath.endsWith('code-insiders')) {
@@ -207,7 +230,7 @@ export function resolveCliPathFromVSCodeExecutablePath(
  */
 export function resolveCliArgsFromVSCodeExecutablePath(
 	vscodeExecutablePath: string,
-	options?: Pick<TestOptions, 'reuseMachineInstall' | 'platform'>
+	options?: Pick<TestOptions, 'reuseMachineInstall' | 'platform'>,
 ) {
 	const args = [
 		resolveCliPathFromVSCodeExecutablePath(vscodeExecutablePath, options?.platform ?? systemDefaultPlatform),
@@ -258,7 +281,7 @@ export class VSCodeCommandError extends Error {
 		args: string[],
 		public readonly exitCode: number | null,
 		public readonly stderr: string,
-		public stdout: string
+		public stdout: string,
 	) {
 		super(`'code ${args.join(' ')}' failed with exit code ${exitCode}:\n\n${stderr}\n\n${stdout}`);
 	}
@@ -388,7 +411,7 @@ export function killTree(processId: number, force: boolean) {
 		cp = spawn(
 			path.join(windir, 'System32', 'taskkill.exe'),
 			[...(force ? ['/F'] : []), '/T', '/PID', processId.toString()],
-			{ stdio: 'inherit' }
+			{ stdio: 'inherit' },
 		);
 	} else {
 		// on linux and OS X we kill all direct and indirect child processes as well