@theia/remote 1.52.0 → 1.53.0-next.55

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

@@ -1,74 +1,74 @@
-// *****************************************************************************
-// 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 { RemoteCopyRegistry, RemoteFile, RemoteCopyOptions } from '@theia/core/lib/node/remote/remote-copy-contribution';
-import { glob as globCallback } from 'glob';
-import { promisify } from 'util';
-import * as path from 'path';
-
-const promiseGlob = promisify(globCallback);
-
-@injectable()
-export class RemoteCopyRegistryImpl implements 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> {
-        return this.doGlob(pattern, this.applicationPackage.projectPath, target);
-    }
-
-    async doGlob(pattern: string, cwd: string, target?: string): Promise<void> {
-        const projectPath = this.applicationPackage.projectPath;
-        const globResult = await promiseGlob(pattern, { cwd, nodir: true });
-        for (const file of globResult) {
-            const targetFile = this.withTarget(file, target);
-            this.files.push({
-                path: path.relative(projectPath, path.resolve(cwd, 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> {
-        let absoluteDir = dir;
-        if (!path.isAbsolute(absoluteDir)) {
-            absoluteDir = path.join(this.applicationPackage.projectPath, dir);
-        }
-        return this.doGlob('**/*', absoluteDir, target ?? dir);
-    }
-
-    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 { RemoteCopyRegistry, RemoteFile, RemoteCopyOptions } from '@theia/core/lib/node/remote/remote-copy-contribution';
+import { glob as globCallback } from 'glob';
+import { promisify } from 'util';
+import * as path from 'path';
+
+const promiseGlob = promisify(globCallback);
+
+@injectable()
+export class RemoteCopyRegistryImpl implements 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> {
+        return this.doGlob(pattern, this.applicationPackage.projectPath, target);
+    }
+
+    async doGlob(pattern: string, cwd: string, target?: string): Promise<void> {
+        const projectPath = this.applicationPackage.projectPath;
+        const globResult = await promiseGlob(pattern, { cwd, nodir: true });
+        for (const file of globResult) {
+            const targetFile = this.withTarget(file, target);
+            this.files.push({
+                path: path.relative(projectPath, path.resolve(cwd, 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> {
+        let absoluteDir = dir;
+        if (!path.isAbsolute(absoluteDir)) {
+            absoluteDir = path.join(this.applicationPackage.projectPath, dir);
+        }
+        return this.doGlob('**/*', absoluteDir, target ?? dir);
+    }
+
+    protected withTarget(file: string, target?: string): string {
+        return target ? path.join(target, file) : file;
+    }
+}

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

@@ -1,116 +1,116 @@
-// *****************************************************************************
-// 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 } from '../remote-types';
-import { RemotePlatform } from '@theia/core/lib/node/remote/remote-cli-contribution';
-import { RemoteNativeDependencyService } from './remote-native-dependency-service';
-import { ContributionProvider } from '@theia/core';
-import { RemoteCopyRegistryImpl } from './remote-copy-contribution';
-import { RemoteCopyContribution, RemoteFile } from '@theia/core/lib/node/remote/remote-copy-contribution';
-
-@injectable()
-export class RemoteCopyService {
-
-    @inject(ApplicationPackage)
-    protected readonly applicationPackage: ApplicationPackage;
-
-    @inject(RemoteCopyRegistryImpl)
-    protected readonly copyRegistry: RemoteCopyRegistryImpl;
-
-    @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 } from '../remote-types';
+import { RemotePlatform } from '@theia/core/lib/node/remote/remote-cli-contribution';
+import { RemoteNativeDependencyService } from './remote-native-dependency-service';
+import { ContributionProvider } from '@theia/core';
+import { RemoteCopyRegistryImpl } from './remote-copy-contribution';
+import { RemoteCopyContribution, RemoteFile } from '@theia/core/lib/node/remote/remote-copy-contribution';
+
+@injectable()
+export class RemoteCopyService {
+
+    @inject(ApplicationPackage)
+    protected readonly applicationPackage: ApplicationPackage;
+
+    @inject(RemoteCopyRegistryImpl)
+    protected readonly copyRegistry: RemoteCopyRegistryImpl;
+
+    @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;
+    }
+}

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

@@ -1,63 +1,63 @@
-// *****************************************************************************
-// 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 { isObject } from '@theia/core';
-import { RequestOptions } from '@theia/core/shared/@theia/request';
-import { RemotePlatform } from '@theia/core/lib/node/remote/remote-cli-contribution';
-
-export interface FileDependencyResult {
-    path: string;
-    mode?: number;
-}
-
-export type DependencyDownload = FileDependencyDownload | DirectoryDependencyDownload;
-
-export interface FileDependencyDownload {
-    file: FileDependencyResult
-    buffer: Buffer
-}
-
-export namespace FileDependencyResult {
-    export function is(item: unknown): item is FileDependencyDownload {
-        return isObject(item) && 'buffer' in item && 'file' in item;
-    }
-}
-
-export interface DirectoryDependencyDownload {
-    archive: 'tar' | 'zip' | 'tgz'
-    buffer: Buffer
-}
-
-export namespace DirectoryDependencyDownload {
-    export function is(item: unknown): item is DirectoryDependencyDownload {
-        return isObject(item) && 'buffer' in item && 'archive' in item;
-    }
-}
-
-export interface DownloadOptions {
-    remotePlatform: RemotePlatform
-    theiaVersion: string;
-    download: (requestInfo: string | RequestOptions) => Promise<Buffer>
-}
-
-export const RemoteNativeDependencyContribution = Symbol('RemoteNativeDependencyContribution');
-
-/**
- * contribution used for downloading prebuild native dependency when connecting to a remote machine with a different system
- */
-export interface RemoteNativeDependencyContribution {
-    download(options: DownloadOptions): Promise<DependencyDownload>;
-}
+// *****************************************************************************
+// 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 { isObject } from '@theia/core';
+import { RequestOptions } from '@theia/core/shared/@theia/request';
+import { RemotePlatform } from '@theia/core/lib/node/remote/remote-cli-contribution';
+
+export interface FileDependencyResult {
+    path: string;
+    mode?: number;
+}
+
+export type DependencyDownload = FileDependencyDownload | DirectoryDependencyDownload;
+
+export interface FileDependencyDownload {
+    file: FileDependencyResult
+    buffer: Buffer
+}
+
+export namespace FileDependencyResult {
+    export function is(item: unknown): item is FileDependencyDownload {
+        return isObject(item) && 'buffer' in item && 'file' in item;
+    }
+}
+
+export interface DirectoryDependencyDownload {
+    archive: 'tar' | 'zip' | 'tgz'
+    buffer: Buffer
+}
+
+export namespace DirectoryDependencyDownload {
+    export function is(item: unknown): item is DirectoryDependencyDownload {
+        return isObject(item) && 'buffer' in item && 'archive' in item;
+    }
+}
+
+export interface DownloadOptions {
+    remotePlatform: RemotePlatform
+    theiaVersion: string;
+    download: (requestInfo: string | RequestOptions) => Promise<Buffer>
+}
+
+export const RemoteNativeDependencyContribution = Symbol('RemoteNativeDependencyContribution');
+
+/**
+ * contribution used for downloading prebuild native dependency when connecting to a remote machine with a different system
+ */
+export interface RemoteNativeDependencyContribution {
+    download(options: DownloadOptions): Promise<DependencyDownload>;
+}