Skip to content

Fix: Persist favicons for pinned tabs and migrate existing pins (#9389) #11363

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Vedaant-Rajoo wants to merge 5 commits into from
Closed

Fix: Persist favicons for pinned tabs and migrate existing pins (#9389) #11363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c77de8e
fix(tabs): persist pinned tab favicons
Vedaant-Rajoo Nov 19, 2025
4647245
refactor(tabs): remove debug favicon logging
Vedaant-Rajoo Nov 19, 2025
810c54a
refactor(tabs): clean up whitespace and improve code readability
Vedaant-Rajoo Nov 19, 2025
c35477e
Merge branch 'dev' into fix-issue-9389
Vedaant-Rajoo Nov 22, 2025
099cd80
style(zen:pinned-tabs): fix indentation and formatting
Vedaant-Rajoo Nov 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
227 changes: 212 additions & 15 deletions src/zen/tabs/ZenPinnedTabManager.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
this.observer.addPinnedTabListener(this._onPinnedTabEvent.bind(this));

this._zenClickEventListener = this._onTabClick.bind(this);
this._migrationAttempted = new Set();

gZenWorkspaces._resolvePinnedInitialized();
}
Expand All @@ -102,14 +103,21 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
}
}

onTabIconChanged(tab, url = null) {
const iconUrl = url ?? tab.iconImage.src;
async onTabIconChanged(tab, url = null) {
const iconUrl = url ?? gBrowser.getIcon(tab);

if (!iconUrl && tab.hasAttribute('zen-pin-id')) {
try {
setTimeout(async () => {
const favicon = await this.getFaviconAsBase64(tab.linkedBrowser.currentURI);
if (favicon) {
gBrowser.setIcon(tab, favicon);
const pinId = tab.getAttribute('zen-pin-id');
const pin = this._pinsCache?.find((p) => p.uuid === pinId);
if (pin) {
pin.iconUrl = favicon;
await this.savePin(pin, false);
}
}
});
} catch {
Expand All @@ -119,6 +127,14 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
if (tab.hasAttribute('zen-essential')) {
tab.style.setProperty('--zen-essential-tab-icon', `url(${iconUrl})`);
}
if (iconUrl && tab.hasAttribute('zen-pin-id')) {
const pinId = tab.getAttribute('zen-pin-id');
const pin = this._pinsCache?.find((p) => p.uuid === pinId);
if (pin && iconUrl.startsWith('data:image/')) {
pin.iconUrl = iconUrl;
this.savePin(pin, false).catch(console.error);
}
}
}
}

Expand Down Expand Up @@ -172,27 +188,44 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
// Get pin data
const pins = await ZenPinnedTabsStorage.getPins();

// Enhance pins with favicons
this._pinsCache = await Promise.all(
pins.map(async (pin) => {
try {
if (pin.isGroup) {
return pin; // Skip groups for now
return pin;
}

if (pin.iconUrl && pin.iconUrl.trim().length > 0) {
return {
...pin,
iconUrl: pin.iconUrl,
};
}

const image = await this.getFaviconAsBase64(Services.io.newURI(pin.url));
if (image) {
pin.iconUrl = image;
this.savePin(pin, false).catch(console.error);
return {
...pin,
iconUrl: image,
};
}

return {
...pin,
iconUrl: image || null,
iconUrl: null,
};
} catch {
// If favicon fetch fails, continue without icon
return {
...pin,
iconUrl: null,
};
}
})
);

this.#scheduleLazyMigration();
} catch (ex) {
console.error('Failed to initialize pins cache:', ex);
this._pinsCache = [];
Expand All @@ -211,6 +244,76 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
this.hasInitializedPins = true;
}

#scheduleLazyMigration() {
if (this._migrationScheduled) {
return;
}
this._migrationScheduled = true;

setTimeout(() => {
this.#migrateMissingFavicons();
}, 2000);
}

async #migrateMissingFavicons() {
if (!this._pinsCache) {
return;
}

const pinsNeedingMigration = this._pinsCache.filter(
(pin) => !pin.isGroup && !pin.iconUrl && pin.url
);

if (pinsNeedingMigration.length === 0) {
return;
}

const essentialPins = pinsNeedingMigration.filter((pin) => pin.isEssential);
const regularPins = pinsNeedingMigration.filter((pin) => !pin.isEssential);

for (const pin of essentialPins) {
await this.#migratePinFavicon(pin);
await new Promise((resolve) => setTimeout(resolve, 100));
}

for (const pin of regularPins) {
await this.#migratePinFavicon(pin);
await new Promise((resolve) => setTimeout(resolve, 100));
}
}

async #migratePinFavicon(pin) {
if (pin.iconUrl && pin.iconUrl.trim().length > 0) {
return;
}

if (this._migrationAttempted?.has(pin.uuid)) {
return;
}

this._migrationAttempted?.add(pin.uuid);

try {
let favicon = await this.getFaviconAsBase64(Services.io.newURI(pin.url));

if (!favicon) {
favicon = await this.fetchFaviconFromNetwork(pin.url);
}

if (favicon) {
pin.iconUrl = favicon;
await this.savePin(pin, false);

const tab = gBrowser.tabs.find((t) => t.getAttribute('zen-pin-id') === pin.uuid);
if (tab) {
gBrowser.setIcon(tab, favicon);
}
}
} catch (ex) {
console.error('Error migrating favicon for pin', pin.uuid, ex);
}
}

async #initializePinnedTabs(init = false) {
const pins = this._pinsCache;
if (!pins?.length || !init) {
Expand Down Expand Up @@ -714,6 +817,9 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
entry = JSON.parse(tab.getAttribute('zen-pinned-entry'));
}

const tabFavicon = gBrowser.getIcon(tab);
const initialIconUrl = tabFavicon && tabFavicon.startsWith('data:image/') ? tabFavicon : null;

await this.savePin({
uuid,
title: entry?.title || tab.label || browser.contentTitle,
Expand All @@ -723,8 +829,13 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
isEssential: tab.getAttribute('zen-essential') === 'true',
parentUuid: tab.group?.getAttribute('zen-pin-id') || null,
position: tab._pPos,
iconUrl: initialIconUrl,
});

if (!initialIconUrl) {
this.captureFaviconForTab(tab, uuid);
}

tab.setAttribute('zen-pin-id', uuid);
tab.dispatchEvent(
new CustomEvent('ZenPinnedTabCreated', {
Expand Down Expand Up @@ -978,16 +1089,88 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
this.resetPinChangedUrl(tab);
}

captureFaviconForTab(tab, pinId) {
setTimeout(async () => {
try {
const tabFavicon = gBrowser.getIcon(tab);
let faviconDataURI = null;

if (tabFavicon && tabFavicon.startsWith('data:image/')) {
faviconDataURI = tabFavicon;
} else {
faviconDataURI = await this.getFaviconAsBase64(tab.linkedBrowser.currentURI);

if (!faviconDataURI) {
faviconDataURI = await this.fetchFaviconFromNetwork(tab.linkedBrowser.currentURI.spec);
}
}

if (faviconDataURI) {
const pin = this._pinsCache?.find((p) => p.uuid === pinId);
if (pin) {
pin.iconUrl = faviconDataURI;
await this.savePin(pin, false);
}
}
} catch (ex) {
console.error('Favicon capture error for', pinId, ex);
}
}, 100);
}

async getFaviconAsBase64(pageUrl) {
try {
const faviconData = await PlacesUtils.favicons.getFaviconForPage(pageUrl);
if (!faviconData) {
// empty favicon
if (!faviconData || !faviconData.dataURI) {
return null;
}
return faviconData.dataURI;
} catch (ex) {
console.error('Failed to get favicon:', ex);

const dataURI = faviconData.dataURI.spec || null;

if (dataURI && typeof dataURI === 'string' && dataURI.startsWith('data:image/')) {
return dataURI;
}

return null;
} catch {
return null;
}
}

async fetchFaviconFromNetwork(pageUrl) {
try {
if (
pageUrl.startsWith('about:') ||
pageUrl.startsWith('chrome:') ||
pageUrl.startsWith('moz-extension:')
) {
return null;
}

const uri = Services.io.newURI(pageUrl);
const faviconUrl = uri.prePath + '/favicon.ico';

const response = await fetch(faviconUrl, {
method: 'GET',
credentials: 'omit',
});

if (!response.ok) {
return null;
}

const blob = await response.blob();
if (!blob.type.startsWith('image/')) {
return null;
}

return new Promise((resolve, reject) => {
const reader = new FileReader();
reader.onloadend = () => resolve(reader.result);
reader.onerror = () => reject(new Error('Failed to convert blob to data URI'));
reader.readAsDataURL(blob);
});
} catch {
return null;
}
}
Expand Down Expand Up @@ -1019,9 +1202,20 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
if (tab.pinned && tab.hasAttribute('zen-pin-id')) {
const pin = this._pinsCache.find((pin) => pin.uuid === tab.getAttribute('zen-pin-id'));
if (pin) {
const pinId = tab.getAttribute('zen-pin-id');
pin.isEssential = true;
pin.workspaceUuid = null;
this.savePin(pin);

const tabFavicon = gBrowser.getIcon(tab);
if (tabFavicon && tabFavicon.startsWith('data:image/')) {
pin.iconUrl = tabFavicon;
}

this.savePin(pin).catch(console.error);

if (!pin.iconUrl) {
this.captureFaviconForTab(tab, pinId);
}
}
gBrowser.zenHandleTabMove(tab, () => {
if (tab.ownerGlobal !== window) {
Expand Down Expand Up @@ -1270,10 +1464,13 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
if (!pin) {
return;
}
// Remove # and ? from the URL

if (!pin.iconUrl && pin.url && !this._migrationAttempted?.has(pin.uuid)) {
this.#migratePinFavicon(pin);
}

const pinUrl = pin.url.split('#')[0];
const currentUrl = browser.currentURI.spec.split('#')[0];
// Add an indicator that the pin has been changed
if (pinUrl === currentUrl) {
this.resetPinChangedUrl(tab);
return;
Expand All @@ -1299,7 +1496,7 @@ class nsZenPinnedTabManager extends nsZenDOMOperatedFeature {
} else {
tab.setAttribute('zen-pinned-changed', 'true');
}
tab.style.setProperty('--zen-original-tab-icon', `url(${pin.iconUrl?.spec})`);
tab.style.setProperty('--zen-original-tab-icon', `url(${pin.iconUrl})`);
}

removeTabContainersDragoverClass(hideIndicator = true) {
Expand Down
Loading