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

tech story: [M3-8423] - Resolve "Incomplete string escape or encoding" in generate-ansibleConfig.test.ts #10887

Merged
merged 4 commits into from
Sep 10, 2024
Merged

tech story: [M3-8423] - Resolve "Incomplete string escape or encoding" in generate-ansibleConfig.test.ts #10887

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
72eccf5
update regex to sanitize against backslashes
coliu-akamai Sep 4, 2024
839825b
add test case for sanitization
coliu-akamai Sep 4, 2024
ac2ca1b
update test case description to be more accurate
coliu-akamai Sep 4, 2024
6227284
changeset
coliu-akamai Sep 4, 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
5 changes: 5 additions & 0 deletions packages/manager/.changeset/pr-10887-tech-stories-1725467686328.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@linode/manager": Tech Stories
---

Resolve "Incomplete string escape or encoding" codeQL alert in `generate-ansibleConfig.ts` ([#10887](https://github.com/linode/manager/pull/10887))
13 changes: 13 additions & 0 deletions packages/manager/src/utilities/codesnippets/generate-ansibleConfig.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,17 @@ describe('generateAnsibleConfig', () => {

expect(generateAnsibleConfig(config)).toEqual(expectedOutput);
});

it('should safely escape extra backslash characters in YAML strings', () => {
const config = {
label: 'Linode with ] and also \\[, }, and \\{',
Copy link
Contributor Author

@coliu-akamai coliu-akamai Sep 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: Originally I'd had \] and \} in this label, but eslint corrected them to just ] and { 🥲... They still resulted in \\] and \\}, same as the current expected output (which is good/what we'd want, I think!).

region: 'us-central',
root_pass: 'securePass123',
type: 'g6-standard-1',
};

const expectedOutput = `- name: Create a new Linode instance.\n linode.cloud.instance:\n state: "present"\n label: "Linode with \\] and also \\\\\\[, \\}, and \\\\\\{"\n type: "g6-standard-1"\n region: "us-central"\n root_pass: "securePass123"\n`;

expect(generateAnsibleConfig(config)).toEqual(expectedOutput);
});
});
2 changes: 1 addition & 1 deletion packages/manager/src/utilities/codesnippets/generate-ansibleConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { CreateLinodeRequest } from '@linode/api-v4/lib/linodes';
* @returns {string} - The safely escaped string.
*/
function escapeYAMLString(str: string) {
return str.replace(/(["':\[\]\{\}])/g, '\\$1').replace(/\n/g, '\\n');
return str.replace(/(["':\\\[\\\]\\\{\\\}])/g, '\\$1').replace(/\n/g, '\\n');
}

/**
Expand Down
Loading