Merge pull request #715 from atesca09/custom_gallery_patch_fix

Fix custom gallery patch for 1.56

DOCS.md

@@ -3,7 +3,11 @@
 ## Table of Contents
 
 - [Getting all the Telemetry Out](#disable-telemetry)
+  - [Replacements to Microsoft Online Services](#replacement-online-services)
 - [Extensions + Marketplace](#extensions-marketplace)
+  - [How to use the VS Code Marketplace](#howto-vscode-marketplace)
+  - [Proprietary Debugging Tools](#proprietary-debugging-tools)
+  - [Proprietary Extensions](#proprietary-extensions)
 - [Migrating from Visual Studio Code to VSCodium](#migrating)
 - [How do I run VSCodium in portable mode?](#portable)
 - [How do I press and hold a key and have it repeat in VSCodium?](#press-and-hold)
@@ -28,7 +32,7 @@ These can all be disabled.
 
 __Please note that some extensions send telemetry data to Microsoft as well. We have no control over this and can only recommend removing the extension.__ _(For example, the C# extension `ms-vscode.csharp` sends tracking data to Microsoft.)_
 
-### Replacements to Microsoft Online Services
+### <a id="replacement-online-services"></a>Replacements to Microsoft Online Services
 
 When searching the `@tag:usesOnlineServices` filter, note that while the "Update: Mode" setting description still says "The updates are fetched from a Microsoft online service", VSCodium's build script [sets the `updateUrl` field](https://github.com/VSCodium/vscodium/blob/master/prepare_vscode.sh#L36) in `product.json` to that of VSCodium's own small [update server](https://github.com/VSCodium/update-api), so enabling that setting won't actually result in any calls to Microsoft servers.
 
@@ -41,23 +45,46 @@ The `product.json` file is set up to use [open-vsx.org](https://open-vsx.org/) a
 * Ask the extension maintainers to publish to [open-vsx.org](https://open-vsx.org/) in addition to the VS Code Marketplace. The publishing process is documented in the [Open VSX Wiki](https://github.com/eclipse/openvsx/wiki/Publishing-Extensions).
 * Create a pull request to [this repository](https://github.com/open-vsx/publish-extensions) to have the [@open-vsx](https://github.com/open-vsx) service account publish the extensions for you.
 * Download and [install the vsix files](https://code.visualstudio.com/docs/editor/extension-gallery#_install-from-a-vsix).
-* Modify the `extensionsGallery` section of the `product.json` file in your VSCodium installation to use the VS Code Marketplace as shown below. However, note that [it is not clear whether this is legal](https://github.com/microsoft/vscode/issues/31168).
-  ```json
-  "extensionsGallery": {
-      "serviceUrl": "https://marketplace.visualstudio.com/_apis/public/gallery",
-      "itemUrl": "https://marketplace.visualstudio.com/items"
-  }
-  ```
 
 See [this article](https://www.gitpod.io/blog/open-vsx/) for more information on the motivation behind Open VSX.
 
-### Proprietary Debugging Tools
+### <a id="howto-vscode-marketplace"></a>How to use the VS Code Marketplace
+
+You can switch and use the VS Code marketplace by using the following solutions. However, note that [it is not clear whether this is legal](https://github.com/microsoft/vscode/issues/31168).
+
+With the following environment variables:
+- `VSCODE_GALLERY_SERVICE_URL='https://marketplace.visualstudio.com/_apis/public/gallery'`
+- `VSCODE_GALLERY_CACHE_URL='https://vscode.blob.core.windows.net/gallery/index'`
+- `VSCODE_GALLERY_ITEM_URL='https://marketplace.visualstudio.com/items'`
+- `VSCODE_GALLERY_CONTROL_URL=''`
+- `VSCODE_GALLERY_RECOMMENDATIONS_URL=''`
+
+Or by creating a custom `product.json` at the following location:
+- Windows: `%USER%\AppData\Roaming\VSCodium`
+- macOS: `~/Library/Application Support/VSCodium`
+- Linux: `~/.config/VSCodium`
+
+with the content:
+
+```json
+{
+  "extensionsGallery": {
+    "serviceUrl": "https://marketplace.visualstudio.com/_apis/public/gallery",
+    "cacheUrl": "https://vscode.blob.core.windows.net/gallery/index",
+    "itemUrl": "https://marketplace.visualstudio.com/items",
+    "controlUrl": "",
+    "recommendationsUrl": ""
+  }
+}
+```
+
+### <a id="proprietary-debugging-tools"></a>Proprietary Debugging Tools
 
 The debugger provided with Microsoft's [C# extension](https://github.com/OmniSharp/omnisharp-vscode) as well as the (Windows) debugger provided with their [C++ extension](https://github.com/Microsoft/vscode-cpptools) are very restrictively licensed to only work with the offical Visual Studio Code build. See [this comment in the C# extension repo](https://github.com/OmniSharp/omnisharp-vscode/issues/2491#issuecomment-418811364) and [this comment in the C++ extension repo](https://github.com/Microsoft/vscode-cpptools/issues/21#issuecomment-248349017).
 
 A workaround exists to get debugging working in C# projects, by using Samsung's opensource [netcoredbg](https://github.com/Samsung/netcoredbg) package. See [this comment](https://github.com/VSCodium/vscodium/issues/82#issue-409806641) for instructions on how to set that up.
 
-### Proprietary Extensions
+### <a id="proprietary-extensions"></a>Proprietary Extensions
 
 Like the debuggers mentioned above, some extensions you may find in the marketplace (like the [Remote Development Extensions](https://code.visualstudio.com/docs/remote/remote-overview)) only function with the offical Visual Studio Code build. You can work around this by adding the extension's internal ID (found on the extension's page) to the `extensionAllowedProposedApi` property of the product.json in your VSCodium installation. For example:
 

build/build_windows.ps1

@@ -1,9 +1,8 @@
-# powershell -ExecutionPolicy ByPass -File build_windows.ps1
+# powershell -ExecutionPolicy ByPass -File .\build\build_windows.ps1
 
 $env:Path += ";C:\Program Files\Git\bin"
 
 Remove-Item -Recurse -Force VSCode*
-Remove-Item -Recurse -Force vscode
 
 bash ./get_repo.sh
 

patches/binary-name.patch

@@ -0,0 +1,45 @@
+diff --git a/build/gulpfile.vscode.js b/build/gulpfile.vscode.js
+index 6d3a369..57009d4 100644
+--- a/build/gulpfile.vscode.js
++++ b/build/gulpfile.vscode.js
+@@ -276,7 +276,7 @@ function packageTask(platform, arch, sourceFolderName, destinationFolderName, op
+ 			all = es.merge(all, gulp.src('resources/linux/code.png', { base: '.' }));
+ 		} else if (platform === 'darwin') {
+ 			const shortcut = gulp.src('resources/darwin/bin/code.sh')
+-				.pipe(rename('bin/code'));
++				.pipe(rename('bin/' + product.applicationName));
+ 
+ 			all = es.merge(all, shortcut);
+ 		}
+@@ -483,7 +483,7 @@ const generateVSCodeConfigurationTask = task.define('generate-vscode-configurati
+ 		const arch = process.env['VSCODE_ARCH'];
+ 		const appRoot = path.join(buildDir, `VSCode-darwin-${arch}`);
+ 		const appName = process.env.VSCODE_QUALITY === 'insider' ? 'Visual\\ Studio\\ Code\\ -\\ Insiders.app' : 'Visual\\ Studio\\ Code.app';
+-		const appPath = path.join(appRoot, appName, 'Contents', 'Resources', 'app', 'bin', 'code');
++		const appPath = path.join(appRoot, appName, 'Contents', 'Resources', 'app', 'bin', product.applicationName);
+ 		const codeProc = cp.exec(
+ 			`${appPath} --export-default-configuration='${allConfigDetailsPath}' --wait --user-data-dir='${userDataDir}' --extensions-dir='${extensionsDir}'`,
+ 			(err, stdout, stderr) => {
+diff --git a/src/vs/platform/native/electron-main/nativeHostMainService.ts b/src/vs/platform/native/electron-main/nativeHostMainService.ts
+index 50c4460..bf73260 100644
+--- a/src/vs/platform/native/electron-main/nativeHostMainService.ts
++++ b/src/vs/platform/native/electron-main/nativeHostMainService.ts
+@@ -431,4 +431,4 @@ export class NativeHostMainService extends Disposable implements INativeHostMain
+ 		// macOS
+ 		if (this.environmentMainService.isBuilt) {
+-			return join(this.environmentMainService.appRoot, 'bin', 'code');
++			return join(this.environmentMainService.appRoot, 'bin', `${this.productService.applicationName}`);
+ 		}
+diff --git a/src/vs/workbench/contrib/cli/node/cli.contribution.ts b/src/vs/workbench/contrib/cli/node/cli.contribution.ts
+index 30972a4..0a9435c 100644
+--- a/src/vs/workbench/contrib/cli/node/cli.contribution.ts
++++ b/src/vs/workbench/contrib/cli/node/cli.contribution.ts
+@@ -29,7 +29,7 @@ let _source: string | null = null;
+ function getSource(): string {
+ 	if (!_source) {
+ 		const root = FileAccess.asFileUri('', require).fsPath;
+-		_source = path.resolve(root, '..', 'bin', 'code');
++		_source = path.resolve(root, '..', 'bin', product.applicationName);
+ 	}
+ 	return _source;
+ }

patches/custom-gallery.patch

@@ -0,0 +1,75 @@
+diff --git a/src/vs/platform/product/common/product.ts b/src/vs/platform/product/common/product.ts
+index d79c8a3..7a25774 100644
+--- a/src/vs/platform/product/common/product.ts
++++ b/src/vs/platform/product/common/product.ts
+@@ -9,6 +9,7 @@ import { env } from 'vs/base/common/process';
+ import { dirname, joinPath } from 'vs/base/common/resources';
+ import { IProductConfiguration } from 'vs/base/common/product';
+ import { ISandboxConfiguration } from 'vs/base/parts/sandbox/common/sandboxTypes';
++import { getUserDataPath } from 'vs/platform/environment/node/userDataPath';
+ 
+ let product: IProductConfiguration;
+ 
+@@ -31,6 +32,29 @@ else if (typeof require?.__$__nodeRequire === 'function') {
+ 	product = require.__$__nodeRequire(joinPath(rootPath, 'product.json').fsPath);
+ 	const pkg = require.__$__nodeRequire(joinPath(rootPath, 'package.json').fsPath) as { version: string; };
+ 
++	// Merge user-customized product.json
++	try {
++		const merge = (...objects: any[]) =>
++			objects.reduce((result, current) => {
++				Object.keys(current).forEach((key) => {
++					if (Array.isArray(result[key]) && Array.isArray(current[key])) {
++						result[key] = current[key];
++					} else if (typeof result[key] === 'object' && typeof current[key] === 'object') {
++						result[key] = merge(result[key], current[key]);
++					} else {
++						result[key] = current[key];
++					}
++				});
++
++				return result;
++			}, {}) as any;
++
++		const userProduct = require.__$__nodeRequire(joinPath(FileAccess.asFileUri(getUserDataPath({} as any), require), 'product.json').fsPath);
++
++		product = merge(product, userProduct)
++	} catch (ex) {
++	}
++
+ 	// Running out of sources
+ 	if (env['VSCODE_DEV']) {
+ 		Object.assign(product, {
+@@ -40,6 +64,19 @@ else if (typeof require?.__$__nodeRequire === 'function') {
+ 		});
+ 	}
+ 
++	// Set user-defined extension gallery
++	const { serviceUrl, cacheUrl, itemUrl, controlUrl, recommendationsUrl } = product.extensionsGallery || {}
++
++	Object.assign(product, {
++		extensionsGallery: {
++			serviceUrl: env['VSCODE_GALLERY_SERVICE_URL'] || serviceUrl,
++			cacheUrl: env['VSCODE_GALLERY_CACHE_URL'] || cacheUrl,
++			itemUrl: env['VSCODE_GALLERY_ITEM_URL'] || itemUrl,
++			controlUrl: env['VSCODE_GALLERY_CONTROL_URL'] || controlUrl,
++			recommendationsUrl: env['VSCODE_GALLERY_RECOMMENDATIONS_URL'] || recommendationsUrl
++		}
++	})
++
+ 	Object.assign(product, {
+ 		version: pkg.version
+ 	});
+
+diff --git a/src/vs/base/common/product.ts b/src/vs/base/common/product.ts
+index 129b8de..fadb99a 100644
+--- a/src/vs/base/common/product.ts
++++ b/src/vs/base/common/product.ts
+@@ -62,6 +62,7 @@ export interface IProductConfiguration {
+ 
+ 	readonly extensionsGallery?: {
+ 		readonly serviceUrl: string;
++		readonly cacheUrl?: string;
+ 		readonly itemUrl: string;
+ 		readonly controlUrl: string;
+ 		readonly recommendationsUrl: string;

patches/fix-rpm-spec.patch

@@ -1,13 +1,5 @@
 --- vscode/resources/linux/rpm/code.spec.template	2021-03-02 19:26:53.000000000 +0100
 +++ vscode/resources/linux/rpm/code.spec.template.new	2021-03-02 19:28:12.000000000 +0100
-@@ -1,6 +1,6 @@
- Name:     @@NAME@@
- Version:  @@VERSION@@
--Release:  @@RELEASE@@.el7
-+Release:  @@RELEASE@@.el8
- Summary:  Code editing. Redefined.
- Group:    Development/Tools
- Vendor:   Microsoft Corporation
 @@ -69,3 +69,5 @@
  /usr/share/pixmaps/@@ICON@@.png
  /usr/share/bash-completion/completions/@@NAME@@

patches/update-cache-path.patch

@@ -1,7 +1,11 @@
---- vscode/src/vs/platform/update/electron-main/updateService.win32.ts	2021-02-05 11:59:17.564060663 -0600
+--- a/src/vs/platform/update/electron-main/updateService.win32.ts
-+++ src/src/vs/platform/update/electron-main/updateService.win32.ts	2021-02-05 11:59:39.780745778 -0600
++++ b/src/vs/platform/update/electron-main/updateService.win32.ts
-@@ -56,3 +56,3 @@
+@@ -55,7 +55,7 @@ export class Win32UpdateService extends AbstractUpdateService {
+ 
  	@memoize
  	get cachePath(): Promise<string> {
--		const result = path.join(tmpdir(), `vscode-update-${product.target}-${process.arch}`);
+-		const result = path.join(tmpdir(), `vscode-update-${this.productService.target}-${process.arch}`);
-+		const result = path.join(tmpdir(), `vscodium-update-${product.target}-${process.arch}`);
++		const result = path.join(tmpdir(), `${this.productService.nameShort.toLowerCase()}-update-${this.productService.target}-${process.arch}`);
+ 		return fs.promises.mkdir(result, { recursive: true }).then(() => result);
+ 	}
+ 

prepare_vscode.sh

@@ -10,6 +10,8 @@ cd vscode || exit
 # apply patches
 patch -u src/vs/platform/update/electron-main/updateService.win32.ts -i ../patches/update-cache-path.patch
 patch -u resources/linux/rpm/code.spec.template -i ../patches/fix-rpm-spec.patch
+git apply --ignore-whitespace ../patches/binary-name.patch
+git apply --ignore-whitespace ../patches/custom-gallery.patch
 
 if [[ "$OS_NAME" == "osx" ]]; then
   CHILD_CONCURRENCY=1 yarn --frozen-lockfile --ignore-optional