pyrox.dev
1# This file originates from node2nix
2
3{stdenv, nodejs, python2, utillinux, runCommand, writeTextFile}:
4
5let
6 python = if nodejs ? python then nodejs.python else python2;
7
8 # Create a tar wrapper that filters all the 'Ignoring unknown extended header keyword' noise
9 tarWrapper = runCommand "tarWrapper" {} ''
10 mkdir -p $out/bin
11
12 cat > $out/bin/tar <<EOF
13 #! ${stdenv.shell} -e
14 $(type -p tar) "\$@" --warning=no-unknown-keyword
15 EOF
16
17 chmod +x $out/bin/tar
18 '';
19
20 # Function that generates a TGZ file from a NPM project
21 buildNodeSourceDist =
22 { name, version, src, ... }:
23
24 stdenv.mkDerivation {
25 name = "node-tarball-${name}-${version}";
26 inherit src;
27 buildInputs = [ nodejs ];
28 buildPhase = ''
29 export HOME=$TMPDIR
30 tgzFile=$(npm pack)
31 '';
32 installPhase = ''
33 mkdir -p $out/tarballs
34 mv $tgzFile $out/tarballs
35 mkdir -p $out/nix-support
36 echo "file source-dist $out/tarballs/$tgzFile" >> $out/nix-support/hydra-build-products
37 '';
38 };
39
40 includeDependencies = {dependencies}:
41 stdenv.lib.optionalString (dependencies != [])
42 (stdenv.lib.concatMapStrings (dependency:
43 ''
44 # Bundle the dependencies of the package
45 mkdir -p node_modules
46 cd node_modules
47
48 # Only include dependencies if they don't exist. They may also be bundled in the package.
49 if [ ! -e "${dependency.name}" ]
50 then
51 ${composePackage dependency}
52 fi
53
54 cd ..
55 ''
56 ) dependencies);
57
58 # Recursively composes the dependencies of a package
59 composePackage = { name, packageName, src, dependencies ? [], ... }@args:
60 ''
61 DIR=$(pwd)
62 cd $TMPDIR
63
64 unpackFile ${src}
65
66 # Make the base dir in which the target dependency resides first
67 mkdir -p "$(dirname "$DIR/${packageName}")"
68
69 if [ -f "${src}" ]
70 then
71 # Figure out what directory has been unpacked
72 packageDir="$(find . -maxdepth 1 -type d | tail -1)"
73
74 # Restore write permissions to make building work
75 find "$packageDir" -type d -print0 | xargs -0 chmod u+x
76 chmod -R u+w "$packageDir"
77
78 # Move the extracted tarball into the output folder
79 mv "$packageDir" "$DIR/${packageName}"
80 elif [ -d "${src}" ]
81 then
82 # Get a stripped name (without hash) of the source directory.
83 # On old nixpkgs it's already set internally.
84 if [ -z "$strippedName" ]
85 then
86 strippedName="$(stripHash ${src})"
87 fi
88
89 # Restore write permissions to make building work
90 chmod -R u+w "$strippedName"
91
92 # Move the extracted directory into the output folder
93 mv "$strippedName" "$DIR/${packageName}"
94 fi
95
96 # Unset the stripped name to not confuse the next unpack step
97 unset strippedName
98
99 # Include the dependencies of the package
100 cd "$DIR/${packageName}"
101 ${includeDependencies { inherit dependencies; }}
102 cd ..
103 ${stdenv.lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."}
104 '';
105
106 pinpointDependencies = {dependencies, production}:
107 let
108 pinpointDependenciesFromPackageJSON = writeTextFile {
109 name = "pinpointDependencies.js";
110 text = ''
111 var fs = require('fs');
112 var path = require('path');
113
114 function resolveDependencyVersion(location, name) {
115 if(location == process.env['NIX_STORE']) {
116 return null;
117 } else {
118 var dependencyPackageJSON = path.join(location, "node_modules", name, "package.json");
119
120 if(fs.existsSync(dependencyPackageJSON)) {
121 var dependencyPackageObj = JSON.parse(fs.readFileSync(dependencyPackageJSON));
122
123 if(dependencyPackageObj.name == name) {
124 return dependencyPackageObj.version;
125 }
126 } else {
127 return resolveDependencyVersion(path.resolve(location, ".."), name);
128 }
129 }
130 }
131
132 function replaceDependencies(dependencies) {
133 if(typeof dependencies == "object" && dependencies !== null) {
134 for(var dependency in dependencies) {
135 var resolvedVersion = resolveDependencyVersion(process.cwd(), dependency);
136
137 if(resolvedVersion === null) {
138 process.stderr.write("WARNING: cannot pinpoint dependency: "+dependency+", context: "+process.cwd()+"\n");
139 } else {
140 dependencies[dependency] = resolvedVersion;
141 }
142 }
143 }
144 }
145
146 /* Read the package.json configuration */
147 var packageObj = JSON.parse(fs.readFileSync('./package.json'));
148
149 /* Pinpoint all dependencies */
150 replaceDependencies(packageObj.dependencies);
151 if(process.argv[2] == "development") {
152 replaceDependencies(packageObj.devDependencies);
153 }
154 replaceDependencies(packageObj.optionalDependencies);
155
156 /* Write the fixed package.json file */
157 fs.writeFileSync("package.json", JSON.stringify(packageObj, null, 2));
158 '';
159 };
160 in
161 ''
162 node ${pinpointDependenciesFromPackageJSON} ${if production then "production" else "development"}
163
164 ${stdenv.lib.optionalString (dependencies != [])
165 ''
166 if [ -d node_modules ]
167 then
168 cd node_modules
169 ${stdenv.lib.concatMapStrings (dependency: pinpointDependenciesOfPackage dependency) dependencies}
170 cd ..
171 fi
172 ''}
173 '';
174
175 # Recursively traverses all dependencies of a package and pinpoints all
176 # dependencies in the package.json file to the versions that are actually
177 # being used.
178
179 pinpointDependenciesOfPackage = { packageName, dependencies ? [], production ? true, ... }@args:
180 ''
181 if [ -d "${packageName}" ]
182 then
183 cd "${packageName}"
184 ${pinpointDependencies { inherit dependencies production; }}
185 cd ..
186 ${stdenv.lib.optionalString (builtins.substring 0 1 packageName == "@") "cd .."}
187 fi
188 '';
189
190 # Extract the Node.js source code which is used to compile packages with
191 # native bindings
192 nodeSources = runCommand "node-sources" {} ''
193 tar --no-same-owner --no-same-permissions -xf ${nodejs.src}
194 mv node-* $out
195 '';
196
197 # Script that adds _integrity fields to all package.json files to prevent NPM from consulting the cache (that is empty)
198 addIntegrityFieldsScript = writeTextFile {
199 name = "addintegrityfields.js";
200 text = ''
201 var fs = require('fs');
202 var path = require('path');
203
204 function augmentDependencies(baseDir, dependencies) {
205 for(var dependencyName in dependencies) {
206 var dependency = dependencies[dependencyName];
207
208 // Open package.json and augment metadata fields
209 var packageJSONDir = path.join(baseDir, "node_modules", dependencyName);
210 var packageJSONPath = path.join(packageJSONDir, "package.json");
211
212 if(fs.existsSync(packageJSONPath)) { // Only augment packages that exist. Sometimes we may have production installs in which development dependencies can be ignored
213 console.log("Adding metadata fields to: "+packageJSONPath);
214 var packageObj = JSON.parse(fs.readFileSync(packageJSONPath));
215
216 if(dependency.integrity) {
217 packageObj["_integrity"] = dependency.integrity;
218 } else {
219 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.
220 }
221
222 packageObj["_resolved"] = dependency.version; // Set the resolved version to the version identifier. This prevents NPM from cloning Git repositories.
223 fs.writeFileSync(packageJSONPath, JSON.stringify(packageObj, null, 2));
224 }
225
226 // Augment transitive dependencies
227 if(dependency.dependencies !== undefined) {
228 augmentDependencies(packageJSONDir, dependency.dependencies);
229 }
230 }
231 }
232
233 if(fs.existsSync("./package-lock.json")) {
234 var packageLock = JSON.parse(fs.readFileSync("./package-lock.json"));
235
236 if(packageLock.lockfileVersion !== 1) {
237 process.stderr.write("Sorry, I only understand lock file version 1!\n");
238 process.exit(1);
239 }
240
241 if(packageLock.dependencies !== undefined) {
242 augmentDependencies(".", packageLock.dependencies);
243 }
244 }
245 '';
246 };
247
248 # Reconstructs a package-lock file from the node_modules/ folder structure and package.json files with dummy sha1 hashes
249 reconstructPackageLock = writeTextFile {
250 name = "addintegrityfields.js";
251 text = ''
252 var fs = require('fs');
253 var path = require('path');
254
255 var packageObj = JSON.parse(fs.readFileSync("package.json"));
256
257 var lockObj = {
258 name: packageObj.name,
259 version: packageObj.version,
260 lockfileVersion: 1,
261 requires: true,
262 dependencies: {}
263 };
264
265 function augmentPackageJSON(filePath, dependencies) {
266 var packageJSON = path.join(filePath, "package.json");
267 if(fs.existsSync(packageJSON)) {
268 var packageObj = JSON.parse(fs.readFileSync(packageJSON));
269 dependencies[packageObj.name] = {
270 version: packageObj.version,
271 integrity: "sha1-000000000000000000000000000=",
272 dependencies: {}
273 };
274 processDependencies(path.join(filePath, "node_modules"), dependencies[packageObj.name].dependencies);
275 }
276 }
277
278 function processDependencies(dir, dependencies) {
279 if(fs.existsSync(dir)) {
280 var files = fs.readdirSync(dir);
281
282 files.forEach(function(entry) {
283 var filePath = path.join(dir, entry);
284 var stats = fs.statSync(filePath);
285
286 if(stats.isDirectory()) {
287 if(entry.substr(0, 1) == "@") {
288 // When we encounter a namespace folder, augment all packages belonging to the scope
289 var pkgFiles = fs.readdirSync(filePath);
290
291 pkgFiles.forEach(function(entry) {
292 if(stats.isDirectory()) {
293 var pkgFilePath = path.join(filePath, entry);
294 augmentPackageJSON(pkgFilePath, dependencies);
295 }
296 });
297 } else {
298 augmentPackageJSON(filePath, dependencies);
299 }
300 }
301 });
302 }
303 }
304
305 processDependencies("node_modules", lockObj.dependencies);
306
307 fs.writeFileSync("package-lock.json", JSON.stringify(lockObj, null, 2));
308 '';
309 };
310
311 # Builds and composes an NPM package including all its dependencies
312 buildNodePackage = { name, packageName, version, dependencies ? [], production ? true, npmFlags ? "", dontNpmInstall ? false, bypassCache ? false, preRebuild ? "", ... }@args:
313
314 let
315 forceOfflineFlag = if bypassCache then "--offline" else "--registry http://www.example.com";
316 in
317 stdenv.lib.makeOverridable stdenv.mkDerivation (builtins.removeAttrs args [ "dependencies" ] // {
318 name = "node-${name}-${version}";
319 buildInputs = [ tarWrapper python nodejs ] ++ stdenv.lib.optional (stdenv.isLinux) utillinux ++ args.buildInputs or [];
320 dontStrip = args.dontStrip or true; # Striping may fail a build for some package deployments
321
322 inherit dontNpmInstall preRebuild;
323
324 unpackPhase = args.unpackPhase or "true";
325
326 buildPhase = args.buildPhase or "true";
327
328 compositionScript = composePackage args;
329 pinpointDependenciesScript = pinpointDependenciesOfPackage args;
330
331 passAsFile = [ "compositionScript" "pinpointDependenciesScript" ];
332
333 installPhase = args.installPhase or ''
334 # Create and enter a root node_modules/ folder
335 mkdir -p $out/lib/node_modules
336 cd $out/lib/node_modules
337
338 # Compose the package and all its dependencies
339 source $compositionScriptPath
340
341 # Pinpoint the versions of all dependencies to the ones that are actually being used
342 echo "pinpointing versions of dependencies..."
343 source $pinpointDependenciesScriptPath
344
345 # Patch the shebangs of the bundled modules to prevent them from
346 # calling executables outside the Nix store as much as possible
347 patchShebangs .
348
349 # Deploy the Node.js package by running npm install. Since the
350 # dependencies have been provided already by ourselves, it should not
351 # attempt to install them again, which is good, because we want to make
352 # it Nix's responsibility. If it needs to install any dependencies
353 # anyway (e.g. because the dependency parameters are
354 # incomplete/incorrect), it fails.
355 #
356 # The other responsibilities of NPM are kept -- version checks, build
357 # steps, postprocessing etc.
358
359 export HOME=$TMPDIR
360 cd "${packageName}"
361 runHook preRebuild
362
363 ${stdenv.lib.optionalString bypassCache ''
364 if [ ! -f package-lock.json ]
365 then
366 echo "No package-lock.json file found, reconstructing..."
367 node ${reconstructPackageLock}
368 fi
369
370 node ${addIntegrityFieldsScript}
371 ''}
372
373 npm ${forceOfflineFlag} --nodedir=${nodeSources} ${npmFlags} ${stdenv.lib.optionalString production "--production"} rebuild
374
375 if [ "$dontNpmInstall" != "1" ]
376 then
377 # NPM tries to download packages even when they already exist if npm-shrinkwrap is used.
378 rm -f npm-shrinkwrap.json
379
380 npm ${forceOfflineFlag} --nodedir=${nodeSources} ${npmFlags} ${stdenv.lib.optionalString production "--production"} install
381 fi
382
383 # Create symlink to the deployed executable folder, if applicable
384 if [ -d "$out/lib/node_modules/.bin" ]
385 then
386 ln -s $out/lib/node_modules/.bin $out/bin
387 fi
388
389 # Create symlinks to the deployed manual page folders, if applicable
390 if [ -d "$out/lib/node_modules/${packageName}/man" ]
391 then
392 mkdir -p $out/share
393 for dir in "$out/lib/node_modules/${packageName}/man/"*
394 do
395 mkdir -p $out/share/man/$(basename "$dir")
396 for page in "$dir"/*
397 do
398 ln -s $page $out/share/man/$(basename "$dir")
399 done
400 done
401 fi
402
403 # Run post install hook, if provided
404 runHook postInstall
405 '';
406 });
407
408 # Builds a development shell
409 buildNodeShell = { name, packageName, version, src, dependencies ? [], production ? true, npmFlags ? "", dontNpmInstall ? false, bypassCache ? false, ... }@args:
410 let
411 forceOfflineFlag = if bypassCache then "--offline" else "--registry http://www.example.com";
412
413 nodeDependencies = stdenv.mkDerivation {
414 name = "node-dependencies-${name}-${version}";
415
416 buildInputs = [ tarWrapper python nodejs ] ++ stdenv.lib.optional (stdenv.isLinux) utillinux ++ args.buildInputs or [];
417
418 includeScript = includeDependencies { inherit dependencies; };
419 pinpointDependenciesScript = pinpointDependenciesOfPackage args;
420
421 passAsFile = [ "includeScript" "pinpointDependenciesScript" ];
422
423 buildCommand = ''
424 mkdir -p $out/${packageName}
425 cd $out/${packageName}
426
427 source $includeScriptPath
428
429 # Create fake package.json to make the npm commands work properly
430 cp ${src}/package.json .
431 chmod 644 package.json
432 ${stdenv.lib.optionalString bypassCache ''
433 if [ -f ${src}/package-lock.json ]
434 then
435 cp ${src}/package-lock.json .
436 fi
437 ''}
438
439 # Pinpoint the versions of all dependencies to the ones that are actually being used
440 echo "pinpointing versions of dependencies..."
441 cd ..
442 source $pinpointDependenciesScriptPath
443 cd ${packageName}
444
445 # Patch the shebangs of the bundled modules to prevent them from
446 # calling executables outside the Nix store as much as possible
447 patchShebangs .
448
449 export HOME=$PWD
450
451 ${stdenv.lib.optionalString bypassCache ''
452 if [ ! -f package-lock.json ]
453 then
454 echo "No package-lock.json file found, reconstructing..."
455 node ${reconstructPackageLock}
456 fi
457
458 node ${addIntegrityFieldsScript}
459 ''}
460
461 npm ${forceOfflineFlag} --nodedir=${nodeSources} ${npmFlags} ${stdenv.lib.optionalString production "--production"} rebuild
462
463 ${stdenv.lib.optionalString (!dontNpmInstall) ''
464 # NPM tries to download packages even when they already exist if npm-shrinkwrap is used.
465 rm -f npm-shrinkwrap.json
466
467 npm ${forceOfflineFlag} --nodedir=${nodeSources} ${npmFlags} ${stdenv.lib.optionalString production "--production"} install
468 ''}
469
470 cd ..
471 mv ${packageName} lib
472 ln -s $out/lib/node_modules/.bin $out/bin
473 '';
474 };
475 in
476 stdenv.lib.makeOverridable stdenv.mkDerivation {
477 name = "node-shell-${name}-${version}";
478
479 buildInputs = [ python nodejs ] ++ stdenv.lib.optional (stdenv.isLinux) utillinux ++ args.buildInputs or [];
480 buildCommand = ''
481 mkdir -p $out/bin
482 cat > $out/bin/shell <<EOF
483 #! ${stdenv.shell} -e
484 $shellHook
485 exec ${stdenv.shell}
486 EOF
487 chmod +x $out/bin/shell
488 '';
489
490 # Provide the dependencies in a development shell through the NODE_PATH environment variable
491 inherit nodeDependencies;
492 shellHook = stdenv.lib.optionalString (dependencies != []) ''
493 export NODE_PATH=$nodeDependencies/lib/node_modules
494 '';
495 };
496in
497{ inherit buildNodeSourceDist buildNodePackage buildNodeShell; }