Skip to content

Commit 6d9bef2

Browse files
gorhillgorhill
committed
[mv3] Fix issue with updateContentScripts API and other fixes
Avoid using updateContentScripts() as it suffers from an unexpected behavior, causing injected content scripts to lose proper order at injection time. The order in which content scripts are injected is key for uBOL content scripts. Potential out of order injection was causing cosmetic filtering to be broken. Use actual storage API to persist data across service worker wake-ups and browser launches. uBOL was trying to avoid using storage API, at the cost of somewhat hacky code (using DNR API to persist settings). Make use of session storage if available, to speed up initialization of waking up the service worker (which at this point is necessary to properly implement cosmetic filtering).
1 parent 666cbd1 commit 6d9bef2

11 files changed

Lines changed: 296 additions & 351 deletions

File tree

‎platform/mv3/chromium/manifest.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
"permissions": [
3535
"activeTab",
3636
"declarativeNetRequest",
37-
"scripting"
37+
"scripting",
38+
"storage"
3839
],
3940
"short_name": "uBO Lite",
4041
"version": "0.1",

‎platform/mv3/extension/js/background.js‎

Lines changed: 48 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ import {
2929
browser,
3030
dnr,
3131
runtime,
32+
localRead, localWrite,
33+
sessionRead, sessionWrite,
3234
} from './ext.js';
3335

3436
import {
@@ -75,72 +77,61 @@ function getCurrentVersion() {
7577
}
7678

7779
async function loadRulesetConfig() {
78-
const dynamicRuleMap = await getDynamicRules();
79-
const configRule = dynamicRuleMap.get(CURRENT_CONFIG_BASE_RULE_ID);
80-
if ( configRule === undefined ) {
81-
rulesetConfig.enabledRulesets = await defaultRulesetsFromLanguage();
82-
rulesetConfig.firstRun = true;
80+
let data = await sessionRead('rulesetConfig');
81+
if ( data ) {
82+
rulesetConfig.version = data.version;
83+
rulesetConfig.enabledRulesets = data.enabledRulesets;
84+
rulesetConfig.autoReload = data.autoReload;
8385
return;
8486
}
85-
let rawConfig;
86-
try {
87-
rawConfig = JSON.parse(self.atob(configRule.condition.urlFilter));
88-
} catch(ex) {
89-
}
90-
91-
// New format
92-
if ( Array.isArray(rawConfig) ) {
93-
rulesetConfig.version = rawConfig[0];
94-
rulesetConfig.enabledRulesets = rawConfig[1];
95-
rulesetConfig.autoReload = rawConfig[2];
87+
data = await localRead('rulesetConfig');
88+
if ( data ) {
89+
rulesetConfig.version = data.version;
90+
rulesetConfig.enabledRulesets = data.enabledRulesets;
91+
rulesetConfig.autoReload = data.autoReload;
9692
return;
9793
}
98-
99-
// Legacy format. TODO: remove when next new format is widely in use.
100-
const match = /^\|\|(?:example|ubolite)\.invalid\/([^\/]+)\/(?:([^\/]+)\/)?/.exec(
101-
configRule.condition.urlFilter
102-
);
103-
if ( match === null ) { return; }
104-
rulesetConfig.version = match[1];
105-
if ( match[2] ) {
106-
rulesetConfig.enabledRulesets =
107-
decodeURIComponent(match[2] || '').split(' ');
94+
data = await loadRulesetConfig.convertLegacyStorage();
95+
if ( data ) {
96+
rulesetConfig.version = data.version;
97+
rulesetConfig.enabledRulesets = data.enabledRulesets;
98+
rulesetConfig.autoReload = data.autoReload;
99+
return;
108100
}
101+
rulesetConfig.enabledRulesets = await defaultRulesetsFromLanguage();
102+
rulesetConfig.firstRun = true;
103+
sessionWrite('rulesetConfig', rulesetConfig);
104+
localWrite('rulesetConfig', rulesetConfig);
109105
}
110106

111-
async function saveRulesetConfig() {
107+
// TODO: To remove after next stable release is widespread (2023-06-04)
108+
loadRulesetConfig.convertLegacyStorage = async function() {
112109
const dynamicRuleMap = await getDynamicRules();
113-
let configRule = dynamicRuleMap.get(CURRENT_CONFIG_BASE_RULE_ID);
114-
if ( configRule === undefined ) {
115-
configRule = {
116-
id: CURRENT_CONFIG_BASE_RULE_ID,
117-
action: {
118-
type: 'allow',
119-
},
120-
condition: {
121-
urlFilter: '',
122-
initiatorDomains: [
123-
'ubolite.invalid',
124-
],
125-
resourceTypes: [
126-
'main_frame',
127-
],
128-
},
129-
};
110+
const configRule = dynamicRuleMap.get(CURRENT_CONFIG_BASE_RULE_ID);
111+
if ( configRule === undefined ) { return; }
112+
let rawConfig;
113+
try {
114+
rawConfig = JSON.parse(self.atob(configRule.condition.urlFilter));
115+
} catch(ex) {
116+
return;
130117
}
131-
const rawConfig = [
132-
rulesetConfig.version,
133-
rulesetConfig.enabledRulesets,
134-
rulesetConfig.autoReload,
135-
];
136-
const urlFilter = self.btoa(JSON.stringify(rawConfig));
137-
if ( urlFilter === configRule.condition.urlFilter ) { return; }
138-
configRule.condition.urlFilter = urlFilter;
139-
140-
return dnr.updateDynamicRules({
141-
addRules: [ configRule ],
118+
if ( rawConfig === undefined ) { return; }
119+
const config = {
120+
version: rawConfig[0],
121+
enabledRulesets: rawConfig[1],
122+
autoReload: rawConfig[2],
123+
};
124+
localWrite('rulesetConfig', config);
125+
sessionWrite('rulesetConfig', config);
126+
dnr.updateDynamicRules({
142127
removeRuleIds: [ CURRENT_CONFIG_BASE_RULE_ID ],
143128
});
129+
return config;
130+
};
131+
132+
async function saveRulesetConfig() {
133+
sessionWrite('rulesetConfig', rulesetConfig);
134+
return localWrite('rulesetConfig', rulesetConfig);
144135
}
145136

146137
/******************************************************************************/
@@ -185,6 +176,8 @@ function onMessage(request, sender, callback) {
185176
css: request.css,
186177
origin: 'USER',
187178
target: { tabId, frameIds: [ frameId ] },
179+
}).catch(reason => {
180+
console.log(reason);
188181
});
189182
return;
190183
}

‎platform/mv3/extension/js/dashboard.js‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121

2222
'use strict';
2323

24-
import { simpleStorage } from './storage.js';
2524
import { dom, qs$ } from './dom.js';
2625

2726
/******************************************************************************/
@@ -82,9 +81,6 @@ const loadDashboardPanel = function(pane, first) {
8281
dom.cl.add(tabButton, 'selected');
8382
tabButton.scrollIntoView();
8483
document.querySelector('#iframe').contentWindow.location.replace(pane);
85-
if ( pane !== 'no-dashboard.html' ) {
86-
simpleStorage.setItem('dashboardLastVisitedPane', pane);
87-
}
8884
};
8985
if ( first ) {
9086
return loadPane();

‎platform/mv3/extension/js/ext.js‎

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,4 +61,50 @@ function sendMessage(msg) {
6161

6262
/******************************************************************************/
6363

64-
export { browser, dnr, i18n, runtime, sendMessage };
64+
async function localRead(key) {
65+
if ( browser.storage instanceof Object === false ) { return; }
66+
if ( browser.storage.local instanceof Object === false ) { return; }
67+
try {
68+
const bin = await browser.storage.local.get(key);
69+
if ( bin instanceof Object === false ) { return; }
70+
return bin[key];
71+
} catch(ex) {
72+
}
73+
}
74+
75+
async function localWrite(key, value) {
76+
if ( browser.storage instanceof Object === false ) { return; }
77+
if ( browser.storage.local instanceof Object === false ) { return; }
78+
return browser.storage.local.set({ [key]: value });
79+
}
80+
81+
/******************************************************************************/
82+
83+
async function sessionRead(key) {
84+
if ( browser.storage instanceof Object === false ) { return; }
85+
if ( browser.storage.session instanceof Object === false ) { return; }
86+
try {
87+
const bin = await browser.storage.session.get(key);
88+
if ( bin instanceof Object === false ) { return; }
89+
return bin[key];
90+
} catch(ex) {
91+
}
92+
}
93+
94+
async function sessionWrite(key, value) {
95+
if ( browser.storage instanceof Object === false ) { return; }
96+
if ( browser.storage.session instanceof Object === false ) { return; }
97+
return browser.storage.session.set({ [key]: value });
98+
}
99+
100+
/******************************************************************************/
101+
102+
export {
103+
browser,
104+
dnr,
105+
i18n,
106+
runtime,
107+
sendMessage,
108+
localRead, localWrite,
109+
sessionRead, sessionWrite,
110+
};

0 commit comments

Comments
 (0)