Description

This project demonstrates ENAMETOOLONG OS level error which sometimes happens to occur in node-config library.

Prerequisites

• Multiple configuration subfolders (around 10 or more)
• Deep directory nesting. You should clone this repo deeper enough so that your filenames become quite long to eventually produce this bug (don't place it on the HOME dir level, it should be deeper)

Recommendations

It's better to run this code on OS X system which has Python installed (Linux should also work, but I didn't test this script there, however I know that Linux has usually 4096 bytes limitation for PATH_MAX).

Steps to reproduce

1. Clone the project
2. Run npm i
3. Execute npm start in terminal and check the error message which looks like this:

{ MAX_PATH: 1024, MAX_FILENAME: 255 }
{ paths:
   [ 'environment-000',
     'environment-001',
     'environment-002',
     'environment-003',
     'environment-04',
     'environment-05',
     'environment-06',
     'environment-07',
     'environment-08',
     'environment-09',
     'environment-10',
     'environment-11' ] }
{ longPath:
   '/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-000:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-001:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-002:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-003:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-04:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-05:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-06:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-07:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-08:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-09:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-10:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-11',
  longPathLength: 1024 }
/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/node_modules/config/lib/config.js:771
      throw new Error('Config file ' + fullFilename + ' cannot be read. Error code is: '+e2.code
      ^

Error: Config file /Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-000:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-001:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-002:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-003:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-04:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-05:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-06:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-07:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-08:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-09:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-10:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-11/runtime.json cannot be read. Error code is: ENAMETOOLONG. Error message is: ENAMETOOLONG: name too long, open '/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-000:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-001:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-002:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-003:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-04:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-05:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-06:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-07:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-08:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-09:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-10:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-11/runtime.json'
    at Config.util.parseFile (/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/node_modules/config/lib/config.js:771:13)
    at Config.util.loadFileConfigs (/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/node_modules/config/lib/config.js:648:26)
    at new Config (/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/node_modules/config/lib/config.js:116:27)
    at Object.<anonymous> (/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/node_modules/config/lib/config.js:1441:31)
    at Module._compile (internal/modules/cjs/loader.js:689:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:700:10)
    at Module.load (internal/modules/cjs/loader.js:599:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:538:12)
    at Function.Module._load (internal/modules/cjs/loader.js:530:3)
    at Module.require (internal/modules/cjs/loader.js:637:17)

4. Pay attention to this part:

Error: Config file /Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-000
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-001
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-002
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-003
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-04
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-05
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-06
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-07
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-08
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-09
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-10
:/Users/alexlubchuk/open-source/issues/node-config-enametoolong-issue/environment-11/runtime.json cannot be read. Error code is: ENAMETOOLONG.

5. By default the length of the filenames is configured in such a way that it fails for filenames that has 1024 bytes long (OS X default PATH_MAX value). Check longPathLength variable that is logged in terminal, which value it contains. Then rename some of the subfolders so that longPathLength is less than 1024, i.e. environment-000 dir to environment-00 and run script again. Make sure you don't see that error any more.

6. Values of PATH_MAX and NAME_MAX are printed out for debug purposes using python os module (python 2 should be installed on your system).

7. Another way how you can check the value of PATH_MAX on your OS X system is to run this script (probably you will need to adjust the path if it fails to run):

# First you need to find syslimits.h file
find /Applications/Xcode.app -type f -name "syslimits"

# Then you can check the value
cat /<put_your_path_here>/syslimits.h | grep -i  path_max