azuredatastudio/build/darwin/create-universal-app.ts

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

'use strict';

import { makeUniversalApp } from 'vscode-universal-bundler';
import { spawn } from '@malept/cross-spawn-promise';
import * as fs from 'fs-extra';
import * as path from 'path';
import * as plist from 'plist';
import * as product from '../../product.json';
import * as glob from 'glob'; // {{SQL CARBON EDIT}}

async function main() {
	const buildDir = process.env['AGENT_BUILDDIRECTORY'];
	const arch = process.env['VSCODE_ARCH'];

	if (!buildDir) {
		throw new Error('$AGENT_BUILDDIRECTORY not set');
	}

	// {{SQL CARBON EDIT}}
	const x64AppNameBase = 'azuredatastudio-darwin-x64';
	const arm64AppNameBase = 'azuredatastudio-darwin-arm64';
	// {{SQL CARBON EDIT}} - END

	const appName = product.nameLong + '.app';
	const x64AppPath = path.join(buildDir, x64AppNameBase, appName); // {{SQL CARBON EDIT}} - CHANGE VSCode to azuredatastudio
	const arm64AppPath = path.join(buildDir, arm64AppNameBase, appName); // {{SQL CARBON EDIT}} - CHANGE VSCode to azuredatastudio
	const x64AsarPath = path.join(x64AppPath, 'Contents', 'Resources', 'app', 'node_modules.asar');
	const arm64AsarPath = path.join(arm64AppPath, 'Contents', 'Resources', 'app', 'node_modules.asar');
	const outAppPath = path.join(buildDir, `azuredatastudio-darwin-${arch}`, appName); // {{SQL CARBON EDIT}} - CHANGE VSCode to azuredatastudio
	const productJsonPath = path.resolve(outAppPath, 'Contents', 'Resources', 'app', 'product.json');
	const infoPlistPath = path.resolve(outAppPath, 'Contents', 'Info.plist');

	// {{SQL CARBON EDIT}}
	// Current STS arm64 builds doesn't work on osx-arm64, we need to use the x64 version of STS on osx-arm64 until the issue is fixed.
	// Tracked by: https://github.com/microsoft/azuredatastudio/issues/20775
	// makeUniversalApp function will complain if the x64 ADS and arm64 ADS have the same STS binaries, to workaround the issue, we need
	// to delete STS from both of them and then copy it to the universal app.
	const stsPath = '/Contents/Resources/app/extensions/mssql/sqltoolsservice';
	const tempSTSDir = path.join(buildDir, 'sqltoolsservice');
	const x64STSDir = path.join(x64AppPath, stsPath);
	const arm64STSDir = path.join(arm64AppPath, stsPath);
	const targetSTSDirs = [x64STSDir, arm64STSDir];
	// backup the x64 STS to a temporary directory, later it will be copied to the universal app directory.
	await fs.copy(x64STSDir, tempSTSDir);
	// delete STS directories from both x64 ADS and arm64 ADS.
	console.debug(`Removing SqlToolsService folders.`);
	targetSTSDirs.forEach(async dir => {
		await fs.remove(dir);
	});

	// makeUniversalApp requires the non-binary files in arm64 and x64 versions to be exactly the same,
	// but sometimes the content of nls.metadata.json files could be different(only the order of the entries).
	// To workaround the issue, we need to replace these files in arm64 ADS with the files from x64 ADS.
	// Tracked by issue: https://github.com/microsoft/azuredatastudio/issues/20792
	const sourceFiles = glob.sync(path.join(x64AppPath, '/Contents/Resources/app/**/nls.metadata.json'));
	sourceFiles.forEach(source => {
		const target = source.replace(x64AppNameBase, arm64AppNameBase);
		console.debug(`Replacing file '${target}' with '${source}'`);
		fs.copySync(source, target, { overwrite: true });
	});
	// {{SQL CARBON EDIT}} - END

	await makeUniversalApp({
		x64AppPath,
		arm64AppPath,
		x64AsarPath,
		arm64AsarPath,
		filesToSkip: [
			'product.json',
			'Credits.rtf',
			'CodeResources',
			'fsevents.node',
			'Info.plist', // TODO@deepak1556: regressed with 11.4.2 internal builds
			'.npmrc'
		],
		outAppPath,
		force: true
	});

	let productJson = await fs.readJson(productJsonPath);
	Object.assign(productJson, {
		darwinUniversalAssetId: 'darwin-universal'
	});
	await fs.writeJson(productJsonPath, productJson);

	let infoPlistString = await fs.readFile(infoPlistPath, 'utf8');
	let infoPlistJson = plist.parse(infoPlistString);
	Object.assign(infoPlistJson, {
		LSRequiresNativeExecution: true
	});
	await fs.writeFile(infoPlistPath, plist.build(infoPlistJson), 'utf8');

	// Verify if native module architecture is correct
	const findOutput = await spawn('find', [outAppPath, '-name', 'keytar.node'])
	const lipoOutput = await spawn('lipo', ['-archs', findOutput.replace(/\n$/, "")]);
	if (lipoOutput.replace(/\n$/, "") !== 'x86_64 arm64') {
		throw new Error(`Invalid arch, got : ${lipoOutput}`)
	}

	// {{SQL CARBON EDIT}}
	console.debug(`Copying SqlToolsService to the universal app folder.`);
	await fs.copy(tempSTSDir, path.join(outAppPath, stsPath), { overwrite: true });
}

if (require.main === module) {
	main().catch(err => {
		console.error(err);
		process.exit(1);
	});
}