@theia/dev-container 1.52.0 → 1.53.0-next.55

package/README.md

@@ -1,43 +1,43 @@
-<div align='center'>
-
-<br />
-
-<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
-
-<h2>ECLIPSE THEIA - DEV-CONTAINER EXTENSION</h2>
-
-<hr />
-
-</div>
-
-## Description
-
-The `@theia/dev-container` extension provides functionality to create, start and connect to development containers similiar to the
-[vscode Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
-
-The full devcontainer.json Schema can be found [here](https://containers.dev/implementors/json_reference/).
-Currently only a small number of configuration file properties are implemented. Those include the following:
-- name
-- Image
-- dockerfile/build.dockerfile
-- build.context
-- location
-- forwardPorts
-- mounts
-
-see `main-container-creation-contributions.ts` for how to implementations or how to implement additional ones. 
-
-
-## Additional Information
-
-- [Theia - GitHub](https://github.com/eclipse-theia/theia)
-- [Theia - Website](https://theia-ide.org/)
-
-## License
-
-- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
-- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
-
-## Trademark
-"Theia" is a trademark of the Eclipse Foundation
-https://www.eclipse.org/theia
+<div align='center'>
+
+<br />
+
+<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
+
+<h2>ECLIPSE THEIA - DEV-CONTAINER EXTENSION</h2>
+
+<hr />
+
+</div>
+
+## Description
+
+The `@theia/dev-container` extension provides functionality to create, start and connect to development containers similiar to the
+[vscode Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers).
+
+The full devcontainer.json Schema can be found [here](https://containers.dev/implementors/json_reference/).
+Currently only a small number of configuration file properties are implemented. Those include the following:
+- name
+- Image
+- dockerfile/build.dockerfile
+- build.context
+- location
+- forwardPorts
+- mounts
+
+see `main-container-creation-contributions.ts` for how to implementations or how to implement additional ones. 
+
+
+## Additional Information
+
+- [Theia - GitHub](https://github.com/eclipse-theia/theia)
+- [Theia - Website](https://theia-ide.org/)
+
+## License
+
+- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
+- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
+
+## Trademark
+"Theia" is a trademark of the Eclipse Foundation
+https://www.eclipse.org/theia

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@theia/dev-container",
-  "version": "1.52.0",
+  "version": "1.53.0-next.55+d1a989a68c",
   "description": "Theia - Editor Preview Extension",
   "dependencies": {
-    "@theia/core": "1.52.0",
-    "@theia/output": "1.52.0",
-    "@theia/remote": "1.52.0",
-    "@theia/workspace": "1.52.0",
+    "@theia/core": "1.53.0-next.55+d1a989a68c",
+    "@theia/output": "1.53.0-next.55+d1a989a68c",
+    "@theia/remote": "1.53.0-next.55+d1a989a68c",
+    "@theia/workspace": "1.53.0-next.55+d1a989a68c",
     "dockerode": "^4.0.2",
     "jsonc-parser": "^2.2.0",
     "uuid": "^8.0.0"
@@ -45,11 +45,11 @@
     "watch": "theiaext watch"
   },
   "devDependencies": {
-    "@theia/ext-scripts": "1.52.0",
+    "@theia/ext-scripts": "1.53.0",
     "@types/dockerode": "^3.3.23"
   },
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "40ceebcd4ee75f13ec16b9dc7314e9384493c1ac"
+  "gitHead": "d1a989a68c1b5ec1f9098e9126653c6346844769"
 }

package/src/dev-container-server/dev-container-server.ts

@@ -1,53 +1,53 @@
-// *****************************************************************************
-// Copyright (C) 2024 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 { createConnection } from 'net';
-import { stdin, argv, stdout } from 'process';
-
-/**
- * this node.js Program is supposed to be executed by an docker exec session inside a docker container.
- * It uses a tty session to listen on stdin and send on stdout all communication with the theia backend running inside the container.
- */
-
-let backendPort: number | undefined = undefined;
-argv.slice(2).forEach(arg => {
-    if (arg.startsWith('-target-port')) {
-        backendPort = parseInt(arg.split('=')[1]);
-    }
-});
-
-if (!backendPort) {
-    throw new Error('please start with -target-port={port number}');
-}
-if (stdin.isTTY) {
-    stdin.setRawMode(true);
-}
-const connection = createConnection(backendPort, '0.0.0.0');
-
-connection.pipe(stdout);
-stdin.pipe(connection);
-
-connection.on('error', error => {
-    console.error('connection error', error);
-});
-
-connection.on('close', () => {
-    console.log('connection closed');
-    process.exit(0);
-});
-
-// keep the process running
-setInterval(() => { }, 1 << 30);
+// *****************************************************************************
+// Copyright (C) 2024 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 { createConnection } from 'net';
+import { stdin, argv, stdout } from 'process';
+
+/**
+ * this node.js Program is supposed to be executed by an docker exec session inside a docker container.
+ * It uses a tty session to listen on stdin and send on stdout all communication with the theia backend running inside the container.
+ */
+
+let backendPort: number | undefined = undefined;
+argv.slice(2).forEach(arg => {
+    if (arg.startsWith('-target-port')) {
+        backendPort = parseInt(arg.split('=')[1]);
+    }
+});
+
+if (!backendPort) {
+    throw new Error('please start with -target-port={port number}');
+}
+if (stdin.isTTY) {
+    stdin.setRawMode(true);
+}
+const connection = createConnection(backendPort, '0.0.0.0');
+
+connection.pipe(stdout);
+stdin.pipe(connection);
+
+connection.on('error', error => {
+    console.error('connection error', error);
+});
+
+connection.on('close', () => {
+    console.log('connection closed');
+    process.exit(0);
+});
+
+// keep the process running
+setInterval(() => { }, 1 << 30);

package/src/electron-browser/container-connection-contribution.ts

@@ -1,103 +1,103 @@
-// *****************************************************************************
-// Copyright (C) 2024 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 { inject, injectable } from '@theia/core/shared/inversify';
-import { AbstractRemoteRegistryContribution, RemoteRegistry } from '@theia/remote/lib/electron-browser/remote-registry-contribution';
-import { LastContainerInfo, RemoteContainerConnectionProvider } from '../electron-common/remote-container-connection-provider';
-import { RemotePreferences } from '@theia/remote/lib/electron-browser/remote-preferences';
-import { WorkspaceStorageService } from '@theia/workspace/lib/browser/workspace-storage-service';
-import { Command, QuickInputService } from '@theia/core';
-import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
-import { ContainerOutputProvider } from './container-output-provider';
-
-export namespace RemoteContainerCommands {
-    export const REOPEN_IN_CONTAINER = Command.toLocalizedCommand({
-        id: 'dev-container:reopen-in-container',
-        label: 'Reopen in Container',
-        category: 'Dev Container'
-    }, 'theia/dev-container/connect');
-}
-
-const LAST_USED_CONTAINER = 'lastUsedContainer';
-@injectable()
-export class ContainerConnectionContribution extends AbstractRemoteRegistryContribution {
-
-    @inject(RemoteContainerConnectionProvider)
-    protected readonly connectionProvider: RemoteContainerConnectionProvider;
-
-    @inject(RemotePreferences)
-    protected readonly remotePreferences: RemotePreferences;
-
-    @inject(WorkspaceStorageService)
-    protected readonly workspaceStorageService: WorkspaceStorageService;
-
-    @inject(WorkspaceService)
-    protected readonly workspaceService: WorkspaceService;
-
-    @inject(QuickInputService)
-    protected readonly quickInputService: QuickInputService;
-
-    @inject(ContainerOutputProvider)
-    protected readonly containerOutputProvider: ContainerOutputProvider;
-
-    registerRemoteCommands(registry: RemoteRegistry): void {
-        registry.registerCommand(RemoteContainerCommands.REOPEN_IN_CONTAINER, {
-            execute: () => this.openInContainer()
-        });
-    }
-
-    async openInContainer(): Promise<void> {
-        const devcontainerFile = await this.getOrSelectDevcontainerFile();
-        if (!devcontainerFile) {
-            return;
-        }
-        const lastContainerInfoKey = `${LAST_USED_CONTAINER}:${devcontainerFile}`;
-        const lastContainerInfo = await this.workspaceStorageService.getData<LastContainerInfo | undefined>(lastContainerInfoKey);
-
-        this.containerOutputProvider.openChannel();
-
-        const connectionResult = await this.connectionProvider.connectToContainer({
-            nodeDownloadTemplate: this.remotePreferences['remote.nodeDownloadTemplate'],
-            lastContainerInfo,
-            devcontainerFile
-        });
-
-        this.workspaceStorageService.setData<LastContainerInfo>(lastContainerInfoKey, {
-            id: connectionResult.containerId,
-            lastUsed: Date.now()
-        });
-
-        this.openRemote(connectionResult.port, false, connectionResult.workspacePath);
-    }
-
-    async getOrSelectDevcontainerFile(): Promise<string | undefined> {
-        const devcontainerFiles = await this.connectionProvider.getDevContainerFiles();
-
-        if (devcontainerFiles.length === 1) {
-            return devcontainerFiles[0].path;
-        }
-
-        return (await this.quickInputService.pick(devcontainerFiles.map(file => ({
-            type: 'item',
-            label: file.name,
-            description: file.path,
-            file: file.path,
-        })), {
-            title: 'Select a devcontainer.json file'
-        }))?.file;
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2024 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 { inject, injectable } from '@theia/core/shared/inversify';
+import { AbstractRemoteRegistryContribution, RemoteRegistry } from '@theia/remote/lib/electron-browser/remote-registry-contribution';
+import { LastContainerInfo, RemoteContainerConnectionProvider } from '../electron-common/remote-container-connection-provider';
+import { RemotePreferences } from '@theia/remote/lib/electron-browser/remote-preferences';
+import { WorkspaceStorageService } from '@theia/workspace/lib/browser/workspace-storage-service';
+import { Command, QuickInputService } from '@theia/core';
+import { WorkspaceService } from '@theia/workspace/lib/browser/workspace-service';
+import { ContainerOutputProvider } from './container-output-provider';
+
+export namespace RemoteContainerCommands {
+    export const REOPEN_IN_CONTAINER = Command.toLocalizedCommand({
+        id: 'dev-container:reopen-in-container',
+        label: 'Reopen in Container',
+        category: 'Dev Container'
+    }, 'theia/dev-container/connect');
+}
+
+const LAST_USED_CONTAINER = 'lastUsedContainer';
+@injectable()
+export class ContainerConnectionContribution extends AbstractRemoteRegistryContribution {
+
+    @inject(RemoteContainerConnectionProvider)
+    protected readonly connectionProvider: RemoteContainerConnectionProvider;
+
+    @inject(RemotePreferences)
+    protected readonly remotePreferences: RemotePreferences;
+
+    @inject(WorkspaceStorageService)
+    protected readonly workspaceStorageService: WorkspaceStorageService;
+
+    @inject(WorkspaceService)
+    protected readonly workspaceService: WorkspaceService;
+
+    @inject(QuickInputService)
+    protected readonly quickInputService: QuickInputService;
+
+    @inject(ContainerOutputProvider)
+    protected readonly containerOutputProvider: ContainerOutputProvider;
+
+    registerRemoteCommands(registry: RemoteRegistry): void {
+        registry.registerCommand(RemoteContainerCommands.REOPEN_IN_CONTAINER, {
+            execute: () => this.openInContainer()
+        });
+    }
+
+    async openInContainer(): Promise<void> {
+        const devcontainerFile = await this.getOrSelectDevcontainerFile();
+        if (!devcontainerFile) {
+            return;
+        }
+        const lastContainerInfoKey = `${LAST_USED_CONTAINER}:${devcontainerFile}`;
+        const lastContainerInfo = await this.workspaceStorageService.getData<LastContainerInfo | undefined>(lastContainerInfoKey);
+
+        this.containerOutputProvider.openChannel();
+
+        const connectionResult = await this.connectionProvider.connectToContainer({
+            nodeDownloadTemplate: this.remotePreferences['remote.nodeDownloadTemplate'],
+            lastContainerInfo,
+            devcontainerFile
+        });
+
+        this.workspaceStorageService.setData<LastContainerInfo>(lastContainerInfoKey, {
+            id: connectionResult.containerId,
+            lastUsed: Date.now()
+        });
+
+        this.openRemote(connectionResult.port, false, connectionResult.workspacePath);
+    }
+
+    async getOrSelectDevcontainerFile(): Promise<string | undefined> {
+        const devcontainerFiles = await this.connectionProvider.getDevContainerFiles();
+
+        if (devcontainerFiles.length === 1) {
+            return devcontainerFiles[0].path;
+        }
+
+        return (await this.quickInputService.pick(devcontainerFiles.map(file => ({
+            type: 'item',
+            label: file.name,
+            description: file.path,
+            file: file.path,
+        })), {
+            title: 'Select a devcontainer.json file'
+        }))?.file;
+    }
+
+}

package/src/electron-browser/container-info-contribution.ts

@@ -1,46 +1,46 @@
-// *****************************************************************************
-// Copyright (C) 2024 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 { inject, injectable } from '@theia/core/shared/inversify';
-import { FrontendApplicationContribution } from '@theia/core/lib/browser';
-import type { ContainerInspectInfo } from 'dockerode';
-import { RemoteContainerConnectionProvider } from '../electron-common/remote-container-connection-provider';
-import { PortForwardingService } from '@theia/remote/lib/electron-browser/port-forwarding/port-forwarding-service';
-
-@injectable()
-export class ContainerInfoContribution implements FrontendApplicationContribution {
-
-    @inject(RemoteContainerConnectionProvider)
-    protected readonly connectionProvider: RemoteContainerConnectionProvider;
-
-    @inject(PortForwardingService)
-    protected readonly portForwardingService: PortForwardingService;
-
-    containerInfo: ContainerInspectInfo | undefined;
-
-    async onStart(): Promise<void> {
-        this.containerInfo = await this.connectionProvider.getCurrentContainerInfo(parseInt(new URLSearchParams(location.search).get('port') ?? '0'));
-
-        this.portForwardingService.forwardedPorts = Object.entries(this.containerInfo?.NetworkSettings.Ports ?? {}).flatMap(([_, ports]) => (
-            ports.map(port => ({
-                editing: false,
-                address: port.HostIp ?? '',
-                localPort: parseInt(port.HostPort ?? '0'),
-                origin: 'container'
-            }))));
-    }
-
-}
+// *****************************************************************************
+// Copyright (C) 2024 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 { inject, injectable } from '@theia/core/shared/inversify';
+import { FrontendApplicationContribution } from '@theia/core/lib/browser';
+import type { ContainerInspectInfo } from 'dockerode';
+import { RemoteContainerConnectionProvider } from '../electron-common/remote-container-connection-provider';
+import { PortForwardingService } from '@theia/remote/lib/electron-browser/port-forwarding/port-forwarding-service';
+
+@injectable()
+export class ContainerInfoContribution implements FrontendApplicationContribution {
+
+    @inject(RemoteContainerConnectionProvider)
+    protected readonly connectionProvider: RemoteContainerConnectionProvider;
+
+    @inject(PortForwardingService)
+    protected readonly portForwardingService: PortForwardingService;
+
+    containerInfo: ContainerInspectInfo | undefined;
+
+    async onStart(): Promise<void> {
+        this.containerInfo = await this.connectionProvider.getCurrentContainerInfo(parseInt(new URLSearchParams(location.search).get('port') ?? '0'));
+
+        this.portForwardingService.forwardedPorts = Object.entries(this.containerInfo?.NetworkSettings.Ports ?? {}).flatMap(([_, ports]) => (
+            ports.map(port => ({
+                editing: false,
+                address: port.HostIp ?? '',
+                localPort: parseInt(port.HostPort ?? '0'),
+                origin: 'container'
+            }))));
+    }
+
+}

package/src/electron-browser/container-output-provider.ts

@@ -1,36 +1,36 @@
-// *****************************************************************************
-// Copyright (C) 2024 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, inject } from '@theia/core/shared/inversify';
-import { OutputChannel, OutputChannelManager } from '@theia/output/lib/browser/output-channel';
-
-@injectable()
-export class ContainerOutputProvider implements ContainerOutputProvider {
-
-    @inject(OutputChannelManager)
-    protected readonly outputChannelManager: OutputChannelManager;
-
-    protected currentChannel?: OutputChannel;
-
-    openChannel(): void {
-        this.currentChannel = this.outputChannelManager.getChannel('Container');
-        this.currentChannel.show();
-    };
-
-    onRemoteOutput(output: string): void {
-        this.currentChannel?.appendLine(output);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2024 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, inject } from '@theia/core/shared/inversify';
+import { OutputChannel, OutputChannelManager } from '@theia/output/lib/browser/output-channel';
+
+@injectable()
+export class ContainerOutputProvider implements ContainerOutputProvider {
+
+    @inject(OutputChannelManager)
+    protected readonly outputChannelManager: OutputChannelManager;
+
+    protected currentChannel?: OutputChannel;
+
+    openChannel(): void {
+        this.currentChannel = this.outputChannelManager.getChannel('Container');
+        this.currentChannel.show();
+    };
+
+    onRemoteOutput(output: string): void {
+        this.currentChannel?.appendLine(output);
+    }
+}