refactor(xsnap): Cleanup build.js

[gibson042]

Ref #9614
Ref #9618

Description

Simplifies and documents functions. See individual commits for details.

Security Considerations

None.

Scaling Considerations

n/a

Documentation Considerations

Includes JSDoc improvements.

Testing Considerations

None.

Upgrade Considerations

n/a

[cloudflare-workers-and-pages]

Deploying agoric-sdk with    Cloudflare Pages

Latest commit:	9d42867
Status:	✅  Deploy successful!
Preview URL:	https://ab14868c.agoric-sdk.pages.dev
Branch Preview URL:	https://gibson-2024-07-xsnap-build-c.agoric-sdk.pages.dev

View logs

[mhofman]

I think this looks like a pure refactor but I'm not confident I'm following all the changes. My main concern is breakage in the case of yarn install of xsnap. I believe we have poor coverage of that case.

[gibson042]

I think this looks like a pure refactor but I'm not confident I'm following all the changes. My main concern is breakage in the case of yarn install of xsnap. I believe we have poor coverage of that case.

@mhofman I just stepped through everything to re-convince myself, and came away satisfied... is there a commit that I should break down further? The most intricate was 4d4674d , which breaks down like so:

Given hasBin, hasSource, hasGit, showEnv = args.includes('--show-env');, and isWorkingCopy = hasGit || (!hasSource && !hasBin);...

old main behavior	old main behavior
If showEnv, then Assert isWorkingCopy. updateSubmodules(showEnv, …). <implicit return> If isWorkingCopy, then updateSubmodules(showEnv, …). Set hasSource = true;. If hasSource, then force = await (!hasBin || isRejected(npm.run(…)));. buildXsnap(platform, force, …). Else if not hasBin, then throw.	If args.includes('--show-env'), then Assert isWorkingCopy. updateSubmodules(true, …). return. If isWorkingCopy, then updateSubmodules(false, …). If hasSource or isWorkingCopy, then force = await (!hasBin || isRejected(npm.run(…)));. buildXsnap(platform, force, …). Else if not hasBin, then throw.

[mhofman]

The most intricate was 4d4674d , which breaks down like so

Yeah that was the one that I wasn't sure of the equivalence just starring at the code last night. With the added explanation and a fresh brain, I'll take another pass