fix: installation error on various platforms

Author: connor4312

.gitignore

@@ -2,3 +2,4 @@
 node_modules
 
 out
+*.tgz

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 2.5.2 | 2024-04-09
+
+- Fix install issue on various platforms
+
 ### 2.5.1 | 2024-04-07
 
 - Allow downloading server versions

lib/download.test.mts

@@ -15,7 +15,12 @@ import {
 	fetchTargetInferredVersion,
 } from './download.js';
 import { SilentReporter } from './progress.js';
-import { resolveCliPathFromVSCodeExecutablePath, systemDefaultPlatform } from './util.js';
+import {
+	isPlatformDarwin,
+	isPlatformLinux,
+	isPlatformWindows,
+	resolveCliPathFromVSCodeExecutablePath
+} from './util.js';
 
 const platforms = [
 	'darwin',
@@ -25,6 +30,14 @@ const platforms = [
 	'linux-x64',
 	'linux-arm64',
 	'linux-armhf',
+
+	'cli-linux-x64',
+	'cli-win32-x64',
+	'cli-darwin-x64',
+
+	'server-win32-x64',
+	'server-darwin',
+	'server-linux-x64',
 ];
 
 describe('sane downloads', () => {
@@ -34,6 +47,13 @@ describe('sane downloads', () => {
 		await fs.mkdir(testTempDir, { recursive: true });
 	});
 
+	const isRunnableOnThisPlatform =
+		process.platform === 'win32'
+			? isPlatformWindows
+			: process.platform === 'darwin'
+				? isPlatformDarwin
+				: isPlatformLinux;
+
 	for (const quality of ['insiders', 'stable']) {
 		for (const platform of platforms) {
 			test.concurrent(`${quality}/${platform}`, async () => {
@@ -53,7 +73,7 @@ describe('sane downloads', () => {
 					throw new Error(`expected ${exePath} to from ${location}`);
 				}
 
-				if (platform === systemDefaultPlatform) {
+				if (platform.includes(process.arch) && isRunnableOnThisPlatform(platform)) {
 					const shell = process.platform === 'win32';
 					const version = spawnSync(shell ? `"${exePath}"` : exePath, ['--version'], { shell });
 					expect(version.status).to.equal(0);

lib/download.ts

@@ -21,6 +21,7 @@ import {
 	insidersDownloadDirToExecutablePath,
 	isDefined,
 	isPlatformCLI,
+	isPlatformServer,
 	isSubdirectory,
 	onceWithoutRejections,
 	streamToBuffer,
@@ -349,9 +350,9 @@ 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') {
+		const stripComponents = isPlatformServer(platform) ? 1 : 0;
 		try {
 			reporter.report({ stage: ProgressReportStage.ExtractingSynchonrously });
 
@@ -409,6 +410,8 @@ async function unzipVSCode(
 			fs.unlink(stagingFile, () => undefined);
 		}
 	} else {
+		const stripComponents = isPlatformCLI(platform) ? 0 : 1;
+
 		// tar does not create extractDir by default
 		if (!fs.existsSync(extractDir)) {
 			fs.mkdirSync(extractDir);

lib/util.ts

@@ -20,6 +20,7 @@ export let systemDefaultPlatform: DownloadPlatform;
 
 export const isPlatformWindows = (platform: string) => platform.includes('win32');
 export const isPlatformDarwin = (platform: string) => platform.includes('darwin');
+export const isPlatformLinux = (platform: string) => platform.includes('linux');
 export const isPlatformServer = (platform: string) => platform.includes('server');
 export const isPlatformCLI = (platform: string) => platform.includes('cli-');
 
@@ -108,28 +109,38 @@ export function urlToOptions(url: string): https.RequestOptions {
 }
 
 export function downloadDirToExecutablePath(dir: string, platform: DownloadPlatform) {
-	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');
+	if (isPlatformServer(platform)) {
+		return isPlatformWindows(platform)
+			? path.resolve(dir, 'bin', 'code-server.cmd')
+			: path.resolve(dir, 'bin', 'code-server');
+	} else if (isPlatformCLI(platform)) {
+		return isPlatformWindows(platform) ? path.resolve(dir, 'code.exe') : path.resolve(dir, 'code');
 	} else {
-		return path.resolve(dir, 'code');
+		if (isPlatformWindows(platform)) {
+			return path.resolve(dir, 'Code.exe');
+		} 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 (isPlatformWindows(platform)) {
-		return isPlatformServer(platform)
+	if (isPlatformServer(platform)) {
+		return isPlatformWindows(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');
+			: path.resolve(dir, 'bin', 'code-server-insiders');
+	} else if (isPlatformCLI(platform)) {
+		return isPlatformWindows(platform) ? path.resolve(dir, 'code-insiders.exe') : path.resolve(dir, 'code-insiders');
 	} else {
-		return path.resolve(dir, 'code-insiders');
+		if (isPlatformWindows(platform)) {
+			return path.resolve(dir, 'Code - Insiders.exe');
+		} else if (isPlatformDarwin(platform)) {
+			return path.resolve(dir, 'Visual Studio Code - Insiders.app/Contents/MacOS/Electron');
+		} else {
+			return path.resolve(dir, 'code-insiders');
+		}
 	}
 }
 
@@ -193,6 +204,10 @@ export function resolveCliPathFromVSCodeExecutablePath(
 	if (platform === 'win32-archive') {
 		throw new Error('Windows 32-bit is no longer supported');
 	}
+	if (isPlatformServer(platform) || isPlatformCLI(platform)) {
+		// no separate CLI
+		return vscodeExecutablePath;
+	}
 	if (isPlatformWindows(platform)) {
 		if (vscodeExecutablePath.endsWith('Code - Insiders.exe')) {
 			return path.resolve(vscodeExecutablePath, '../bin/code-insiders.cmd');

pipeline.yml

@@ -29,10 +29,24 @@ extends:
           - script: npm ci
             displayName: Install dependencies
 
+        testPlatforms:
+          - name: Linux
+            nodeVersions:
+              - 20.x
+          - name: MacOS
+            nodeVersions:
+              - 20.x
+          - name: Windows
+            nodeVersions:
+              - 20.x
+
         testSteps:
           - script: npm ci
             displayName: Install dependencies
 
+          - script: npm test
+            displayName: Run own tests
+
           - script: cd sample && npm ci
             displayName: Install dependencies (fs-provider)