Custom Scriptlets names should allow uppercase characters and not be restricted to lowercase only.

[ghost]

Platforms

all

Description

While not a big issue, having all Scriptlet names being all lower case, is just not the best thing in some cases.

For example, sometimes you might create a name based on a function, and you used thisFunction in the code, so for the brain to want to see it as user-thisfuncion.js is just weird.
Or for example, if you add the Return Dislike Button userscript as scriptlet, you might want to use it as user-ReturnDislikeButton.js just as you are used to see it on the extension and the internet, or YouTube or YT rather than yt just for easily spot the Scriptlets in the list.

It is more of a QOL implementation, since having eveything lowercase is just not the same as being able to read scriptlets name with some uppercase on them. The only way to kind of do this by now is adding dashes (-) to the name, but that means a longer name thaty could be easily fixed by not restricting scriptlets names to be only lowercase.

[Antrikshgwal]

Hey!! @ShivanKaul
Can you describe how I can replicate this issue? I'm having trouble finding how to create a custom scriplet in Brave. Thanks!

[TEMP-ad]

You can just look at the commits in brave-core and see how it works, no reason for anyone from Brave team to explain it, especially when it is disabled by default.

Anyway, you just install Nightly on Desktop, enable brave://flags/#brave-adblock-custom-scriptlets and you get the toggle in brave://adblock

[ShivanKaul]

@boocmp do you remember why we decided to restrict the script name to be lowercase? I can't think of a security reason for doing so.

[ShivanKaul]

@Antrikshgwal we'll be enabling Custom Scriptlets by default on Brave Nightly soon: brave/brave-core#27334

The feature itself is available (default off right now) in Brave Nightly and Brave Beta. You can enable it manually like @TEMP-ad said:

Anyway, you just install Nightly on Desktop, enable brave://flags/#brave-adblock-custom-scriptlets and you get the toggle in brave://adblock

If you have any trouble, let me know.

[boocmp]

Because it is the requirement of the scriptlets themself. Our engine makes them lowercase internally (and adds .js extension if missed), I've just repeated it in UI. We can remove the lowercase restriction in the UI, but you still won't be able to create scriptlets with the same name in different char cases (I mean 'theFunction' and 'thefunction' are the same for adblock engine).

[TEMP-ad]

Well, if we talk about how internally things work, then Brave actually reads Scriptlets that have different cases and treat them as different Scriptlets, so theFunction and thefunction are two different scriptlets by the adblocker.

Regardless how things get added to resources.json, if we manually add scriptlets, you can test this pretty easy:

Something like:

  {
    "name": "Brave-fix.js",
    "aliases": [],
    "kind": { "mime": "application/javascript" },
    "content": "Y29uc29sZS5sb2coInRlc3QxIik="
  },
  {
    "name": "Brave-Fix.js",
    "aliases": [],
    "kind": { "mime": "application/javascript" },
    "content": "Y29uc29sZS5sb2coInRlc3QwIik="
  }

They will be used as different scriptlets, and you can use them as

example.com##+js(Brave-Fix)
example.com##+js(brave-fix)
example.com##+js(Brave-fix)

So two console.log and then the other one being the default one and deleting the Brave navigator info gets applied to the page.

Now, if the scriptlets are changed to have the same name, in my tests, it the Adblocker will just read the ones at the top, so if whatever is first, will be read and then the others ignored. so something like this will give the test0 in console, and if you move the default one to the top, it will be used instead.

  {
    "name": "brave-fix.js",
    "aliases": [],
    "kind": { "mime": "application/javascript" },
    "content": "Y29uc29sZS5sb2coInRlc3QwIik="
  },
  {
    "name": "brave-fix.js",
    "aliases": [],
    "kind": { "mime": "application/javascript" },
    "content": "Y29uc29sZS5sb2coInRlc3QxIik="
  },
  {
    "name": "brave-fix.js",
    "aliases": [],
    "kind": { "mime": "application/javascript" },
    "content": "Ly8vIGJyYXZlLWZpeC5qcwovLy8gYWxpYXMgYmYuanMKZGVsZXRlIE5hdmlnYXRvci5wcm90b3R5cGUuYnJhdmUKZGVsZXRlIHdpbmRvdy5uYXZpZ2F0b3IuYnJhdmUK"
  },

So I am not saying adding user- and making it lowercase and having unique Scriptlet names in the Developer Mode is wrong, I am just saying how the Adblocker behaves comparing resources.json file to the custom scriptlets in developer mode.

And in the end, if possible, at least it would be nice to have the lowercase name rescrition removed, because it is easier to read for the brain something that is not completely lowercase, examples of scriptlets I made: user-YTContinueWatching-Removal.js vs user-ytcontinuewatching-removal.js, but also some names like ReturnYouTubeDislike.js vs returnyoutubedislike.js make more sense, since it has an extension and all.

I know, technically the name doesn't matter, and dashes is what scriptlets usually use to make the spaces and make them easy to read, but having too many scriptlets in the list and scrolldown with all lowercase is just awkward to look at, especially when we can't just re-order the scriptlets to have them grouped properly if needed.
And since it's our user created scriptlets I hope we can just use whatever case we want for the names, because pretty names make things nicer to look at 100%, for the rules and the custom scriptlets list.

[boocmp]

@TEMP-ad.
I'm sorry, I think I missed something or misunderstood when I looked at the script name processing code. Now I can't find the code that confused me. You're right, they're case-sensitive, I will fix it.