Skip to content

chore(registry): refactor logic of what browsers to download to top level #9078

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
yury-s merged 1 commit into from
Sep 22, 2021
Merged

chore(registry): refactor logic of what browsers to download to top level #9078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions src/cli/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,10 @@ program
.action(async function(args: string[], command: program.Command) {
try {
if (!args.length) {
const executables = registry.defaultExecutables();
if (command.opts().withDeps)
await registry.installDeps();
await registry.install();
await registry.installDeps(executables);
await registry.install(executables);
} else {
const executables = checkBrowsersToInstall(args);
if (command.opts().withDeps)
Expand Down Expand Up @@ -143,7 +144,7 @@ program
.action(async function(args: string[]) {
try {
if (!args.length)
await registry.installDeps();
await registry.installDeps(registry.defaultExecutables());
else
await registry.installDeps(checkBrowsersToInstall(args));
} catch (e) {
Expand Down
27 changes: 21 additions & 6 deletions src/utils/registry.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,10 +487,12 @@ export class Registry {
return this._executables.find(b => b.name === name);
}

private _addRequirementsAndDedupe(executables: Executable[] | undefined): ExecutableImpl[] {
defaultExecutables(): Executable[] {
return this._executables.filter(e => e.installType === 'download-by-default');
}

private _addRequirementsAndDedupe(executables: Executable[]): ExecutableImpl[] {
const set = new Set<ExecutableImpl>();
if (!executables)
executables = this._executables.filter(executable => executable.installType === 'download-by-default');
for (const executable of executables as ExecutableImpl[]) {
set.add(executable);
if (executable.browserName === 'chromium')
Expand All @@ -514,7 +516,7 @@ export class Registry {
return await validateDependenciesWindows(windowsExeAndDllDirectories.map(d => path.join(browserDirectory, d)));
}

async installDeps(executablesToInstallDeps?: Executable[]) {
async installDeps(executablesToInstallDeps: Executable[]) {
const executables = this._addRequirementsAndDedupe(executablesToInstallDeps);
const targets = new Set<DependencyGroup>();
for (const executable of executables) {
Expand All @@ -528,7 +530,7 @@ export class Registry {
return await installDependenciesLinux(targets);
}

async install(executablesToInstall?: Executable[]) {
async install(executablesToInstall: Executable[]) {
const executables = this._addRequirementsAndDedupe(executablesToInstall);
await fs.promises.mkdir(registryDirectory, { recursive: true });
const lockfilePath = path.join(registryDirectory, '__dirlock');
Expand Down Expand Up @@ -703,12 +705,25 @@ function buildPlaywrightCLICommand(sdkLanguage: string, parameters: string): str
}

export async function installDefaultBrowsersForNpmInstall() {
const defaultBrowserNames = registry.defaultExecutables().map(e => e.name);
return installBrowsersForNpmInstall(defaultBrowserNames);
}

export async function installBrowsersForNpmInstall(browsers: string[]) {
// PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD should have a value of 0 or 1
if (getAsBooleanFromENV('PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD')) {
logPolitely('Skipping browsers download because `PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD` env variable is set');
return false;
}
await registry.install();
const executables: Executable[] = [];
for (const browserName of browsers) {
const executable = registry.findExecutable(browserName);
if (!executable || executable.installType === 'none')
throw new Error(`Cannot install ${browserName}`);
executables.push(executable);
}

await registry.install(executables);
}

export const registry = new Registry(require('../../browsers.json'));