Skip to content

buildx(build): percent-encode git context query values #1401

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

Open
sinoru wants to merge 1 commit into
base: main
Choose a base branch
from
Open

buildx(build): percent-encode git context query values #1401

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions __tests__/buildx/build.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,11 @@ describe('gitContext', () => {
[{ref: 'refs/heads/master', checksum: undefined, format: 'query', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true, attrs: {'fetch-by-commit': 'true'}}, 'https://github.com/docker/actions-toolkit.git?ref=refs/heads/master&checksum=860c1904a1ce19322e91ac35af1ab07466440c37&fetch-by-commit=true'],
[{ref: 'refs/pull/15/merge', checksum: undefined, format: 'query', prHeadRef: true, sendGitQueryAsInput: false, buildxQuerySupport: true, attrs: {'fetch-by-commit': 'true'}}, 'https://github.com/docker/actions-toolkit.git?ref=refs/pull/15/head&checksum=f11797113e5a9b86bd976329c5dbb8a8bfdfadfa&fetch-by-commit=true'],
[{ref: 'refs/heads/master', checksum: undefined, format: 'query', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true, attrs: {'fetch-by-commit': 'false'}}, 'https://github.com/docker/actions-toolkit.git?ref=860c1904a1ce19322e91ac35af1ab07466440c37&fetch-by-commit=false'],
// query values must be percent-encoded: BuildKit decodes "+" (SemVer build metadata separator) as a space (https://github.com/docker/github-builder/issues/330)
[{ref: 'refs/tags/v1.0.0-beta+exp.sha.5114f85', checksum: undefined, format: 'query', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true, attrs: {checksum: 'cafebabe'}}, 'https://github.com/docker/actions-toolkit.git?ref=refs/tags/v1.0.0-beta%2Bexp.sha.5114f85&checksum=cafebabe'],
[{ref: 'refs/tags/v1.0.0-beta+exp.sha.5114f85', checksum: undefined, format: 'query', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true, attrs: {'fetch-by-commit': 'true'}}, 'https://github.com/docker/actions-toolkit.git?ref=refs/tags/v1.0.0-beta%2Bexp.sha.5114f85&checksum=860c1904a1ce19322e91ac35af1ab07466440c37&fetch-by-commit=true'],
[{ref: 'refs/heads/feature/a&b=c#d%e', checksum: undefined, format: 'query', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true, attrs: {checksum: 'cafebabe'}}, 'https://github.com/docker/actions-toolkit.git?ref=refs/heads/feature/a%26b%3Dc%23d%25e&checksum=cafebabe'],
[{ref: 'refs/heads/master', checksum: undefined, format: 'query', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true, subdir: 'sub dir/with+plus'}, 'https://github.com/docker/actions-toolkit.git?ref=860c1904a1ce19322e91ac35af1ab07466440c37&subdir=sub%20dir/with%2Bplus'],
// fragment format
[{ref: 'refs/heads/master', format: 'fragment', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true}, 'https://github.com/docker/actions-toolkit.git#860c1904a1ce19322e91ac35af1ab07466440c37'],
[{ref: 'master', format: 'fragment', prHeadRef: false, sendGitQueryAsInput: false, buildxQuerySupport: true}, 'https://github.com/docker/actions-toolkit.git#860c1904a1ce19322e91ac35af1ab07466440c37'],
Expand Down
16 changes: 12 additions & 4 deletions src/buildx/build.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,23 +102,31 @@ export class Build {
// Only use fetch-by-commit when the caller opts in; older BuildKit
// versions do not know this query key. Without it, use the pinned commit
// as the ref to keep existing compatibility.
const query = [`ref=${fetchByCommit || explicitChecksum ? ref : pinnedRef}`];
const query = [`ref=${Build.encodeGitQueryValue(fetchByCommit || explicitChecksum ? ref : pinnedRef)}`];
const queryChecksum = fetchByCommit ? pinnedRef : explicitChecksum;
if (queryChecksum) {
query.push(`checksum=${queryChecksum}`);
query.push(`checksum=${Build.encodeGitQueryValue(queryChecksum)}`);
}
if (subdir && subdir !== '.') {
query.push(`subdir=${subdir}`);
query.push(`subdir=${Build.encodeGitQueryValue(subdir)}`);
}
for (const [name, value] of extraAttrs) {
query.push(`${name}=${value}`);
query.push(`${Build.encodeGitQueryValue(name)}=${Build.encodeGitQueryValue(value)}`);
}
return `${baseURL}?${query.join('&')}`;
}

return `${baseURL}#${pinnedRef}${subdir && subdir !== '.' ? `:${subdir}` : ''}`;
}

// BuildKit parses the git context query with Go's url.Query(), which
// decodes "+" as a space and treats "&", "=", "#", "%" and ";" as
// delimiters. Percent-encode each value but keep "/" readable since it has
// no special meaning in a query component (e.g. refs/tags/v1.0.0+build).
private static encodeGitQueryValue(value: string): string {
return value.split('/').map(encodeURIComponent).join('/');
}

public getImageIDFilePath(): string {
return path.join(Context.tmpDir(), this.iidFilename);
}
Expand Down