Skip to content

Decode remote config files as UTF-8 #4323

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
theinfosecguy wants to merge 1 commit into
base: main
Choose a base branch
from
+64 −2
Open

Decode remote config files as UTF-8 #4323

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
2 changes: 1 addition & 1 deletion lib/entry-points.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

61 changes: 61 additions & 0 deletions src/config/file.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,67 @@ test("getConfigFileInput ignores repository property value when FF is off", asyn
.passes(t.is, undefined);
});

for (const { name, contents } of [
...["Security", "Sécurité", "日本語", "🛡️"].map((configName) => ({
name: configName,
contents: `name: ${configName}
paths:
- "src/${configName}"
paths-ignore:
- "generated/${configName}"
`,
})),
{
name: "Café",
contents: `name: "Caf\\u00e9"
paths:
- "src/Caf\\u00e9"
paths-ignore:
- "generated/Caf\\u00e9"
`,
},
]) {
test.serial(
`getRemoteConfig preserves UTF-8 configuration: ${name}`,
async (t) => {
const configFile = "octo-org/codeql-config/config.yml@main";
const config = {
name,
paths: [`src/${name}`],
"paths-ignore": [`generated/${name}`],
};
const client = github.getOctokit("123");
const response = {
data: {
content: Buffer.from(contents, "utf8").toString("base64"),
encoding: "base64",
},
};
const getContent = sinon
.stub(client.rest.repos, "getContent")
// eslint-disable-next-line @typescript-eslint/no-unsafe-argument
.resolves(response as any);
sinon.stub(api, "getApiClientWithExternalAuth").returns(client);

for (const features of [[], [Feature.ValidateDbConfig]]) {
await callee(getRemoteConfig)
.withFeatures(features)
.withArgs(configFile, SAMPLE_DOTCOM_API_DETAILS)
.passes(t.deepEqual, config);
}

t.assert(
getContent.alwaysCalledWithExactly({
owner: "octo-org",
repo: "codeql-config",
path: "config.yml",
ref: "main",
}),
);
},
);
}

test.serial("getRemoteConfig uses proxy when it is supposed to", async (t) => {
const client = github.getOctokit("123");
const response = {
Expand Down
2 changes: 1 addition & 1 deletion src/config/file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ export async function getRemoteConfig(
return parseUserConfig(
actionState.logger,
configFile,
Buffer.from(fileContents, "base64").toString("binary"),
Buffer.from(fileContents, "base64").toString("utf8"),
validateConfig,
);
}
1 change: 1 addition & 0 deletions unreleased-change-notes/fix-remote-config-utf8.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Fixed remote configuration files corrupting Unicode names and paths or failing to parse when they contain non-ASCII characters.