Skip to content

Commit 277790f

Browse files
committed
AG-35667 inject into frames without source
Merge in ADGUARD-FILTERS/tsurlfilter from fix/AG-35667 to release/v3.1 Squashed commit of the following: commit 2ec1208 Author: Dávid Tóta <d.tota@adguard.com> Date: Thu Oct 3 16:57:47 2024 +0300 packages/tswebextension/CHANGELOG.md edited online with Bitbucket commit 4d123eb Merge: 83dcc62 4a524dc Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 16:56:02 2024 +0300 Merge branch 'release/v3.1' into fix/AG-35667 commit 83dcc62 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 16:15:42 2024 +0300 AG-35667 dry code a little bit commit 73da4c5 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 16:06:38 2024 +0300 AG-35667 improve readability commit 8b4a86a Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 16:05:46 2024 +0300 AG-35667 improve documentation commit 0c7141c Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 16:03:38 2024 +0300 AG-35667 encapsulate frames map commit db7fb07 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 16:02:13 2024 +0300 AG-35667 improve documentation commit 501b766 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 16:01:02 2024 +0300 AG-35667 improve types commit f126726 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 15:59:26 2024 +0300 AG-35667 improve changelog commit 82100c2 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 15:59:04 2024 +0300 AG-35667 improve changelog commit 74f0b9f Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 15:58:14 2024 +0300 AG-35667 improve documentation commit 0fc3a53 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 15:56:35 2024 +0300 AG-35667 move constant to static class member commit a4d80ef Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 15:48:20 2024 +0300 AG-35667 refactor name commit aa949d9 Author: Maxim Topciu <mtopciu@adguard.com> Date: Thu Oct 3 15:40:37 2024 +0300 AG-35667 simplify code commit 95eae17 Author: Maxim Topciu <mtopciu@adguard.com> Date: Wed Oct 2 19:10:34 2024 +0300 AG-35667 fix lock file commit f0c5d18 Author: Maxim Topciu <mtopciu@adguard.com> Date: Wed Oct 2 18:46:26 2024 +0300 AG-35667 remove redundant eslint exclusion commit 8ddfb36 Author: Maxim Topciu <mtopciu@adguard.com> Date: Wed Oct 2 18:07:45 2024 +0300 AG-35667 update changelog commit a84b1e3 Author: Maxim Topciu <mtopciu@adguard.com> Date: Wed Oct 2 18:06:50 2024 +0300 AG-35667 update version commit de9314f Merge: 25a8fc3 899aff9 Author: Maxim Topciu <mtopciu@adguard.com> Date: Wed Oct 2 17:34:58 2024 +0300 Merge branch 'release/v3.1' into fix/AG-35667 commit 25a8fc3 Author: Maxim Topciu <mtopciu@adguard.com> Date: Tue Oct 1 19:39:09 2024 +0300 AG-35667 fix switcher ... and 29 more commits
1 parent 4a524dc commit 277790f

19 files changed

Lines changed: 1038 additions & 1220 deletions

‎packages/tswebextension/CHANGELOG.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
88
<!-- TODO: manually add compare links for version changes -->
99
<!-- e.g. [0.1.2]: https://github.com/AdguardTeam/tsurlfilter/compare/tswebextension-v0.1.1...tswebextension-v0.1.2 -->
1010

11+
## Unreleased
12+
13+
### Fixed
14+
- MV3 extension cannot apply rules to `about:blank` iframes [AdguardBrowserExtension#2975]
15+
16+
[AdguardBrowserExtension#2975]: https://github.com/AdguardTeam/AdguardBrowserExtension/issues/2975
17+
1118
## [2.3.0-alpha.1] - 2024-10-02
1219

1320
### Changed

‎packages/tswebextension/package.json‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@adguard/tswebextension",
3-
"version": "2.3.0-alpha.1",
3+
"version": "2.4.0-alpha.0",
44
"description": "This is a TypeScript library that implements AdGuard's extension API",
55
"main": "dist/index.js",
66
"typings": "dist/types/src/lib/mv2/background/index.d.ts",
@@ -93,7 +93,7 @@
9393
"@adguard/scriptlets": "^1.12.1",
9494
"@adguard/tsurlfilter": "workspace:^",
9595
"bowser": "2.11.0",
96-
"chrome-types": "^0.1.283",
96+
"chrome-types": "^0.1.307",
9797
"commander": "11.0.0",
9898
"fs-extra": "11.1.1",
9999
"lodash-es": "^4.17.21",
@@ -114,7 +114,7 @@
114114
"@swc-node/register": "^1.6.6",
115115
"@swc/core": "1.4.8",
116116
"@swc/jest": "0.2.36",
117-
"@types/chrome": "^0.0.242",
117+
"@types/chrome": "^0.0.272",
118118
"@types/fs-extra": "^11.0.1",
119119
"@types/jest": "29.5.2",
120120
"@types/lodash-es": "^4.17.9",
@@ -140,6 +140,6 @@
140140
"sinon-chrome": "^3.0.1",
141141
"ts-jest": "^29.1.0",
142142
"ts-node": "^10.9.1",
143-
"typescript": "5.1.3"
143+
"typescript": "5.6.2"
144144
}
145145
}

‎packages/tswebextension/setupTests.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import browser from 'sinon-chrome';
22
import { TextEncoder, TextDecoder } from 'util';
33

44
global.chrome = {
5+
...browser,
56
// @ts-ignore
67
scripting: {
78
insertCSS: jest.fn(),

‎packages/tswebextension/src/lib/mv3/background/cosmetic-api.ts‎

Lines changed: 20 additions & 198 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,7 @@ import { createFrameMatchQuery } from '../../common/utils/create-frame-match-que
1212
import { getErrorMessage } from '../../common/error';
1313
import { logger } from '../../common/utils/logger';
1414
import { CosmeticApiCommon } from '../../common/cosmetic-api';
15-
import {
16-
type ExecuteScriptletParams,
17-
type ExecuteScriptParams,
18-
type InsertCSSParams,
19-
ScriptingApi,
20-
} from './scripting-api';
21-
import { requestContextStorage } from './request/request-context-storage';
15+
import { ScriptingApi } from './scripting-api';
2216
import { defaultFilteringLog, FilteringEventType } from '../../common/filtering-log';
2317
import { getDomain } from '../../common/utils/url';
2418
import { type ContentType } from '../../common/request-type';
@@ -41,13 +35,6 @@ export type ContentScriptCosmeticData = {
4135
extCssRules: string[] | null,
4236
};
4337

44-
type ApplyCosmeticResultParams = {
45-
tabId: number,
46-
frameId: number,
47-
cosmeticResult: CosmeticResult,
48-
frameUrl: string,
49-
};
50-
5138
/**
5239
* Script text and scriptlets.
5340
*/
@@ -56,27 +43,6 @@ type ScriptTextAndScriptlets = {
5643
scriptletDataList: ScriptletData[]
5744
};
5845

59-
/**
60-
* Parameters for executing scriptlet data list.
61-
*/
62-
type ExecuteScriptletsParams = Omit<ExecuteScriptletParams, 'scriptletData'> & {
63-
/**
64-
* The scriptlet data to be executed.
65-
*/
66-
scriptletDataList: ScriptletData[];
67-
};
68-
69-
/**
70-
* Parameters for executing a script with additional frame URL.
71-
*/
72-
export type ExecuteScriptParamsWithUrl = ExecuteScriptParams & {
73-
/**
74-
* The URL of the frame.
75-
* Used to determine if a blob should be used for injection.
76-
*/
77-
frameUrl: string;
78-
};
79-
8046
/**
8147
* Information for logging js rules.
8248
*/
@@ -278,33 +244,6 @@ export class CosmeticApi extends CosmeticApiCommon {
278244
return data;
279245
}
280246

281-
/**
282-
* Injects scriptlet data list to the page by request id.
283-
*
284-
* @param requestId Request id.
285-
*/
286-
public static async applyScriptletsByRequest(requestId: string): Promise<void> {
287-
const requestContext = requestContextStorage.get(requestId);
288-
const scriptletDataList = requestContext?.scriptletDataList;
289-
290-
if (!scriptletDataList) {
291-
return;
292-
}
293-
294-
try {
295-
await Promise.all(scriptletDataList.map((scriptletData) => {
296-
return ScriptingApi.executeScriptlet({
297-
tabId: requestContext.tabId,
298-
frameId: requestContext.frameId,
299-
scriptletData,
300-
domainName: getDomain(requestContext.requestUrl),
301-
});
302-
}));
303-
} catch (e) {
304-
logger.debug('[applyScriptletsByRequest] error occurred during injection', getErrorMessage(e));
305-
}
306-
}
307-
308247
/**
309248
* Determines if a blob should be used for script injection based on the request url.
310249
* This method is used in scenarios where inline scripts are blocked by a Content Security Policy (CSP),
@@ -329,48 +268,27 @@ export class CosmeticApi extends CosmeticApiCommon {
329268
return BLOB_INJECTION_URLS.has(domain);
330269
}
331270

332-
/**
333-
* Injects js to specified frame based on provided data and injection FSM state.
334-
*
335-
* @param requestId Request id.
336-
*/
337-
public static async applyJsByRequest(requestId: string): Promise<void> {
338-
const requestContext = requestContextStorage.get(requestId);
339-
if (!requestContext?.scriptText) {
340-
return;
341-
}
342-
343-
try {
344-
await ScriptingApi.executeScript({
345-
tabId: requestContext.tabId,
346-
frameId: requestContext.frameId,
347-
scriptText: requestContext.scriptText,
348-
useBlob: CosmeticApi.shouldUseBlob(requestContext.requestUrl),
349-
});
350-
} catch (e) {
351-
logger.debug('[applyJsByRequest] error occurred during injection', getErrorMessage(e));
352-
}
353-
}
354-
355271
/**
356272
* Injects js to specified tab and frame.
357273
*
358274
* @param tabId Tab id.
359275
* @param frameId Frame id.
360276
*/
361277
public static async applyJsByTabAndFrame(tabId: number, frameId: number): Promise<void> {
362-
const requestContext = requestContextStorage.getByTabAndFrame(tabId, frameId);
278+
const frameContext = tabsApi.getFrameContext(tabId, frameId);
363279

364-
if (!requestContext?.scriptText) {
280+
const scriptText = frameContext?.preparedCosmeticResult?.scriptText;
281+
282+
if (!scriptText) {
365283
return;
366284
}
367285

368286
try {
369287
await ScriptingApi.executeScript({
370288
tabId,
371289
frameId,
372-
scriptText: requestContext.scriptText,
373-
useBlob: CosmeticApi.shouldUseBlob(requestContext.requestUrl),
290+
scriptText,
291+
useBlob: CosmeticApi.shouldUseBlob(frameContext.url),
374292
});
375293
} catch (e) {
376294
logger.debug('[applyJsByTabAndFrame] error occurred during injection', getErrorMessage(e));
@@ -384,8 +302,13 @@ export class CosmeticApi extends CosmeticApiCommon {
384302
* @param frameId Frame id.
385303
*/
386304
public static async applyScriptletsByTabAndFrame(tabId: number, frameId: number): Promise<void> {
387-
const requestContext = requestContextStorage.getByTabAndFrame(tabId, frameId);
388-
const scriptletDataList = requestContext?.scriptletDataList;
305+
const frameContext = tabsApi.getFrameContext(tabId, frameId);
306+
307+
if (!frameContext) {
308+
return;
309+
}
310+
311+
const scriptletDataList = frameContext.preparedCosmeticResult?.scriptletDataList;
389312

390313
if (!scriptletDataList) {
391314
return;
@@ -397,7 +320,7 @@ export class CosmeticApi extends CosmeticApiCommon {
397320
tabId,
398321
frameId,
399322
scriptletData,
400-
domainName: getDomain(requestContext.requestUrl),
323+
domainName: getDomain(frameContext.url),
401324
});
402325
}));
403326
} catch (e) {
@@ -412,14 +335,16 @@ export class CosmeticApi extends CosmeticApiCommon {
412335
* @param frameId Frame id.
413336
*/
414337
public static async applyCssByTabAndFrame(tabId: number, frameId: number): Promise<void> {
415-
const requestContext = requestContextStorage.getByTabAndFrame(tabId, frameId);
416-
if (!requestContext?.cssText) {
338+
const requestContext = tabsApi.getFrameContext(tabId, frameId);
339+
340+
const cssText = requestContext?.preparedCosmeticResult?.cssText;
341+
if (!cssText) {
417342
return;
418343
}
419344

420345
try {
421346
await ScriptingApi.insertCSS({
422-
cssText: requestContext.cssText,
347+
cssText,
423348
tabId,
424349
frameId,
425350
});
@@ -433,109 +358,6 @@ export class CosmeticApi extends CosmeticApiCommon {
433358
}
434359
}
435360

436-
/**
437-
* Wraps CSS injection with try-catch block.
438-
* @param params Parameters for applying CSS rules.
439-
*/
440-
private static async insertCSS(params: InsertCSSParams): Promise<void> {
441-
try {
442-
await ScriptingApi.insertCSS(params);
443-
} catch (e) {
444-
logger.debug('[insertCSS] error occurred during injection', getErrorMessage(e));
445-
}
446-
}
447-
448-
/**
449-
* Wraps script execution with try-catch block.
450-
* @param params Parameters for executing a script.
451-
*/
452-
private static async executeScript(params: ExecuteScriptParamsWithUrl): Promise<void> {
453-
try {
454-
await ScriptingApi.executeScript({
455-
tabId: params.tabId,
456-
frameId: params.frameId,
457-
scriptText: params.scriptText,
458-
useBlob: CosmeticApi.shouldUseBlob(params.frameUrl),
459-
});
460-
} catch (e) {
461-
logger.debug('[executeScript] error occurred during injection', getErrorMessage(e));
462-
}
463-
}
464-
465-
/**
466-
* Wraps script execution with try-catch block.
467-
* @param params Parameters for executing a script.
468-
*/
469-
private static async executeScriptlets(params: ExecuteScriptletsParams): Promise<void> {
470-
const {
471-
tabId,
472-
frameId,
473-
scriptletDataList,
474-
domainName,
475-
} = params;
476-
477-
try {
478-
await Promise.all(scriptletDataList.map((scriptletData) => {
479-
return ScriptingApi.executeScriptlet({
480-
tabId,
481-
frameId,
482-
scriptletData,
483-
domainName,
484-
});
485-
}));
486-
} catch (e) {
487-
logger.debug('[executeScriptlets] error occurred during injection', getErrorMessage(e));
488-
}
489-
}
490-
491-
/**
492-
* Injects a cosmetic result to the frame by tab id and frame id.
493-
*
494-
* @param params Parameters for applying a cosmetic result.
495-
* @param params.tabId Tab id.
496-
* @param params.frameId Frame id.
497-
* @param params.cosmeticResult Cosmetic result.
498-
* @param params.frameUrl Frame URL.
499-
* @returns Promise that resolves when the cosmetic result is applied.
500-
*/
501-
public static async applyCosmeticResult(
502-
{
503-
tabId,
504-
frameId,
505-
cosmeticResult,
506-
frameUrl,
507-
}: ApplyCosmeticResultParams,
508-
): Promise<void> {
509-
const { scriptText, scriptletDataList } = CosmeticApi.getScriptTextAndScriptlets(cosmeticResult);
510-
const cssText = CosmeticApi.getCssText(cosmeticResult);
511-
512-
if (cssText) {
513-
CosmeticApi.insertCSS({
514-
tabId,
515-
frameId,
516-
cssText,
517-
});
518-
}
519-
520-
if (scriptText) {
521-
CosmeticApi.executeScript({
522-
tabId,
523-
frameId,
524-
scriptText,
525-
frameUrl,
526-
});
527-
}
528-
529-
if (scriptletDataList.length > 0) {
530-
CosmeticApi.executeScriptlets({
531-
tabId,
532-
frameId,
533-
scriptletDataList,
534-
domainName: getDomain(frameUrl),
535-
});
536-
}
537-
}
538-
539361
/**
540362
* Patches rule selector adding adguard mark rule info in the content attribute.
541363
* Example:

0 commit comments

Comments
 (0)