@theia/remote 1.45.0 → 1.46.0-next.72

package/src/electron-node/setup/app-native-dependency-contribution.ts

@@ -1,48 +1,48 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox 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 { injectable } from '@theia/core/shared/inversify';
-import { RemoteNativeDependencyContribution, DownloadOptions, DependencyDownload } from './remote-native-dependency-contribution';
-import { RemotePlatform } from '../remote-types';
-import { OS } from '@theia/core';
-
-@injectable()
-export class AppNativeDependencyContribution implements RemoteNativeDependencyContribution {
-
-    appDownloadUrlBase = 'https://github.com/eclipse-theia/theia/releases/download';
-
-    protected getDefaultURLForFile(remotePlatform: RemotePlatform, theiaVersion: string): string {
-        if (remotePlatform.arch !== 'x64') {
-            throw new Error(`Unsupported remote architecture '${remotePlatform.arch}'. Remote support is only available for x64 architectures.`);
-        }
-        let platform: string;
-        if (remotePlatform.os === OS.Type.Windows) {
-            platform = 'win32';
-        } else if (remotePlatform.os === OS.Type.OSX) {
-            platform = 'darwin';
-        } else {
-            platform = 'linux';
-        }
-        return `${this.appDownloadUrlBase}/v${theiaVersion}/native-dependencies-${platform}-${remotePlatform.arch}.zip`;
-    }
-
-    async download(options: DownloadOptions): Promise<DependencyDownload> {
-        return {
-            buffer: await options.download(this.getDefaultURLForFile(options.remotePlatform, options.theiaVersion)),
-            archive: 'zip'
-        };
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox 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 { injectable } from '@theia/core/shared/inversify';
+import { RemoteNativeDependencyContribution, DownloadOptions, DependencyDownload } from './remote-native-dependency-contribution';
+import { RemotePlatform } from '../remote-types';
+import { OS } from '@theia/core';
+
+@injectable()
+export class AppNativeDependencyContribution implements RemoteNativeDependencyContribution {
+
+    appDownloadUrlBase = 'https://github.com/eclipse-theia/theia/releases/download';
+
+    protected getDefaultURLForFile(remotePlatform: RemotePlatform, theiaVersion: string): string {
+        if (remotePlatform.arch !== 'x64') {
+            throw new Error(`Unsupported remote architecture '${remotePlatform.arch}'. Remote support is only available for x64 architectures.`);
+        }
+        let platform: string;
+        if (remotePlatform.os === OS.Type.Windows) {
+            platform = 'win32';
+        } else if (remotePlatform.os === OS.Type.OSX) {
+            platform = 'darwin';
+        } else {
+            platform = 'linux';
+        }
+        return `${this.appDownloadUrlBase}/v${theiaVersion}/native-dependencies-${platform}-${remotePlatform.arch}.zip`;
+    }
+
+    async download(options: DownloadOptions): Promise<DependencyDownload> {
+        return {
+            buffer: await options.download(this.getDefaultURLForFile(options.remotePlatform, options.theiaVersion)),
+            archive: 'zip'
+        };
+    }
+}

package/src/electron-node/setup/main-copy-contribution.ts

@@ -1,28 +1,28 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox 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 { injectable } from '@theia/core/shared/inversify';
-import { RemoteCopyContribution, RemoteCopyRegistry } from './remote-copy-contribution';
-
-@injectable()
-export class MainCopyContribution implements RemoteCopyContribution {
-    async copy(registry: RemoteCopyRegistry): Promise<void> {
-        registry.file('package.json');
-        await registry.glob('lib/backend/**/*.js');
-        await registry.directory('lib/frontend');
-        await registry.directory('lib/webview');
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox 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 { injectable } from '@theia/core/shared/inversify';
+import { RemoteCopyContribution, RemoteCopyRegistry } from './remote-copy-contribution';
+
+@injectable()
+export class MainCopyContribution implements RemoteCopyContribution {
+    async copy(registry: RemoteCopyRegistry): Promise<void> {
+        registry.file('package.json');
+        await registry.glob('lib/backend/**/*.js');
+        await registry.directory('lib/frontend');
+        await registry.directory('lib/webview');
+    }
+}

package/src/electron-node/setup/remote-copy-contribution.ts

@@ -1,90 +1,90 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox 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 { ApplicationPackage } from '@theia/core/shared/@theia/application-package';
-import { inject, injectable } from '@theia/core/shared/inversify';
-import { glob as globCallback } from 'glob';
-import { promisify } from 'util';
-import * as path from 'path';
-import { MaybePromise } from '@theia/core';
-
-const promiseGlob = promisify(globCallback);
-
-export const RemoteCopyContribution = Symbol('RemoteCopyContribution');
-
-export interface RemoteCopyContribution {
-    copy(registry: RemoteCopyRegistry): MaybePromise<void>
-}
-
-export interface RemoteCopyOptions {
-    /**
-     * The mode that the file should be set to once copied to the remote.
-     *
-     * Only relevant for POSIX-like systems
-     */
-    mode?: number;
-}
-
-export interface RemoteFile {
-    path: string
-    target: string
-    options?: RemoteCopyOptions;
-}
-
-@injectable()
-export class RemoteCopyRegistry {
-
-    @inject(ApplicationPackage)
-    protected readonly applicationPackage: ApplicationPackage;
-
-    protected readonly files: RemoteFile[] = [];
-
-    getFiles(): RemoteFile[] {
-        return this.files.slice();
-    }
-
-    async glob(pattern: string, target?: string): Promise<void> {
-        const projectPath = this.applicationPackage.projectPath;
-        const globResult = await promiseGlob(pattern, {
-            cwd: projectPath
-        });
-        const relativeFiles = globResult.map(file => path.relative(projectPath, file));
-        for (const file of relativeFiles) {
-            const targetFile = this.withTarget(file, target);
-            this.files.push({
-                path: file,
-                target: targetFile
-            });
-        }
-    }
-
-    file(file: string, target?: string, options?: RemoteCopyOptions): void {
-        const targetFile = this.withTarget(file, target);
-        this.files.push({
-            path: file,
-            target: targetFile,
-            options
-        });
-    }
-
-    async directory(dir: string, target?: string): Promise<void> {
-        return this.glob(dir + '/**', target);
-    }
-
-    protected withTarget(file: string, target?: string): string {
-        return target ? path.join(target, file) : file;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox 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 { ApplicationPackage } from '@theia/core/shared/@theia/application-package';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { glob as globCallback } from 'glob';
+import { promisify } from 'util';
+import * as path from 'path';
+import { MaybePromise } from '@theia/core';
+
+const promiseGlob = promisify(globCallback);
+
+export const RemoteCopyContribution = Symbol('RemoteCopyContribution');
+
+export interface RemoteCopyContribution {
+    copy(registry: RemoteCopyRegistry): MaybePromise<void>
+}
+
+export interface RemoteCopyOptions {
+    /**
+     * The mode that the file should be set to once copied to the remote.
+     *
+     * Only relevant for POSIX-like systems
+     */
+    mode?: number;
+}
+
+export interface RemoteFile {
+    path: string
+    target: string
+    options?: RemoteCopyOptions;
+}
+
+@injectable()
+export class RemoteCopyRegistry {
+
+    @inject(ApplicationPackage)
+    protected readonly applicationPackage: ApplicationPackage;
+
+    protected readonly files: RemoteFile[] = [];
+
+    getFiles(): RemoteFile[] {
+        return this.files.slice();
+    }
+
+    async glob(pattern: string, target?: string): Promise<void> {
+        const projectPath = this.applicationPackage.projectPath;
+        const globResult = await promiseGlob(pattern, {
+            cwd: projectPath
+        });
+        const relativeFiles = globResult.map(file => path.relative(projectPath, file));
+        for (const file of relativeFiles) {
+            const targetFile = this.withTarget(file, target);
+            this.files.push({
+                path: file,
+                target: targetFile
+            });
+        }
+    }
+
+    file(file: string, target?: string, options?: RemoteCopyOptions): void {
+        const targetFile = this.withTarget(file, target);
+        this.files.push({
+            path: file,
+            target: targetFile,
+            options
+        });
+    }
+
+    async directory(dir: string, target?: string): Promise<void> {
+        return this.glob(dir + '/**', target);
+    }
+
+    protected withTarget(file: string, target?: string): string {
+        return target ? path.join(target, file) : file;
+    }
+}

package/src/electron-node/setup/remote-copy-service.ts

@@ -1,114 +1,114 @@
-// *****************************************************************************
-// Copyright (C) 2023 TypeFox 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 archiver from 'archiver';
-import * as path from 'path';
-import * as fs from 'fs';
-import * as os from 'os';
-import { ApplicationPackage } from '@theia/core/shared/@theia/application-package';
-import { inject, injectable, named } from '@theia/core/shared/inversify';
-import { RemoteConnection, RemotePlatform } from '../remote-types';
-import { RemoteNativeDependencyService } from './remote-native-dependency-service';
-import { ContributionProvider } from '@theia/core';
-import { RemoteCopyContribution, RemoteCopyRegistry, RemoteFile } from './remote-copy-contribution';
-
-@injectable()
-export class RemoteCopyService {
-
-    @inject(ApplicationPackage)
-    protected readonly applicationPackage: ApplicationPackage;
-
-    @inject(RemoteCopyRegistry)
-    protected readonly copyRegistry: RemoteCopyRegistry;
-
-    @inject(RemoteNativeDependencyService)
-    protected readonly nativeDependencyService: RemoteNativeDependencyService;
-
-    @inject(ContributionProvider) @named(RemoteCopyContribution)
-    protected readonly copyContributions: ContributionProvider<RemoteCopyContribution>;
-
-    protected initialized = false;
-
-    async copyToRemote(remote: RemoteConnection, remotePlatform: RemotePlatform, destination: string): Promise<void> {
-        const zipName = path.basename(destination);
-        const projectPath = this.applicationPackage.projectPath;
-        const tempDir = await this.getTempDir();
-        const zipPath = path.join(tempDir, zipName);
-        const files = await this.getFiles(remotePlatform, tempDir);
-        // We stream to a file here and then copy it because it is faster
-        // Copying files via sftp is 4x times faster compared to readable streams
-        const stream = fs.createWriteStream(zipPath);
-        const archive = archiver('tar', {
-            gzip: true
-        });
-        archive.pipe(stream);
-        for (const file of files) {
-            const filePath = path.isAbsolute(file.path)
-                ? file.path
-                : path.join(projectPath, file.path);
-
-            archive.file(filePath, {
-                name: file.target,
-                mode: file.options?.mode
-            });
-        }
-        await archive.finalize();
-        await remote.copy(zipPath, destination);
-        await fs.promises.rm(tempDir, {
-            recursive: true,
-            force: true
-        });
-    }
-
-    protected async getFiles(remotePlatform: RemotePlatform, tempDir: string): Promise<RemoteFile[]> {
-        const [localFiles, nativeDependencies] = await Promise.all([
-            this.loadCopyContributions(),
-            this.loadNativeDependencies(remotePlatform, tempDir)
-        ]);
-        return [...localFiles, ...nativeDependencies];
-    }
-
-    protected async loadCopyContributions(): Promise<RemoteFile[]> {
-        if (this.initialized) {
-            return this.copyRegistry.getFiles();
-        }
-        await Promise.all(this.copyContributions.getContributions()
-            .map(copyContribution => copyContribution.copy(this.copyRegistry)));
-        this.initialized = true;
-        return this.copyRegistry.getFiles();
-    }
-
-    protected async loadNativeDependencies(remotePlatform: RemotePlatform, tempDir: string): Promise<RemoteFile[]> {
-        const dependencyFiles = await this.nativeDependencyService.downloadDependencies(remotePlatform, tempDir);
-        return dependencyFiles.map(file => ({
-            path: file.path,
-            target: file.target,
-            options: {
-                mode: file.mode
-            }
-        }));
-    }
-
-    protected async getTempDir(): Promise<string> {
-        const dir = path.join(os.tmpdir(), 'theia-remote-');
-        const tempDir = await fs.promises.mkdtemp(dir);
-        return tempDir;
-    }
-
-    protected async getRemoteDownloadLocation(): Promise<string | undefined> {
-        return undefined;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2023 TypeFox 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 archiver from 'archiver';
+import * as path from 'path';
+import * as fs from 'fs';
+import * as os from 'os';
+import { ApplicationPackage } from '@theia/core/shared/@theia/application-package';
+import { inject, injectable, named } from '@theia/core/shared/inversify';
+import { RemoteConnection, RemotePlatform } from '../remote-types';
+import { RemoteNativeDependencyService } from './remote-native-dependency-service';
+import { ContributionProvider } from '@theia/core';
+import { RemoteCopyContribution, RemoteCopyRegistry, RemoteFile } from './remote-copy-contribution';
+
+@injectable()
+export class RemoteCopyService {
+
+    @inject(ApplicationPackage)
+    protected readonly applicationPackage: ApplicationPackage;
+
+    @inject(RemoteCopyRegistry)
+    protected readonly copyRegistry: RemoteCopyRegistry;
+
+    @inject(RemoteNativeDependencyService)
+    protected readonly nativeDependencyService: RemoteNativeDependencyService;
+
+    @inject(ContributionProvider) @named(RemoteCopyContribution)
+    protected readonly copyContributions: ContributionProvider<RemoteCopyContribution>;
+
+    protected initialized = false;
+
+    async copyToRemote(remote: RemoteConnection, remotePlatform: RemotePlatform, destination: string): Promise<void> {
+        const zipName = path.basename(destination);
+        const projectPath = this.applicationPackage.projectPath;
+        const tempDir = await this.getTempDir();
+        const zipPath = path.join(tempDir, zipName);
+        const files = await this.getFiles(remotePlatform, tempDir);
+        // We stream to a file here and then copy it because it is faster
+        // Copying files via sftp is 4x times faster compared to readable streams
+        const stream = fs.createWriteStream(zipPath);
+        const archive = archiver('tar', {
+            gzip: true
+        });
+        archive.pipe(stream);
+        for (const file of files) {
+            const filePath = path.isAbsolute(file.path)
+                ? file.path
+                : path.join(projectPath, file.path);
+
+            archive.file(filePath, {
+                name: file.target,
+                mode: file.options?.mode
+            });
+        }
+        await archive.finalize();
+        await remote.copy(zipPath, destination);
+        await fs.promises.rm(tempDir, {
+            recursive: true,
+            force: true
+        });
+    }
+
+    protected async getFiles(remotePlatform: RemotePlatform, tempDir: string): Promise<RemoteFile[]> {
+        const [localFiles, nativeDependencies] = await Promise.all([
+            this.loadCopyContributions(),
+            this.loadNativeDependencies(remotePlatform, tempDir)
+        ]);
+        return [...localFiles, ...nativeDependencies];
+    }
+
+    protected async loadCopyContributions(): Promise<RemoteFile[]> {
+        if (this.initialized) {
+            return this.copyRegistry.getFiles();
+        }
+        await Promise.all(this.copyContributions.getContributions()
+            .map(copyContribution => copyContribution.copy(this.copyRegistry)));
+        this.initialized = true;
+        return this.copyRegistry.getFiles();
+    }
+
+    protected async loadNativeDependencies(remotePlatform: RemotePlatform, tempDir: string): Promise<RemoteFile[]> {
+        const dependencyFiles = await this.nativeDependencyService.downloadDependencies(remotePlatform, tempDir);
+        return dependencyFiles.map(file => ({
+            path: file.path,
+            target: file.target,
+            options: {
+                mode: file.mode
+            }
+        }));
+    }
+
+    protected async getTempDir(): Promise<string> {
+        const dir = path.join(os.tmpdir(), 'theia-remote-');
+        const tempDir = await fs.promises.mkdtemp(dir);
+        return tempDir;
+    }
+
+    protected async getRemoteDownloadLocation(): Promise<string | undefined> {
+        return undefined;
+    }
+}