feat: e pr download-dist <number>

[samuelmaddock]

e pr download-dist <number> will download a pull request's dist artifacts to ~/.electron_build_tools/artifacts/pr_{number}_{platform}_{arch}

As a followup, we could add a electron-fiddle:// command to register it as a local build for easier testing. With that, this command could register the downloaded artifact.

[itsananderson]

For Mac versions, do we want to automatically remove the quarantine with xattr -c Electron.app since the app will be unsigned, or do we want to leave that to the developer?

I suppose we could either prompt the caller, or add a CLI flag if it doesn't seem safe to automatically remove it

[samuelmaddock]

I was also wondering about this. When I run the script, and double-click the .app, it doesn't seem to show me the popup about it being downloaded from the internet 🤔

[itsananderson]

Maybe when I manually downloaded the artifact, that attribute was added by Chrome to the .zip and then propagated to the .app when I extracted the zip. If downloading it via a script doesn't encounter the same problem, then all the better :)

[dsanders11]

• Can we implement this without it being a breaking change to e pr? I know we don't guarantee CLI stability, but it's nice to avoid breaking it in case others are using it (such as other tooling like the Electron Build Tools VS Code extension)
• This won't support Windows until we migrate from AppVeyor to GHA (should be soon), might be worth calling out

[samuelmaddock]

Can we implement this without it being a breaking change to e pr? I know we don't guarantee CLI stability, but it's nice to avoid breaking it in case others are using it (such as other tooling like the Electron Build Tools VS Code extension)

Agreed. I was able to find a way to do this in 9e2ad26 👍

This won't support Windows until we migrate from AppVeyor to GHA (should be soon), might be worth calling out

For now this will fail when it can't the artifacts.

$ e pr download-dist 44411 --platform=win32 --arch=x64
Failed to find artifact: generated_artifacts_win32_x64

[dsanders11]

I'm a +1 on the general concept, but a couple of thoughts on the implementation:

• Would be nice if there was a built-in way to clean out downloaded artifacts so they don't build up over time.
• I think some guard rails around this would be good, to prevent a user from fat fingering a PR number and potentially running code they didn't intend to on their local machine. Perhaps a confirmation prompt that displays the title of the PR, the author, indicates if it's a fork, etc?

[dsanders11]

extract-zip is unmaintained and the last release was 4 years ago, so I'd prefer to use a maintained alternative if we're adding a new dependency.

IMO https://www.npmjs.com/package/adm-zip is a solid alternative, and it can extract to a Buffer in-memory which could be useful to avoid the temp dir logic (at the expense of higher memory usage) and get straight to the dist.zip file. Quick pseudo-code example:

const distZipEntry = artifactZip.getEntry('dist.zip');
if (!distZipEntry) {
  fatal(`dist.zip not found within the artifact.`);
  return;
}

const distZip = new AdmZip(artifactZip.readFile(distZipEntry));
distZip.extractAllTo(outputDir);

[samuelmaddock]

This is validating actually 👍 I would have reached for that package first, but saw we were using extract-zip in many other places so I was aiming for consistency.

[dsanders11]

Yea, historically we've used it but probably time to move on given it's unmaintained. I have loose plans to migrate our other usages of it as appropriate.

[samuelmaddock]

@dsanders11 here's sample output from the confirmation prompt I added

$ e pr download-dist 44598            
? You are about to download artifacts from:

“feat: add query-session-end and improve session-end events on Windows (#44598)” by savely-krasovsky
https://github.com/savely-krasovsky/electron (fork)

Proceed? (Y/n)

$ e pr download-dist 44411            
? You are about to download artifacts from:

“feat: service worker preload scripts (#44411)” by samuelmaddock
https://github.com/electron/electron

Proceed? (Y/n)

I'm still thinking about how I want to approach cleaning up. Whether it should be another command or automatically checked each time any build-tools command is issued.

Also, excellent recommendation with extracting in-memory. It cleaned up a lot of code!

[dsanders11]

I think you're using an older version of Yarn so these are getting folded back into one, which can actually cause some weird issues (not sure it will in this specific case). If I revert these changes and run yarn install with v1.22.22 the only change I get is the adm-zip addition.

[samuelmaddock]

Opened #680 for cleaning up artifacts.

[samuelmaddock]

Bad news regarding adm-zip, it doesn't support symlinks (cthackers/adm-zip#455) which Electron.app contains once extracted. I may have to switch back to extract-zip for this reason.

[dsanders11]

@samuelmaddock, ah, unfortunate. Thanks for the update, makes sense.