Merge pull request #268619 from tweag/lib-descriptions
[NixPkgs.git] / pkgs / development / node-packages / node-env.nix
blobbc1e36628ac8ae108a36071827199bb1e8213da6
1 # This file originates from node2nix
3 {lib, stdenv, nodejs, python2, pkgs, libtool, runCommand, writeTextFile, writeShellScript}:
5 let
6   # Workaround to cope with utillinux in Nixpkgs 20.09 and util-linux in Nixpkgs master
7   utillinux = if pkgs ? utillinux then pkgs.utillinux else pkgs.util-linux;
9   python = if nodejs ? python then nodejs.python else python2;
11   # Create a tar wrapper that filters all the 'Ignoring unknown extended header keyword' noise
12   tarWrapper = runCommand "tarWrapper" {} ''
13     mkdir -p $out/bin
15     cat > $out/bin/tar <<EOF
16     #! ${stdenv.shell} -e
17     $(type -p tar) "\$@" --warning=no-unknown-keyword --delay-directory-restore
18     EOF
20     chmod +x $out/bin/tar
21   '';
23   # Function that generates a TGZ file from a NPM project
24   buildNodeSourceDist =
25     { name, version, src, ... }:
27     stdenv.mkDerivation {
28       name = "node-tarball-${name}-${version}";
29       inherit src;
30       buildInputs = [ nodejs ];
31       buildPhase = ''
32         export HOME=$TMPDIR
33         tgzFile=$(npm pack | tail -n 1) # Hooks to the pack command will add output (https://docs.npmjs.com/misc/scripts)
34       '';
35       installPhase = ''
36         mkdir -p $out/tarballs
37         mv $tgzFile $out/tarballs
38         mkdir -p $out/nix-support
39         echo "file source-dist $out/tarballs/$tgzFile" >> $out/nix-support/hydra-build-products
40       '';
41     };
43   # Common shell logic
44   installPackage = writeShellScript "install-package" ''
45     installPackage() {
46       local packageName=$1 src=$2
48       local strippedName
50       local DIR=$PWD
51       cd $TMPDIR
53       unpackFile $src
55       # Make the base dir in which the target dependency resides first
56       mkdir -p "$(dirname "$DIR/$packageName")"
58       if [ -f "$src" ]
59       then
60           # Figure out what directory has been unpacked
61           packageDir="$(find . -maxdepth 1 -type d | tail -1)"
63           # Restore write permissions to make building work
64           find "$packageDir" -type d -exec chmod u+x {} \;
65           chmod -R u+w "$packageDir"
67           # Move the extracted tarball into the output folder
68           mv "$packageDir" "$DIR/$packageName"
69       elif [ -d "$src" ]
70       then
71           # Get a stripped name (without hash) of the source directory.
72           # On old nixpkgs it's already set internally.
73           if [ -z "$strippedName" ]
74           then
75               strippedName="$(stripHash $src)"
76           fi
78           # Restore write permissions to make building work
79           chmod -R u+w "$strippedName"
81           # Move the extracted directory into the output folder
82           mv "$strippedName" "$DIR/$packageName"
83       fi
85       # Change to the package directory to install dependencies
86       cd "$DIR/$packageName"
87     }
88   '';
90   # Bundle the dependencies of the package
91   #
92   # Only include dependencies if they don't exist. They may also be bundled in the package.
93   includeDependencies = {dependencies}:
94     lib.optionalString (dependencies != []) (
95       ''
96         mkdir -p node_modules
97         cd node_modules
98       ''
99       + (lib.concatMapStrings (dependency:
100         ''
101           if [ ! -e "${dependency.packageName}" ]; then
102               ${composePackage dependency}
103           fi
104         ''
105       ) dependencies)
106       + ''
107         cd ..
108       ''
109     );
111   # Recursively composes the dependencies of a package
112   composePackage = { name, packageName, src, dependencies ? [], ... }@args:
113     builtins.addErrorContext "while evaluating node package '${packageName}'" ''
114       installPackage "${packageName}" "${src}"
115       ${includeDependencies { inherit dependencies; }}
116       cd ..
117       ${lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."}
118     '';
120   pinpointDependencies = {dependencies, production}:
121     let
122       pinpointDependenciesFromPackageJSON = writeTextFile {
123         name = "pinpointDependencies.js";
124         text = ''
125           var fs = require('fs');
126           var path = require('path');
128           function resolveDependencyVersion(location, name) {
129               if(location == process.env['NIX_STORE']) {
130                   return null;
131               } else {
132                   var dependencyPackageJSON = path.join(location, "node_modules", name, "package.json");
134                   if(fs.existsSync(dependencyPackageJSON)) {
135                       var dependencyPackageObj = JSON.parse(fs.readFileSync(dependencyPackageJSON));
137                       if(dependencyPackageObj.name == name) {
138                           return dependencyPackageObj.version;
139                       }
140                   } else {
141                       return resolveDependencyVersion(path.resolve(location, ".."), name);
142                   }
143               }
144           }
146           function replaceDependencies(dependencies) {
147               if(typeof dependencies == "object" && dependencies !== null) {
148                   for(var dependency in dependencies) {
149                       var resolvedVersion = resolveDependencyVersion(process.cwd(), dependency);
151                       if(resolvedVersion === null) {
152                           process.stderr.write("WARNING: cannot pinpoint dependency: "+dependency+", context: "+process.cwd()+"\n");
153                       } else {
154                           dependencies[dependency] = resolvedVersion;
155                       }
156                   }
157               }
158           }
160           /* Read the package.json configuration */
161           var packageObj = JSON.parse(fs.readFileSync('./package.json'));
163           /* Pinpoint all dependencies */
164           replaceDependencies(packageObj.dependencies);
165           if(process.argv[2] == "development") {
166               replaceDependencies(packageObj.devDependencies);
167           }
168           else {
169               packageObj.devDependencies = {};
170           }
171           replaceDependencies(packageObj.optionalDependencies);
172           replaceDependencies(packageObj.peerDependencies);
174           /* Write the fixed package.json file */
175           fs.writeFileSync("package.json", JSON.stringify(packageObj, null, 2));
176         '';
177       };
178     in
179     ''
180       node ${pinpointDependenciesFromPackageJSON} ${if production then "production" else "development"}
182       ${lib.optionalString (dependencies != [])
183         ''
184           if [ -d node_modules ]
185           then
186               cd node_modules
187               ${lib.concatMapStrings (dependency: pinpointDependenciesOfPackage dependency) dependencies}
188               cd ..
189           fi
190         ''}
191     '';
193   # Recursively traverses all dependencies of a package and pinpoints all
194   # dependencies in the package.json file to the versions that are actually
195   # being used.
197   pinpointDependenciesOfPackage = { packageName, dependencies ? [], production ? true, ... }@args:
198     ''
199       if [ -d "${packageName}" ]
200       then
201           cd "${packageName}"
202           ${pinpointDependencies { inherit dependencies production; }}
203           cd ..
204           ${lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."}
205       fi
206     '';
208   # Extract the Node.js source code which is used to compile packages with
209   # native bindings
210   nodeSources = runCommand "node-sources" {} ''
211     tar --no-same-owner --no-same-permissions -xf ${nodejs.src}
212     mv node-* $out
213   '';
215   # Script that adds _integrity fields to all package.json files to prevent NPM from consulting the cache (that is empty)
216   addIntegrityFieldsScript = writeTextFile {
217     name = "addintegrityfields.js";
218     text = ''
219       var fs = require('fs');
220       var path = require('path');
222       function augmentDependencies(baseDir, dependencies) {
223           for(var dependencyName in dependencies) {
224               var dependency = dependencies[dependencyName];
226               // Open package.json and augment metadata fields
227               var packageJSONDir = path.join(baseDir, "node_modules", dependencyName);
228               var packageJSONPath = path.join(packageJSONDir, "package.json");
230               if(fs.existsSync(packageJSONPath)) { // Only augment packages that exist. Sometimes we may have production installs in which development dependencies can be ignored
231                   console.log("Adding metadata fields to: "+packageJSONPath);
232                   var packageObj = JSON.parse(fs.readFileSync(packageJSONPath));
234                   if(dependency.integrity) {
235                       packageObj["_integrity"] = dependency.integrity;
236                   } else {
237                       packageObj["_integrity"] = "sha1-000000000000000000000000000="; // When no _integrity string has been provided (e.g. by Git dependencies), add a dummy one. It does not seem to harm and it bypasses downloads.
238                   }
240                   if(dependency.resolved) {
241                       packageObj["_resolved"] = dependency.resolved; // Adopt the resolved property if one has been provided
242                   } else {
243                       packageObj["_resolved"] = dependency.version; // Set the resolved version to the version identifier. This prevents NPM from cloning Git repositories.
244                   }
246                   if(dependency.from !== undefined) { // Adopt from property if one has been provided
247                       packageObj["_from"] = dependency.from;
248                   }
250                   fs.writeFileSync(packageJSONPath, JSON.stringify(packageObj, null, 2));
251               }
253               // Augment transitive dependencies
254               if(dependency.dependencies !== undefined) {
255                   augmentDependencies(packageJSONDir, dependency.dependencies);
256               }
257           }
258       }
260       if(fs.existsSync("./package-lock.json")) {
261           var packageLock = JSON.parse(fs.readFileSync("./package-lock.json"));
263           if(![1, 2].includes(packageLock.lockfileVersion)) {
264             process.stderr.write("Sorry, I only understand lock file versions 1 and 2!\n");
265             process.exit(1);
266           }
268           if(packageLock.dependencies !== undefined) {
269               augmentDependencies(".", packageLock.dependencies);
270           }
271       }
272     '';
273   };
275   # Reconstructs a package-lock file from the node_modules/ folder structure and package.json files with dummy sha1 hashes
276   reconstructPackageLock = writeTextFile {
277     name = "reconstructpackagelock.js";
278     text = ''
279       var fs = require('fs');
280       var path = require('path');
282       var packageObj = JSON.parse(fs.readFileSync("package.json"));
284       var lockObj = {
285           name: packageObj.name,
286           version: packageObj.version,
287           lockfileVersion: 2,
288           requires: true,
289           packages: {
290               "": {
291                   name: packageObj.name,
292                   version: packageObj.version,
293                   license: packageObj.license,
294                   bin: packageObj.bin,
295                   dependencies: packageObj.dependencies,
296                   engines: packageObj.engines,
297                   optionalDependencies: packageObj.optionalDependencies
298               }
299           },
300           dependencies: {}
301       };
303       function augmentPackageJSON(filePath, packages, dependencies) {
304           var packageJSON = path.join(filePath, "package.json");
305           if(fs.existsSync(packageJSON)) {
306               var packageObj = JSON.parse(fs.readFileSync(packageJSON));
307               packages[filePath] = {
308                   version: packageObj.version,
309                   integrity: "sha1-000000000000000000000000000=",
310                   dependencies: packageObj.dependencies,
311                   engines: packageObj.engines,
312                   optionalDependencies: packageObj.optionalDependencies
313               };
314               dependencies[packageObj.name] = {
315                   version: packageObj.version,
316                   integrity: "sha1-000000000000000000000000000=",
317                   dependencies: {}
318               };
319               processDependencies(path.join(filePath, "node_modules"), packages, dependencies[packageObj.name].dependencies);
320           }
321       }
323       function processDependencies(dir, packages, dependencies) {
324           if(fs.existsSync(dir)) {
325               var files = fs.readdirSync(dir);
327               files.forEach(function(entry) {
328                   var filePath = path.join(dir, entry);
329                   var stats = fs.statSync(filePath);
331                   if(stats.isDirectory()) {
332                       if(entry.substr(0, 1) == "@") {
333                           // When we encounter a namespace folder, augment all packages belonging to the scope
334                           var pkgFiles = fs.readdirSync(filePath);
336                           pkgFiles.forEach(function(entry) {
337                               if(stats.isDirectory()) {
338                                   var pkgFilePath = path.join(filePath, entry);
339                                   augmentPackageJSON(pkgFilePath, packages, dependencies);
340                               }
341                           });
342                       } else {
343                           augmentPackageJSON(filePath, packages, dependencies);
344                       }
345                   }
346               });
347           }
348       }
350       processDependencies("node_modules", lockObj.packages, lockObj.dependencies);
352       fs.writeFileSync("package-lock.json", JSON.stringify(lockObj, null, 2));
353     '';
354   };
356   # Script that links bins defined in package.json to the node_modules bin directory
357   # NPM does not do this for top-level packages itself anymore as of v7
358   linkBinsScript = writeTextFile {
359     name = "linkbins.js";
360     text = ''
361       var fs = require('fs');
362       var path = require('path');
364       var packageObj = JSON.parse(fs.readFileSync("package.json"));
366       var nodeModules = Array(packageObj.name.split("/").length).fill("..").join(path.sep);
368       if(packageObj.bin !== undefined) {
369           fs.mkdirSync(path.join(nodeModules, ".bin"))
371           if(typeof packageObj.bin == "object") {
372               Object.keys(packageObj.bin).forEach(function(exe) {
373                   if(fs.existsSync(packageObj.bin[exe])) {
374                       console.log("linking bin '" + exe + "'");
375                       fs.symlinkSync(
376                           path.join("..", packageObj.name, packageObj.bin[exe]),
377                           path.join(nodeModules, ".bin", exe)
378                       );
379                   }
380                   else {
381                       console.log("skipping non-existent bin '" + exe + "'");
382                   }
383               })
384           }
385           else {
386               if(fs.existsSync(packageObj.bin)) {
387                   console.log("linking bin '" + packageObj.bin + "'");
388                   fs.symlinkSync(
389                       path.join("..", packageObj.name, packageObj.bin),
390                       path.join(nodeModules, ".bin", packageObj.name.split("/").pop())
391                   );
392               }
393               else {
394                   console.log("skipping non-existent bin '" + packageObj.bin + "'");
395               }
396           }
397       }
398       else if(packageObj.directories !== undefined && packageObj.directories.bin !== undefined) {
399           fs.mkdirSync(path.join(nodeModules, ".bin"))
401           fs.readdirSync(packageObj.directories.bin).forEach(function(exe) {
402               if(fs.existsSync(path.join(packageObj.directories.bin, exe))) {
403                   console.log("linking bin '" + exe + "'");
404                   fs.symlinkSync(
405                       path.join("..", packageObj.name, packageObj.directories.bin, exe),
406                       path.join(nodeModules, ".bin", exe)
407                   );
408               }
409               else {
410                   console.log("skipping non-existent bin '" + exe + "'");
411               }
412           })
413       }
414     '';
415   };
417   prepareAndInvokeNPM = {packageName, bypassCache, reconstructLock, npmFlags, production}:
418     let
419       forceOfflineFlag = if bypassCache then "--offline" else "--registry http://www.example.com";
420     in
421     ''
422         # Pinpoint the versions of all dependencies to the ones that are actually being used
423         echo "pinpointing versions of dependencies..."
424         source $pinpointDependenciesScriptPath
426         # Patch the shebangs of the bundled modules to prevent them from
427         # calling executables outside the Nix store as much as possible
428         patchShebangs .
430         # Deploy the Node.js package by running npm install. Since the
431         # dependencies have been provided already by ourselves, it should not
432         # attempt to install them again, which is good, because we want to make
433         # it Nix's responsibility. If it needs to install any dependencies
434         # anyway (e.g. because the dependency parameters are
435         # incomplete/incorrect), it fails.
436         #
437         # The other responsibilities of NPM are kept -- version checks, build
438         # steps, postprocessing etc.
440         export HOME=$TMPDIR
441         cd "${packageName}"
442         runHook preRebuild
444         ${lib.optionalString bypassCache ''
445           ${lib.optionalString reconstructLock ''
446             if [ -f package-lock.json ]
447             then
448                 echo "WARNING: Reconstruct lock option enabled, but a lock file already exists!"
449                 echo "This will most likely result in version mismatches! We will remove the lock file and regenerate it!"
450                 rm package-lock.json
451             else
452                 echo "No package-lock.json file found, reconstructing..."
453             fi
455             node ${reconstructPackageLock}
456           ''}
458           node ${addIntegrityFieldsScript}
459         ''}
461         npm ${forceOfflineFlag} --nodedir=${nodeSources} ${npmFlags} ${lib.optionalString production "--production"} rebuild
463         runHook postRebuild
465         if [ "''${dontNpmInstall-}" != "1" ]
466         then
467             # NPM tries to download packages even when they already exist if npm-shrinkwrap is used.
468             rm -f npm-shrinkwrap.json
470             npm ${forceOfflineFlag} --nodedir=${nodeSources} --no-bin-links --ignore-scripts ${npmFlags} ${lib.optionalString production "--production"} install
471         fi
473         # Link executables defined in package.json
474         node ${linkBinsScript}
475     '';
477   # Builds and composes an NPM package including all its dependencies
478   buildNodePackage =
479     { name
480     , packageName
481     , version ? null
482     , dependencies ? []
483     , buildInputs ? []
484     , production ? true
485     , npmFlags ? ""
486     , dontNpmInstall ? false
487     , bypassCache ? false
488     , reconstructLock ? false
489     , preRebuild ? ""
490     , dontStrip ? true
491     , unpackPhase ? "true"
492     , buildPhase ? "true"
493     , meta ? {}
494     , ... }@args:
496     let
497       extraArgs = removeAttrs args [ "name" "dependencies" "buildInputs" "dontStrip" "dontNpmInstall" "preRebuild" "unpackPhase" "buildPhase" "meta" ];
498     in
499     stdenv.mkDerivation ({
500       name = "${name}${if version == null then "" else "-${version}"}";
501       buildInputs = [ tarWrapper python nodejs ]
502         ++ lib.optional (stdenv.isLinux) utillinux
503         ++ lib.optional (stdenv.isDarwin) libtool
504         ++ buildInputs;
506       inherit nodejs;
508       inherit dontStrip; # Stripping may fail a build for some package deployments
509       inherit dontNpmInstall preRebuild unpackPhase buildPhase;
511       compositionScript = composePackage args;
512       pinpointDependenciesScript = pinpointDependenciesOfPackage args;
514       passAsFile = [ "compositionScript" "pinpointDependenciesScript" ];
516       installPhase = ''
517         source ${installPackage}
519         # Create and enter a root node_modules/ folder
520         mkdir -p $out/lib/node_modules
521         cd $out/lib/node_modules
523         # Compose the package and all its dependencies
524         source $compositionScriptPath
526         ${prepareAndInvokeNPM { inherit packageName bypassCache reconstructLock npmFlags production; }}
528         # Create symlink to the deployed executable folder, if applicable
529         if [ -d "$out/lib/node_modules/.bin" ]
530         then
531             ln -s $out/lib/node_modules/.bin $out/bin
533             # Fixup all executables
534             ls $out/bin/* | while read i
535             do
536                 file="$(readlink -f "$i")"
537                 chmod u+rwx "$file"
538                 if isScript "$file"
539                 then
540                     sed -i 's/\r$//' "$file"  # convert crlf to lf
541                 fi
542             done
543         fi
545         # Create symlinks to the deployed manual page folders, if applicable
546         if [ -d "$out/lib/node_modules/${packageName}/man" ]
547         then
548             mkdir -p $out/share
549             for dir in "$out/lib/node_modules/${packageName}/man/"*
550             do
551                 mkdir -p $out/share/man/$(basename "$dir")
552                 for page in "$dir"/*
553                 do
554                     ln -s $page $out/share/man/$(basename "$dir")
555                 done
556             done
557         fi
559         # Run post install hook, if provided
560         runHook postInstall
561       '';
563       meta = {
564         # default to Node.js' platforms
565         platforms = nodejs.meta.platforms;
566       } // meta;
567     } // extraArgs);
569   # Builds a node environment (a node_modules folder and a set of binaries)
570   buildNodeDependencies =
571     { name
572     , packageName
573     , version ? null
574     , src
575     , dependencies ? []
576     , buildInputs ? []
577     , production ? true
578     , npmFlags ? ""
579     , dontNpmInstall ? false
580     , bypassCache ? false
581     , reconstructLock ? false
582     , dontStrip ? true
583     , unpackPhase ? "true"
584     , buildPhase ? "true"
585     , ... }@args:
587     let
588       extraArgs = removeAttrs args [ "name" "dependencies" "buildInputs" ];
589     in
590       stdenv.mkDerivation ({
591         name = "node-dependencies-${name}${if version == null then "" else "-${version}"}";
593         buildInputs = [ tarWrapper python nodejs ]
594           ++ lib.optional (stdenv.isLinux) utillinux
595           ++ lib.optional (stdenv.isDarwin) libtool
596           ++ buildInputs;
598         inherit dontStrip; # Stripping may fail a build for some package deployments
599         inherit dontNpmInstall unpackPhase buildPhase;
601         includeScript = includeDependencies { inherit dependencies; };
602         pinpointDependenciesScript = pinpointDependenciesOfPackage args;
604         passAsFile = [ "includeScript" "pinpointDependenciesScript" ];
606         installPhase = ''
607           source ${installPackage}
609           mkdir -p $out/${packageName}
610           cd $out/${packageName}
612           source $includeScriptPath
614           # Create fake package.json to make the npm commands work properly
615           cp ${src}/package.json .
616           chmod 644 package.json
617           ${lib.optionalString bypassCache ''
618             if [ -f ${src}/package-lock.json ]
619             then
620                 cp ${src}/package-lock.json .
621                 chmod 644 package-lock.json
622             fi
623           ''}
625           # Go to the parent folder to make sure that all packages are pinpointed
626           cd ..
627           ${lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."}
629           ${prepareAndInvokeNPM { inherit packageName bypassCache reconstructLock npmFlags production; }}
631           # Expose the executables that were installed
632           cd ..
633           ${lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."}
635           mv ${packageName} lib
636           ln -s $out/lib/node_modules/.bin $out/bin
637         '';
638       } // extraArgs);
640   # Builds a development shell
641   buildNodeShell =
642     { name
643     , packageName
644     , version ? null
645     , src
646     , dependencies ? []
647     , buildInputs ? []
648     , production ? true
649     , npmFlags ? ""
650     , dontNpmInstall ? false
651     , bypassCache ? false
652     , reconstructLock ? false
653     , dontStrip ? true
654     , unpackPhase ? "true"
655     , buildPhase ? "true"
656     , ... }@args:
658     let
659       nodeDependencies = buildNodeDependencies args;
660       extraArgs = removeAttrs args [ "name" "dependencies" "buildInputs" "dontStrip" "dontNpmInstall" "unpackPhase" "buildPhase" ];
661     in
662     stdenv.mkDerivation ({
663       name = "node-shell-${name}${if version == null then "" else "-${version}"}";
665       buildInputs = [ python nodejs ] ++ lib.optional (stdenv.isLinux) utillinux ++ buildInputs;
666       buildCommand = ''
667         mkdir -p $out/bin
668         cat > $out/bin/shell <<EOF
669         #! ${stdenv.shell} -e
670         $shellHook
671         exec ${stdenv.shell}
672         EOF
673         chmod +x $out/bin/shell
674       '';
676       # Provide the dependencies in a development shell through the NODE_PATH environment variable
677       inherit nodeDependencies;
678       shellHook = lib.optionalString (dependencies != []) ''
679         export NODE_PATH=${nodeDependencies}/lib/node_modules
680         export PATH="${nodeDependencies}/bin:$PATH"
681       '';
682     } // extraArgs);
685   buildNodeSourceDist = lib.makeOverridable buildNodeSourceDist;
686   buildNodePackage = lib.makeOverridable buildNodePackage;
687   buildNodeDependencies = lib.makeOverridable buildNodeDependencies;
688   buildNodeShell = lib.makeOverridable buildNodeShell;