Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: support forwardPorts config #859

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: support forwardPorts config #859

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bd25ad7
adding 'static' port forwarding support
MunsMan Mar 1, 2023
99afaec
rename file to `ports.ts`
agilgur5 Jul 16, 2024
04fd200
simplify and fix naming and style
agilgur5 Jul 16, 2024
63f6f36
remove second trailing newline
agilgur5 Jul 16, 2024
5356a4d
more style fixes and naming
agilgur5 Jul 16, 2024
a8b9491
more cleanly separate out getting ports from converting them into flags
agilgur5 Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions src/spec-node/ports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { DevContainerFromDockerfileConfig, DevContainerFromImageConfig } from '../spec-configuration/configuration';

function normalizePorts(ports: number | string | (number | string)[] | undefined): string[] {
ports = ports ?? [];
ports = typeof ports === 'number' || typeof ports === 'string' ? [ports] : ports;
return ports.map((port) => typeof port === 'number' ? `127.0.0.1:${port}:${port}`: port);
}

export function getStaticPorts(config: DevContainerFromDockerfileConfig | DevContainerFromImageConfig): string[] {
return normalizePorts(config.forwardPorts).concat(normalizePorts(config.appPort));
}
8 changes: 4 additions & 4 deletions src/spec-node/singleContainer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import { LogLevel, Log, makeLog } from '../spec-utils/log';
import { extendImage, getExtendImageBuildInfo, updateRemoteUserUID } from './containerFeatures';
import { getDevcontainerMetadata, getImageBuildInfoFromDockerfile, getImageMetadataFromContainer, ImageMetadataEntry, lifecycleCommandOriginMapFromMetadata, mergeConfiguration, MergedDevContainerConfig } from './imageMetadata';
import { ensureDockerfileHasFinalStageName, generateMountCommand } from './dockerfileUtils';
import { getStaticPorts } from './ports';

export const hostFolderLabel = 'devcontainer.local_folder'; // used to label containers created from a workspace/folder
export const configFileLabel = 'devcontainer.config_file';
Expand Down Expand Up @@ -196,7 +197,7 @@ async function buildAndExtendImage(buildParams: DockerResolverParameters, config
if (buildParams.buildxPush) {
args.push('--push');
} else {
if (buildParams.buildxOutput) {
if (buildParams.buildxOutput) {
args.push('--output', buildParams.buildxOutput);
} else {
args.push('--load'); // (short for --output=docker, i.e. load into normal 'docker images' collection)
Expand Down Expand Up @@ -348,9 +349,8 @@ export async function spawnDevContainer(params: DockerResolverParameters, config
const { common } = params;
common.progress(ResolverProgress.StartingContainer);

const appPort = config.appPort;
const exposedPorts = typeof appPort === 'number' || typeof appPort === 'string' ? [appPort] : appPort || [];
const exposed = (<string[]>[]).concat(...exposedPorts.map(port => ['-p', typeof port === 'number' ? `127.0.0.1:${port}:${port}` : port]));
const exposedPorts = getStaticPorts(config);
const exposed = exposedPorts.flatMap((port) => ['-p', port]);

const cwdMount = workspaceMount ? ['--mount', workspaceMount] : [];

Expand Down