Refactor Mac installer generation #776

remixz · 2015-02-10T03:38:30Z

This refactors the Mac installer generation to use Packages. This moves io.js away from using the deprecated Package Maker, and allows for easy localization of the Mac installer.

I've included a README with localization instructions, which should make it easy for localization teams to localize the installer. The only thing I couldn't test with this was the package signing, so that should be tested before merging. This might also help pave the way to fixing other Mac installer-related issues, since now it's using something a bit modern for generation.

This refactors the Mac .pkg generation to use Packages. This moves io.js away from using the deprecated Package Maker, and allows for easy localization of the installer.

rvagg · 2015-02-10T04:30:18Z

Amazing, this is a great contribution @remixz, I'll try and make time to test this out and give feedback.

Initial quesitons:

is it possible to bring this on par to the Windows installer and make the node symlink an optional part of the install (opt-out)? We could perhaps do the same with npm so you could choose to not even install that, but that's arguably less useful.
should we include the license as rtf? part of the Windows installer build process is to make an rtf version (see vcbuild.bat), is there any reason to do the same here?

remixz · 2015-02-10T04:57:46Z

Yes! I'll have to add a flag or something to disable the symlink in tools/install.py so the node symlink isn't included in the installer, but otherwise it's easy to do. It'll just be an empty install step with a post-install script. I can also make the installer show the "custom install" view by default, so it looks something like this:

As well, with the PR as it is, npm can be unselected, but it's still installed with the io.js step. This actually does beg the question: why is there a separate step for npm? From what I can tell, it's not needed.
We can add it as rtf, but there's no advantage I can think of, aside from changing the font.

remixz · 2015-02-10T08:03:49Z

Idea: Should this include an uninstaller? Choosing the option would disable all the others, like this:

Then it can just run an arbitrary script that would remove files. This would help bring parity with other platforms.

ghost · 2015-02-10T11:05:27Z

I think an uninstall is important.

bnoordhuis · 2015-02-10T11:26:37Z

is it possible to bring this on par to the Windows installer and make the node symlink an optional part of the install (opt-out)?

I'm not sure if that makes sense on OS X. A symlink opt-out may give the false impression that joyent/node and io.js can coexist peacefully when they can't.

The installer installs to /usr/local. If a joyent/node install already exists there, io.js will happily stamp on it. The symlink is just the top of the ice berg.

The only scenario that I can think of where an opt-out would help is when joyent/node and io.js are installed to separate locations that are both on the PATH. The exact meaning of the "Create a symlink" checkbox would need to be called out in the installer if we don't want angry bug reports. :-)

remixz · 2015-02-11T00:38:36Z

@bnoordhuis A description can be added to the symlink installer entry, so when someone clicks on it to uncheck it, it can say something like "joyent/node and io.js don't coexist nicely, keeping this symlink is recommended".

bnoordhuis · 2015-02-11T10:12:17Z

@remixz Sounds good.

tellnes · 2015-02-12T15:43:46Z

Could we reuse the translations for other distributions?

tellnes · 2015-02-12T15:44:16Z

Makefile

@@ -252,16 +253,26 @@ release-only:
 		exit 1 ; \
 	fi

+pre-pkg:


Should this be added to .PHONY?

@tellnes Good catch. Fixed, thanks!

fhemberger · 2015-02-12T16:20:32Z

I prepared the German translation for the installer using Packages: https://github.com/fhemberger/io.js/commit/65ba54ec0eb112ce040415ac2b3b321b8e38b5d1
As soon as this PR lands, we can use this commit as a basis for further internationalization.

remixz · 2015-02-13T00:29:48Z

@tellnes It's likely, but there'd have to be some changes so that it doesn't specifically reference Mac locations.

@fhemberger Awesome!! 👍 🎉 It might need to be rebased by the time this is merged, since the file will probably change a bit when the uninstaller is finalized, but this is great.

bnoordhuis · 2015-02-13T14:58:41Z

tools/install.py

@@ -194,6 +195,8 @@ def run(args):
  conf = load_config()
  variables = conf['variables']
  target_defaults = conf['target_defaults']
+  # argv[4] is a variable representing whether a symlink should be made
+  no_symlink = True if len(args) > 4 and args[4] == 'true' else False


no_symlink = len(args) > 4 and args[4] == 'true'?

remixz · 2015-02-13T23:49:20Z

@bnoordhuis Implemented all of your changes. Thanks!

bnoordhuis · 2015-02-13T23:52:17Z

LGTM but I'm not an expert when it comes to OS X installers.

@iojs/collaborators Can I have one more LGTM?

remixz · 2015-02-13T23:54:02Z

@bnoordhuis Ah, I need to finish the uninstaller portion before this can ship. (unless you want to move that to another PR?)

remixz · 2015-02-14T00:46:58Z

Cool. I've added the uninstaller, which means once reviewed, this should be good to go.

evanlucas · 2015-02-14T01:19:10Z

From running local tests, it looks like tools/osx-codesign.sh may need to be updated. It tries to explicitly codesign node instead of iojs

evanlucas · 2015-02-14T01:44:54Z

Ah nevermind, got it to work. Is there a way to change the success screen when uninstall is selected? Currently, it is the same, which could cause some confusion.

This is what is shown after a successful uninstall:

remixz · 2015-02-14T05:14:05Z

@evanlucas I changed tools/osx-codesign.sh to sign iojs, since even though you got it working, I'm pretty sure it should be signing iojs, unless someone has a reason for it not to.

For the success screen, I'm pretty sure it can't change based on what's installed, which definitely leaves a sucky experience for people doing an uninstall.

rvagg · 2015-02-16T01:23:39Z

i18n changes pending resolution of #819

fhemberger · 2015-03-02T08:11:00Z

Is the updated installer ready to land?

As #819 seems to be resolved according to the TC meeting, I'd love to add the translation for the installer and make it a proper PR.

bnoordhuis · 2015-03-02T10:43:25Z

Should /usr/local/lib/node_modules/ be removed?

I don't know if it's possible to implement this but what tools/install.py does is unlink the directory iff it's empty after removing all installed files.

Conflicts: .gitignore

remixz · 2015-03-05T00:15:01Z

@bnoordhuis Yup, that can be done! Added with 2526e1d.

@fhemberger If the translation issue is all resolved, then I think this is ready to land.

fhemberger · 2015-03-05T06:07:36Z

Thanks, I'll create a proper translation PR for further discussion as soon as this has landed.

fhemberger · 2015-03-17T10:10:15Z

@remixz We should add a paragraph to introduction.rtf to clarify that node.js and io.js cannot be installed in parallel (and the symlink will overwrite the one of any previously installed node versions). If the user wants to use both, they have to use version managers like nvm or n and use them instead of the Mac installer (see discussion in #389).

fhemberger · 2015-05-24T08:54:21Z

Any news on the status of the new Mac installer? cc @nodejs/core

Qard · 2015-06-26T20:47:24Z

@nodejs/collaborators Anyone familiar with the existing OSX installer that can review this?

rvagg · 2015-06-27T02:43:53Z

On my list but not a high priority compared to other things like node-gyp, so help from others would be greatly appreciated. @remixz if you have time would you mind rebasing on the current master, there's been a bunch of changes in this area that you'll need to catch up on.

rvagg · 2015-07-28T07:40:15Z

@remixz would you mind having another look at this, rebase and target a new PR against next for now and we might try and do this at the same time as #2247. It's not a top priority but would be good to get this done before the converged release.

evanlucas · 2015-08-26T13:39:24Z

I think we should definitely try to get this merged before the converged release. Anything I can do to help?

fhemberger · 2015-08-26T14:30:30Z

The changes in this PR need to be merged against the current master for the 4.0.0 release, including the renaming from 'iojs' to 'node'. It would be great if we could get this running, so we can ship localized installers in the next major version.

fhemberger · 2015-08-27T07:41:43Z

I did a rebase against master in #2571, can you all please have a look?

jasnell · 2015-10-22T01:56:10Z

Closing this in favor of #2571

Refactor Mac .pkg generation

97e79f5

This refactors the Mac .pkg generation to use Packages. This moves io.js away from using the deprecated Package Maker, and allows for easy localization of the installer.

rvagg self-assigned this Feb 10, 2015

Florian-R mentioned this pull request Feb 11, 2015

please remove node symlink from iojs installer #796

Closed

remixz added 3 commits February 11, 2015 17:50

Add symlink step to Mac installer

f186d1c

Merge remote-tracking branch 'origin/v1.x' into refactor-mac-installer

8491b02

Create empty files on pre-pkg, set up uninstall

e08d2df

jessy1092 mentioned this pull request Feb 12, 2015

Translate installers for OS X and Windows #819

Closed

tellnes reviewed Feb 12, 2015
View reviewed changes

Add pre-pkg to .PHONY in makefile

2fb6c21

bnoordhuis reviewed Feb 13, 2015
View reviewed changes

fhemberger mentioned this pull request Feb 13, 2015

Status of translation nodejs/nodejs-de#16

Closed

9 tasks

remixz added 3 commits February 13, 2015 15:48

Wrap Makefile lines at 80 characters

5580022

Wrap osx-pkg README at 80 characters

d1c2ac7

Simplify no_symlink check in tools/install.py

1755cc8

Add uninstaller

1434328

Change codesign to sign iojs, not node

5e2c01c

Fishrock123 added the install Issues and PRs related to the installers. label Feb 15, 2015

remixz added 2 commits March 4, 2015 15:58

Merge remote-tracking branch 'origin/v1.x' into refactor-mac-installer

cb069d4

Conflicts: .gitignore

Remove node_modules if folder is empty

2526e1d

rvagg mentioned this pull request Mar 18, 2015

Cherrypicked commits from joyent/node #1163

Closed

chrisdickinson added the land-on-master label Apr 17, 2015

silverwind added the macos Issues and PRs related to the macOS platform / OSX. label Jul 13, 2015

Fishrock123 mentioned this pull request Aug 28, 2015

Refactor mac installer (Rebase of #776 against master) #2571

Closed

jasnell closed this Oct 22, 2015

rvagg mentioned this pull request Mar 11, 2016

Refactor mac installer (built on #2571) #5656

Closed

rvagg mentioned this pull request Jun 27, 2016

Make uninstaller for Mac #7371

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Mac installer generation #776

Refactor Mac installer generation #776

remixz commented Feb 10, 2015

rvagg commented Feb 10, 2015

remixz commented Feb 10, 2015

remixz commented Feb 10, 2015

ghost commented Feb 10, 2015

bnoordhuis commented Feb 10, 2015

remixz commented Feb 11, 2015

bnoordhuis commented Feb 11, 2015

tellnes commented Feb 12, 2015

tellnes Feb 12, 2015

remixz Feb 13, 2015

fhemberger commented Feb 12, 2015

remixz commented Feb 13, 2015

bnoordhuis Feb 13, 2015

remixz commented Feb 13, 2015

bnoordhuis commented Feb 13, 2015

remixz commented Feb 13, 2015

remixz commented Feb 14, 2015

evanlucas commented Feb 14, 2015

evanlucas commented Feb 14, 2015

remixz commented Feb 14, 2015

rvagg commented Feb 16, 2015

fhemberger commented Mar 2, 2015

bnoordhuis commented Mar 2, 2015

remixz commented Mar 5, 2015

fhemberger commented Mar 5, 2015

fhemberger commented Mar 17, 2015

fhemberger commented May 24, 2015

Qard commented Jun 26, 2015

rvagg commented Jun 27, 2015

rvagg commented Jul 28, 2015

evanlucas commented Aug 26, 2015

fhemberger commented Aug 26, 2015

fhemberger commented Aug 27, 2015

jasnell commented Oct 22, 2015

Refactor Mac installer generation #776

Refactor Mac installer generation #776

Conversation

remixz commented Feb 10, 2015

rvagg commented Feb 10, 2015

remixz commented Feb 10, 2015

remixz commented Feb 10, 2015

ghost commented Feb 10, 2015

bnoordhuis commented Feb 10, 2015

remixz commented Feb 11, 2015

bnoordhuis commented Feb 11, 2015

tellnes commented Feb 12, 2015

tellnes Feb 12, 2015

Choose a reason for hiding this comment

remixz Feb 13, 2015

Choose a reason for hiding this comment

fhemberger commented Feb 12, 2015

remixz commented Feb 13, 2015

bnoordhuis Feb 13, 2015

Choose a reason for hiding this comment

remixz commented Feb 13, 2015

bnoordhuis commented Feb 13, 2015

remixz commented Feb 13, 2015

remixz commented Feb 14, 2015

evanlucas commented Feb 14, 2015

evanlucas commented Feb 14, 2015

remixz commented Feb 14, 2015

rvagg commented Feb 16, 2015

fhemberger commented Mar 2, 2015

bnoordhuis commented Mar 2, 2015

remixz commented Mar 5, 2015

fhemberger commented Mar 5, 2015

fhemberger commented Mar 17, 2015

fhemberger commented May 24, 2015

Qard commented Jun 26, 2015

rvagg commented Jun 27, 2015

rvagg commented Jul 28, 2015

evanlucas commented Aug 26, 2015

fhemberger commented Aug 26, 2015

fhemberger commented Aug 27, 2015

jasnell commented Oct 22, 2015