forked from duckduckgo/duckduckgo-privacy-extension
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Extract tab lifecycle events (duckduckgo#2123)
* Rename 'features' to 'components'. * Move all tabManager tracking code to a separate component * Fix lint * Fix import * Remove onCreatedNavigationTarget listener from events.js
- Loading branch information
1 parent
44feb69
commit 21b1b0c
Showing
8 changed files
with
131 additions
and
112 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| /* global BUILD_TARGET */ | ||
| import browser from 'webextension-polyfill' | ||
| import { restoreDefaultClickToLoadRuleActions } from '../dnr-click-to-load' | ||
| import Companies from '../companies' | ||
| import { isRedirect } from '../utils' | ||
| // eslint-disable-next-line no-restricted-syntax | ||
| import * as devtools from '../devtools' | ||
|
|
||
| /** | ||
| * @typedef {import('../tab-manager.js')} TabManager | ||
| * @typedef {import('../devtools')} Devtools | ||
| */ | ||
|
|
||
| export default class TabTracker { | ||
| /** | ||
| * @param {{ | ||
| * tabManager: TabManager; | ||
| * }} options | ||
| */ | ||
| constructor ({ tabManager }) { | ||
| this.tabManager = tabManager | ||
| this.createdTargets = new Map() | ||
|
|
||
| browser.webRequest.onHeadersReceived.addListener((request) => { | ||
| this.tabManager.updateTabUrl(request) | ||
| const tab = tabManager.get({ tabId: request.tabId }) | ||
| // SERP ad click detection | ||
| if ( | ||
| isRedirect(request.statusCode) | ||
| ) { | ||
| tab.setAdClickIfValidRedirect(request.url) | ||
| } else if (tab && tab.adClick && tab.adClick.adClickRedirect && !isRedirect(request.statusCode)) { | ||
| tab.adClick.setAdBaseDomain(tab.site.baseDomain || '') | ||
| } | ||
| }, { urls: ['<all_urls>'], types: ['main_frame'] }) | ||
|
|
||
| // Store the created tab id for when onBeforeNavigate is called so data can be copied across from the source tab | ||
| browser.webNavigation.onCreatedNavigationTarget.addListener(details => { | ||
| this.createdTargets.set(details.tabId, details.sourceTabId) | ||
| }) | ||
|
|
||
| // keep track of URLs that the browser navigates to. | ||
| // | ||
| // this is supplemented by tabManager.updateTabUrl() on headersReceived: | ||
| // tabManager.updateTabUrl only fires when a tab has finished loading with a 200, | ||
| // which misses a couple of edge cases like browser special pages | ||
| // and Gmail's weird redirect which returns a 200 via a service worker | ||
| browser.webNavigation.onBeforeNavigate.addListener((details) => { | ||
| // ignore navigation on iframes | ||
| if (details.frameId !== 0) return | ||
|
|
||
| const currentTab = tabManager.get({ tabId: details.tabId }) | ||
| const newTab = tabManager.create({ tabId: details.tabId, url: details.url }) | ||
|
|
||
| if (BUILD_TARGET === 'chrome-mv3') { | ||
| // Ensure that the correct declarativeNetRequest allowing rules are | ||
| // added for this tab. | ||
| // Note: The webNavigation.onBeforeCommitted event would be better, | ||
| // since onBeforeNavigate can be fired for a navigation that is | ||
| // not later committed. But since there is a race-condition | ||
| // between the page loading and the rules being added, let's use | ||
| // onBeforeNavigate for now as it fires sooner. | ||
| restoreDefaultClickToLoadRuleActions(newTab) | ||
| } | ||
|
|
||
| // persist the last URL the tab was trying to upgrade to HTTPS | ||
| if (currentTab && currentTab.httpsRedirects) { | ||
| newTab.httpsRedirects.persistMainFrameRedirect(currentTab.httpsRedirects.getMainFrameRedirect()) | ||
| } | ||
| if (this.createdTargets.has(details.tabId)) { | ||
| const sourceTabId = this.createdTargets.get(details.tabId) | ||
| this.createdTargets.delete(details.tabId) | ||
|
|
||
| const sourceTab = tabManager.get({ tabId: sourceTabId }) | ||
| if (sourceTab && sourceTab.adClick) { | ||
| this.createdTargets.set(details.tabId, sourceTabId) | ||
| if (sourceTab.adClick.shouldPropagateAdClickForNewTab(newTab)) { | ||
| newTab.adClick = sourceTab.adClick.propagate(newTab.id) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| newTab.updateSite(details.url) | ||
| devtools.postMessage(details.tabId, 'tabChange', devtools.serializeTab(newTab)) | ||
| }) | ||
|
|
||
| browser.tabs.onCreated.addListener((info) => { | ||
| if (info.id) { | ||
| tabManager.createOrUpdateTab(info.id, info) | ||
| } | ||
| }) | ||
|
|
||
| browser.tabs.onUpdated.addListener((id, info) => { | ||
| // sync company data to storage when a tab finishes loading | ||
| if (info.status === 'complete') { | ||
| Companies.syncToStorage() | ||
| } | ||
| tabManager.createOrUpdateTab(id, info) | ||
| }) | ||
|
|
||
| browser.tabs.onRemoved.addListener((id, info) => { | ||
| // remove the tab object | ||
| tabManager.delete(id) | ||
| }) | ||
|
|
||
| this.restoreOrCreateTabs() | ||
| } | ||
|
|
||
| async restoreOrCreateTabs () { | ||
| const savedTabs = await browser.tabs.query({ status: 'complete' }) | ||
| for (let i = 0; i < savedTabs.length; i++) { | ||
| const tab = savedTabs[i] | ||
|
|
||
| if (tab.url) { | ||
| // On reinstall we wish to create the tab again | ||
| await this.tabManager.restoreOrCreate(tab) | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters