Transform maven, gradle and jupyterlab usages to their features v2 counterparts (#461)

Author: chrmarti

package.json

@@ -35,7 +35,7 @@
 		"definitions": "npm-run-all definitions-clean definitions-copy",
 		"lint": "eslint -c .eslintrc.js --rulesdir ./build/eslint --max-warnings 0 --ext .ts ./src",
 		"definitions-clean": "rimraf dist/node_modules/vscode-dev-containers",
-		"definitions-copy": "copyfiles \"node_modules/vscode-dev-containers/container-features/{devcontainer-features.json,feature-scripts.env,fish-debian.sh,gradle-debian.sh,homebrew-debian.sh,install.sh,jupyterlab-debian.sh,maven-debian.sh}\" dist",
+		"definitions-copy": "copyfiles \"node_modules/vscode-dev-containers/container-features/{devcontainer-features.json,feature-scripts.env,fish-debian.sh,homebrew-debian.sh,install.sh}\" dist",
 		"npm-pack": "npm pack",
 		"clean": "npm-run-all clean-dist clean-built",
 		"clean-dist": "rimraf dist",

src/spec-configuration/containerFeaturesConfiguration.ts

@@ -634,7 +634,8 @@ async function processUserFeatures(params: ContainerFeatureInternalParams, confi
 	let configPath = config.configFilePath && uriToFsPath(config.configFilePath, platform);
 	output.write(`configPath: ${configPath}`, LogLevel.Trace);
 
-	for (const userFeature of userFeatures) {
+	const updatedUserFeatures = updateDeprecatedFeaturesIntoOptions(userFeatures, output);
+	for (const userFeature of updatedUserFeatures) {
 		const newFeatureSet = await processFeatureIdentifier(params, configPath, workspaceRoot, userFeature);
 
 		if (!newFeatureSet) {
@@ -645,6 +646,56 @@ async function processUserFeatures(params: ContainerFeatureInternalParams, confi
 	return featuresConfig;
 }
 
+const deprecatedFeaturesIntoOptions: Record<string, { mapTo: string; withOptions: any }> = {
+	gradle: {
+		mapTo: 'java',
+		withOptions: {
+			installGradle: true
+		}
+	},
+	maven: {
+		mapTo: 'java',
+		withOptions: {
+			installMaven: true
+		}
+	},
+	jupyterlab: {
+		mapTo: 'python',
+		withOptions: {
+			installJupyterlab: true
+		}
+	},
+};
+
+export function updateDeprecatedFeaturesIntoOptions(userFeatures: DevContainerFeature[], output: Log) {
+	const newFeaturePath = 'ghcr.io/devcontainers/features';
+	const versionBackwardComp = '1';
+	for (const update of userFeatures.filter(feature => deprecatedFeaturesIntoOptions[feature.id])) {
+		const { mapTo, withOptions } = deprecatedFeaturesIntoOptions[update.id];
+		output.write(`(!) WARNING: Using the deprecated '${update.id}' Feature. It is now part of the '${mapTo}' Feature. See https://github.com/devcontainers/features/tree/main/src/${mapTo}#options for the updated Feature.`, LogLevel.Warning);
+		const qualifiedMapToId = `${newFeaturePath}/${mapTo}`;
+		let userFeature = userFeatures.find(feature => feature.id === mapTo || feature.id === qualifiedMapToId || feature.id.startsWith(`${qualifiedMapToId}:`));
+		if (userFeature) {
+			userFeature.options = {
+				...(
+					typeof userFeature.options === 'object' ? userFeature.options :
+						typeof userFeature.options === 'string' ? { version: userFeature.options } :
+							{}
+				),
+				...withOptions,
+			};
+		} else {
+			userFeature = {
+				id: `${qualifiedMapToId}:${versionBackwardComp}`,
+				options: withOptions
+			};
+			userFeatures.push(userFeature);
+		}
+	}
+	const updatedUserFeatures = userFeatures.filter(feature => !deprecatedFeaturesIntoOptions[feature.id]);
+	return updatedUserFeatures;
+}
+
 export async function getFeatureIdType(params: CommonParams, userFeatureId: string) {
 	const { output } = params;
 	// See the specification for valid feature identifiers:

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

@@ -2,11 +2,11 @@ import { assert } from 'chai';
 import * as path from 'path';
 import { DevContainerConfig, DevContainerFeature } from '../../spec-configuration/configuration';
 import { OCIRef } from '../../spec-configuration/containerCollectionsOCI';
-import { Feature, FeatureSet, getBackwardCompatibleFeatureId, getFeatureInstallWrapperScript, processFeatureIdentifier } from '../../spec-configuration/containerFeaturesConfiguration';
+import { Feature, FeatureSet, getBackwardCompatibleFeatureId, getFeatureInstallWrapperScript, processFeatureIdentifier, updateDeprecatedFeaturesIntoOptions } from '../../spec-configuration/containerFeaturesConfiguration';
 import { getSafeId, findContainerUsers } from '../../spec-node/containerFeatures';
 import { ImageMetadataEntry } from '../../spec-node/imageMetadata';
 import { SubstitutedConfig } from '../../spec-node/utils';
-import { createPlainLog, LogLevel, makeLog } from '../../spec-utils/log';
+import { createPlainLog, LogLevel, makeLog, nullLog } from '../../spec-utils/log';
 
 export const output = makeLog(createPlainLog(text => process.stdout.write(text), () => LogLevel.Trace));
 
@@ -447,6 +447,58 @@ describe('validate function getBackwardCompatibleFeatureId', () => {
     });
 });
 
+describe('validate function updateDeprecatedFeaturesIntoOptions', () => {
+	it('should add feature with option', () => {
+		const updated = updateDeprecatedFeaturesIntoOptions([
+			{
+				id: 'jupyterlab',
+				options: {}
+			}
+		], nullLog);
+		assert.strictEqual(updated.length, 1);
+		assert.strictEqual(updated[0].id, 'ghcr.io/devcontainers/features/python:1');
+		assert.ok(updated[0].options);
+		assert.strictEqual(typeof updated[0].options, 'object');
+		assert.strictEqual((updated[0].options as Record<string, string | boolean | undefined>)['installJupyterlab'], true);
+	});
+	
+	it('should update feature with option', () => {
+		const updated = updateDeprecatedFeaturesIntoOptions([
+			{
+				id: 'ghcr.io/devcontainers/features/python:1',
+				options: {}
+			},
+			{
+				id: 'jupyterlab',
+				options: {}
+			}
+		], nullLog);
+		assert.strictEqual(updated.length, 1);
+		assert.strictEqual(updated[0].id, 'ghcr.io/devcontainers/features/python:1');
+		assert.ok(updated[0].options);
+		assert.strictEqual(typeof updated[0].options, 'object');
+		assert.strictEqual((updated[0].options as Record<string, string | boolean | undefined>)['installJupyterlab'], true);
+	});
+
+	it('should update legacy feature with option', () => {
+		const updated = updateDeprecatedFeaturesIntoOptions([
+			{
+				id: 'python',
+				options: {}
+			},
+			{
+				id: 'jupyterlab',
+				options: {}
+			}
+		], nullLog);
+		assert.strictEqual(updated.length, 1);
+		assert.strictEqual(updated[0].id, 'python');
+		assert.ok(updated[0].options);
+		assert.strictEqual(typeof updated[0].options, 'object');
+		assert.strictEqual((updated[0].options as Record<string, string | boolean | undefined>)['installJupyterlab'], true);
+	});
+});
+
 describe('validate function getFeatureInstallWrapperScript', () => {
 	it('returns a valid script when optional feature values do not exist', () => {
         const feature: Feature = {