core(fr): add page to context (#14359)

GoogleChrome · Sep 6, 2022 · 7ecd66b · 7ecd66b
1 parent fd304ed
commit 7ecd66b
Show file tree

Hide file tree

Showing 7 changed files with 35 additions and 8 deletions.
diff --git a/core/fraggle-rock/gather/navigation-runner.js b/core/fraggle-rock/gather/navigation-runner.js
@@ -28,6 +28,7 @@ import NetworkRecords from '../../computed/network-records.js';
 /**
  * @typedef NavigationContext
  * @property {Driver} driver
+ * @property {LH.Puppeteer.Page} page
  * @property {LH.Config.FRConfig} config
  * @property {LH.Config.NavigationDefn} navigation
  * @property {LH.NavigationRequestor} requestor
@@ -218,6 +219,7 @@ async function _navigation(navigationContext) {
     url: initialUrl,
     gatherMode: /** @type {const} */ ('navigation'),
     driver: navigationContext.driver,
+    page: navigationContext.page,
     computedCache: navigationContext.computedCache,
     artifactDefinitions: navigationContext.navigation.artifacts,
     artifactState,
@@ -250,10 +252,10 @@ async function _navigation(navigationContext) {
 }
 
 /**
- * @param {{driver: Driver, config: LH.Config.FRConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache']}} args
+ * @param {{driver: Driver, page: LH.Puppeteer.Page, config: LH.Config.FRConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache']}} args
  * @return {Promise<{artifacts: Partial<LH.FRArtifacts & LH.FRBaseArtifacts>}>}
  */
-async function _navigations({driver, config, requestor, baseArtifacts, computedCache}) {
+async function _navigations({driver, page, config, requestor, baseArtifacts, computedCache}) {
   if (!config.navigations) throw new Error('No navigations configured');
 
   /** @type {Partial<LH.FRArtifacts & LH.FRBaseArtifacts>} */
@@ -264,6 +266,7 @@ async function _navigations({driver, config, requestor, baseArtifacts, computedC
   for (const navigation of config.navigations) {
     const navigationContext = {
       driver,
+      page,
       navigation,
       requestor,
       config,
@@ -333,7 +336,7 @@ async function navigationGather(requestor, options) {
         requestor: normalizedRequestor,
       };
       const {baseArtifacts} = await _setup(context);
-      const {artifacts} = await _navigations({...context, baseArtifacts, computedCache});
+      const {artifacts} = await _navigations({...context, page, baseArtifacts, computedCache});
       await _cleanup(context);
 
       return finalizeArtifacts(baseArtifacts, artifacts);

diff --git a/core/fraggle-rock/gather/runner-helpers.js b/core/fraggle-rock/gather/runner-helpers.js
@@ -7,6 +7,7 @@
 /**
  * @typedef CollectPhaseArtifactOptions
  * @property {import('./driver.js').Driver} driver
+ * @property {LH.Puppeteer.Page} page
  * @property {Array<LH.Config.AnyArtifactDefn>} artifactDefinitions
  * @property {ArtifactState} artifactState
  * @property {LH.FRBaseArtifacts} baseArtifacts
@@ -66,6 +67,7 @@ const phaseToPriorPhase = {
 async function collectPhaseArtifacts(options) {
   const {
     driver,
+    page,
     artifactDefinitions,
     artifactState,
     baseArtifacts,
@@ -91,6 +93,7 @@ async function collectPhaseArtifacts(options) {
       return gatherer[phase]({
         gatherMode,
         driver,
+        page,
         baseArtifacts,
         dependencies,
         computedCache,

diff --git a/core/fraggle-rock/gather/snapshot-runner.js b/core/fraggle-rock/gather/snapshot-runner.js
@@ -17,11 +17,11 @@ import {getBaseArtifacts, finalizeArtifacts} from './base-artifacts.js';
  * @return {Promise<LH.Gatherer.FRGatherResult>}
  */
 async function snapshotGather(options) {
-  const {flags = {}} = options;
+  const {page, flags = {}} = options;
   log.setLevel(flags.logLevel || 'error');
 
   const {config} = await initializeConfig('snapshot', options.config, flags);
-  const driver = new Driver(options.page);
+  const driver = new Driver(page);
   await driver.connect();
 
   /** @type {Map<string, LH.ArbitraryEqualityMap>} */
@@ -43,6 +43,7 @@ async function snapshotGather(options) {
         phase: 'getArtifact',
         gatherMode: 'snapshot',
         driver,
+        page,
         baseArtifacts,
         artifactDefinitions,
         artifactState,

diff --git a/core/fraggle-rock/gather/timespan-runner.js b/core/fraggle-rock/gather/timespan-runner.js
@@ -18,11 +18,11 @@ import {getBaseArtifacts, finalizeArtifacts} from './base-artifacts.js';
  * @return {Promise<{endTimespanGather(): Promise<LH.Gatherer.FRGatherResult>}>}
  */
 async function startTimespanGather(options) {
-  const {flags = {}} = options;
+  const {page, flags = {}} = options;
   log.setLevel(flags.logLevel || 'error');
 
   const {config} = await initializeConfig('timespan', options.config, flags);
-  const driver = new Driver(options.page);
+  const driver = new Driver(page);
   await driver.connect();
 
   /** @type {Map<string, LH.ArbitraryEqualityMap>} */
@@ -34,6 +34,7 @@ async function startTimespanGather(options) {
   /** @type {Omit<import('./runner-helpers.js').CollectPhaseArtifactOptions, 'phase'>} */
   const phaseOptions = {
     driver,
+    page,
     artifactDefinitions,
     artifactState,
     baseArtifacts,

diff --git a/core/test/fraggle-rock/gather/navigation-runner-test.js b/core/test/fraggle-rock/gather/navigation-runner-test.js
@@ -46,6 +46,8 @@ describe('NavigationRunner', () => {
   let mockDriver;
   /** @type {import('../../../fraggle-rock/gather/driver.js').Driver} */
   let driver;
+  /** @type {LH.Puppeteer.Page} */
+  let page;
   /** @type {LH.Config.FRConfig} */
   let config;
   /** @type {LH.Config.NavigationDefn} */
@@ -113,6 +115,7 @@ describe('NavigationRunner', () => {
     mockDriver = createMockDriver();
     mockDriver.url.mockReturnValue('about:blank');
     driver = mockDriver.asDriver();
+    page = mockDriver._page.asPage();
 
     mocks.reset();
   });
@@ -186,7 +189,7 @@ describe('NavigationRunner', () => {
 
   describe('_navigations', () => {
     const run = () =>
-      runner._navigations({driver, config, requestor, computedCache, baseArtifacts});
+      runner._navigations({driver, page, config, requestor, computedCache, baseArtifacts});
 
     it('should throw if no navigations available', async () => {
       config = {...config, navigations: null};
@@ -312,6 +315,7 @@ describe('NavigationRunner', () => {
     /** @param {LH.Config.NavigationDefn} navigation */
     const run = navigation => runner._navigation({
       driver,
+      page,
       config,
       navigation,
       requestor,
@@ -334,6 +338,7 @@ describe('NavigationRunner', () => {
 
       const {artifacts} = await runner._navigation({
         driver,
+        page,
         config,
         navigation,
         requestor: requestedUrl,
@@ -351,6 +356,7 @@ describe('NavigationRunner', () => {
     it('skips about:blank if using a callback requestor', async () => {
       const {artifacts} = await runner._navigation({
         driver,
+        page,
         config,
         navigation,
         requestor: () => {},
@@ -491,6 +497,7 @@ describe('NavigationRunner', () => {
       navigation.blankPage = 'data:text/html;...';
       await runner._setupNavigation({
         driver,
+        page,
         navigation,
         requestor: requestedUrl,
         config,
@@ -507,6 +514,7 @@ describe('NavigationRunner', () => {
     it('should prepare target for navigation', async () => {
       await runner._setupNavigation({
         driver,
+        page,
         navigation,
         requestor: requestedUrl,
         config,
@@ -521,6 +529,7 @@ describe('NavigationRunner', () => {
       mocks.prepareMock.prepareTargetForIndividualNavigation.mockResolvedValue({warnings});
       const result = await runner._setupNavigation({
         driver,
+        page,
         navigation,
         requestor: requestedUrl,
         config,
@@ -535,6 +544,7 @@ describe('NavigationRunner', () => {
     const run = () =>
       runner._navigate({
         driver,
+        page,
         navigation,
         requestor,
         config,

diff --git a/core/test/fraggle-rock/gather/runner-helpers-test.js b/core/test/fraggle-rock/gather/runner-helpers-test.js
@@ -87,6 +87,8 @@ describe('collectPhaseArtifacts', () => {
 
   /** @type {ReturnType<ReturnType<typeof createMockDriver>['asDriver']>} */
   let driver;
+  /** @type {LH.Puppeteer.Page} */
+  let page;
   /** @type {ReturnType<typeof createMockDriver>} */
   let mockDriver;
   /** @type {LH.FRBaseArtifacts} */
@@ -112,6 +114,7 @@ describe('collectPhaseArtifacts', () => {
 
   beforeEach(() => {
     mockDriver = createMockDriver();
+    page = mockDriver._page.asPage();
     driver = mockDriver.asDriver();
     artifactState = {
       startInstrumentation: {},
@@ -130,6 +133,7 @@ describe('collectPhaseArtifacts', () => {
         const {artifactDefinitions, gatherers} = createGathererSet();
         await helpers.collectPhaseArtifacts({
           driver,
+          page,
           artifactDefinitions,
           artifactState,
           phase,
@@ -154,6 +158,7 @@ describe('collectPhaseArtifacts', () => {
     const {artifactDefinitions} = createGathererSet();
     await helpers.collectPhaseArtifacts({
       driver,
+      page,
       artifactDefinitions,
       artifactState,
       gatherMode: 'navigation',
@@ -186,6 +191,7 @@ describe('collectPhaseArtifacts', () => {
 
     await helpers.collectPhaseArtifacts({
       driver,
+      page,
       artifactDefinitions,
       artifactState,
       gatherMode: 'navigation',
@@ -219,6 +225,7 @@ describe('collectPhaseArtifacts', () => {
     const {artifactDefinitions, gatherers} = createGathererSet();
     await helpers.collectPhaseArtifacts({
       driver,
+      page,
       artifactDefinitions,
       artifactState,
       gatherMode: 'navigation',

diff --git a/types/gatherer.d.ts b/types/gatherer.d.ts
@@ -52,6 +52,8 @@ declare module Gatherer {
     gatherMode: GatherMode;
     /** The connection to the page being analyzed. */
     driver: FRTransitionalDriver;
+    /** The Puppeteer page handle. Will be undefined in legacy navigation mode. */
+    page?: LH.Puppeteer.Page;
     /** The set of base artifacts that are always collected. */
     baseArtifacts: FRBaseArtifacts;
     /** The cached results of computed artifacts. */