playwright/utils/linux-browser-dependencies
Patrick Shaw 6e78dcb7dc
fix: Allow portable bash paths for systems including NixOS (#23889)
Although very common, bash is not guaranteed to be located at
`/bin/bash`. NixOS is an example of this.

More commonly, `/bin/bash` can be quite out of date. An example of this
is MacOS's version of `bash`. This realistically won't affect Playwright
but it's worth noting. You can technically update MacOS's system version
of bash but you need elevated permissions to do so.

By using `/usr/bin/env bash` instead of `/bin/bash` we can execute
Playwright's bash scripts in like NixOS and generally improve the
selection behaviour for bash in other systems too.

Some discussion of why it's worth favouring `/usr/bin/env bash` over
`/bin/bash`:
- Discusses `/bin/bash` missing in NixOS:
https://discourse.nixos.org/t/add-bin-bash-to-avoid-unnecessary-pain/5673
- Some general commentary on why `/usr/bin/env bash` is favoured:
https://askubuntu.com/a/1402721
- Points out how old bash is in MacOS:
https://itnext.io/upgrading-bash-on-macos-7138bd1066ba

Improves situation at #5501
2023-07-03 06:27:06 -07:00
..
inside_docker fix: Allow portable bash paths for systems including NixOS (#23889) 2023-07-03 06:27:06 -07:00
.gitignore devops: add script to generate shared object => package mapping (#3022) 2020-07-20 10:35:42 -07:00
README.md chore: use bash instead of sh in code blocks (#6847) 2021-06-02 18:23:06 +02:00
run.sh fix: Allow portable bash paths for systems including NixOS (#23889) 2023-07-03 06:27:06 -07:00

Mapping distribution libraries to package names

Playwright requires a set of packages on Linux distribution for browsers to work. Before launching browser on Linux, Playwright uses ldd to make sure browsers have all dependencies met.

If this is not the case, Playwright suggests users packages to install to meet the dependencies. This tool helps to maintain a map between package names and shared libraries it provides, per distribution.

Usage

To generate a map of browser library to package name on Ubuntu:bionic:

./run.sh ubuntu:bionic

Results will be saved to the RUN_RESULT.

How it works

The script does the following:

  1. Launches docker with given linux distribution
  2. Installs playwright browsers inside the distribution
  3. For every dependency that Playwright browsers miss inside the distribution, uses apt-file to reverse-search package with the library.