Changes for Features V2

.vscode/launch.json

@@ -10,7 +10,13 @@
             "name": "Launch cli - up",
             "program": "${workspaceFolder}/src/spec-node/devContainersSpecCLI.ts",
             "cwd": "${workspaceFolder}",
-            "args": ["up", "--workspace-folder", "../features-playground", "--log-level", "debug", ],
+            "args": [
+                "up",
+                "--workspace-folder",
+                "../devcontainers-features",
+                "--log-level",
+                "debug",
+            ],
             "console": "integratedTerminal",
         }
     ]

src/spec-common/injectHeadless.ts

@@ -105,18 +105,13 @@ export type DevContainerConfigCommand = 'initializeCommand' | 'onCreateCommand'
 
 const defaultWaitFor: DevContainerConfigCommand = 'updateContentCommand';
 
-export interface DevContainerFeature {
-	id: string;
-	options: boolean | string | Record<string, boolean | string | undefined>;
-}
-
 export interface CommonDevContainerConfig {
 	configFilePath?: URI;
 	remoteEnv?: Record<string, string | null>;
 	forwardPorts?: (number | string)[];
 	portsAttributes?: Record<string, PortAttributes>;
 	otherPortsAttributes?: PortAttributes;
-	features?: DevContainerFeature[] | Record<string, string | boolean | Record<string, string | boolean>>;
+	features?: Record<string, string | boolean | Record<string, string | boolean>>;
 	onCreateCommand?: string | string[];
 	updateContentCommand?: string | string[];
 	postCreateCommand?: string | string[];

src/spec-configuration/configuration.ts

@@ -59,7 +59,8 @@ export interface DevContainerFromImageConfig {
 	remoteUser?: string;
 	updateRemoteUserUID?: boolean;
 	userEnvProbe?: UserEnvProbe;
-	features?: DevContainerFeature[] | Record<string, string | boolean | Record<string, string | boolean>>;
+	features?: Record<string, string | boolean | Record<string, string | boolean>>;
+	overrideFeatureInstallOrder?: string[];
 	hostRequirements?: HostRequirements;
 }
 
@@ -90,7 +91,8 @@ export type DevContainerFromDockerfileConfig = {
 	remoteUser?: string;
 	updateRemoteUserUID?: boolean;
 	userEnvProbe?: UserEnvProbe;
-	features?: DevContainerFeature[] | Record<string, string | boolean | Record<string, string | boolean>>;
+	features?: Record<string, string | boolean | Record<string, string | boolean>>;
+	overrideFeatureInstallOrder?: string[];
 	hostRequirements?: HostRequirements;
 } & (
 		{
@@ -137,7 +139,8 @@ export interface DevContainerFromDockerComposeConfig {
 	remoteUser?: string;
 	updateRemoteUserUID?: boolean;
 	userEnvProbe?: UserEnvProbe;
-	features?: DevContainerFeature[] | Record<string, string | boolean | Record<string, string | boolean>>;
+	features?: Record<string, string | boolean | Record<string, string | boolean>>;
+	overrideFeatureInstallOrder?: string[];
 	hostRequirements?: HostRequirements;
 }
 

src/spec-configuration/containerFeaturesConfiguration.ts

@@ -7,11 +7,13 @@ import * as jsonc from 'jsonc-parser';
 import * as path from 'path';
 import * as URL from 'url';
 import * as tar from 'tar';
+import { existsSync } from 'fs';
 import { DevContainerConfig, DevContainerFeature } from './configuration';
 import { mkdirpLocal, readLocalFile, rmLocal, writeLocalFile, cpDirectoryLocal } from '../spec-utils/pfs';
 import { Log, LogLevel } from '../spec-utils/log';
 import { request } from '../spec-utils/httpRequest';
-import { existsSync } from 'fs';
+import { computeFeatureInstallationOrder } from './containerFeaturesOrder';
+
 
 const V1_ASSET_NAME = 'devcontainer-features.tgz';
 
@@ -38,6 +40,7 @@ export interface Feature {
 	capAdd?: string[];
 	securityOpt?: string[];
 	entrypoint?: string;
+	installAfter?: string[];
 	include?: string[];
 	exclude?: string[];
 	value: boolean | string | Record<string, boolean | string | undefined>; // set programmatically
@@ -414,6 +417,15 @@ export async function generateFeaturesConfig(params: { extensionPath: string; cw
 	output.write('--- Fetching User Features ----', LogLevel.Trace);
 	await fetchFeatures(params, featuresConfig, locallyCachedFeatureSet, dstFolder);
 
+	const ordererdFeatures = computeFeatureInstallationOrder(config, featuresConfig.featureSets);
+
+	output.write('--- Computed order ----', LogLevel.Trace);
+	for (const feature of ordererdFeatures) {
+		output.write(`${feature.features[0].id}`, LogLevel.Trace);
+	}
+
+	featuresConfig.featureSets = ordererdFeatures;
+
 	return featuresConfig;
 }
 
@@ -826,6 +838,7 @@ async function parseDevContainerFeature(featureSet: FeatureSet, feature: Feature
 		featureSet.internalVersion = '2';
 		feature.buildArg = featureJson.buildArg;
 		feature.options = featureJson.options;
+		feature.installAfter = featureJson.installAfter;
 	} else {
 		featureSet.internalVersion = '1';
 	}

src/spec-configuration/containerFeaturesOrder.ts

@@ -0,0 +1,108 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+
+import { ContainerError } from '../spec-common/errors';
+import { FeatureSet } from '../spec-configuration/containerFeaturesConfiguration';
+import { DevContainerConfig } from './configuration';
+
+interface FeatureNode {
+    feature: FeatureSet;
+    before: Set<FeatureNode>;
+    after: Set<FeatureNode>;
+}
+
+export function computeFeatureInstallationOrder(config: DevContainerConfig, features: FeatureSet[]) {
+
+    if (!config.overrideFeatureInstallOrder) {
+        return computeInstallationOrder(features);
+    }
+    else {
+        return computeOverrideInstallationOrder(config, features);
+    }
+}
+
+function computeOverrideInstallationOrder(config: DevContainerConfig, features: FeatureSet[]) {
+    const automaticOrder = computeInstallationOrder(features);
+
+    const orderedFeatures = [];
+
+    for (const featureId of config.overrideFeatureInstallOrder!) {
+        const feature = automaticOrder.find(feature => feature.features[0].name === featureId);
+        if (!feature) {
+            throw new ContainerError({ description: `Feature ${featureId} not found` });
+        }
+        orderedFeatures.push(feature);
+        features.splice(features.indexOf(feature), 1);
+    }
+
+    return orderedFeatures.concat(features);
+}
+
+function computeInstallationOrder(features: FeatureSet[]) {
+    const nodesById = features.map<FeatureNode>(feature => ({
+        feature,
+        before: new Set(),
+        after: new Set(),
+    })).reduce((map, feature) => map.set(feature.feature.features[0].id, feature), new Map<string, FeatureNode>());
+
+    const nodes = [...nodesById.values()];
+    for (const later of nodes) {
+        for (const firstId of later.feature.features[0].installAfter || []) {
+            const first = nodesById.get(firstId);
+            // soft dependencies
+            if (first) {
+                later.after.add(first);
+                first.before.add(later);
+            }
+        }
+    }
+
+    const { roots, islands } = nodes.reduce((prev, node) => {
+        if (node.after.size === 0) {
+            if (node.before.size === 0) {
+                prev.islands.push(node);
+            } else {
+                prev.roots.push(node);
+            }
+        }
+        return prev;
+    }, { roots: [] as FeatureNode[], islands: [] as FeatureNode[] });
+
+    const orderedFeatures = [];
+    let current = roots;
+    while (current.length) {
+        const next = [];
+        for (const first of current) {
+            for (const later of first.before) {
+                later.after.delete(first);
+                if (later.after.size === 0) {
+                    next.push(later);
+                }
+            }
+        }
+        orderedFeatures.push(
+            ...current.map(node => node.feature)
+                .sort((a, b) => a.features[0].id.localeCompare(b.features[0].id)) // stable order
+        );
+        current = next;
+    }
+
+    orderedFeatures.push(
+        ...islands.map(node => node.feature)
+            .sort((a, b) => a.features[0].id.localeCompare(b.features[0].id)) // stable order
+    );
+
+    const missing = new Set(nodesById.keys());
+    for (const feature of orderedFeatures) {
+        missing.delete(feature.features[0].id);
+    }
+
+    if (missing.size !== 0) {
+        throw new ContainerError({ description: `Features declare cyclic dependency: ${[...missing].join(', ')}` });
+    }
+
+    return orderedFeatures;
+}

src/spec-configuration/tsconfig.json

@@ -3,6 +3,9 @@
 	"references": [
 		{
 			"path": "../spec-utils"
+		},
+		{
+			"path": "../spec-common"
 		}
 	]
 }