Merge pull request #1135 from ross-p-smith/ross/inline-cache

Added BUILDKIT_INLINE_CACHE for containerFeature path

Author: abdurriq

src/spec-node/containerFeatures.ts

@@ -11,7 +11,7 @@ import { LogLevel, makeLog } from '../spec-utils/log';
 import { FeaturesConfig, getContainerFeaturesBaseDockerFile, getFeatureInstallWrapperScript, getFeatureLayers, getFeatureMainValue, getFeatureValueObject, generateFeaturesConfig, Feature, generateContainerEnvs } from '../spec-configuration/containerFeaturesConfiguration';
 import { readLocalFile } from '../spec-utils/pfs';
 import { includeAllConfiguredFeatures } from '../spec-utils/product';
-import { createFeaturesTempFolder, DockerResolverParameters, getCacheFolder, getFolderImageName, getEmptyContextFolder, SubstitutedConfig } from './utils';
+import { createFeaturesTempFolder, DockerResolverParameters, getCacheFolder, getFolderImageName, getEmptyContextFolder, SubstitutedConfig, isBuildxCacheToInline } from './utils';
 import { isEarlierVersion, parseVersion, runCommandNoPty } from '../spec-common/commonUtils';
 import { getDevcontainerMetadata, getDevcontainerMetadataLabel, getImageBuildInfoFromImage, ImageBuildInfo, ImageMetadataEntry, imageMetadataLabel, MergedDevContainerConfig } from './imageMetadata';
 import { supportsBuildContexts } from './dockerfileUtils';
@@ -85,6 +85,9 @@ export async function extendImage(params: DockerResolverParameters, config: Subs
 		if (params.buildxCacheTo) {
 			args.push('--cache-to', params.buildxCacheTo);
 		}
+		if (!isBuildxCacheToInline(params.buildxCacheTo)) {
+			args.push('--build-arg', 'BUILDKIT_INLINE_CACHE=1');
+		}
 		if (!params.buildNoCache) {
 			params.additionalCacheFroms.forEach(cacheFrom => args.push('--cache-from', cacheFrom));
 		}

src/spec-node/singleContainer.ts

@@ -4,7 +4,7 @@
  *--------------------------------------------------------------------------------------------*/
 
 
-import { createContainerProperties, startEventSeen, ResolverResult, getTunnelInformation, getDockerfilePath, getDockerContextPath, DockerResolverParameters, isDockerFileConfig, uriToWSLFsPath, WorkspaceConfiguration, getFolderImageName, inspectDockerImage, logUMask, SubstitutedConfig, checkDockerSupportForGPU, isBuildKitImagePolicyError } from './utils';
+import { createContainerProperties, startEventSeen, ResolverResult, getTunnelInformation, getDockerfilePath, getDockerContextPath, DockerResolverParameters, isDockerFileConfig, uriToWSLFsPath, WorkspaceConfiguration, getFolderImageName, inspectDockerImage, logUMask, SubstitutedConfig, checkDockerSupportForGPU, isBuildKitImagePolicyError, isBuildxCacheToInline } from './utils';
 import { ContainerProperties, setupInContainer, ResolverProgress, ResolverParameters } from '../spec-common/injectHeadless';
 import { ContainerError, toErrorText } from '../spec-common/errors';
 import { ContainerDetails, listContainers, DockerCLIParameters, inspectContainers, dockerCLI, dockerPtyCLI, toPtyExecParameters, ImageDetails, toExecParameters, removeContainer } from '../spec-shutdown/dockerUtils';
@@ -209,7 +209,9 @@ async function buildAndExtendImage(buildParams: DockerResolverParameters, config
 		if (buildParams.buildxCacheTo) {
 			args.push('--cache-to', buildParams.buildxCacheTo);
 		}
-		args.push('--build-arg', 'BUILDKIT_INLINE_CACHE=1');
+		if (!isBuildxCacheToInline(buildParams.buildxCacheTo)) {
+			args.push('--build-arg', 'BUILDKIT_INLINE_CACHE=1');
+		}
 	} else {
 		args.push('build');
 	}

src/spec-node/utils.ts

@@ -93,6 +93,13 @@ export async function logUMask(params: DockerResolverParameters): Promise<string
 	}
 }
 
+export function isBuildxCacheToInline(buildxCacheTo: string | undefined): boolean {
+	if (!buildxCacheTo) {
+		return false;
+	}
+	return /type\s*=\s*inline/i.test(buildxCacheTo);
+}
+
 export type ParsedAuthority = DevContainerAuthority;
 
 export type UpdateRemoteUserUIDDefault = 'never' | 'on' | 'off';

src/test/utils.test.ts

@@ -0,0 +1,29 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as assert from 'assert';
+
+import { isBuildxCacheToInline } from '../spec-node/utils';
+
+describe('Utils', function () {
+	describe('isBuildxCacheToInline', function () {
+		it('returns false for undefined or empty', () => {
+			assert.strictEqual(isBuildxCacheToInline(undefined), false);
+			assert.strictEqual(isBuildxCacheToInline(''), false);
+		});
+
+		it('returns true for inline cache type', () => {
+			assert.strictEqual(isBuildxCacheToInline('type=inline'), true);
+			assert.strictEqual(isBuildxCacheToInline('type = inline'), true);
+			assert.strictEqual(isBuildxCacheToInline('type=INLINE'), true);
+			assert.strictEqual(isBuildxCacheToInline('mode=max,type=inline,compression=zstd'), true);
+		});
+
+		it('returns false for non-inline cache type', () => {
+			assert.strictEqual(isBuildxCacheToInline('type=registry'), false);
+			assert.strictEqual(isBuildxCacheToInline('type=local'), false);
+			assert.strictEqual(isBuildxCacheToInline('inline'), false);
+		});
+	});
+});