Skip to content

core: rename resolved config types #14647

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

Merged
merged 3 commits into from
Jan 4, 2023
Merged

core: rename resolved config types #14647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
80636ba
core: rename resolved config types
adamraine Jan 4, 2023
7e3131e
resolved
adamraine Jan 4, 2023
12d552c
back a few
adamraine Jan 4, 2023
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
8 changes: 4 additions & 4 deletions core/config/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ function resolveFakeNavigations(artifactDefns, settings) {
* @param {LH.Gatherer.GatherMode} gatherMode
* @param {LH.Config.Json=} configJSON
* @param {LH.Flags=} flags
* @return {Promise<{resolvedConfig: LH.Config.FRConfig, warnings: string[]}>}
* @return {Promise<{resolvedConfig: LH.Config.ResolvedConfig, warnings: string[]}>}
*/
async function initializeConfig(gatherMode, configJSON, flags = {}) {
const status = {msg: 'Initialize config', id: 'lh:config'};
Expand All @@ -256,7 +256,7 @@ async function initializeConfig(gatherMode, configJSON, flags = {}) {

const navigations = resolveFakeNavigations(artifacts, settings);

/** @type {LH.Config.FRConfig} */
/** @type {LH.Config.ResolvedConfig} */
let resolvedConfig = {
artifacts,
navigations,
Expand All @@ -276,11 +276,11 @@ async function initializeConfig(gatherMode, configJSON, flags = {}) {
}

/**
* @param {LH.Config.FRConfig} resolvedConfig
* @param {LH.Config.ResolvedConfig} resolvedConfig
* @return {string}
*/
function getConfigDisplayString(resolvedConfig) {
/** @type {LH.Config.FRConfig} */
/** @type {LH.Config.ResolvedConfig} */
const resolvedConfigCopy = JSON.parse(JSON.stringify(resolvedConfig));

if (resolvedConfigCopy.navigations) {
Expand Down
46 changes: 23 additions & 23 deletions core/config/filters.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ const filterResistantArtifactIds = ['Stacks', 'NetworkUserAgent'];
* If `onlyCategories` is not set, this function returns the list of all audit IDs across all
* categories.
*
* @param {LH.Config.FRConfig['categories']} allCategories
* @param {LH.Config.ResolvedConfig['categories']} allCategories
* @param {string[] | undefined} onlyCategories
* @return {Set<string>}
*/
Expand All @@ -55,9 +55,9 @@ function getAuditIdsInCategories(allCategories, onlyCategories) {
/**
* Filters an array of artifacts down to the set that's required by the specified audits.
*
* @param {LH.Config.FRConfig['artifacts']} artifacts
* @param {LH.Config.FRConfig['audits']} audits
* @return {LH.Config.FRConfig['artifacts']}
* @param {LH.Config.ResolvedConfig['artifacts']} artifacts
* @param {LH.Config.ResolvedConfig['audits']} audits
* @return {LH.Config.ResolvedConfig['artifacts']}
*/
function filterArtifactsByAvailableAudits(artifacts, audits) {
if (!artifacts) return null;
Expand Down Expand Up @@ -95,9 +95,9 @@ function filterArtifactsByAvailableAudits(artifacts, audits) {
/**
* Filters an array of artifacts down to the set that supports the specified gather mode.
*
* @param {LH.Config.FRConfig['artifacts']} artifacts
* @param {LH.Config.ResolvedConfig['artifacts']} artifacts
* @param {LH.Gatherer.GatherMode} mode
* @return {LH.Config.FRConfig['artifacts']}
* @return {LH.Config.ResolvedConfig['artifacts']}
*/
function filterArtifactsByGatherMode(artifacts, mode) {
if (!artifacts) return null;
Expand All @@ -109,9 +109,9 @@ function filterArtifactsByGatherMode(artifacts, mode) {
/**
* Filters an array of navigations down to the set supported by the available artifacts.
*
* @param {LH.Config.FRConfig['navigations']} navigations
* @param {LH.Config.ResolvedConfig['navigations']} navigations
* @param {Array<LH.Config.AnyArtifactDefn>} availableArtifacts
* @return {LH.Config.FRConfig['navigations']}
* @return {LH.Config.ResolvedConfig['navigations']}
*/
function filterNavigationsByAvailableArtifacts(navigations, availableArtifacts) {
if (!navigations) return navigations;
Expand All @@ -133,9 +133,9 @@ function filterNavigationsByAvailableArtifacts(navigations, availableArtifacts)
/**
* Filters an array of audits down to the set that can be computed using only the specified artifacts.
*
* @param {LH.Config.FRConfig['audits']} audits
* @param {LH.Config.ResolvedConfig['audits']} audits
* @param {Array<LH.Config.AnyArtifactDefn>} availableArtifacts
* @return {LH.Config.FRConfig['audits']}
* @return {LH.Config.ResolvedConfig['audits']}
*/
function filterAuditsByAvailableArtifacts(audits, availableArtifacts) {
if (!audits) return null;
Expand All @@ -152,9 +152,9 @@ function filterAuditsByAvailableArtifacts(audits, availableArtifacts) {
/**
* Optional `supportedModes` property can explicitly exclude an audit even if all required artifacts are available.
*
* @param {LH.Config.FRConfig['audits']} audits
* @param {LH.Config.ResolvedConfig['audits']} audits
* @param {LH.Gatherer.GatherMode} mode
* @return {LH.Config.FRConfig['audits']}
* @return {LH.Config.ResolvedConfig['audits']}
*/
function filterAuditsByGatherMode(audits, mode) {
if (!audits) return null;
Expand All @@ -168,9 +168,9 @@ function filterAuditsByGatherMode(audits, mode) {
/**
* Optional `supportedModes` property can explicitly exclude a category even if some audits are available.
*
* @param {LH.Config.Config['categories']} categories
* @param {LH.Config.LegacyResolvedConfig['categories']} categories
* @param {LH.Gatherer.GatherMode} mode
* @return {LH.Config.Config['categories']}
* @return {LH.Config.LegacyResolvedConfig['categories']}
*/
function filterCategoriesByGatherMode(categories, mode) {
if (!categories) return null;
Expand All @@ -185,9 +185,9 @@ function filterCategoriesByGatherMode(categories, mode) {
/**
* Filters a categories object and their auditRefs down to the specified category ids.
*
* @param {LH.Config.Config['categories']} categories
* @param {LH.Config.LegacyResolvedConfig['categories']} categories
* @param {string[] | null | undefined} onlyCategories
* @return {LH.Config.Config['categories']}
* @return {LH.Config.LegacyResolvedConfig['categories']}
*/
function filterCategoriesByExplicitFilters(categories, onlyCategories) {
if (!categories || !onlyCategories) return categories;
Expand All @@ -201,7 +201,7 @@ function filterCategoriesByExplicitFilters(categories, onlyCategories) {
* Logs a warning if any specified onlyCategory is not a known category that can
* be included.
*
* @param {LH.Config.Config['categories']} allCategories
* @param {LH.Config.LegacyResolvedConfig['categories']} allCategories
* @param {string[] | null} onlyCategories
* @return {void}
*/
Expand All @@ -219,9 +219,9 @@ function warnOnUnknownOnlyCategories(allCategories, onlyCategories) {
* Filters a categories object and their auditRefs down to the set that can be computed using
* only the specified audits.
*
* @param {LH.Config.Config['categories']} categories
* @param {LH.Config.LegacyResolvedConfig['categories']} categories
* @param {Array<LH.Config.AuditDefn>} availableAudits
* @return {LH.Config.Config['categories']}
* @return {LH.Config.LegacyResolvedConfig['categories']}
*/
function filterCategoriesByAvailableAudits(categories, availableAudits) {
if (!categories) return categories;
Expand Down Expand Up @@ -257,9 +257,9 @@ function filterCategoriesByAvailableAudits(categories, availableAudits) {
/**
* Filters a config's artifacts, audits, and categories down to the set that supports the specified gather mode.
*
* @param {LH.Config.FRConfig} resolvedConfig
* @param {LH.Config.ResolvedConfig} resolvedConfig
* @param {LH.Gatherer.GatherMode} mode
* @return {LH.Config.FRConfig}
* @return {LH.Config.ResolvedConfig}
*/
function filterConfigByGatherMode(resolvedConfig, mode) {
const artifacts = filterArtifactsByGatherMode(resolvedConfig.artifacts, mode);
Expand All @@ -280,9 +280,9 @@ function filterConfigByGatherMode(resolvedConfig, mode) {
* Filters a config's artifacts, audits, and categories down to the requested set.
* Skip audits overrides inclusion via `onlyAudits`/`onlyCategories`.
*
* @param {LH.Config.FRConfig} resolvedConfig
* @param {LH.Config.ResolvedConfig} resolvedConfig
* @param {Pick<LH.Config.Settings, 'onlyAudits'|'onlyCategories'|'skipAudits'>} filters
* @return {LH.Config.FRConfig}
* @return {LH.Config.ResolvedConfig}
*/
function filterConfigByExplicitFilters(resolvedConfig, filters) {
const {onlyAudits, onlyCategories, skipAudits} = filters;
Expand Down
10 changes: 5 additions & 5 deletions core/config/validation.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ function assertValidFRGatherer(gathererDefn) {

/**
* Throws an error if the provided object does not implement the required navigations interface.
* @param {LH.Config.FRConfig['navigations']} navigationsDefn
* @param {LH.Config.ResolvedConfig['navigations']} navigationsDefn
* @return {{warnings: string[]}}
*/
function assertValidFRNavigations(navigationsDefn) {
Expand Down Expand Up @@ -164,9 +164,9 @@ function assertValidAudit(auditDefinition) {
}

/**
* @param {LH.Config.FRConfig['categories']} categories
* @param {LH.Config.FRConfig['audits']} audits
* @param {LH.Config.FRConfig['groups']} groups
* @param {LH.Config.ResolvedConfig['categories']} categories
* @param {LH.Config.ResolvedConfig['audits']} audits
* @param {LH.Config.ResolvedConfig['groups']} groups
*/
function assertValidCategories(categories, audits, groups) {
if (!categories) {
Expand Down Expand Up @@ -247,7 +247,7 @@ function assertArtifactTopologicalOrder(navigations) {
}

/**
* @param {LH.Config.FRConfig} resolvedConfig
* @param {LH.Config.ResolvedConfig} resolvedConfig
* @return {{warnings: string[]}}
*/
function assertValidConfig(resolvedConfig) {
Expand Down
2 changes: 1 addition & 1 deletion core/gather/base-artifacts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import {
} from './driver/environment.js';

/**
* @param {LH.Config.FRConfig} resolvedConfig
* @param {LH.Config.ResolvedConfig} resolvedConfig
* @param {LH.Gatherer.FRTransitionalDriver} driver
* @param {{gatherMode: LH.Gatherer.GatherMode}} context
* @return {Promise<LH.BaseArtifacts>}
Expand Down
8 changes: 4 additions & 4 deletions core/gather/navigation-runner.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import {NetworkRecords} from '../computed/network-records.js';
* @typedef NavigationContext
* @property {Driver} driver
* @property {LH.Puppeteer.Page} page
* @property {LH.Config.FRConfig} resolvedConfig
* @property {LH.Config.ResolvedConfig} resolvedConfig
* @property {LH.Config.NavigationDefn} navigation
* @property {LH.NavigationRequestor} requestor
* @property {LH.FRBaseArtifacts} baseArtifacts
Expand All @@ -42,7 +42,7 @@ const DEFAULT_HOSTNAME = '127.0.0.1';
const DEFAULT_PORT = 9222;

/**
* @param {{driver: Driver, resolvedConfig: LH.Config.FRConfig, requestor: LH.NavigationRequestor}} args
* @param {{driver: Driver, resolvedConfig: LH.Config.ResolvedConfig, requestor: LH.NavigationRequestor}} args
* @return {Promise<{baseArtifacts: LH.FRBaseArtifacts}>}
*/
async function _setup({driver, resolvedConfig, requestor}) {
Expand Down Expand Up @@ -250,7 +250,7 @@ async function _navigation(navigationContext) {
}

/**
* @param {{driver: Driver, page: LH.Puppeteer.Page, resolvedConfig: LH.Config.FRConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache']}} args
* @param {{driver: Driver, page: LH.Puppeteer.Page, resolvedConfig: LH.Config.ResolvedConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache']}} args
* @return {Promise<{artifacts: Partial<LH.FRArtifacts & LH.FRBaseArtifacts>}>}
*/
async function _navigations(args) {
Expand Down Expand Up @@ -299,7 +299,7 @@ async function _navigations(args) {
}

/**
* @param {{requestedUrl?: string, driver: Driver, resolvedConfig: LH.Config.FRConfig}} args
* @param {{requestedUrl?: string, driver: Driver, resolvedConfig: LH.Config.ResolvedConfig}} args
*/
async function _cleanup({requestedUrl, driver, resolvedConfig}) {
const didResetStorage = !resolvedConfig.settings.disableStorageReset && requestedUrl;
Expand Down
4 changes: 2 additions & 2 deletions core/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import log from 'lighthouse-logger';

import {Runner} from './runner.js';
import {CriConnection} from './legacy/gather/connections/cri.js';
import {Config} from './legacy/config/config.js';
import {LegacyResolvedConfig} from './legacy/config/config.js';
import UrlUtils from './lib/url-utils.js';
import {Driver} from './legacy/gather/driver.js';
import {UserFlow, auditGatherSteps} from './user-flow.js';
Expand Down Expand Up @@ -63,7 +63,7 @@ async function legacyNavigation(url, flags = {}, configJSON, userConnection) {
flags.logLevel = flags.logLevel || 'error';
log.setLevel(flags.logLevel);

const resolvedConfig = await Config.fromJson(configJSON, flags);
const resolvedConfig = await LegacyResolvedConfig.fromJson(configJSON, flags);
const computedCache = new Map();
const options = {resolvedConfig, computedCache};
const connection = userConnection || new CriConnection(flags.port, flags.hostname);
Expand Down
Loading