Postinstall script installation fails when installing locally

[horike37]

This is a Bug Report

Description

I know a correct way to install globally using npm install serverless - g, but when installing locally in own project with npm install serverless --save, an error occurs during execution of postinstall.js.

Is this bug? or does it mean sls has not supported for installing locally?

step to reproduce

• Create directory with mkdir sls-project && cd sls-project
• Run npm init
• Run npm install serverless --save, and you will see the following error

$npm install serverless --save
npm WARN registry Unexpected warning for https://registry.npmjs.org/: Miscellaneous Warning EINTEGRITY: sha1-F2n0tVHu3OQZ8FBd6uLiZ2NULTc= integrity checksum failed when using sha1: wanted sha1-F2n0tVHu3OQZ8FBd6uLiZ2NULTc= but got sha512-0TZ20a+xcIl4u0+Mj5xDH2yOWdmQiXlKf9Hm+TgDXjTMsEYb+gDrmb8e8UNAzMCitX8NBqG4Z/FUQIyzv/R1JQ==. (2982 bytes)

> serverless@1.15.3 postinstall /Users/horike/src/sls-project/node_modules/serverless
> node ./scripts/postinstall.js

module.js:471
    throw err;
    ^

Error: Cannot find module '/Users/horike/src/sls-project/node_modules/serverless/node_modules/tabtab/src/cli.js'
    at Function.Module._resolveFilename (module.js:469:15)
    at Function.Module._load (module.js:417:25)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:394:7)
    at startup (bootstrap_node.js:149:9)
    at bootstrap_node.js:509:3
module.js:471
    throw err;
    ^

Error: Cannot find module '/Users/horike/src/sls-project/node_modules/serverless/node_modules/tabtab/src/cli.js'
    at Function.Module._resolveFilename (module.js:469:15)
    at Function.Module._load (module.js:417:25)
    at Module.runMain (module.js:604:10)
    at run (bootstrap_node.js:394:7)
    at startup (bootstrap_node.js:149:9)
    at bootstrap_node.js:509:3

> spawn-sync@1.0.15 postinstall /Users/horike/src/sls-project/node_modules/spawn-sync
> node postinstall

npm WARN saveError ENOENT: no such file or directory, open '/Users/horike/src/sls-project/package.json'
npm notice created a lockfile as package-lock.json. You should commit this file.
npm WARN enoent ENOENT: no such file or directory, open '/Users/horike/src/sls-project/package.json'
npm WARN sls-project No description
npm WARN sls-project No repository field.
npm WARN sls-project No README data
npm WARN sls-project No license field.

+ serverless@1.15.3
added 210 packages in 23.298s

Similar or dependent issues:

• Postinstall script installation of tabtab fails #3760
• Fix postinstall error #3763

Additional Data

• node version: 6.10.2
• npm version: 5.0.3
• Serverless Framework Version you're using:1.15.3
• Operating System: macOS 10.11.6
• Stack Trace: above
• Provider Error messages: above

[HyperBrain]

I think I know what that is - @horike37 can you check if the tabtab package in your project is located at node_modules/tabtab instead of node_modules/serverless/tabtab.

This can happen is npm flattens the module directory and optimizes it.
@pmuens If that's the case, the postinstall call of the tabtab cli should try to find the cli.js in one of the locations and execute it from where it is actually located.

[horike37]

@HyperBrain
I think what you stated correctly.
When instaling globally, the tabtab package is located at serverless/node_modules/tabtab/src/cli.js, so sls can run the cli.
However, when instaling in my project, the cli is located at ./node_modules/tabtab/src/cli.js, so sls can not find the cli. sls has expected the cli installed at ./node_modules/serverless/node_modules/tabtab/src/cli.js

[HyperBrain]

as a quick fix you can use npm install --legacy-bundling in your project dir. This will make sure that npm disables the optimization and flattening. But remove the node_modules dir before.

[horike37]

as a quick fix you can use npm install --legacy-bundling in your project dir

That's make sense! I didn't know it

cc: @k1LoW

[HyperBrain]

@pmuens I use the get-installed-path node package in some of my code. This let's you find the installation location of node modules easily. You could use that to retrieve the current location of the tabtab module:

const getInstalledPath = require('get-installed-path');
...
const tabtabPath = getInstalledPath.sync('tabtab', { local: true });

[k1LoW]

@HyperBrain Thank you for your advice!

[pmuens]

Thanks for opening @horike37 and thanks for jumping in and debugging @HyperBrain 👍

We'll look into this! /cc @eahefnawy @brianneisler

[hash]

Hello, on windows it is still broken.
My fix attempt:

diff --git a/scripts/postinstall.js b/scripts/postinstall.js
index 9eb4fba3..5de81cc0 100644
--- a/scripts/postinstall.js
+++ b/scripts/postinstall.js
@@ -5,6 +5,7 @@
 
 const Serverless = require('../lib/Serverless');
 const execSync = require('child_process').execSync;
+const path = require('path');
 
 try {
   const serverless = new Serverless();
@@ -20,14 +21,16 @@ try {
 
 function setupAutocomplete() {
   return new Promise((resolve, reject) => {
-    const tabtabPath = require.resolve('tabtab').replace(/\/index.js$/, '');
+    const tabtabPath = require.resolve('tabtab').split(path.sep);
+    if (tabtabPath[tabtabPath.length - 1] === 'index.js') { tabtabPath.pop(); }
+    const tabtabPathCli = path.join(...tabtabPath, 'src', 'cli.js');
     try {
-      execSync(`node ${tabtabPath}/src/cli.js install --name serverless --auto`);
-      execSync(`node ${tabtabPath}/src/cli.js install --name sls --auto`);
+      execSync(`node ${tabtabPathCli} install --name serverless --auto`);
+      execSync(`node ${tabtabPathCli} install --name sls --auto`);
       return resolve();
     } catch (error) {
-      execSync(`node ${tabtabPath}/src/cli.js install --name serverless --stdout`);
-      execSync(`node ${tabtabPath}/src/cli.js install --name sls --stdout`);
+      execSync(`node ${tabtabPathCli} install --name serverless --stdout`);
+      execSync(`node ${tabtabPathCli} install --name sls --stdout`);
       console.log('Could not auto-install serverless autocomplete script.');
       console.log('Please copy / paste the script above into your shell.');
       return reject(error);