0.11.0 & --skip-feature-auto-mapping

Author: chrmarti

CHANGELOG.md

@@ -4,6 +4,11 @@ Notable changes.
 
 ## August 2022
 
+### [0.11.0]
+
+- WIP on features v2:
+	- Auto map old feature ids to OCI features. (https://github.com/devcontainers/cli/pull/100)
+
 ### [0.10.0]
 
 - Implement optional default values in localEnv/containerEnv expansions. (https://github.com/devcontainers/cli/issues/50)

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@devcontainers/cli",
 	"description": "Dev Containers CLI",
-	"version": "0.10.0",
+	"version": "0.11.0",
 	"bin": {
 		"devcontainer": "devcontainer.js"
 	},

src/spec-common/injectHeadless.ts

@@ -58,6 +58,7 @@ export interface ResolverParameters {
 	remoteEnv: Record<string, string>;
 	buildxPlatform: string | undefined;
 	buildxPush: boolean;
+	skipFeatureAutoMapping: boolean;
 }
 
 export interface PostCreate {

src/spec-configuration/containerFeaturesConfiguration.ts

@@ -383,7 +383,7 @@ function updateFromOldProperties<T extends { features: (Feature & { extensions?:
 
 // Generate a base featuresConfig object with the set of locally-cached features, 
 // as well as downloading and merging in remote feature definitions.
-export async function generateFeaturesConfig(params: { extensionPath: string; cwd: string; output: Log; env: NodeJS.ProcessEnv }, dstFolder: string, config: DevContainerConfig, getLocalFeaturesFolder: (d: string) => string) {
+export async function generateFeaturesConfig(params: { extensionPath: string; cwd: string; output: Log; env: NodeJS.ProcessEnv; skipFeatureAutoMapping: boolean }, dstFolder: string, config: DevContainerConfig, getLocalFeaturesFolder: (d: string) => string) {
 	const { output } = params;
 
 	const workspaceCwd = params.cwd;
@@ -412,7 +412,7 @@ export async function generateFeaturesConfig(params: { extensionPath: string; cw
 
 	// Read features and get the type.
 	output.write('--- Processing User Features ----', LogLevel.Trace);
-	featuresConfig = await processUserFeatures(params.output, params.env, workspaceCwd, userFeatures, featuresConfig);
+	featuresConfig = await processUserFeatures(params.output, params.env, workspaceCwd, userFeatures, featuresConfig, params.skipFeatureAutoMapping);
 	output.write(JSON.stringify(featuresConfig, null, 4), LogLevel.Trace);
 
 	const ociCacheDir = await prepareOCICache(dstFolder);
@@ -461,9 +461,9 @@ function featuresToArray(config: DevContainerConfig): DevContainerFeature[] | un
 
 // Process features contained in devcontainer.json
 // Creates one feature set per feature to aid in support of the previous structure.
-async function processUserFeatures(output: Log, env: NodeJS.ProcessEnv, workspaceCwd: string, userFeatures: DevContainerFeature[], featuresConfig: FeaturesConfig): Promise<FeaturesConfig> {
+async function processUserFeatures(output: Log, env: NodeJS.ProcessEnv, workspaceCwd: string, userFeatures: DevContainerFeature[], featuresConfig: FeaturesConfig, skipFeatureAutoMapping: boolean): Promise<FeaturesConfig> {
 	for (const userFeature of userFeatures) {
-		const newFeatureSet = await processFeatureIdentifier(output, env, workspaceCwd, userFeature);
+		const newFeatureSet = await processFeatureIdentifier(output, env, workspaceCwd, userFeature, skipFeatureAutoMapping);
 		if (!newFeatureSet) {
 			throw new Error(`Failed to process feature ${userFeature.id}`);
 		}
@@ -547,11 +547,13 @@ export function getBackwardCompatibleFeatureId(id: string) {
 
 // Strictly processes the user provided feature identifier to determine sourceInformation type.
 // Returns a featureSet per feature.
-export async function processFeatureIdentifier(output: Log, env: NodeJS.ProcessEnv, workspaceCwd: string, userFeature: DevContainerFeature): Promise<FeatureSet | undefined> {
+export async function processFeatureIdentifier(output: Log, env: NodeJS.ProcessEnv, workspaceCwd: string, userFeature: DevContainerFeature, skipFeatureAutoMapping?: boolean): Promise<FeatureSet | undefined> {
 	output.write(`* Processing feature: ${userFeature.id}`);
 
 	// Adding backward compatibility
-	userFeature.id = getBackwardCompatibleFeatureId(userFeature.id);
+	if (!skipFeatureAutoMapping) {
+		userFeature.id = getBackwardCompatibleFeatureId(userFeature.id);
+	}
 
 	const { type, manifest } = await getFeatureIdType(output, env, userFeature.id);
 

src/spec-node/devContainers.ts

@@ -49,6 +49,7 @@ export interface ProvisionOptions {
 	omitLoggerHeader?: boolean | undefined;
 	buildxPlatform: string | undefined;
 	buildxPush: boolean;
+	skipFeatureAutoMapping: boolean;
 }
 
 export async function launch(options: ProvisionOptions, disposables: (() => Promise<unknown> | undefined)[]) {
@@ -119,6 +120,7 @@ export async function createDockerParams(options: ProvisionOptions, disposables:
 		remoteEnv,
 		buildxPlatform: options.buildxPlatform,
 		buildxPush: options.buildxPush,
+		skipFeatureAutoMapping: options.skipFeatureAutoMapping,
 	};
 
 	const dockerPath = options.dockerPath || 'docker';

src/spec-node/devContainersSpecCLI.ts

@@ -94,6 +94,7 @@ function provisionOptions(y: Argv) {
 		'remote-env': { type: 'string', description: 'Remote environment variables of the format name=value. These will be added when executing the user commands.' },
 		'cache-from': { type: 'string', description: 'Additional image to use as potential layer cache during image building' },
 		'buildkit': { choices: ['auto' as 'auto', 'never' as 'never'], default: 'auto' as 'auto', description: 'Control whether BuildKit should be used' },
+		'skip-feature-auto-mapping': { type: 'boolean', default: false, hidden: true, description: 'Temporary option for testing.' },
 	})
 		.check(argv => {
 			const idLabels = (argv['id-label'] && (Array.isArray(argv['id-label']) ? argv['id-label'] : [argv['id-label']])) as string[] | undefined;
@@ -152,6 +153,7 @@ async function provision({
 	'remote-env': addRemoteEnv,
 	'cache-from': addCacheFrom,
 	'buildkit': buildkit,
+	'skip-feature-auto-mapping': skipFeatureAutoMapping,
 }: ProvisionArgs) {
 
 	const workspaceFolder = workspaceFolderArg ? path.resolve(process.cwd(), workspaceFolderArg) : undefined;
@@ -195,6 +197,7 @@ async function provision({
 		useBuildKit: buildkit,
 		buildxPlatform: undefined,
 		buildxPush: false,
+		skipFeatureAutoMapping,
 	};
 
 	const result = await doProvision(options);
@@ -254,6 +257,7 @@ function buildOptions(y: Argv) {
 		'buildkit': { choices: ['auto' as 'auto', 'never' as 'never'], default: 'auto' as 'auto', description: 'Control whether BuildKit should be used' },
 		'platform': { type: 'string', description: 'Set target platforms.' },
 		'push': { type: 'boolean', default: false, description: 'Push to a container registry.' },
+		'skip-feature-auto-mapping': { type: 'boolean', default: false, hidden: true, description: 'Temporary option for testing.' },
 	});
 }
 
@@ -284,6 +288,7 @@ async function doBuild({
 	'buildkit': buildkit,
 	'platform': buildxPlatform,
 	'push': buildxPush,
+	'skip-feature-auto-mapping': skipFeatureAutoMapping,
 }: BuildArgs) {
 	const disposables: (() => Promise<unknown> | undefined)[] = [];
 	const dispose = async () => {
@@ -323,6 +328,7 @@ async function doBuild({
 			useBuildKit: buildkit,
 			buildxPlatform,
 			buildxPush,
+			skipFeatureAutoMapping,
 		}, disposables);
 
 		const { common, dockerCLI, dockerComposeCLI } = params;
@@ -453,6 +459,7 @@ function runUserCommandsOptions(y: Argv) {
 		prebuild: { type: 'boolean', default: false, description: 'Stop after onCreateCommand and updateContentCommand, rerunning updateContentCommand if it has run before.' },
 		'stop-for-personalization': { type: 'boolean', default: false, description: 'Stop for personalization.' },
 		'remote-env': { type: 'string', description: 'Remote environment variables of the format name=value. These will be added when executing the user commands.' },
+		'skip-feature-auto-mapping': { type: 'boolean', default: false, hidden: true, description: 'Temporary option for testing.' },
 	})
 		.check(argv => {
 			const idLabels = (argv['id-label'] && (Array.isArray(argv['id-label']) ? argv['id-label'] : [argv['id-label']])) as string[] | undefined;
@@ -501,6 +508,7 @@ async function doRunUserCommands({
 	prebuild,
 	'stop-for-personalization': stopForPersonalization,
 	'remote-env': addRemoteEnv,
+	'skip-feature-auto-mapping': skipFeatureAutoMapping,
 }: RunUserCommandsArgs) {
 	const disposables: (() => Promise<unknown> | undefined)[] = [];
 	const dispose = async () => {
@@ -541,6 +549,7 @@ async function doRunUserCommands({
 			useBuildKit: 'auto',
 			buildxPlatform: undefined,
 			buildxPush: false,
+			skipFeatureAutoMapping,
 		}, disposables);
 
 		const { common } = params;
@@ -599,6 +608,7 @@ function readConfigurationOptions(y: Argv) {
 		'terminal-columns': { type: 'number', implies: ['terminal-rows'], description: 'Number of rows to render the output for. This is required for some of the subprocesses to correctly render their output.' },
 		'terminal-rows': { type: 'number', implies: ['terminal-columns'], description: 'Number of columns to render the output for. This is required for some of the subprocesses to correctly render their output.' },
 		'include-features-configuration': { type: 'boolean', default: false, description: 'Include features configuration.' },
+		'skip-feature-auto-mapping': { type: 'boolean', default: false, hidden: true, description: 'Temporary option for testing.' },
 	});
 }
 
@@ -619,6 +629,7 @@ async function readConfiguration({
 	'terminal-rows': terminalRows,
 	'terminal-columns': terminalColumns,
 	'include-features-configuration': includeFeaturesConfig,
+	'skip-feature-auto-mapping': skipFeatureAutoMapping,
 }: ReadConfigurationArgs) {
 	const disposables: (() => Promise<unknown> | undefined)[] = [];
 	const dispose = async () => {
@@ -650,7 +661,7 @@ async function readConfiguration({
 		if (!configs) {
 			throw new ContainerError({ description: `Dev container config (${uriToFsPath(configFile || getDefaultDevContainerConfigPath(cliHost, workspace!.configFolderPath), cliHost.platform)}) not found.` });
 		}
-		const featuresConfiguration = includeFeaturesConfig ? await generateFeaturesConfig({ extensionPath, cwd, output, env: cliHost.env }, (await createFeaturesTempFolder({ cliHost, package: pkg })), configs.config, getContainerFeaturesFolder) : undefined;
+		const featuresConfiguration = includeFeaturesConfig ? await generateFeaturesConfig({ extensionPath, cwd, output, env: cliHost.env, skipFeatureAutoMapping }, (await createFeaturesTempFolder({ cliHost, package: pkg })), configs.config, getContainerFeaturesFolder) : undefined;
 		await new Promise<void>((resolve, reject) => {
 			process.stdout.write(JSON.stringify({
 				configuration: configs.config,
@@ -690,6 +701,7 @@ function execOptions(y: Argv) {
 		'terminal-rows': { type: 'number', implies: ['terminal-columns'], description: 'Number of columns to render the output for. This is required for some of the subprocesses to correctly render their output.' },
 		'default-user-env-probe': { choices: ['none' as 'none', 'loginInteractiveShell' as 'loginInteractiveShell', 'interactiveShell' as 'interactiveShell', 'loginShell' as 'loginShell'], default: defaultDefaultUserEnvProbe, description: 'Default value for the devcontainer.json\'s "userEnvProbe".' },
 		'remote-env': { type: 'string', description: 'Remote environment variables of the format name=value. These will be added when executing the user commands.' },
+		'skip-feature-auto-mapping': { type: 'boolean', default: false, hidden: true, description: 'Temporary option for testing.' },
 	})
 		.positional('cmd', {
 			type: 'string',
@@ -746,6 +758,7 @@ export async function doExec({
 	'terminal-columns': terminalColumns,
 	'default-user-env-probe': defaultUserEnvProbe,
 	'remote-env': addRemoteEnv,
+	'skip-feature-auto-mapping': skipFeatureAutoMapping,
 	_: restArgs,
 }: ExecArgs & { _?: string[] }) {
 	const disposables: (() => Promise<unknown> | undefined)[] = [];
@@ -788,6 +801,7 @@ export async function doExec({
 			omitLoggerHeader: true,
 			buildxPlatform: undefined,
 			buildxPush: false,
+			skipFeatureAutoMapping,
 		}, disposables);
 
 		const { common } = params;

src/spec-node/featuresCLI/testCommandImpl.ts

@@ -309,6 +309,7 @@ async function launchProject(params: DockerResolverParameters, workspaceFolder:
 			`devcontainer.local_folder=${workspaceFolder}`
 		],
 		remoteEnv: common.remoteEnv,
+		skipFeatureAutoMapping: common.skipFeatureAutoMapping,
 		log: text => quiet ? null : process.stderr.write(text),
 	};
 
@@ -357,6 +358,7 @@ async function exec(_params: DockerResolverParameters, cmd: string, args: string
 	const execArgs = {
 		...staticExecParams,
 		'workspace-folder': workspaceFolder,
+		'skip-feature-auto-mapping': false,
 		cmd,
 		args,
 		_: [
@@ -400,5 +402,6 @@ async function generateDockerParams(workspaceFolder: string, args: FeaturesTestC
 		useBuildKit: 'auto',
 		buildxPlatform: undefined,
 		buildxPush: false,
+		skipFeatureAutoMapping: false,
 	}, disposables);
 }

src/test/container-features/generateFeaturesConfig.test.ts

@@ -14,7 +14,7 @@ describe('validate generateFeaturesConfig()', function () {
 
     // Setup
     const env = { 'SOME_KEY': 'SOME_VAL' };
-    const params = { extensionPath: '', cwd: '', output, env, persistedFolder: '' };
+    const params = { extensionPath: '', cwd: '', output, env, persistedFolder: '', skipFeatureAutoMapping: false };
 
     // Mocha executes with the root of the project as the cwd.
     const localFeaturesFolder = (_: string) => {