gecko-dev/browser/actors/AboutNewTabChild.sys.mjs

105 lines
4.0 KiB
JavaScript

/* vim: set ts=2 sw=2 sts=2 et tw=80: */
/* 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 { XPCOMUtils } from "resource://gre/modules/XPCOMUtils.sys.mjs";
import { AppConstants } from "resource://gre/modules/AppConstants.sys.mjs";
import { PrivateBrowsingUtils } from "resource://gre/modules/PrivateBrowsingUtils.sys.mjs";
import { RemotePageChild } from "resource://gre/actors/RemotePageChild.sys.mjs";
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
NimbusFeatures: "resource://nimbus/ExperimentAPI.sys.mjs",
});
XPCOMUtils.defineLazyPreferenceGetter(
lazy,
"ACTIVITY_STREAM_DEBUG",
"browser.newtabpage.activity-stream.debug",
false
);
let gNextPortID = 0;
export class AboutNewTabChild extends RemotePageChild {
handleEvent(event) {
if (event.type == "DOMDocElementInserted") {
let portID = Services.appinfo.processID + ":" + ++gNextPortID;
this.sendAsyncMessage("Init", {
portID,
url: this.contentWindow.document.documentURI.replace(/[\#|\?].*$/, ""),
});
} else if (event.type == "load") {
this.sendAsyncMessage("Load");
} else if (event.type == "DOMContentLoaded") {
if (!this.contentWindow.document.body.firstElementChild) {
return; // about:newtab is a blank page
}
// If the separate about:welcome page is enabled, we can skip all of this,
// since that mode doesn't load any of the Activity Stream bits.
if (
(lazy.NimbusFeatures.aboutwelcome.getVariable("enabled") ?? true) &&
this.contentWindow.location.pathname.includes("welcome")
) {
return;
}
const debug = !AppConstants.RELEASE_OR_BETA && lazy.ACTIVITY_STREAM_DEBUG;
const debugString = debug ? "-dev" : "";
// This list must match any similar ones in render-activity-stream-html.js.
const scripts = [
"chrome://browser/content/contentSearchUI.js",
"chrome://browser/content/contentSearchHandoffUI.js",
"chrome://browser/content/contentTheme.js",
`resource://activity-stream/vendor/react${debugString}.js`,
`resource://activity-stream/vendor/react-dom${debugString}.js`,
"resource://activity-stream/vendor/prop-types.js",
"resource://activity-stream/vendor/react-transition-group.js",
"resource://activity-stream/vendor/redux.js",
"resource://activity-stream/vendor/react-redux.js",
"resource://activity-stream/data/content/activity-stream.bundle.js",
"resource://activity-stream/data/content/newtab-render.js",
];
for (let script of scripts) {
Services.scriptloader.loadSubScript(script, this.contentWindow);
}
} else if (event.type == "unload") {
try {
this.sendAsyncMessage("Unload");
} catch (e) {
// If the tab has been closed the frame message manager has already been
// destroyed
}
} else if (
(event.type == "pageshow" || event.type == "visibilitychange") &&
// The default browser notification shouldn't be shown on about:welcome
// since we don't want to distract from the onboarding wizard.
!this.contentWindow.location.pathname.includes("welcome")
) {
// Don't show the notification in non-permanent private windows
// since it is expected to have very little opt-in here.
let contentWindowPrivate = PrivateBrowsingUtils.isContentWindowPrivate(
this.contentWindow
);
if (
this.document.visibilityState == "visible" &&
(!contentWindowPrivate ||
(contentWindowPrivate &&
PrivateBrowsingUtils.permanentPrivateBrowsing))
) {
this.sendAsyncMessage("AboutNewTabVisible");
// Note: newtab feature info is currently being loaded in PrefsFeed.sys.mjs,
// But we're recording exposure events here.
lazy.NimbusFeatures.newtab.recordExposureEvent({ once: true });
}
}
}
}