clients(devtools): require third-party-web to be provided (GoogleChro…

…me#16166)
olamidepeterojo · Sep 5, 2024 · 8a2f18a · 8a2f18a
1 parent ba1a46c
commit 8a2f18a
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 32 deletions.
diff --git a/build/build-bundle.js b/build/build-bundle.js
@@ -136,6 +136,11 @@ async function buildBundle(entryPath, distPath, opts = {minify: true}) {
     shimsObj[`${LH_ROOT}/shared/localization/locales.js`] = 'export const locales = {};';
   }
 
+  // Don't bundle third-party-web (CDT provides its own copy). This prevents duplications of 40+ KB.
+  if (isDevtools(entryPath)) {
+    shimsObj['third-party-web/nostats-subset.js'] = 'export default {};';
+  }
+
   for (const modulePath of modulesToIgnore) {
     shimsObj[modulePath] = 'export default {}';
   }

diff --git a/cli/test/smokehouse/lighthouse-runners/bundle.js b/cli/test/smokehouse/lighthouse-runners/bundle.js
@@ -18,6 +18,7 @@ import {once} from 'events';
 
 import puppeteer from 'puppeteer-core';
 import * as ChromeLauncher from 'chrome-launcher';
+import thirdPartyWebLib from 'third-party-web/nostats-subset.js';
 
 import {LH_ROOT} from '../../../../shared/root.js';
 import {loadArtifacts, saveArtifacts} from '../../../../core/lib/asset-saver.js';
@@ -74,6 +75,11 @@ async function runBundledLighthouse(url, config, testRunnerOptions) {
   // @ts-expect-error - not worth giving test global an actual type.
   const lighthouse = global.runBundledLighthouse;
 
+  /** @type {import('../../../../core/lib/third-party-web.js')['default']} */
+  // @ts-expect-error
+  const thirdPartyWeb = global.thirdPartyWeb;
+  thirdPartyWeb.provideThirdPartyWeb(thirdPartyWebLib);
+
   // Launch and connect to Chrome.
   const launchedChrome = await ChromeLauncher.launch({
     chromeFlags: [

diff --git a/clients/devtools/devtools-entry.js b/clients/devtools/devtools-entry.js
@@ -14,6 +14,7 @@ import lighthouse, {navigation, startTimespan, snapshot} from '../../core/index.
 import {lookupLocale} from '../../core/lib/i18n/i18n.js';
 import {registerLocaleData, getCanonicalLocales} from '../../shared/localization/format.js';
 import * as constants from '../../core/config/constants.js';
+import thirdPartyWeb from '../../core/lib/third-party-web.js';
 
 // Rollup seems to overlook some references to `Buffer`, so it must be made explicit.
 // (`parseSourceMapFromDataUrl` breaks without this)
@@ -68,47 +69,16 @@ function lookupCanonicalLocale(locales) {
   return lookupLocale(locales, getCanonicalLocales());
 }
 
-/**
- * TODO: Expose api directly when DevTools usage is updated.
- * @param {string} url
- * @param {{page: LH.Puppeteer.Page, config?: LH.Config, flags?: LH.Flags}} args
- */
-function runLighthouseNavigation(url, {page, ...options}) {
-  return navigation(page, url, options);
-}
-
-/**
- * TODO: Expose api directly when DevTools usage is updated.
- * @param {{page: LH.Puppeteer.Page, config?: LH.Config, flags?: LH.Flags}} args
- */
-function startLighthouseTimespan({page, ...options}) {
-  return startTimespan(page, options);
-}
-
-/**
- * TODO: Expose api directly when DevTools usage is updated.
- * @param {{page: LH.Puppeteer.Page, config?: LH.Config, flags?: LH.Flags}} args
- */
-function runLighthouseSnapshot({page, ...options}) {
-  return snapshot(page, options);
-}
-
 // Expose only in DevTools' worker
 if (typeof self !== 'undefined') {
   // TODO: refactor and delete `global.isDevtools`.
   global.isDevtools = true;
 
-  // @ts-expect-error
-  self.runLighthouseNavigation = runLighthouseNavigation;
   // @ts-expect-error
   self.navigation = navigation;
   // @ts-expect-error
-  self.startLighthouseTimespan = startLighthouseTimespan;
-  // @ts-expect-error
   self.startTimespan = startTimespan;
   // @ts-expect-error
-  self.runLighthouseSnapshot = runLighthouseSnapshot;
-  // @ts-expect-error
   self.snapshot = snapshot;
   // @ts-expect-error
   self.createConfig = createConfig;
@@ -119,8 +89,12 @@ if (typeof self !== 'undefined') {
   // TODO: expose as lookupCanonicalLocale in LighthouseService.ts?
   // @ts-expect-error
   self.lookupLocale = lookupCanonicalLocale;
+  // @ts-expect-error
+  self.thirdPartyWeb = thirdPartyWeb;
 } else {
   // For the bundle smoke test.
   // @ts-expect-error
   global.runBundledLighthouse = lighthouse;
+  // @ts-expect-error
+  global.thirdPartyWeb = thirdPartyWeb;
 }
diff --git a/core/lib/third-party-web.js b/core/lib/third-party-web.js
@@ -4,7 +4,18 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import thirdPartyWeb from 'third-party-web/nostats-subset.js';
+import thirdPartyWebLib from 'third-party-web/nostats-subset.js';
+
+let thirdPartyWeb = thirdPartyWebLib;
+
+/**
+ * For use by DevTools.
+ *
+ * @param {typeof import('third-party-web/nostats-subset.js')} providedThirdPartyWeb
+ */
+function provideThirdPartyWeb(providedThirdPartyWeb) {
+  thirdPartyWeb = providedThirdPartyWeb;
+}
 
 /** @typedef {import("third-party-web").IEntity} ThirdPartyEntity */
 /** @typedef {import("third-party-web").IProduct} ThirdPartyProduct */
@@ -45,6 +56,7 @@ function isFirstParty(url, mainDocumentEntity) {
 }
 
 export default {
+  provideThirdPartyWeb,
   getEntity,
   getProduct,
   isThirdParty,