`bun add puppeteer` doesn't run postinstall script for trusted dependency

[dr-noid]

What version of Bun is running?

1.0.0+822a00c4d508b54f650933a73ca5f4a3af9a7983

What platform is your computer?

Linux 5.15.90.1-microsoft-standard-WSL2 x86_64 x86_64

What steps can reproduce the bug?

mkdir bun-puppeteer
cd bun-puppeteer
bun init
add "trustedDependencies": ["puppeteer"] to package.json
package.json reference:

{
  "name": "bun-puppeteer",
  "module": "index.ts",
  "type": "module",
  "devDependencies": {
    "bun-types": "latest"
  },
  "peerDependencies": {
    "typescript": "^5.0.0"
  },
  "trustedDependencies": [
    "puppeteer"
  ]
}

bun add puppeteer
bun install

index.ts:

import puppeteer from "puppeteer";
await puppeteer.launch({ headless: false });

bun run index.ts

What is the expected behavior?

bun run starts a headless browser

What do you see instead?

bun-puppeteer $ bun run index.ts

269 | if (this.puppeteer.configuration.browserRevision) {
270 | throw new Error(Tried to find the browser at the configured path (${executablePath}) for revision ${this.puppeteer.browserRevision}, but no executable was found.);
271 | }
272 | switch (this.product) {
273 | case 'chrome':
274 | throw new Error(Could not find Chrome (ver. ${this.puppeteer.browserRevision}). This can occur if either\n +
^
error: Could not find Chrome (ver. 116.0.5845.96). This can occur if either

1. you did not perform an installation before running the script (e.g. npm install) or
2. your cache path is incorrectly configured (which is: /home/drnoid/.cache/puppeteer).
   For (2), check out our guide on configuring puppeteer at https://pptr.dev/guides/configuration.
   at resolveExecutablePath (/home/drnoid/coding/bun-puppeteer/node_modules/puppeteer-core/lib/esm/puppeteer/node/ProductLauncher.js:274:26)
   at /home/drnoid/coding/bun-puppeteer/node_modules/puppeteer-core/lib/esm/puppeteer/node/ChromeLauncher.js:92:31
   at processTicksAndRejections (:1:2602)

Additional information

There is a 99.9% chance that this is an issue with the postinstall script of puppeteer.
If I install puppeteer with pnpm or npm it will run the postinstall script and download the browser in the .cache directory.

[dr-noid]

I found a little workaround for now:

in my package.json I added a postinstall script with
bunx @puppeteer/browsers install chrome@stable --path $HOME/.cache/puppeteer

using the puppeteer CLI to install the missing chrome driver.

[geongeorge]

@dr-noid I feel you are right, Chrome was not downloaded when I installed puppeteer with bun.

[stewones]

same here. postinstall ^ worked though 🙏

[Alino]

I am on m1 pro mac and adding the postinstall script did run the post-install command after running bun install. However it had no effect and the issue remains.

bun install v1.0.0 (822a00c4)
chrome@116.0.5845.96 /Users/admin/.cache/puppeteer/chrome/mac_arm-116.0.5845.96/chrome-mac-arm64/Google Chrome for Testing.app/Contents/MacOS/Google Chrome for Testing

bun start
[2023-09-11T14:18:53.314Z]  Could not find Chrome (ver. 115.0.5790.98). This can occur if either
 1. you did not perform an installation before running the script (e.g. `npm install`) or
 2. your cache path is incorrectly configured (which is: /Users/admin/.cache/puppeteer).
For (2), check out our guide on configuring puppeteer at https://pptr.dev/guides/configuration.
/Users/admin/Documents/Projects/blabla/node_modules/puppeteer-core/src/node/ProductLauncher.ts:438
          throw new Error(
                ^
Error: Could not find Chrome (ver. 115.0.5790.98). This can occur if either
 1. you did not perform an installation before running the script (e.g. `npm install`) or
 2. your cache path is incorrectly configured (which is: /Users/admin/.cache/puppeteer).
For (2), check out our guide on configuring puppeteer at https://pptr.dev/guides/configuration.

UPDATE: I fixed it by using the specific chrome version to install in the postinstall script.
"postinstall": "bunx @puppeteer/browsers install chrome@115.0.5790.98 --path $HOME/.cache/puppeteer"

[dr-noid]

@Alino glad you found a fix, this issue probably won't get any traction because from the outside it looks like an issue with puppeteer. I haven't done any testing on this but my guess is this is an issue with trustedDependencies and postinstall scripts as a whole.

[rgl]

It's a two fold problem.

1. Puppeteer postinstall calls the node cli.
2. Installing the browser and immediately running is broken in bun.

See #4894

[Parzival-3141]

Related #4959

[azat-io]

bunx @puppeteer/browsers install chrome@stable --path $HOME/.cache/puppeteer not works for me. I'm trying to do it in docker

[dr-noid]

@azat-io i don't have much experience with docker so I don't know how the filesystem structure is laid out, you could always omit the --path argument, in that case puppeteer will install it under ${cwd}/chrome and you can reference this path when using puppeteer.launch({}) by argument.

[An-GG]

If I install puppeteer with pnpm or npm it will run the postinstall script and download the browser in the .cache directory.

So I haven't been able to reproduce the issue using your procedure (the first install of puppeteer on a system using bun in a brand new project has consistently worked for me so far) but I've experienced a lot of similar issues on subsequent runs of bun install.

I think the problem basically stems from bun only calling postinstall scripts when you first add a package (aka when it first gets added to bun.lockb), whereas npm will run a package's postinstall scripts every time it is added to the node_modules directory. Critically, you commit your bun lockfile to git, but obviously you don't commit node_modules.

If the files created by puppeteer's postinstall script (in ~/.cache/puppeteer) are damaged or removed, they'll stay that way because bun will basically never call the postinstall script again (unless you delete bun.lockb, which works but obv I'd like to keep dep versions locked).

npm faces a similar issue actually. If you do an npm install, confirm puppeteer is working, and then delete ~/.cache/puppeteer without changing the node_modules dir, npm will not rerun postinstall scripts and you'll get the same error. This is quickly fixed if you reclone your project and npm install again, but doing the same for bun does not work (bc bun.lockb).

[dr-noid]

@An-GG thanks for your response, I actually tried to look more into it after you mentioned the bun.lockb file and I think I exactly when the issue happens.

You can recreate the problem like this:

1. Init project with bun init
2. Add puppeteer to trustedDependencies
3. Install puppeteer bun add, bun install etc <-- postinstall not ran
   

However, it does run the postinstall script if I do this:

1. Init project with bun init
2. Add puppeteer to trustedDependencies
3. Delete the auto-generated Bun lockfile rm bun.lockb
4. Install puppeteer bun add (without a bun.lockb present, postinstall is ran)
   

[An-GG]

@dr-noid That's really interesting - so even just an empty bun.lockb prevented the postinstall hook from running.
But then once it's in bun.lockb, running bun install in a fresh clone of your project does properly run the postinstall hook???

I had assumed this was a result of too eagerly reusing cached installs of packages, but it seems like its a much more glaring bug.

Personally I am still confused on the proper usage of bun add vs bun install. Half the time in my testing I accidentally used bun install puppeteer out of habit and that seems to do the same thing as bun add, I think, but the docs don't discuss using install that way so I'm feeling like I'm in undefined behavior territory.

I have no evidence of this but specifically regarding the puppeteer postinstall issue, I think at one point I encountered better success with using install puppeteer instead of add puppeteer. This may have been entirely hallucinated.

[dr-noid]

@An-GG I have only been able to get Bun to run the postinstall hook when I did bun add puppeteer WITHOUT the lockfile present.