@theia/plugin-ext-vscode 1.53.0-next.5 → 1.53.0-next.55

package/src/node/plugin-vscode-file-handler.ts

@@ -1,62 +1,62 @@
-// *****************************************************************************
-// Copyright (C) 2018 Red Hat, Inc. and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import { PluginDeployerFileHandler, PluginDeployerEntry, PluginDeployerFileHandlerContext } from '@theia/plugin-ext';
-import * as filenamify from 'filenamify';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import * as fs from '@theia/core/shared/fs-extra';
-import { PluginVSCodeEnvironment } from '../common/plugin-vscode-environment';
-import { FileUri } from '@theia/core/lib/common/file-uri';
-import { unpackToDeploymentDir } from './plugin-vscode-utils';
-
-export const isVSCodePluginFile = (pluginPath?: string) => Boolean(pluginPath && (pluginPath.endsWith('.vsix') || pluginPath.endsWith('.tgz')));
-
-@injectable()
-export class PluginVsCodeFileHandler implements PluginDeployerFileHandler {
-    @inject(PluginVSCodeEnvironment)
-    protected readonly environment: PluginVSCodeEnvironment;
-
-    async accept(resolvedPlugin: PluginDeployerEntry): Promise<boolean> {
-        return resolvedPlugin.isFile().then(file => {
-            if (!file) {
-                return false;
-            }
-            return isVSCodePluginFile(resolvedPlugin.path());
-        });
-    }
-
-    async handle(context: PluginDeployerFileHandlerContext): Promise<void> {
-        const id = this.getNormalizedExtensionId(context.pluginEntry().id());
-        const extensionDeploymentDir = await unpackToDeploymentDir(this.environment, context.pluginEntry().path(), id);
-        context.pluginEntry().updatePath(extensionDeploymentDir);
-        console.log(`root path: ${context.pluginEntry().rootPath}`);
-        const originalPath = context.pluginEntry().originalPath();
-        if (originalPath && originalPath !== extensionDeploymentDir) {
-            const tempDirUri = await this.environment.getTempDirUri();
-            if (originalPath.startsWith(FileUri.fsPath(tempDirUri))) {
-                try {
-                    await fs.remove(FileUri.fsPath(originalPath));
-                } catch (e) {
-                    console.error(`[${id}]: failed to remove temporary files: "${originalPath}"`, e);
-                }
-            }
-        }
-    }
-
-    protected getNormalizedExtensionId(pluginId: string): string {
-        return filenamify(pluginId, { replacement: '_' }).replace(/\.vsix$/, '');
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Red Hat, Inc. and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { PluginDeployerFileHandler, PluginDeployerEntry, PluginDeployerFileHandlerContext } from '@theia/plugin-ext';
+import * as filenamify from 'filenamify';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import * as fs from '@theia/core/shared/fs-extra';
+import { PluginVSCodeEnvironment } from '../common/plugin-vscode-environment';
+import { FileUri } from '@theia/core/lib/common/file-uri';
+import { unpackToDeploymentDir } from './plugin-vscode-utils';
+
+export const isVSCodePluginFile = (pluginPath?: string) => Boolean(pluginPath && (pluginPath.endsWith('.vsix') || pluginPath.endsWith('.tgz')));
+
+@injectable()
+export class PluginVsCodeFileHandler implements PluginDeployerFileHandler {
+    @inject(PluginVSCodeEnvironment)
+    protected readonly environment: PluginVSCodeEnvironment;
+
+    async accept(resolvedPlugin: PluginDeployerEntry): Promise<boolean> {
+        return resolvedPlugin.isFile().then(file => {
+            if (!file) {
+                return false;
+            }
+            return isVSCodePluginFile(resolvedPlugin.path());
+        });
+    }
+
+    async handle(context: PluginDeployerFileHandlerContext): Promise<void> {
+        const id = this.getNormalizedExtensionId(context.pluginEntry().id());
+        const extensionDeploymentDir = await unpackToDeploymentDir(this.environment, context.pluginEntry().path(), id);
+        context.pluginEntry().updatePath(extensionDeploymentDir);
+        console.log(`root path: ${context.pluginEntry().rootPath}`);
+        const originalPath = context.pluginEntry().originalPath();
+        if (originalPath && originalPath !== extensionDeploymentDir) {
+            const tempDirUri = await this.environment.getTempDirUri();
+            if (originalPath.startsWith(FileUri.fsPath(tempDirUri))) {
+                try {
+                    await fs.remove(FileUri.fsPath(originalPath));
+                } catch (e) {
+                    console.error(`[${id}]: failed to remove temporary files: "${originalPath}"`, e);
+                }
+            }
+        }
+    }
+
+    protected getNormalizedExtensionId(pluginId: string): string {
+        return filenamify(pluginId, { replacement: '_' }).replace(/\.vsix$/, '');
+    }
+}

package/src/node/plugin-vscode-init.ts

@@ -1,80 +1,80 @@
-// *****************************************************************************
-// Copyright (C) 2018-2019 Red Hat, Inc.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-import * as theia from '@theia/plugin';
-import { BackendInitializationFn, PluginAPIFactory, Plugin, emptyPlugin } from '@theia/plugin-ext';
-import { VSCODE_DEFAULT_API_VERSION } from '../common/plugin-vscode-types';
-
-process.env['VSCODE_PID'] = process.env['THEIA_PARENT_PID'];
-
-const pluginsApiImpl = new Map<string, typeof theia>();
-const plugins = new Array<Plugin>();
-let defaultApi: typeof theia;
-let isLoadOverride = false;
-let pluginApiFactory: PluginAPIFactory;
-
-export const doInitialization: BackendInitializationFn = (apiFactory: PluginAPIFactory, plugin: Plugin) => {
-    pluginsApiImpl.set(plugin.model.id, createVSCodeAPI(apiFactory, plugin));
-    plugins.push(plugin);
-    pluginApiFactory = apiFactory;
-
-    if (!isLoadOverride) {
-        overrideInternalLoad();
-        isLoadOverride = true;
-    }
-};
-
-function createVSCodeAPI(apiFactory: PluginAPIFactory, plugin: Plugin): typeof theia {
-    const vscode = apiFactory(plugin);
-
-    // override the version for vscode to be a VSCode version
-    (<any>vscode).version = process.env['VSCODE_API_VERSION'] || VSCODE_DEFAULT_API_VERSION;
-    return vscode;
-}
-
-function overrideInternalLoad(): void {
-    const module = require('module');
-    const vscodeModuleName = 'vscode';
-    // save original load method
-    const internalLoad = module._load;
-
-    // if we try to resolve theia module, return the filename entry to use cache.
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    module._load = function (request: string, parent: any, isMain: {}): any {
-        if (request !== vscodeModuleName) {
-            return internalLoad.apply(this, arguments);
-        }
-
-        const plugin = findPlugin(parent.filename);
-        if (plugin) {
-            const apiImpl = pluginsApiImpl.get(plugin.model.id);
-            return apiImpl;
-        }
-
-        if (!defaultApi) {
-            console.warn(`Could not identify plugin for 'Theia' require call from ${parent.filename}`);
-            defaultApi = createVSCodeAPI(pluginApiFactory, emptyPlugin);
-        }
-
-        return defaultApi;
-    };
-}
-
-function findPlugin(filePath: string): Plugin | undefined {
-    return plugins.find(plugin => filePath.startsWith(plugin.pluginFolder));
-}
+// *****************************************************************************
+// Copyright (C) 2018-2019 Red Hat, Inc.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+import * as theia from '@theia/plugin';
+import { BackendInitializationFn, PluginAPIFactory, Plugin, emptyPlugin } from '@theia/plugin-ext';
+import { VSCODE_DEFAULT_API_VERSION } from '../common/plugin-vscode-types';
+
+process.env['VSCODE_PID'] = process.env['THEIA_PARENT_PID'];
+
+const pluginsApiImpl = new Map<string, typeof theia>();
+const plugins = new Array<Plugin>();
+let defaultApi: typeof theia;
+let isLoadOverride = false;
+let pluginApiFactory: PluginAPIFactory;
+
+export const doInitialization: BackendInitializationFn = (apiFactory: PluginAPIFactory, plugin: Plugin) => {
+    pluginsApiImpl.set(plugin.model.id, createVSCodeAPI(apiFactory, plugin));
+    plugins.push(plugin);
+    pluginApiFactory = apiFactory;
+
+    if (!isLoadOverride) {
+        overrideInternalLoad();
+        isLoadOverride = true;
+    }
+};
+
+function createVSCodeAPI(apiFactory: PluginAPIFactory, plugin: Plugin): typeof theia {
+    const vscode = apiFactory(plugin);
+
+    // override the version for vscode to be a VSCode version
+    (<any>vscode).version = process.env['VSCODE_API_VERSION'] || VSCODE_DEFAULT_API_VERSION;
+    return vscode;
+}
+
+function overrideInternalLoad(): void {
+    const module = require('module');
+    const vscodeModuleName = 'vscode';
+    // save original load method
+    const internalLoad = module._load;
+
+    // if we try to resolve theia module, return the filename entry to use cache.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    module._load = function (request: string, parent: any, isMain: {}): any {
+        if (request !== vscodeModuleName) {
+            return internalLoad.apply(this, arguments);
+        }
+
+        const plugin = findPlugin(parent.filename);
+        if (plugin) {
+            const apiImpl = pluginsApiImpl.get(plugin.model.id);
+            return apiImpl;
+        }
+
+        if (!defaultApi) {
+            console.warn(`Could not identify plugin for 'Theia' require call from ${parent.filename}`);
+            defaultApi = createVSCodeAPI(pluginApiFactory, emptyPlugin);
+        }
+
+        return defaultApi;
+    };
+}
+
+function findPlugin(filePath: string): Plugin | undefined {
+    return plugins.find(plugin => filePath.startsWith(plugin.pluginFolder));
+}

package/src/node/plugin-vscode-utils.ts

@@ -1,101 +1,101 @@
-// *****************************************************************************
-// Copyright (C) 2023 STMicroelectronics and others.
-//
-// This program and the accompanying materials are made available under the
-// terms of the Eclipse Public License v. 2.0 which is available at
-// http://www.eclipse.org/legal/epl-2.0.
-//
-// This Source Code may also be made available under the following Secondary
-// Licenses when the conditions for such availability set forth in the Eclipse
-// Public License v. 2.0 are satisfied: GNU General Public License, version 2
-// with the GNU Classpath Exception which is available at
-// https://www.gnu.org/software/classpath/license.html.
-//
-// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
-// *****************************************************************************
-
-import * as decompress from 'decompress';
-import * as path from 'path';
-import * as filenamify from 'filenamify';
-import { FileUri } from '@theia/core/lib/node';
-import * as fs from '@theia/core/shared/fs-extra';
-import { PluginVSCodeEnvironment } from '../common/plugin-vscode-environment';
-
-export async function decompressExtension(sourcePath: string, destPath: string): Promise<boolean> {
-    try {
-        await decompress(sourcePath, destPath);
-        if (sourcePath.endsWith('.tgz')) {
-            // unzip node_modules from built-in extensions, see https://github.com/eclipse-theia/theia/issues/5756
-            const extensionPath = path.join(destPath, 'package');
-            const vscodeNodeModulesPath = path.join(extensionPath, 'vscode_node_modules.zip');
-            if (await fs.pathExists(vscodeNodeModulesPath)) {
-                await decompress(vscodeNodeModulesPath, path.join(extensionPath, 'node_modules'));
-            }
-        }
-        return true;
-    } catch (error) {
-        console.error(`Failed to decompress ${sourcePath} to ${destPath}: ${error}`);
-        throw error;
-    }
-}
-
-export async function existsInDeploymentDir(env: PluginVSCodeEnvironment, extensionId: string): Promise<boolean> {
-    return fs.pathExists(await getExtensionDeploymentDir(env, extensionId));
-}
-
-export const TMP_DIR_PREFIX = 'tmp-vscode-unpacked-';
-export async function unpackToDeploymentDir(env: PluginVSCodeEnvironment, sourcePath: string, extensionId: string): Promise<string> {
-    const extensionDeploymentDir = await getExtensionDeploymentDir(env, extensionId);
-    if (await fs.pathExists(extensionDeploymentDir)) {
-        console.log(`[${extensionId}]: deployment dir "${extensionDeploymentDir}" already exists`);
-        return extensionDeploymentDir;
-    }
-
-    const tempDir = await getTempDir(env, TMP_DIR_PREFIX);
-    try {
-        console.log(`[${extensionId}]: trying to decompress "${sourcePath}" into "${tempDir}"...`);
-        if (!await decompressExtension(sourcePath, tempDir)) {
-            await fs.remove(tempDir);
-            const msg = `[${extensionId}]: decompressing "${sourcePath}" to "${tempDir}" failed`;
-            console.error(msg);
-            throw new Error(msg);
-        }
-    } catch (e) {
-        await fs.remove(tempDir);
-        const msg = `[${extensionId}]: error while decompressing "${sourcePath}" to "${tempDir}"`;
-        console.error(msg, e);
-        throw e;
-    }
-    console.log(`[${extensionId}]: decompressed to temp dir "${tempDir}"`);
-
-    try {
-        console.log(`[${extensionId}]: renaming to extension dir "${extensionDeploymentDir}"...`);
-        await fs.rename(tempDir, extensionDeploymentDir);
-        return extensionDeploymentDir;
-    } catch (e) {
-        await fs.remove(tempDir);
-        console.error(`[${extensionId}]: error while renaming "${tempDir}" to "${extensionDeploymentDir}"`, e);
-        throw e;
-    }
-}
-
-export async function getExtensionDeploymentDir(env: PluginVSCodeEnvironment, extensionId: string): Promise<string> {
-    const deployedPluginsDirUri = await env.getDeploymentDirUri();
-    const normalizedExtensionId = filenamify(extensionId, { replacement: '_' });
-    const extensionDeploymentDirPath = FileUri.fsPath(deployedPluginsDirUri.resolve(normalizedExtensionId));
-    return extensionDeploymentDirPath;
-}
-
-export async function getTempDir(env: PluginVSCodeEnvironment, prefix: string): Promise<string> {
-    const deploymentDirPath = FileUri.fsPath(await env.getDeploymentDirUri());
-    try {
-        if (!await fs.pathExists(deploymentDirPath)) {
-            console.log(`Creating deployment dir ${deploymentDirPath}`);
-            await fs.mkdirs(deploymentDirPath);
-        }
-        return await fs.mkdtemp(path.join(deploymentDirPath, prefix));
-    } catch (error) {
-        console.error(`Failed to create deployment dir ${deploymentDirPath}: ${error}`);
-        throw error;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import * as decompress from 'decompress';
+import * as path from 'path';
+import * as filenamify from 'filenamify';
+import { FileUri } from '@theia/core/lib/node';
+import * as fs from '@theia/core/shared/fs-extra';
+import { PluginVSCodeEnvironment } from '../common/plugin-vscode-environment';
+
+export async function decompressExtension(sourcePath: string, destPath: string): Promise<boolean> {
+    try {
+        await decompress(sourcePath, destPath);
+        if (sourcePath.endsWith('.tgz')) {
+            // unzip node_modules from built-in extensions, see https://github.com/eclipse-theia/theia/issues/5756
+            const extensionPath = path.join(destPath, 'package');
+            const vscodeNodeModulesPath = path.join(extensionPath, 'vscode_node_modules.zip');
+            if (await fs.pathExists(vscodeNodeModulesPath)) {
+                await decompress(vscodeNodeModulesPath, path.join(extensionPath, 'node_modules'));
+            }
+        }
+        return true;
+    } catch (error) {
+        console.error(`Failed to decompress ${sourcePath} to ${destPath}: ${error}`);
+        throw error;
+    }
+}
+
+export async function existsInDeploymentDir(env: PluginVSCodeEnvironment, extensionId: string): Promise<boolean> {
+    return fs.pathExists(await getExtensionDeploymentDir(env, extensionId));
+}
+
+export const TMP_DIR_PREFIX = 'tmp-vscode-unpacked-';
+export async function unpackToDeploymentDir(env: PluginVSCodeEnvironment, sourcePath: string, extensionId: string): Promise<string> {
+    const extensionDeploymentDir = await getExtensionDeploymentDir(env, extensionId);
+    if (await fs.pathExists(extensionDeploymentDir)) {
+        console.log(`[${extensionId}]: deployment dir "${extensionDeploymentDir}" already exists`);
+        return extensionDeploymentDir;
+    }
+
+    const tempDir = await getTempDir(env, TMP_DIR_PREFIX);
+    try {
+        console.log(`[${extensionId}]: trying to decompress "${sourcePath}" into "${tempDir}"...`);
+        if (!await decompressExtension(sourcePath, tempDir)) {
+            await fs.remove(tempDir);
+            const msg = `[${extensionId}]: decompressing "${sourcePath}" to "${tempDir}" failed`;
+            console.error(msg);
+            throw new Error(msg);
+        }
+    } catch (e) {
+        await fs.remove(tempDir);
+        const msg = `[${extensionId}]: error while decompressing "${sourcePath}" to "${tempDir}"`;
+        console.error(msg, e);
+        throw e;
+    }
+    console.log(`[${extensionId}]: decompressed to temp dir "${tempDir}"`);
+
+    try {
+        console.log(`[${extensionId}]: renaming to extension dir "${extensionDeploymentDir}"...`);
+        await fs.rename(tempDir, extensionDeploymentDir);
+        return extensionDeploymentDir;
+    } catch (e) {
+        await fs.remove(tempDir);
+        console.error(`[${extensionId}]: error while renaming "${tempDir}" to "${extensionDeploymentDir}"`, e);
+        throw e;
+    }
+}
+
+export async function getExtensionDeploymentDir(env: PluginVSCodeEnvironment, extensionId: string): Promise<string> {
+    const deployedPluginsDirUri = await env.getDeploymentDirUri();
+    const normalizedExtensionId = filenamify(extensionId, { replacement: '_' });
+    const extensionDeploymentDirPath = FileUri.fsPath(deployedPluginsDirUri.resolve(normalizedExtensionId));
+    return extensionDeploymentDirPath;
+}
+
+export async function getTempDir(env: PluginVSCodeEnvironment, prefix: string): Promise<string> {
+    const deploymentDirPath = FileUri.fsPath(await env.getDeploymentDirUri());
+    try {
+        if (!await fs.pathExists(deploymentDirPath)) {
+            console.log(`Creating deployment dir ${deploymentDirPath}`);
+            await fs.mkdirs(deploymentDirPath);
+        }
+        return await fs.mkdtemp(path.join(deploymentDirPath, prefix));
+    } catch (error) {
+        console.error(`Failed to create deployment dir ${deploymentDirPath}: ${error}`);
+        throw error;
+    }
+}