tools, build: macOS installer improvements

[jpwesselink]

Replacement for current macOS installer scripts.

This builds on prior work by @rvagg, @lance, @fhemberger & @evanlucas

• Uses pkgbuild and productbuild instead of outdated Packagemaker.
• Optional installation of npm.
• Removes previous npm installation before installing npm.
• Packages carry correct version attributes.
• Support for intl installer features, defaults to en.
• Fancy formatted license.
• Renamed osx references to macOS.

Packagemaker, which is used for building the macOS packages is outdated. The last release was in 2012, as part of the Auxiliary Tools for Xcode. Next to this, it seems thatPackagemaker is poorly documented, and unwieldy to use at best. pkgbuild and productbuild are easier to use, still supported by Apple, and (correct me if I'm wrong), the de facto standard for creating macOS installation files.

The optional installation of npm also removes any previous installed npm distribution.

Package versions also propagate to the package artefacts, which will fix#15012

$ pkgutil --pkg-info org.nodejs.node.pkg package-id: org.nodejs.node.pkg version: v9.0.0-nightly2017-09-04c34f2eae80 volume: / location: / install-time: 1504526061 

$ pkgutil --pkg-info org.nodejs.npm.pkg package-id: org.nodejs.npm.pkg version: v5.3.0 volume: / location: / install-time: 1504523991 

License is formatted using ./tools/license2rtf.js, but since the font size turns out fairly small, it might need some tweaking.

Localized resources can be provided by adding them to{lang}.lproj directory to ./tools/macos-installer/productbuild/Resources/. As of writing the supported language is English. Please see Apple's documentation on Localized Resources in Bundles

To test packaging without code or package signing, I found that the method below worked best for me. (if there is a better way to do this, I'd love to know)

$ DISTTYPE=nightly DATESTRING=2017-09-04 COMMIT=c34f2eae80 make pkg -j 4 

cc @nodejs/build, @jasnell, @rvagg, @MylesBorins, @watilde, @ashleygwilliams

Fixes: #15012
Refs: #5656
Refs: #2571
Refs: #7097

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• commit message follows commit guidelines
• Run on CI
• Update build docs at https://github.com/nodejs/build/tree/master/setup/osx

Affected core subsystem(s)

tools, build

[watilde]

ping @nodejs/platform-macos

[watilde]

ci: https://ci.nodejs.org/job/node-test-pull-request/9940/
https://ci.nodejs.org/job/node-test-pull-request/9939/

[evanlucas]

Thanks for picking this up!! I'll try to run it this week and confirm that code signing still works and such as well.

[lance]

Looks good! I noted in the code that the symlink path to npx needs to be changed. Otherwise, it's a great improvement.

[lance]

This should be:

ln -sf ../lib/node_modules/npm/bin/npx-cli.js npx

[jpwesselink]

Ok to amend those changes to same commit, or should I add new commits, and squash later?

[lance]

Everything will be squashed when it lands in master, so you can just add new commits.

[fhemberger]

@jpwesselink Awesome, thanks for picking it up! Hope we can finally land a new installer this time. 😀

[jpwesselink]

@fhemberger I hope we can :) New users would really benefit from it

[jasnell]

Gave it a try and it appears to work. Rubber stamp LGTM but I'm not an expert with macos installers so would appreciate others taking a look @nodejs/tsc

[mscdex]

@nodejs/platform-macos is probably a better group to ping?

[joyeecheung]

This script needs to return an exit code 0 to work (see docosx). Otherwise it will abort (showing "The installation failed" if there isn't a /usr/local/lib/node_modules/npm ). Can you add

exit 0 

to the end of this file?

[jpwesselink]

Sure can

[mgol]

Doesn't rm -f return 0 even when there was no file to remove? And when it failed to remove npm then we have an unexpected failure anyway.

[joyeecheung]

Also a couple suggestions

[joyeecheung]

The message looks like this after installation:

Can you wrap each line with <p> or <li>(with <ul> or <ol>) so they would break better? Also it would be nice to include the version numbers in the message.

[jpwesselink]

Like Node.js{nodeversion} was installed ...?

[joyeecheung]

Maybe something like

<div><p>This package has installed:</p><ul><li>Node.js{nodeversion} to <code>/usr/local/bin/node</code></li><li>npm{npmversion} to <code>/usr/local/bin/npm</code></li></ul><p>Make sure that <code>/usr/local/bin</code> is in your <code>$PATH</code>.</p></div>

[jpwesselink]

TY, let me grab some screenshots of the result

[jpwesselink]

Here we go.

I think we should wrap the unordered list in a paragraph as well to give the last line some space.

[joyeecheung]

I would suggest to use css for that because technically paragraphs can not contain lists...

[jpwesselink]

!

[joyeecheung]

Nit: tab indentation (also the similar lines below)

[joyeecheung]

It would be nice if this message is formatted similar to how the conclusion message is formatted, maybe like this:

<div><p>This package will install</p><ul><li>Node.js{nodeversion} to <code>/usr/local/bin/node</code></li><li>npm{npmversion} to <code>/usr/local/bin/npm</code></li></ul></div>

[jpwesselink]

How about this?

[joyeecheung]

Looking good!

[jpwesselink]

Also adjusted the vertical alignment of the logo to match the logo alignment of the current installer.

[lance]

Should there be a semver-[major|minor] for a change to the installer?

[gibfahn]

Should there be a semver-[major|minor] for a change to the installer?

Only if it's a breaking change for end-users. Which bits would be? Maybe this?

Removes previous npm installation before installing npm.

[joyeecheung]

LGTM, thanks!

[joyeecheung]

CI: https://ci.nodejs.org/job/node-test-pull-request/10006/

[gibfahn]

Looks like this causes two lines to be printed on top of each other (#17965). @jpwesselink any ideas as to why this is happening?

[gibfahn]

Release team were +1 on backporting to v6.x.