Merge pull request #442 from brave/bump-base64

Bump base64

Author: antonok-edm

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "adblock"
-version = "0.9.5"
+version = "0.9.6"
 authors = ["Anton Lazarev <[email protected]>", "Andrius Aucinas"]
 edition = "2021"
 
@@ -34,7 +34,7 @@ idna = "1.0.3"
 serde =  { version = "1.0", features = ["derive", "rc"] }
 seahash = "3"   # seahash 4 introduces a breaking hash algorithm change
 memchr = "2.4"
-base64 = "0.13"
+base64 = "0.22"
 rmp-serde = "0.15"
 cssparser = { version = "0.29", optional = true }
 selectors = { version = "0.24", optional = true }

Cargo.toml

@@ -122,6 +122,7 @@ fn build_resources_for_filters(#[allow(unused)] filters: &[NetworkFilter]) -> Re
     #[cfg(not(feature = "resource-assembler"))]
     {
         use adblock::resources::{MimeType, Resource, ResourceType};
+        use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
 
         filters
             .iter()
@@ -137,7 +138,7 @@ fn build_resources_for_filters(#[allow(unused)] filters: &[NetworkFilter]) -> Re
                     name: redirect.to_owned(),
                     aliases: vec![],
                     kind: ResourceType::Mime(MimeType::from_extension(&redirect)),
-                    content: base64::encode(redirect),
+                    content: BASE64_STANDARD.encode(redirect),
                     dependencies: vec![],
                     permission: Default::default(),
                 }

benches/bench_redirect_performance.rs

@@ -156,11 +156,12 @@ impl Resource {
     /// dependencies. Content will be automatically base64-encoded by the constructor.
     #[cfg(test)]
     pub fn simple(name: &str, kind: MimeType, content: &str) -> Self {
+        use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
         Self {
             name: name.to_string(),
             aliases: vec![],
             kind: ResourceType::Mime(kind),
-            content: base64::encode(content),
+            content: BASE64_STANDARD.encode(content),
             dependencies: vec![],
             permission: Default::default(),
         }

src/resources/mod.rs

@@ -2,6 +2,7 @@
 //! files in the uBlock Origin repository.
 
 use crate::resources::{MimeType, Resource, ResourceType};
+use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
 use memchr::memmem;
 use once_cell::sync::Lazy;
 use regex::Regex;
@@ -191,7 +192,7 @@ fn read_template_resources(scriptlets_data: &str) -> Vec<Resource> {
                 .map(|aliases| aliases.iter().map(|alias| alias.to_string()).collect())
                 .unwrap_or_default(),
             kind,
-            content: base64::encode(&script),
+            content: BASE64_STANDARD.encode(&script),
             dependencies: vec![],
             permission: Default::default(),
         });
@@ -220,9 +221,9 @@ fn build_resource_from_file_contents(
     let content = match mimetype {
         MimeType::ApplicationJavascript | MimeType::TextHtml | MimeType::TextPlain => {
             let utf8string = std::str::from_utf8(resource_contents).unwrap();
-            base64::encode(&utf8string.replace('\r', ""))
+            BASE64_STANDARD.encode(&utf8string.replace('\r', ""))
         }
-        _ => base64::encode(&resource_contents),
+        _ => BASE64_STANDARD.encode(&resource_contents),
     };
 
     Resource {

src/resources/resource_assembler.rs

@@ -2,6 +2,7 @@
 
 use std::collections::HashMap;
 
+use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
 use once_cell::sync::Lazy;
 use regex::Regex;
 use thiserror::Error;
@@ -134,7 +135,7 @@ impl ResourceStorage {
             }
 
             // Ensure the resource contents are valid base64 (and utf8 if applicable)
-            let decoded = base64::decode(&resource.content)?;
+            let decoded = BASE64_STANDARD.decode(&resource.content)?;
             if content_type.is_textual() {
                 let _ = String::from_utf8(decoded)?;
             }
@@ -174,7 +175,7 @@ impl ResourceStorage {
         let mut result = String::new();
 
         for dep in deps.iter() {
-            if let Ok(decoded) = base64::decode(&dep.content) {
+            if let Ok(decoded) = BASE64_STANDARD.decode(&dep.content) {
                 if let Ok(dep) = core::str::from_utf8(&decoded) {
                     result += dep;
                     result += "\n";
@@ -245,7 +246,7 @@ impl ResourceStorage {
             self.recursive_dependencies(dep, required_deps, filter_permission)?;
         }
 
-        let template = String::from_utf8(base64::decode(&resource.content)?)?;
+        let template = String::from_utf8(BASE64_STANDARD.decode(&resource.content)?)?;
 
         if let Some(function_name) = extract_function_name(&template) {
             // newer function-style resource: pass args using function call syntax

src/resources/resource_storage.rs

@@ -4,6 +4,7 @@ use adblock::request::Request;
 use adblock::resources::{MimeType, Resource, ResourceType};
 use adblock::Engine;
 
+use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
 use serde::{Deserialize, Serialize};
 
 use adblock::lists::ParseOptions;
@@ -43,7 +44,7 @@ fn build_resources_from_filters(filters: &[String]) -> Vec<Resource> {
                 name: redirect.to_owned(),
                 aliases: vec![],
                 kind: ResourceType::Mime(MimeType::from_extension(&redirect)),
-                content: base64::encode(redirect),
+                content: BASE64_STANDARD.encode(redirect),
                 dependencies: vec![],
                 permission: Default::default(),
             }

tests/matching.rs

@@ -344,6 +344,7 @@ mod blocker_tests {
     use crate::lists::parse_filters;
     use crate::request::Request;
     use crate::resources::Resource;
+    use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
     use std::collections::HashSet;
     use std::iter::FromIterator;
 
@@ -1340,7 +1341,7 @@ mod blocker_tests {
                 .unwrap();
             Some(format!(
                 "data:text/plain;base64,{}",
-                base64::encode(identifier)
+                BASE64_STANDARD.encode(identifier)
             ))
         }
         let a_redirect = add_simple_resource(&mut resources, "a");

tests/unit/blocker.rs

@@ -80,6 +80,7 @@ mod key_from_selector_tests {
 mod cosmetic_cache_tests {
     use super::super::*;
     use crate::resources::Resource;
+    use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
 
     fn cache_from_rules(rules: Vec<&str>) -> CosmeticFilterCache {
         let parsed_rules = rules
@@ -207,7 +208,7 @@ mod cosmetic_cache_tests {
                 name: "set-constant.js".into(),
                 aliases: vec![],
                 kind: ResourceType::Template,
-                content: base64::encode("set-constant.js, {{1}}, {{2}}"),
+                content: BASE64_STANDARD.encode("set-constant.js, {{1}}, {{2}}"),
                 dependencies: vec![],
                 permission: Default::default(),
             },
@@ -668,7 +669,7 @@ mod cosmetic_cache_tests {
             name: "abort-on-property-read.js".into(),
             aliases: vec!["aopr".to_string()],
             kind: ResourceType::Template,
-            content: base64::encode("abort-on-property-read.js, {{1}}"),
+            content: BASE64_STANDARD.encode("abort-on-property-read.js, {{1}}"),
             dependencies: vec![],
             permission: Default::default(),
         }]);

tests/unit/cosmetic_filter_cache.rs

@@ -3,6 +3,7 @@ mod tests {
     use super::super::*;
     use crate::lists::FilterFormat;
     use crate::resources::MimeType;
+    use base64::{engine::Engine as _, prelude::BASE64_STANDARD};
 
     #[test]
     fn tags_enable_adds_tags() {
@@ -291,7 +292,7 @@ mod tests {
             matched_rule.redirect,
             Some(format!(
                 "data:application/javascript;base64,{}",
-                base64::encode(format!("{}", script))
+                BASE64_STANDARD.encode(format!("{}", script))
             )),
             "Expected redirect to contain resource"
         );
@@ -724,15 +725,15 @@ mod tests {
                 name: "trusted-set-cookie.js".to_string(),
                 aliases: vec![],
                 kind: ResourceType::Mime(MimeType::ApplicationJavascript),
-                content: base64::encode("trusted-set-cookie"),
+                content: BASE64_STANDARD.encode("trusted-set-cookie"),
                 dependencies: vec![],
                 permission: UBO_PERM,
             },
             Resource {
                 name: "brave-fix.js".to_string(),
                 aliases: vec![],
                 kind: ResourceType::Mime(MimeType::ApplicationJavascript),
-                content: base64::encode("brave-fix"),
+                content: BASE64_STANDARD.encode("brave-fix"),
                 dependencies: vec![],
                 permission: BRAVE_PERM,
             },
@@ -844,7 +845,7 @@ mod tests {
                 name: "trusted-set-local-storage-item.js".into(),
                 aliases: vec![],
                 kind: ResourceType::Mime(MimeType::ApplicationJavascript),
-                content: base64::encode("function trustedSetLocalStorageItem(key = '', value = '') { setLocalStorageItemFn('local', true, key, value); }"),
+                content: BASE64_STANDARD.encode("function trustedSetLocalStorageItem(key = '', value = '') { setLocalStorageItemFn('local', true, key, value); }"),
                 dependencies: vec![],
                 permission: Default::default(),
             },

tests/unit/engine.rs

@@ -99,7 +99,9 @@ mod tests {
         .replace('\r', "");
         assert_eq!(
             std::str::from_utf8(
-                &base64::decode(&reserialized[34].content).expect("decode base64 content")
+                &BASE64_STANDARD
+                    .decode(&reserialized[34].content)
+                    .expect("decode base64 content")
             )
             .expect("convert to utf8 string"),
             noopjs_contents,
@@ -191,7 +193,7 @@ mod tests {
         );
         assert_eq!(
             std::str::from_utf8(
-                &base64::decode(&reserialized[20].content).expect("decode base64 content")
+                &BASE64_STANDARD.decode(&reserialized[20].content).expect("decode base64 content")
             ).expect("convert to utf8 string"),
             "(function() {\nif ( window !== window.top ) {\nreturn;\n}\nvar tstart;\nvar ttl = 30000;\nvar delay = 0;\nvar delayStep = 50;\nvar buster = function() {\nvar docEl = document.documentElement,\nbodyEl = document.body,\nvw = Math.min(docEl.clientWidth, window.innerWidth),\nvh = Math.min(docEl.clientHeight, window.innerHeight),\ntol = Math.min(vw, vh) * 0.05,\nel = document.elementFromPoint(vw/2, vh/2),\nstyle, rect;\nfor (;;) {\nif ( el === null || el.parentNode === null || el === bodyEl ) {\nbreak;\n}\nstyle = window.getComputedStyle(el);\nif ( parseInt(style.zIndex, 10) >= 1000 || style.position === 'fixed' ) {\nrect = el.getBoundingClientRect();\nif ( rect.left <= tol && rect.top <= tol && (vw - rect.right) <= tol && (vh - rect.bottom) < tol ) {\nel.parentNode.removeChild(el);\ntstart = Date.now();\nel = document.elementFromPoint(vw/2, vh/2);\nbodyEl.style.setProperty('overflow', 'auto', 'important');\ndocEl.style.setProperty('overflow', 'auto', 'important');\ncontinue;\n}\n}\nel = el.parentNode;\n}\nif ( (Date.now() - tstart) < ttl ) {\ndelay = Math.min(delay + delayStep, 1000);\nsetTimeout(buster, delay);\n}\n};\nvar domReady = function(ev) {\nif ( ev ) {\ndocument.removeEventListener(ev.type, domReady);\n}\ntstart = Date.now();\nsetTimeout(buster, delay);\n};\nif ( document.readyState === 'loading' ) {\ndocument.addEventListener('DOMContentLoaded', domReady);\n} else {\ndomReady();\n}\n})();\n",
         );
@@ -201,7 +203,7 @@ mod tests {
         assert_eq!(reserialized[6].kind, ResourceType::Template);
         assert_eq!(
             std::str::from_utf8(
-                &base64::decode(&reserialized[6].content).expect("decode base64 content")
+                &BASE64_STANDARD.decode(&reserialized[6].content).expect("decode base64 content")
             ).expect("convert to utf8 string"),
             "(function() {\nconst rawPrunePaths = '{{1}}';\nconst rawNeedlePaths = '{{2}}';\nconst prunePaths = rawPrunePaths !== '{{1}}' && rawPrunePaths !== ''\n? rawPrunePaths.split(/ +/)\n: [];\nlet needlePaths;\nlet log, reLogNeedle;\nif ( prunePaths.length !== 0 ) {\nneedlePaths = prunePaths.length !== 0 &&\nrawNeedlePaths !== '{{2}}' && rawNeedlePaths !== ''\n? rawNeedlePaths.split(/ +/)\n: [];\n} else {\nlog = console.log.bind(console);\nlet needle;\nif ( rawNeedlePaths === '' || rawNeedlePaths === '{{2}}' ) {\nneedle = '.?';\n} else if ( rawNeedlePaths.charAt(0) === '/' && rawNeedlePaths.slice(-1) === '/' ) {\nneedle = rawNeedlePaths.slice(1, -1);\n} else {\nneedle = rawNeedlePaths.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\$&');\n}\nreLogNeedle = new RegExp(needle);\n}\nconst findOwner = function(root, path, prune = false) {\nlet owner = root;\nlet chain = path;\nfor (;;) {\nif ( typeof owner !== 'object' || owner === null  ) {\nreturn false;\n}\nconst pos = chain.indexOf('.');\nif ( pos === -1 ) {\nif ( prune === false ) {\nreturn owner.hasOwnProperty(chain);\n}\nif ( chain === '*' ) {\nfor ( const key in owner ) {\nif ( owner.hasOwnProperty(key) === false ) { continue; }\ndelete owner[key];\n}\n} else if ( owner.hasOwnProperty(chain) ) {\ndelete owner[chain];\n}\nreturn true;\n}\nconst prop = chain.slice(0, pos);\nif (\nprop === '[]' && Array.isArray(owner) ||\nprop === '*' && owner instanceof Object\n) {\nconst next = chain.slice(pos + 1);\nlet found = false;\nfor ( const key of Object.keys(owner) ) {\nfound = findOwner(owner[key], next, prune) || found;\n}\nreturn found;\n}\nif ( owner.hasOwnProperty(prop) === false ) { return false; }\nowner = owner[prop];\nchain = chain.slice(pos + 1);\n}\n};\nconst mustProcess = function(root) {\nfor ( const needlePath of needlePaths ) {\nif ( findOwner(root, needlePath) === false ) {\nreturn false;\n}\n}\nreturn true;\n};\nconst pruner = function(o) {\nif ( log !== undefined ) {\nconst json = JSON.stringify(o, null, 2);\nif ( reLogNeedle.test(json) ) {\nlog('uBO:', location.hostname, json);\n}\nreturn o;\n}\nif ( mustProcess(o) === false ) { return o; }\nfor ( const path of prunePaths ) {\nfindOwner(o, path, true);\n}\nreturn o;\n};\nJSON.parse = new Proxy(JSON.parse, {\napply: function() {\nreturn pruner(Reflect.apply(...arguments));\n},\n});\nResponse.prototype.json = new Proxy(Response.prototype.json, {\napply: function() {\nreturn Reflect.apply(...arguments).then(o => pruner(o));\n},\n});\n})();\n",
         );
@@ -283,7 +285,7 @@ mod tests {
         );
         assert_eq!(
             std::str::from_utf8(
-                &base64::decode(&reserialized[18].content).expect("decode base64 content")
+                &BASE64_STANDARD.decode(&reserialized[18].content).expect("decode base64 content")
             ).expect("convert to utf8 string"),
             "(function() {\nif ( window !== window.top ) {\nreturn;\n}\nvar tstart;\nvar ttl = 30000;\nvar delay = 0;\nvar delayStep = 50;\nvar buster = function() {\nvar docEl = document.documentElement,\nbodyEl = document.body,\nvw = Math.min(docEl.clientWidth, window.innerWidth),\nvh = Math.min(docEl.clientHeight, window.innerHeight),\ntol = Math.min(vw, vh) * 0.05,\nel = document.elementFromPoint(vw/2, vh/2),\nstyle, rect;\nfor (;;) {\nif ( el === null || el.parentNode === null || el === bodyEl ) {\nbreak;\n}\nstyle = window.getComputedStyle(el);\nif ( parseInt(style.zIndex, 10) >= 1000 || style.position === 'fixed' ) {\nrect = el.getBoundingClientRect();\nif ( rect.left <= tol && rect.top <= tol && (vw - rect.right) <= tol && (vh - rect.bottom) < tol ) {\nel.parentNode.removeChild(el);\ntstart = Date.now();\nel = document.elementFromPoint(vw/2, vh/2);\nbodyEl.style.setProperty('overflow', 'auto', 'important');\ndocEl.style.setProperty('overflow', 'auto', 'important');\ncontinue;\n}\n}\nel = el.parentNode;\n}\nif ( (Date.now() - tstart) < ttl ) {\ndelay = Math.min(delay + delayStep, 1000);\nsetTimeout(buster, delay);\n}\n};\nvar domReady = function(ev) {\nif ( ev ) {\ndocument.removeEventListener(ev.type, domReady);\n}\ntstart = Date.now();\nsetTimeout(buster, delay);\n};\nif ( document.readyState === 'loading' ) {\ndocument.addEventListener('DOMContentLoaded', domReady);\n} else {\ndomReady();\n}\n})();\n",
         );