Skip to content

Commit 5e164aa

Browse files
committed
ditch generateDocumentId and generateParentDocumentId
1 parent 409935f commit 5e164aa

File tree

3 files changed

+23
-53
lines changed

3 files changed

+23
-53
lines changed

packages/tswebextension/src/lib/mv2/background/tabs/tabs-api.ts

+1-48
Original file line numberDiff line numberDiff line change
@@ -120,57 +120,10 @@ export class TabsApi extends TabsApiCommon<FrameMV2, TabContext> {
120120
*
121121
* @returns ID as a string based on tab and frame IDs.
122122
*/
123-
private static generateId(tabId: number, frameId: number): string {
123+
public static generateId(tabId: number, frameId: number): string {
124124
return `${tabId}-${frameId}`;
125125
}
126126

127-
/**
128-
* Calculates document ID.
129-
*
130-
* @param tabId Tab ID.
131-
* @param frameId Frame ID.
132-
* @param documentId Document ID, may be undefined.
133-
*
134-
* @returns Calculated document ID:
135-
* - `documentId` if passed value is defined;
136-
* - generated ID based on tab and frame IDs.
137-
*/
138-
public static generateDocumentId(
139-
tabId: number,
140-
frameId: number,
141-
documentId?: string,
142-
): string {
143-
return typeof documentId === 'undefined'
144-
? TabsApi.generateId(tabId, frameId)
145-
: documentId;
146-
}
147-
148-
/**
149-
* Calculates parent document ID.
150-
*
151-
* @param tabId Tab ID.
152-
* @param parentFrameId Parent frame ID.
153-
* @param parentDocumentId Parent document ID, may be undefined.
154-
*
155-
* @returns Calculated parent document ID:
156-
* - `parentDocumentId` if passed value is defined;
157-
* - `undefined` if parent frame is a document-level frame so no parent document;
158-
* - generated ID based on tab and frame IDs.
159-
*/
160-
public static generateParentDocumentId(
161-
tabId: number,
162-
parentFrameId: number,
163-
parentDocumentId: string | undefined,
164-
): string | undefined {
165-
if (typeof parentDocumentId !== 'undefined') {
166-
return parentDocumentId;
167-
}
168-
169-
return TabsApi.isDocumentLevelFrame(parentFrameId)
170-
? undefined
171-
: TabsApi.generateId(tabId, parentFrameId);
172-
}
173-
174127
// TODO: do the same in MV3 (AG-39527)
175128
// since cosmetic rules should not be applied in the assistant frame (AG-9829)
176129
/**

packages/tswebextension/src/lib/mv2/background/tabs/tabs-cosmetic-injector.ts

+11-2
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,17 @@ export class TabsCosmeticInjector {
9292
documentId,
9393
} = frameDetails;
9494

95-
const calculatedParentDocumentId = TabsApi.generateParentDocumentId(tabId, parentFrameId, parentDocumentId);
96-
const calculatedDocumentId = TabsApi.generateDocumentId(tabId, frameId, documentId);
95+
/**
96+
* Use parentDocumentId if it is defined, otherwise:
97+
* - if parent frame is a document-level frame, use undefined
98+
* - else generate parentDocumentId based on tabId and parentFrameId.
99+
*/
100+
const calculatedParentDocumentId = parentDocumentId
101+
|| (TabsApi.isDocumentLevelFrame(parentFrameId)
102+
? undefined
103+
: TabsApi.generateId(tabId, parentFrameId));
104+
105+
const calculatedDocumentId = documentId || TabsApi.generateId(tabId, frameId);
97106

98107
this.tabsApi.setFrameContext(tabId, frameId, new FrameMV2({
99108
tabId,

packages/tswebextension/src/lib/mv2/background/web-request-api.ts

+11-3
Original file line numberDiff line numberDiff line change
@@ -701,7 +701,15 @@ export class WebRequestApi {
701701
frameId,
702702
url,
703703
timeStamp,
704-
parentDocumentId: TabsApi.generateParentDocumentId(tabId, parentFrameId, parentDocumentId),
704+
/**
705+
* Use parentDocumentId if it is defined, otherwise:
706+
* - if parent frame is a document-level frame, use undefined
707+
* - else generate parentDocumentId based on tabId and parentFrameId.
708+
*/
709+
parentDocumentId: parentDocumentId
710+
|| (TabsApi.isDocumentLevelFrame(parentFrameId)
711+
? undefined
712+
: TabsApi.generateId(tabId, parentFrameId)),
705713
});
706714
}
707715

@@ -727,7 +735,7 @@ export class WebRequestApi {
727735
tabId,
728736
frameId,
729737
{
730-
documentId: TabsApi.generateDocumentId(tabId, frameId, documentId),
738+
documentId: documentId || TabsApi.generateId(tabId, frameId),
731739
},
732740
);
733741

@@ -781,7 +789,7 @@ export class WebRequestApi {
781789
tabId,
782790
frameId,
783791
{
784-
documentId: TabsApi.generateDocumentId(tabId, frameId, documentId),
792+
documentId: documentId || TabsApi.generateId(tabId, frameId),
785793
},
786794
);
787795

0 commit comments

Comments
 (0)