added dockerfile support

Signed-off-by: Jonah Iden <[email protected]>

Author: jonah-iden

packages/dev-container/package.json

@@ -7,7 +7,8 @@
     "@theia/remote": "1.45.0",
     "@theia/workspace": "1.45.0",
     "dockerode": "^4.0.2",
-    "uuid": "^8.0.0"
+    "uuid": "^8.0.0",
+    "jsonc-parser": "^2.2.0"
   },
   "publishConfig": {
     "access": "public"

packages/dev-container/src/electron-node/devcontainer-contributions/main-container-creation-contributions.ts

@@ -16,10 +16,11 @@
 import * as Docker from 'dockerode';
 import { injectable, interfaces } from '@theia/core/shared/inversify';
 import { ContainerCreationContribution } from '../docker-container-service';
-import { DevContainerConfiguration, ImageContainer } from '../devcontainer-file';
+import { DevContainerConfiguration, DockerfileContainer, ImageContainer } from '../devcontainer-file';
 
 export function registerContainerCreationContributions(bind: interfaces.Bind): void {
     bind(ContainerCreationContribution).to(ImageFileContribution).inSingletonScope();
+    bind(ContainerCreationContribution).to(DockerFileContribution).inSingletonScope();
     bind(ContainerCreationContribution).to(ForwardPortsContribution).inSingletonScope();
     bind(ContainerCreationContribution).to(MountsContribution).inSingletonScope();
 }
@@ -35,6 +36,36 @@ export class ImageFileContribution implements ContainerCreationContribution {
     }
 }
 
+@injectable()
+export class DockerFileContribution implements ContainerCreationContribution {
+    async handleContainerCreation(createOptions: Docker.ContainerCreateOptions, containerConfig: DockerfileContainer, api: Docker): Promise<void> {
+        // check if dockerfile container
+        if (containerConfig.dockerFile || containerConfig.build?.dockerfile) {
+            const dockerfile = (containerConfig.dockerFile ?? containerConfig.build?.dockerfile) as string;
+            const buildStream = await api.buildImage({
+                context: containerConfig.context ?? containerConfig.location,
+                src: [dockerfile],
+            } as Docker.ImageBuildContext, {
+                buildargs: containerConfig.build?.args
+            });
+            // TODO probably have some console windows showing the output of the build
+            const imageId = await new Promise<string>((res, rej) => api.modem.followProgress(buildStream, (err, ouptuts) => {
+                if (err) {
+                    rej(err);
+                } else {
+                    for (let i = ouptuts.length - 1; i >= 0; i--) {
+                        if (ouptuts[i].aux?.ID) {
+                            res(ouptuts[i].aux.ID);
+                            return;
+                        }
+                    }
+                }
+            }));
+            createOptions.Image = imageId;
+        }
+    }
+}
+
 @injectable()
 export class ForwardPortsContribution implements ContainerCreationContribution {
     async handleContainerCreation(createOptions: Docker.ContainerCreateOptions, containerConfig: DevContainerConfiguration, api: Docker): Promise<void> {

packages/dev-container/src/electron-node/devcontainer-file.ts

@@ -18,7 +18,7 @@
  * Defines a dev container
  * type generated from https://containers.dev/implementors/json_schema/ and modified
  */
-export type DevContainerConfiguration = (DockerfileContainer | ImageContainer) & NonComposeContainerBase & DevContainerCommon;
+export type DevContainerConfiguration = (DockerfileContainer | ImageContainer) & NonComposeContainerBase & DevContainerCommon & { location?: string };
 
 export type DockerfileContainer = {
     /**
@@ -33,43 +33,40 @@ export type DockerfileContainer = {
          * The location of the context folder for building the Docker image. The path is relative to the folder containing the `devcontainer.json` file.
          */
         context?: string
-        [k: string]: unknown
     } & BuildOptions
     [k: string]: unknown
-}
-    | ({
+} | {
+    /**
+     * The location of the Dockerfile that defines the contents of the container. The path is relative to the folder containing the `devcontainer.json` file.
+     */
+    dockerFile: string
+    /**
+     * The location of the context folder for building the Docker image. The path is relative to the folder containing the `devcontainer.json` file.
+     */
+    context?: string
+
+    /**
+     * Docker build-related options.
+     */
+    build?: {
         /**
-         * The location of the Dockerfile that defines the contents of the container. The path is relative to the folder containing the `devcontainer.json` file.
+         * Target stage in a multi-stage build.
          */
-        dockerFile: string
+        target?: string
         /**
-         * The location of the context folder for building the Docker image. The path is relative to the folder containing the `devcontainer.json` file.
+         * Build arguments.
          */
-        context?: string
-        [k: string]: unknown
-    } & {
+        args?: {
+            [k: string]: string
+        }
         /**
-         * Docker build-related options.
+         * The image to consider as a cache. Use an array to specify multiple images.
          */
-        build?: {
-            /**
-             * Target stage in a multi-stage build.
-             */
-            target?: string
-            /**
-             * Build arguments.
-             */
-            args?: {
-                [k: string]: string
-            }
-            /**
-             * The image to consider as a cache. Use an array to specify multiple images.
-             */
-            cacheFrom?: string | string[]
-            [k: string]: unknown
-        }
+        cacheFrom?: string | string[]
         [k: string]: unknown
-    });
+    }
+    [k: string]: unknown
+};
 
 export interface BuildOptions {
     /**

packages/dev-container/src/electron-node/docker-container-service.ts

@@ -17,6 +17,7 @@
 import { ContributionProvider, URI } from '@theia/core';
 import { inject, injectable, named } from '@theia/core/shared/inversify';
 import { WorkspaceServer } from '@theia/workspace/lib/common';
+import { parse } from 'jsonc-parser';
 import * as fs from '@theia/core/shared/fs-extra';
 import * as Docker from 'dockerode';
 import { LastContainerInfo } from '../electron-common/remote-container-connection-provider';
@@ -51,7 +52,7 @@ export class DockerContainerService {
                 port = lastContainerInfo.port;
             } catch (e) {
                 container = undefined;
-                console.warn('DevContainer: could not find last used container ', e);
+                console.warn('DevContainer: could not find last used container');
             }
         }
         if (!container) {
@@ -67,7 +68,8 @@ export class DockerContainerService {
         }
 
         const devcontainerFile = workspace.resolve('.devcontainer/devcontainer.json');
-        const devcontainerConfig = JSON.parse(await fs.readFile(devcontainerFile.path.fsPath(), 'utf-8').catch(() => '0')) as DevContainerConfiguration;
+        const devcontainerConfig = parse(await fs.readFile(devcontainerFile.path.fsPath(), 'utf-8').catch(() => '0')) as DevContainerConfiguration;
+        devcontainerConfig.location = devcontainerFile.path.dir.fsPath();
 
         if (!devcontainerConfig) {
             // TODO add ability for user to create new config