/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
import { actionCreators as ac, actionTypes as at } from "common/Actions.mjs";
import { DiscoveryStreamAdmin } from "content-src/components/DiscoveryStreamAdmin/DiscoveryStreamAdmin";
import { ConfirmDialog } from "content-src/components/ConfirmDialog/ConfirmDialog";
import { connect } from "react-redux";
import { DiscoveryStreamBase } from "content-src/components/DiscoveryStreamBase/DiscoveryStreamBase";
import { ErrorBoundary } from "content-src/components/ErrorBoundary/ErrorBoundary";
import { CustomizeMenu } from "content-src/components/CustomizeMenu/CustomizeMenu";
import { BaseContext } from "content-src/lib/BaseContext";
import React, { useState, useEffect } from "react";
import { Search } from "content-src/components/Search/Search";
import { TopSites } from "content-src/components/TopSites/TopSites";
import { Sections } from "content-src/components/Sections/Sections";
import { Logo } from "content-src/components/Logo/Logo";
import { Weather } from "content-src/components/Weather/Weather";
import { WidgetsSidebar } from "content-src/components/Widgets/WidgetsSidebar";
import { DownloadModalToggle } from "content-src/components/DownloadModalToggle/DownloadModalToggle";
import { Notifications } from "content-src/components/Notifications/Notifications";
import { TopicSelection } from "content-src/components/DiscoveryStreamComponents/TopicSelection/TopicSelection";
import { DownloadMobilePromoHighlight } from "../DiscoveryStreamComponents/FeatureHighlight/DownloadMobilePromoHighlight";
import { WallpaperFeatureHighlight } from "../DiscoveryStreamComponents/FeatureHighlight/WallpaperFeatureHighlight";
import { ActivationWindowMessage } from "../ActivationWindowMessage/ActivationWindowMessage";
import { MessageWrapper } from "content-src/components/MessageWrapper/MessageWrapper";
import { ExternalComponentWrapper } from "content-src/components/ExternalComponentWrapper/ExternalComponentWrapper";
import {
ASROUTER_NEWTAB_MESSAGE_POSITIONS,
shouldShowOMCHighlight,
shouldShowASRouterNewTabMessage,
} from "../../lib/asrouter-message-utils.mjs";
import {
WIDGET_REGISTRY,
isWidgetEnabled,
isWidgetToggleVisible,
isWidgetsContainerVisible,
resolveWidgetHasSidebar,
resolveWidgetSize,
} from "common/WidgetsRegistry.mjs";
const VISIBLE = "visible";
const VISIBILITY_CHANGE_EVENT = "visibilitychange";
// Minimum scroll distance in pixels to record a scroll telemetry event.
const SCROLL_TELEMETRY_THRESHOLD = 50;
const PREF_INFERRED_PERSONALIZATION_SYSTEM =
"discoverystream.sections.personalization.inferred.enabled";
const PREF_INFERRED_PERSONALIZATION_USER =
"discoverystream.sections.personalization.inferred.user.enabled";
// @nova-cleanup(remove-pref): Remove PREF_NOVA_ENABLED
const PREF_NOVA_ENABLED = "nova.enabled";
// Returns a function will not be continuously triggered when called. The
// function will be triggered if called again after `wait` milliseconds.
function debounce(func, wait) {
let timer;
return (...args) => {
if (timer) {
return;
}
let wakeUp = () => {
timer = null;
};
timer = setTimeout(wakeUp, wait);
func.apply(this, args);
};
}
export function WithDsAdmin(props) {
const { hash = globalThis?.location?.hash || "" } = props;
const [devtoolsCollapsed, setDevtoolsCollapsed] = useState(
!hash.startsWith("#devtools")
);
useEffect(() => {
const onHashChange = () => {
const h = globalThis?.location?.hash || "";
setDevtoolsCollapsed(!h.startsWith("#devtools"));
};
// run once in case hash changed before mount
onHashChange();
globalThis?.addEventListener("hashchange", onHashChange);
return () => globalThis?.removeEventListener("hashchange", onHashChange);
}, []);
return (
<>
{devtoolsCollapsed ? : null}
>
);
}
export function _Base(props) {
const isDevtoolsEnabled = props.Prefs.values["asrouter.devtoolsEnabled"];
const { App } = props;
if (!App.initialized) {
return null;
}
return (
{isDevtoolsEnabled ? (
) : (
)}
);
}
export class BaseContent extends React.PureComponent {
constructor(props) {
super(props);
this.openPreferences = this.openPreferences.bind(this);
this.openCustomizationMenu = this.openCustomizationMenu.bind(this);
this.closeCustomizationMenu = this.closeCustomizationMenu.bind(this);
this.onWindowScroll = debounce(this.onWindowScroll.bind(this), 5);
this.setPref = this.setPref.bind(this);
this.updateWallpaper = this.updateWallpaper.bind(this);
this.prefersDarkQuery = null;
this.handleColorModeChange = this.handleColorModeChange.bind(this);
this.onVisible = this.onVisible.bind(this);
this.toggleDownloadHighlight = this.toggleDownloadHighlight.bind(this);
this.handleDismissDownloadHighlight =
this.handleDismissDownloadHighlight.bind(this);
this.applyBodyClasses = this.applyBodyClasses.bind(this);
this.toggleSectionsMgmtPanel = this.toggleSectionsMgmtPanel.bind(this);
this.toggleWidgetsManagementPanel =
this.toggleWidgetsManagementPanel.bind(this);
this.openWidgetsPanel = this.openWidgetsPanel.bind(this);
this.attachSearchSentinel = this.attachSearchSentinel.bind(this);
this.onSearchSentinelIntersect = this.onSearchSentinelIntersect.bind(this);
this.searchStickyObserver = null;
this._hasScrolledForSession = false;
this.state = {
fixedSearch: false,
colorMode: "",
fixedNavStyle: {},
wallpaperTheme: "",
showDownloadHighlightOverride: null,
visible: false,
showSectionsMgmtPanel: false,
showWidgetsManagementPanel: false,
};
this.spocPlaceholderStartTime = null;
}
attachSearchSentinel(el) {
if (this.searchStickyObserver) {
this.searchStickyObserver.disconnect();
this.searchStickyObserver = null;
}
if (el) {
this.searchStickyObserver = new IntersectionObserver(
this.onSearchSentinelIntersect,
{ threshold: 0 }
);
this.searchStickyObserver.observe(el);
} else if (this.state.fixedSearch) {
this.setState({ fixedSearch: false });
}
}
onSearchSentinelIntersect(entries) {
const entry = entries[entries.length - 1];
const stuck = !entry.isIntersecting && entry.boundingClientRect.top < 0;
if (stuck !== this.state.fixedSearch) {
this.setState({ fixedSearch: stuck });
}
}
onVisible() {
this.setState({
visible: true,
});
this.shouldDisplayTopicSelectionModal();
this.onVisibilityDispatch();
if (this.isSpocsOnDemandExpired && !this.spocPlaceholderStartTime) {
this.spocPlaceholderStartTime = Date.now();
}
}
onVisibilityDispatch() {
const { onDemand = {} } = this.props.DiscoveryStream.spocs;
// We only need to dispatch this if:
// 1. onDemand is enabled,
// 2. onDemand spocs have not been loaded on this tab.
// 3. Spocs are expired.
if (onDemand.enabled && !onDemand.loaded && this.isSpocsOnDemandExpired) {
// This dispatches that spocs are expired and we need to update them.
this.props.dispatch(
ac.OnlyToMain({
type: at.DISCOVERY_STREAM_SPOCS_ONDEMAND_UPDATE,
})
);
}
}
get isSpocsOnDemandExpired() {
const {
onDemand = {},
cacheUpdateTime,
lastUpdated,
} = this.props.DiscoveryStream.spocs;
// We can bail early if:
// 1. onDemand is off,
// 2. onDemand spocs have been loaded on this tab.
if (!onDemand.enabled || onDemand.loaded) {
return false;
}
return Date.now() - lastUpdated >= cacheUpdateTime;
}
spocsOnDemandUpdated() {
const { onDemand = {}, loaded } = this.props.DiscoveryStream.spocs;
// We only need to fire this if:
// 1. Spoc data is loaded.
// 2. onDemand is enabled.
// 3. The component is visible (not preloaded tab).
// 4. onDemand spocs have not been loaded on this tab.
// 5. Spocs are not expired.
if (
loaded &&
onDemand.enabled &&
this.state.visible &&
!onDemand.loaded &&
!this.isSpocsOnDemandExpired
) {
// This dispatches that spocs have been loaded on this tab
// and we don't need to update them again for this tab.
this.props.dispatch(
ac.BroadcastToContent({ type: at.DISCOVERY_STREAM_SPOCS_ONDEMAND_LOAD })
);
}
}
componentDidMount() {
this.applyBodyClasses();
global.addEventListener("scroll", this.onWindowScroll);
const prefs = this.props.Prefs.values;
const novaEnabled = prefs[PREF_NOVA_ENABLED];
const wallpapersEnabled = prefs["newtabWallpapers.enabled"];
const wallpapersUserEnabled = prefs["newtabWallpapers.user.enabled"];
if (this.props.document.visibilityState === VISIBLE) {
this.onVisible();
} else {
this._onVisibilityChange = () => {
if (this.props.document.visibilityState === VISIBLE) {
this.onVisible();
this.props.document.removeEventListener(
VISIBILITY_CHANGE_EVENT,
this._onVisibilityChange
);
this._onVisibilityChange = null;
}
};
this.props.document.addEventListener(
VISIBILITY_CHANGE_EVENT,
this._onVisibilityChange
);
}
// track change event to dark/light mode
this.prefersDarkQuery = globalThis.matchMedia(
"(prefers-color-scheme: dark)"
);
this.prefersDarkQuery.addEventListener(
"change",
this.handleColorModeChange
);
this.handleColorModeChange();
const isWallpaperVisible = novaEnabled
? wallpapersEnabled && wallpapersUserEnabled
: wallpapersEnabled;
if (isWallpaperVisible) {
this.updateWallpaper();
}
this._onHashChange = () => {
const hash = globalThis.location?.hash || "";
if (hash === "#customize" || hash === "#customize-topics") {
this.openCustomizationMenu();
if (hash === "#customize-topics") {
this.toggleSectionsMgmtPanel();
}
} else if (this.props.App.customizeMenuVisible) {
this.closeCustomizationMenu();
}
};
// Using the Performance API to detect page reload vs fresh navigation.
// Only open customize menu on fresh navigation, not on page refresh.
// See: https://developer.mozilla.org/en-US/docs/Web/API/Performance/getEntriesByType
// See: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceEntry/entryType#navigation
// See: https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming/type
const isReload =
globalThis.performance?.getEntriesByType("navigation")[0]?.type ===
"reload";
if (!isReload) {
this._onHashChange();
}
globalThis.addEventListener("hashchange", this._onHashChange);
}
componentDidUpdate(prevProps) {
this.applyBodyClasses();
const prefs = this.props.Prefs.values;
// Check if weather widget was re-enabled from customization menu
// @nova-cleanup(remove-conditional): Remove novaEnabledInUpdate and weatherPref variables; replace wasWeatherDisabled/isWeatherEnabled with direct reads of prevProps/props.Prefs.values["widgets.weather.enabled"]
const novaEnabledInUpdate = this.props.Prefs.values["nova.enabled"];
const weatherPref = novaEnabledInUpdate
? "widgets.weather.enabled"
: "showWeather";
const wasWeatherDisabled = !prevProps.Prefs.values[weatherPref];
const isWeatherEnabled = this.props.Prefs.values[weatherPref];
if (wasWeatherDisabled && isWeatherEnabled) {
// If weather widget was enabled from customization menu, display opt-in dialog
this.props.dispatch(ac.SetPref("weather.optInDisplayed", true));
}
const novaEnabled = prefs[PREF_NOVA_ENABLED];
const wallpapersEnabled = prefs["newtabWallpapers.enabled"];
const wallpapersUserEnabled = prefs["newtabWallpapers.user.enabled"];
// Previous values of the wallpaper prefs, used to compare against the
// current values and detect what changed since the last render.
const prevNovaEnabled = prevProps.Prefs.values[PREF_NOVA_ENABLED];
const prevWallpapersEnabled =
prevProps.Prefs.values["newtabWallpapers.enabled"];
const prevWallpapersUserEnabled =
prevProps.Prefs.values["newtabWallpapers.user.enabled"];
const isWallpaperActive = novaEnabled
? wallpapersEnabled && wallpapersUserEnabled
: wallpapersEnabled;
// This checks if the wallpaper was active before this update so that we can
// detect when it just turned off and clear it from the background.
const wasWallpaperActive = prevNovaEnabled
? prevWallpapersEnabled && prevWallpapersUserEnabled
: prevWallpapersEnabled;
if (isWallpaperActive) {
// destructure current and previous props with fallbacks
// (preventing undefined errors)
const {
Wallpapers: { uploadedWallpaper = null, wallpaperList = null } = {},
} = this.props;
const {
Wallpapers: {
uploadedWallpaper: prevUploadedWallpaper = null,
wallpaperList: prevWallpaperList = null,
} = {},
Prefs: { values: prevPrefs = {} } = {},
} = prevProps;
const selectedWallpaper = prefs["newtabWallpapers.wallpaper"];
const prevSelectedWallpaper = prevPrefs["newtabWallpapers.wallpaper"];
const initialWallpaper = prefs["newtabWallpapers.initialWallpaper"];
const prevInitialWallpaper =
prevPrefs["newtabWallpapers.initialWallpaper"];
const uploadedWallpaperTheme =
prefs["newtabWallpapers.customWallpaper.theme"];
const prevUploadedWallpaperTheme =
prevPrefs["newtabWallpapers.customWallpaper.theme"];
// don't update wallpaper unless the wallpaper is being changed.
if (
!wasWallpaperActive || // the wallpaper wasn't active last render but is now, meaning it was just enabled, force an apply even if nothing else changed
selectedWallpaper !== prevSelectedWallpaper || // selecting a new wallpaper
initialWallpaper !== prevInitialWallpaper || // experiment sets initial wallpaper
uploadedWallpaper !== prevUploadedWallpaper || // uploading a new wallpaper
wallpaperList !== prevWallpaperList || // remote settings wallpaper list updates
this.props.App.isForStartupCache.Wallpaper !==
prevProps.App.isForStartupCache.Wallpaper || // Startup cached page wallpaper is updating
uploadedWallpaperTheme !== prevUploadedWallpaperTheme
) {
this.updateWallpaper();
}
} else if (wasWallpaperActive) {
// The wallpaper was active last render but isn't anymore, meaning it was just turned off — clear it from the background
this.updateWallpaper();
}
this.spocsOnDemandUpdated();
this.trackSpocPlaceholderDuration(prevProps);
}
trackSpocPlaceholderDuration(prevProps) {
// isExpired returns true when the current props have expired spocs (showing placeholders)
const isExpired = this.isSpocsOnDemandExpired;
// Init tracking when placeholders become visible
if (isExpired && this.state.visible && !this.spocPlaceholderStartTime) {
this.spocPlaceholderStartTime = Date.now();
}
// wasExpired returns true when the previous props had expired spocs (showing placeholders)
const wasExpired =
prevProps.DiscoveryStream.spocs.onDemand?.enabled &&
!prevProps.DiscoveryStream.spocs.onDemand?.loaded &&
Date.now() - prevProps.DiscoveryStream.spocs.lastUpdated >=
prevProps.DiscoveryStream.spocs.cacheUpdateTime;
// Record duration telemetry event when placeholders are replaced with real content
if (wasExpired && !isExpired && this.spocPlaceholderStartTime) {
const duration = Date.now() - this.spocPlaceholderStartTime;
this.props.dispatch(
ac.OnlyToMain({
type: at.DISCOVERY_STREAM_SPOC_PLACEHOLDER_DURATION,
data: { duration },
})
);
this.spocPlaceholderStartTime = null;
}
}
handleColorModeChange() {
const colorMode = this.prefersDarkQuery?.matches ? "dark" : "light";
if (colorMode !== this.state.colorMode) {
this.setState({ colorMode });
this.updateWallpaper();
}
}
componentWillUnmount() {
this.prefersDarkQuery?.removeEventListener(
"change",
this.handleColorModeChange
);
global.removeEventListener("scroll", this.onWindowScroll);
if (this._onVisibilityChange) {
this.props.document.removeEventListener(
VISIBILITY_CHANGE_EVENT,
this._onVisibilityChange
);
}
if (this._onHashChange) {
globalThis.removeEventListener("hashchange", this._onHashChange);
}
if (this.searchStickyObserver) {
this.searchStickyObserver.disconnect();
this.searchStickyObserver = null;
}
}
onWindowScroll() {
if (
!this._hasScrolledForSession &&
global.scrollY > SCROLL_TELEMETRY_THRESHOLD
) {
this._hasScrolledForSession = true;
this.props.dispatch(ac.OnlyToMain({ type: at.NEW_TAB_SCROLL }));
}
if (this.props.Prefs.values[PREF_NOVA_ENABLED]) {
// Nova restores sticky search via IntersectionObserver
// (attachSearchSentinel); the scroll-based fixed-search math below
// is classic-only.
return;
}
if (window.innerHeight <= 700) {
// Bug 1937296: Only apply fixed-search logic
// if the page is tall enough to support it.
return;
}
const prefs = this.props.Prefs.values;
const { showSearch } = prefs;
if (!showSearch) {
// Bug 1944718: Only apply fixed-search logic
// if search is visible.
return;
}
const logoAlwaysVisible = prefs["logowordmark.alwaysVisible"];
/* Bug 1917937: The logic presented below is fragile but accurate to the pixel. As new tab experiments with layouts, we have a tech debt of competing styles and classes the slightly modify where the search bar sits on the page. The larger solution for this is to replace everything with an intersection observer, but would require a larger refactor of this file. In the interim, we can programmatically calculate when to fire the fixed-scroll event and account for the moved elements so that topsites/etc stays in the same place. The CSS this references has been flagged to reference this logic so (hopefully) keep them in sync. */
let SCROLL_THRESHOLD = 0; // When the fixed-scroll event fires
let MAIN_OFFSET_PADDING = 0; // The padding to compensate for the moved elements
const CSS_VAR_SPACE_XXLARGE = 32.04; // Custom Acorn themed variable (8 * 0.267rem);
let layout = {
outerWrapperPaddingTop: 32.04,
searchWrapperPaddingTop: 16.02,
searchWrapperPaddingBottom: CSS_VAR_SPACE_XXLARGE,
searchWrapperFixedScrollPaddingTop: 24.03,
searchWrapperFixedScrollPaddingBottom: 24.03,
searchInnerWrapperMinHeight: 52,
logoAndWordmarkWrapperHeight: 0,
logoAndWordmarkWrapperMarginBottom: 0,
};
// Logo visibility applies to all layouts
if (!logoAlwaysVisible) {
layout.logoAndWordmarkWrapperHeight = 0;
layout.logoAndWordmarkWrapperMarginBottom = 0;
}
SCROLL_THRESHOLD =
layout.outerWrapperPaddingTop +
layout.searchWrapperPaddingTop +
layout.logoAndWordmarkWrapperHeight +
layout.logoAndWordmarkWrapperMarginBottom -
layout.searchWrapperFixedScrollPaddingTop;
MAIN_OFFSET_PADDING =
layout.searchWrapperPaddingTop +
layout.searchWrapperPaddingBottom +
layout.searchInnerWrapperMinHeight +
layout.logoAndWordmarkWrapperHeight +
layout.logoAndWordmarkWrapperMarginBottom;
// Edge case if logo and thums are turned off, but Var A is enabled
if (SCROLL_THRESHOLD < 1) {
SCROLL_THRESHOLD = 1;
}
if (global.scrollY > SCROLL_THRESHOLD && !this.state.fixedSearch) {
this.setState({
fixedSearch: true,
fixedNavStyle: { paddingBlockStart: `${MAIN_OFFSET_PADDING}px` },
});
} else if (global.scrollY <= SCROLL_THRESHOLD && this.state.fixedSearch) {
this.setState({ fixedSearch: false, fixedNavStyle: {} });
}
}
openPreferences() {
this.props.dispatch(ac.OnlyToMain({ type: at.SETTINGS_OPEN }));
this.props.dispatch(ac.UserEvent({ event: "OPEN_NEWTAB_PREFS" }));
}
openCustomizationMenu() {
this.props.dispatch({ type: at.SHOW_PERSONALIZE });
this.props.dispatch(ac.UserEvent({ event: "SHOW_PERSONALIZE" }));
}
closeCustomizationMenu() {
if (this.props.App.customizeMenuVisible) {
this.props.dispatch({ type: at.HIDE_PERSONALIZE });
this.props.dispatch(ac.UserEvent({ event: "HIDE_PERSONALIZE" }));
}
}
setPref(pref, value) {
this.props.dispatch(ac.SetPref(pref, value));
}
applyBodyClasses() {
const { body, documentElement } = this.props.document;
if (documentElement) {
documentElement.classList.toggle(
"nova-tokens",
!!this.props.Prefs.values[PREF_NOVA_ENABLED]
);
}
if (!body) {
return;
}
if (!body.classList.contains("activity-stream")) {
body.classList.add("activity-stream");
}
}
renderWallpaperAttribution() {
const { wallpaperList } = this.props.Wallpapers;
const activeWallpaper =
this.props.Prefs.values[`newtabWallpapers.wallpaper`] ||
this.props.Prefs.values[`newtabWallpapers.initialWallpaper`];
const selected = wallpaperList.find(wp => wp.title === activeWallpaper);
// make sure a wallpaper is selected and that the attribution also exists
if (!selected?.attribution) {
return null;
}
const { name: authorDetails, webpage } = selected.attribution;
if (activeWallpaper && wallpaperList && authorDetails.url) {
return (
{wallpapersEnabled && this.renderWallpaperAttribution()}
{/* Only show the modal on currently visible pages (not preloaded) */}
{mayShowTopicSelection && pocketEnabled && (
)}