JHipster should not install tabtab completions automatically #6162

gmarziou · 2017-07-23T13:40:04Z

Overview of the issue

JHipster should not install tabtab completions automatically, it should ask permission to the user.

Motivation for or Use Case

It's been a long time since I did run jhipster on Windows, in fact it was before jhipster cli was introduced and today I tried and I could not get it working.

One reason why Windows is a hard platform is because our users have many shells: cmd.exe, powershell and git bash are the most common ones. Cygwin can also be found.

So each time we mess with shell on Windows, we can be sure it won't work for some users.

Currently, my problem is with tabtab (which does not work on Windows or may work with bash): it is installed by generator-jhipster using install script in package.json but no uninstall script.

Tabtab writes to a different global location based on type of shell it has detected, surprisingly this includes locations that require sudo rights according to their doc (I did not check) : /usr/local/share/zsh/site-functions, /usr/share/bash-completion/completions or /etc/bash_completion.d.

I think JHipster should not require sudo rights to install.

This forced installation creates another potential issue: it's not versioned, tabtab writes stuff in a global location so if you have projects using different versions of jhipster, all of them will get completions from latest installation.

"jhipster upgrade" installs locally 2 versions of jhipster but we can't tell it not to run tabtab, so a local installation results in global impact which is bad per se and in my particular case results in a failure.

upgrade failing due to tabtab

jhipster upgrade Executing jhipster:upgrade Welcome to the JHipster Upgrade Sub-Generator This will upgrade your current application codebase to the latest JHipster version Looking for latest generator-jhipster version... New generator-jhipster version found: 4.6.2 Git repository detected Created branch jhipster_upgrade Cleaned up directory Installing JHipster 4.6.1 locally events.js:160 throw er; // Unhandled 'error' event ^

Error: �[31m�[1mERROR!�[22m�[39m Something went wrong while installing the JHipster generator! yarn add v0.27.5
info No lockfile found.
[1/4] Resolving packages...
[2/4] Fetching packages...
[3/4] Linking dependencies...
[4/4] Building fresh packages...
info Visit https://yarnpkg.com/en/docs/cli/add for documentation about this command.
error E:\projets\issues\upgrade\node_modules\generator-jhipster: Command failed.
Exit code: 1
Command: C:\WINDOWS\system32\cmd.exe
Arguments: /d /s /c tabtab install --name jhipster --auto
Directory: E:\projets\issues\upgrade\node_modules\generator-jhipster
Output:
module.js:471
throw err;
^

Error: Cannot find module 'E:\projets\issues\upgrade\node_modules\issues\upgrade\node_modules\tabtab\bin\tabtab'
at Function.Module._resolveFilename (module.js:469:15)
at Function.Module._load (module.js:417:25)
at Module.runMain (module.js:604:10)

It's not ideal also for continuous integration either when you could have concurrency issues between different builds.

Reproduce the error

Related issues

Suggest a Fix

Get rid of tabtab in install script and prompt the user for installing it or document it as a pro tip.

JHipster Version(s)

4.6.2

JHipster configuration

Entity configuration(s) `entityName.json` files generated in the `.jhipster` directory

Browsers and Operating System

Checking this box is mandatory (this is just to show you read everything)

The text was updated successfully, but these errors were encountered:

pascalgrimaud · 2017-07-23T13:55:51Z

Although there is an error message, the generator-jhipster should be installed.
But, I agree with you @gmarziou, if tabtab causes trouble, we can try to propose a way to install it separately.

Anyway, jhipster-oh-my-zsh is the best 😛

gmarziou · 2017-07-23T15:14:38Z

Installation works fine but upgrade fails.

jdubois · 2017-07-23T15:36:53Z

we already had a similar issue with someone on Windows or Mac OS X who was upset we modified his .profile (that's what tabtab does to install autocompletion)
Angular CLI has a specific command to install autocompletion

-> we could have a specific sub-generator that installs autocompletion

The only downside is that it goes against our "great developer experience" goal.

gmarziou · 2017-07-23T17:37:26Z

First great user experience is that it works ;)

gmarziou · 2017-07-23T17:51:10Z

could not find the issue with this user about .profile but I found this related issue: #6089

deepu105 · 2017-07-23T19:05:55Z

@gmarziou @jdubois @pascalgrimaud TabTab doesnt support windows as far as I know so we have few options to consider. (Not in any order)

We could just disable auto-completion support all together :(
We could ask user permission before installing TabTab (currently I set it to auto, there is also option to prompt user)
We could load completion manually per session (https://github.com/mklabs/node-tabtab#manual-installation)
4.We could disable installation in windows alone

So please comment on what is more preferable

PierreBesson · 2017-07-23T20:31:21Z

@deepu105, Personally I'm not a big fan of tabtab and it's approach to magically configure things (modifying personal conf files...). Although it always worked for me with nothing to do so it is still kinda cool...
I suggest we move to a different approach which is writing completion scripts ourselves and creating a new completion cli command. So running jhipster completion bash and jhipster completion zsh will output the completion script.

So people need to add the following line to their bashrc/zshrc: source <(jhipster completion bash). This is the approach used by kubectl and I really like it. The shell is a little slower to startup but you are guaranteed that completions correspond to your current cli version. Also it will let us do much smarter completions.

gmarziou · 2017-07-23T21:19:48Z

@deepu105 I'm not sure option 2 would work with upgrade, option 4 could work but it does not solve the other issues I mentioned.

I'm in favor of letting the user decide what to do with her/his files, like baking them up before running sub module, so I like @PierreBesson idea.

In the same idea, I think the upgrade generator should warn the user that it's going to make some changes in her/his local git repo and that it would be a good idea to push local branches to server before starting the upgrade.

deepu105 · 2017-07-23T21:46:11Z

@PierreBesson I like your idea but then the problem is it needs manual steps to make it work and hence mostly will be used only by us and other experienced people. I would atleast like to prompt the user to install completion during installation otherwise I'm afraid that no body will actually do it and use it. It will be like our fish/zsh plugins I guess its used only by our core team mostly (of course just a guess based on queries we get for them)

gmarziou · 2017-07-26T21:17:24Z

Maybe a slight variation of @PierreBesson's idea: we could a have a new sub generator dedicated to all potential helpers (same as what ci-cd does in supporting several tools) and ask a question in the main generator: do you want to improve your development environment?
It is vague enough to include shell completion, IDEs, editors....

I have thought of naming it: "environment", "boost" or "productivity".

PierreBesson · 2017-07-26T21:46:56Z

Maybe we can just print instructions to setup completion after the generator install. If it is just a matter of adding one line to .bashrc/.zshrc I'm sure many people will do it.
We can also propose to install it automatically but we will need to code something for shell detection...

I'm currently hacking on some auto complete scripts... Currently my main issue with our current auto complete is that it's not great, for example it can't auto complete file names when running jhipster import-jdl.

Npm scrpits of generator-jhipster are useful for global installation but they are not required in teh context of an upgrade where the focus is on code and depenencies. These scripts can make the upgrade fail for bad reasons llike issue jhipster#6162 about tabtab. This change add `--ignore-scripts`option to yarn or npm install during upgrade.

gmarziou · 2017-08-05T08:46:44Z

Until we take a long term decision we need to disable tabtab forced installation, it just blocks some users and using --ignore-scripts is only a workaround.

The 2 PR #6180 and #6202 are worth a patch release soon I think.

deepu105 · 2017-08-05T22:51:29Z

We could also look at how npm does the autocompletion. As they add anything to the . files

deepu105 · 2017-08-05T22:55:58Z

Ahh, ok tabtab does the same actually, we just need to use it properly

deepu105 · 2017-08-05T23:05:14Z

Dis some digging so the below enables completion on current shell session for jhipster, but for this to work you need tabtab installed globally with npm i -g tabtab or similar yarn cmd. There is a minor issue of a : at the end though, may be we could find a way to trigger this with a specific command or with some shell magic(which is not my forte)
. <(tabtab install --stdout --name jhipster)

stieler-it · 2017-08-22T09:38:53Z

After upgrading from generator-jhipster 4.5.3 to 4.6.2 we cannot build the prod profile any more. Reason is that we are using a yarn linked version of the generator and the Windows workaround for symlinks seems to break when Yarn is trying to build generator-jhipster with tabtab. If we remove the --force option from yarn in pom.xml it does not fail on tabtab, but later on the missing sass/vendor folder.

Our workaround:

yarn unlink generator-jhipster
mvn clean package -Pprod
yarn link generator-jhipster

gmarziou · 2017-08-22T14:04:35Z

Do you really mean 4.6.2 or current master?

stieler-it · 2017-08-22T21:07:56Z

The problem appeared after upgrading to 4.6.2

gmarziou · 2017-08-22T23:14:44Z

As a workaround you could try to add --ignore-scripts to yarn options as run by the maven plugin.
4.7.0 will include removal of the tabtab and should be released soon.

stieler-it · 2017-08-23T09:50:48Z

Thank you, works for us.

pom.xml diff

- <arguments>install --force</arguments>
+ <arguments>install --force --ignore-scripts</arguments>

mvn clean package -Pprod -> success

gmarziou · 2017-08-24T20:53:26Z

I think we clan close this issue as tabtab has been removed in 4.7.0 and we can open an improvement issue to track how to provide completion in a less intrusive way.

gmarziou added the status: needs-discussion label Jul 23, 2017

PierreBesson closed this as completed Jul 23, 2017

PierreBesson reopened this Jul 23, 2017

gmarziou mentioned this issue Jul 29, 2017

Ignore JHipster package.json scripts during upgrade #6180

Merged

3 tasks

Coccoonx mentioned this issue Aug 4, 2017

Cannot setup JHipster on windows 7 x64 #6200

Closed

1 task

gmarziou mentioned this issue Aug 5, 2017

Don't force users to install shell completions (tabtab) #6202

Merged

2 tasks

deepu105 closed this as completed in 9050532 Aug 5, 2017

deepu105 reopened this Aug 5, 2017

gmarziou added this to the 4.7.0 milestone Aug 24, 2017

gmarziou closed this as completed Aug 24, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JHipster should not install tabtab completions automatically #6162

JHipster should not install tabtab completions automatically #6162

gmarziou commented Jul 23, 2017 •

edited

Loading

pascalgrimaud commented Jul 23, 2017

gmarziou commented Jul 23, 2017

jdubois commented Jul 23, 2017

gmarziou commented Jul 23, 2017

gmarziou commented Jul 23, 2017 •

edited

Loading

deepu105 commented Jul 23, 2017

PierreBesson commented Jul 23, 2017 •

edited

Loading

gmarziou commented Jul 23, 2017 •

edited

Loading

deepu105 commented Jul 23, 2017

gmarziou commented Jul 26, 2017

PierreBesson commented Jul 26, 2017

gmarziou commented Aug 5, 2017 •

edited

Loading

deepu105 commented Aug 5, 2017

deepu105 commented Aug 5, 2017

deepu105 commented Aug 5, 2017

stieler-it commented Aug 22, 2017

gmarziou commented Aug 22, 2017

stieler-it commented Aug 22, 2017

gmarziou commented Aug 22, 2017 •

edited

Loading

stieler-it commented Aug 23, 2017

gmarziou commented Aug 24, 2017 •

edited

Loading

JHipster should not install tabtab completions automatically #6162

JHipster should not install tabtab completions automatically #6162

Comments

gmarziou commented Jul 23, 2017 • edited Loading

Overview of the issue

Motivation for or Use Case

Reproduce the error

Related issues

Suggest a Fix

JHipster Version(s)

JHipster configuration

Entity configuration(s) entityName.json files generated in the .jhipster directory

Browsers and Operating System

pascalgrimaud commented Jul 23, 2017

gmarziou commented Jul 23, 2017

jdubois commented Jul 23, 2017

gmarziou commented Jul 23, 2017

gmarziou commented Jul 23, 2017 • edited Loading

deepu105 commented Jul 23, 2017

PierreBesson commented Jul 23, 2017 • edited Loading

gmarziou commented Jul 23, 2017 • edited Loading

deepu105 commented Jul 23, 2017

gmarziou commented Jul 26, 2017

PierreBesson commented Jul 26, 2017

gmarziou commented Aug 5, 2017 • edited Loading

deepu105 commented Aug 5, 2017

deepu105 commented Aug 5, 2017

deepu105 commented Aug 5, 2017

stieler-it commented Aug 22, 2017

gmarziou commented Aug 22, 2017

stieler-it commented Aug 22, 2017

gmarziou commented Aug 22, 2017 • edited Loading

stieler-it commented Aug 23, 2017

gmarziou commented Aug 24, 2017 • edited Loading

gmarziou commented Jul 23, 2017 •

edited

Loading

Entity configuration(s) `entityName.json` files generated in the `.jhipster` directory

gmarziou commented Jul 23, 2017 •

edited

Loading

PierreBesson commented Jul 23, 2017 •

edited

Loading

gmarziou commented Jul 23, 2017 •

edited

Loading

gmarziou commented Aug 5, 2017 •

edited

Loading

gmarziou commented Aug 22, 2017 •

edited

Loading

gmarziou commented Aug 24, 2017 •

edited

Loading