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

UI: Add workaround to exclude emoji from task escaping #7813

Merged
merged 1 commit into from
Feb 9, 2021
Merged

UI: Add workaround to exclude emoji from task escaping #7813

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 ui/app/utils/escape-task-name.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export default function escapeTaskName(taskName) {
// Regular expression is taken from here: https://stackoverflow.com/a/20053121
return taskName.replace(/[^a-zA-Z0-9,._+@%/-]/g, '\\$&');
return taskName.replace(/[^a-zA-Z0-9,._+@%/-]/gu, '\\$&');
}
1 change: 1 addition & 0 deletions ui/tests/unit/utils/escape-task-name-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ module('Unit | Utility | escape-task-name', function() {
assert.equal(escapeTaskName('plain'), 'plain');
assert.equal(escapeTaskName('a space'), 'a\\ space');
assert.equal(escapeTaskName('dollar $ign'), 'dollar\\ \\$ign');
assert.equal(escapeTaskName('emoji🥳'), 'emoji\\🥳');
Copy link
Contributor

Choose a reason for hiding this comment

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

Should emoji be escaped? Maybe it's harmless?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

They don’t need to be but I can’t think of a way to exclude them from escaping while still escaping things that should be, at least without something like emoji-regex. I do believe it’s harmless to escape them: slightly unsightly, but emoji in task names are surely rare 🤔

The current approach to escaping a task name is “escape everything but these known-to-be-safe characters”. My previous implementation used emoji-regex to let emoji be treated as known-to-be-safe but it seems maybe overkill when escaping them this way doesn’t add much noise. The Stack Overflow answer that I linked to for the original regular expression has a more naïve suggestion to instead escape every character but that seems hideous to me 😆

Copy link
Contributor

Choose a reason for hiding this comment

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

Haha, I agree with you that escaping everything is a nope. Since this is safe I'm happy with it 😄

});
});