Pass docker.environment setting contents to docker (fixes #116)

Author: Sander Ronde

client/src/lib/editorConfig.ts

@@ -1,15 +1,20 @@
 // eslint-disable-next-line node/no-extraneous-import
 import type { TypedWorkspaceConfiguration } from 'vscode-generate-package-json/dist/types/src/configuration';
 
+import type {
+	ConfigSettings,
+	ExternalConfigSettings,
+} from '../../../shared/config';
 import type { LanguageClient } from 'vscode-languageclient/node';
-import type { ConfigSettings } from '../../../shared/config';
 import { watcherNotification } from './notificationChannels';
 import { config } from '../../../shared/commands/defs';
 import type { ExtensionContext } from 'vscode';
 import { window, workspace } from 'vscode';
 import { CLIENT_PREFIX, log } from './log';
 
-export function getEditorConfiguration(): TypedWorkspaceConfiguration<ConfigSettings> {
+export function getEditorConfiguration(): TypedWorkspaceConfiguration<
+	ConfigSettings & ExternalConfigSettings
+> {
 	const document = window.activeTextEditor?.document;
 
 	if (document) {

client/src/lib/setup.ts

@@ -2,7 +2,7 @@ import {
 	assertUnreachable,
 	getConfigFile,
 	pathExists,
-	execute,
+	docker,
 	getPathMapper,
 } from '../../../shared/util';
 import type { WatcherNotificationFileData } from '../../../shared/notificationChannels';
@@ -545,36 +545,36 @@ class DockerSetupSteps extends SetupSteps {
 	};
 	private async _dockerPathExists(path: string): Promise<boolean> {
 		return (
-			await execute('docker', [
-				'exec',
-				this._state.dockerContainerName,
-				'sh',
-				'-c',
-				`[ -f ${path} ]`,
-			])
+			await docker(
+				[
+					'exec',
+					this._state.dockerContainerName,
+					'sh',
+					'-c',
+					`[ -f ${path} ]`,
+				],
+				getEditorConfiguration().get('docker.environment')
+			)
 		).success;
 	}
 
 	private async _getDockerCwd(): Promise<string> {
 		return (
-			await execute('docker', [
-				'exec',
-				this._state.dockerContainerName,
-				'pwd',
-			])
+			await docker(
+				['exec', this._state.dockerContainerName, 'pwd'],
+				getEditorConfiguration().get('docker.environment')
+			)
 		).stdout.trim();
 	}
 
 	private async _dockerContainerNameStep(
 		input: MultiStepInput,
 		next: InputStep
 	): Promise<InputStep> {
-		const { stdout, success } = await execute('docker', [
-			'ps',
-			'-a',
-			'--format',
-			'{{json .Names}}',
-		]);
+		const { stdout, success } = await docker(
+			['ps', '-a', '--format', '{{json .Names}}'],
+			getEditorConfiguration().get('docker.environment')
+		);
 		const dockerContainers = success
 			? stdout
 					.trim()
@@ -602,12 +602,10 @@ class DockerSetupSteps extends SetupSteps {
 			typeof choice === 'string' ? choice : choice.label;
 
 		const containerExists = (
-			await execute('docker', [
-				'exec',
-				this._state.dockerContainerName,
-				'echo',
-				'1',
-			])
+			await docker(
+				['exec', this._state.dockerContainerName, 'echo', '1'],
+				getEditorConfiguration().get('docker.environment')
+			)
 		).success;
 
 		if (containerExists) {

server/src/lib/checkConfigManager.ts

@@ -1,5 +1,5 @@
-import { execute, getConfigFile, getPathMapper } from '../../../shared/util';
-import { getEditorConfiguration } from './editorConfig';
+import { getDockerEnvironment, getEditorConfiguration } from './editorConfig';
+import { docker, getConfigFile, getPathMapper } from '../../../shared/util';
 import { showErrorOnce } from './errorUtil';
 import type { ClassConfig } from './types';
 import * as fs from 'fs/promises';
@@ -47,13 +47,16 @@ export class ConfigurationManager {
 			.dockerContainerName;
 		if (dockerContainerName) {
 			const exists = (
-				await execute('docker', [
-					'exec',
-					dockerContainerName,
-					'sh',
-					'-c',
-					`[ -${isDir ? 'd' : 'f'} ${filePath} ]`,
-				])
+				await docker(
+					[
+						'exec',
+						dockerContainerName,
+						'sh',
+						'-c',
+						`[ -${isDir ? 'd' : 'f'} ${filePath} ]`,
+					],
+					await getDockerEnvironment(classConfig)
+				)
 			).success;
 			return exists ? filePath : null;
 		}

server/src/lib/editorConfig.ts

@@ -1,5 +1,8 @@
+import type {
+	ConfigSettingsWithoutPrefix,
+	DockerConfigSettings,
+} from '../../../shared/config';
 import { replaceHomeDir, replaceVariables } from '../../../shared/variables';
-import type { ConfigSettingsWithoutPrefix } from '../../../shared/config';
 import { fromEntries } from '../../../shared/util';
 import type { ClassConfig } from './types';
 
@@ -62,3 +65,17 @@ export async function getEditorConfiguration(
 			false,
 	};
 }
+
+export async function getDockerEnvironment(
+	classConfig: Pick<ClassConfig, 'connection' | 'workspaceFolders'>
+): Promise<Record<string, string> | null> {
+	const workspaceFolders = await classConfig.workspaceFolders.get();
+	const scope = workspaceFolders?.default.toString();
+	const editorConfig = {
+		...((await classConfig.connection.workspace.getConfiguration({
+			scopeUri: scope,
+			section: 'docker',
+		})) as DockerConfigSettings),
+	};
+	return editorConfig['docker.environment'];
+}

server/src/lib/process.ts

@@ -2,10 +2,10 @@ import type {
 	ChildProcess,
 	SpawnSyncOptionsWithStringEncoding,
 } from 'child_process';
+import { getDockerEnvironment, getEditorConfiguration } from './editorConfig';
 import { processNotification } from './notificationChannels';
 import type { AsyncDisposable, ClassConfig } from './types';
-import { getEditorConfiguration } from './editorConfig';
-import { execute, wait } from '../../../shared/util';
+import { docker, wait } from '../../../shared/util';
 import { debug, sanitizeFilePath } from './debug';
 import { exec, spawn } from 'child_process';
 import { default as psTree } from 'ps-tree';
@@ -85,15 +85,19 @@ export class Process implements AsyncDisposable {
 
 	private static async _getDockerChildPids(
 		containerName: string,
-		pid: number
+		pid: number,
+		classConfig: ClassConfig
 	): Promise<number[]> {
-		const result = await execute('docker', [
-			'exec',
-			containerName,
-			'sh',
-			'-c',
-			"ls /proc | grep -E '^[0-9]+$' | xargs -I{} cat /proc/{}/stat",
-		]);
+		const result = await docker(
+			[
+				'exec',
+				containerName,
+				'sh',
+				'-c',
+				"ls /proc | grep -E '^[0-9]+$' | xargs -I{} cat /proc/{}/stat",
+			],
+			await getDockerEnvironment(classConfig)
+		);
 		if (!result.stdout) {
 			return [];
 		}
@@ -267,16 +271,17 @@ export class Process implements AsyncDisposable {
 			.dockerContainerName;
 		const pids = [
 			pid,
-			...(await Process._getDockerChildPids(containerName, pid)),
-		];
-		return pids.map((pid) =>
-			execute('docker', [
-				'exec',
+			...(await Process._getDockerChildPids(
 				containerName,
-				'kill',
-				'-9',
-				pid.toString(),
-			]).then(() => undefined)
+				pid,
+				this._classConfig
+			)),
+		];
+		return pids.map(async (pid) =>
+			docker(
+				['exec', containerName, 'kill', '-9', pid.toString()],
+				await getDockerEnvironment(this._classConfig)
+			).then(() => undefined)
 		);
 	}
 

shared/config.ts

@@ -16,3 +16,9 @@ export type ConfigSettings = Omit<
 	/** @deprecated */
 	'phpstan.enableLanguageServer'?: boolean;
 };
+
+export type DockerConfigSettings = {
+	'docker.environment': Record<string, string>;
+};
+
+export type ExternalConfigSettings = DockerConfigSettings;

shared/util.ts

@@ -175,9 +175,9 @@ function getAbsolutePath(filePath: string | null, cwd?: string): string | null {
 	return path.join(cwd, filePath);
 }
 
-export async function execute(
-	binary: string,
+export async function docker(
 	args: ReadonlyArray<string>,
+	dockerEnv: Record<string, string> | null,
 	options: Omit<
 		SpawnOptionsWithStdioTuple<StdioNull, StdioPipe, StdioPipe>,
 		'stdio'
@@ -189,8 +189,12 @@ export async function execute(
 	stderr: string;
 	err: Error | null;
 }> {
-	const proc = spawn(binary, args, {
+	const proc = spawn('docker', args, {
 		...options,
+		env: {
+			...process.env,
+			...dockerEnv,
+		},
 		stdio: ['ignore', 'pipe', 'pipe'],
 	});
 	let stdout = '';