Node.js: Difference between revisions

(11 intermediate revisions by 6 users not shown)

Line 1:

__TOC__

~~{{expansion}}~~

~~== Install ==~~

[https://nodejs.org Node.js] is an open-source, cross-platform JavaScript runtime environment that allows developers to execute JavaScript code on the server side. Built on the V8 JavaScript engine, it enables the creation of scalable and high-performance applications, particularly for real-time web services.

== Setup ==

Adapt or add following line to your system configuration:<syntaxhighlight lang="nix>

environment.systemPackages = with pkgs; [ nodejs ];

</syntaxhighlight>

Line 10:

See <code>nix search nixpkgs nodejs</code> for additional versions like <code>nodejs-12_x</code>, etc.

== ~~Packaging ==~~

== Troubleshooting ==

~~=== Packaging with <code>buildNpmPackage</code> ===~~

From the [https://nixos.org/manual/nixpkgs/stable/#javascript-tool-specific Nixpkgs manual]: "<code>buildNpmPackage</code> allows you to package npm-based projects in Nixpkgs without the use of an auto-generated dependencies file (as used in node2nix). It works by utilizing npm’s cache functionality – creating a reproducible cache that contains the dependencies of a project, and pointing npm to it."

~~==== Packaging electron applications ====~~

When trying to <code>npm i</code> electron, by default electron will try to download binaries from the internet, which does not work in the Nix sandbox. To stop it from trying to access the internet, set the environment variable <code>ELECTRON_SKIP_BINARY_DOWNLOAD = "1";</code>.

For examples of packaging electron applications, search [https://github.com/search?q=buildNpmPackage+electron+repo%3ANixOS%2Fnixpkgs&type=code&l=NixOS%2Fnixpkgs Nixpkgs] for the terms "buildNpmPackage" and "electron".

~~=== Packaging with <code>yarn2nix</code> ===~~

~~yarn2nix uses the yarn nodejs tool to create a file called yarn.lock, which in return can be used by yarn2nix to generate a usable yarn expression.~~

~~This is what was needed to convert a small application server [https://git.shackspace.de/rz/muellshack/tree/3be09715911628b164fa1cf346387555ca26a5b1 shackspace muellshack]:~~

~~<syntaxHighlight lang=console>~~

~~$ nix-shell -p yarn yarn2nix~~

~~$ yarn install~~

~~# creates yarn.lock~~

~~$ yarn2nix > yarn.nix~~

~~$ vim package.json~~

~~# add: "bin": "app.js",~~

~~$ cat > default.nix <<EOF~~

~~with (import <nixpkgs> {});~~

~~rec {~~

~~muellshack = mkYarnPackage {~~

~~name = "muellshack";~~

~~src = ./.;~~

~~packageJSON = ./package.json;~~

~~yarnLock = ./yarn.lock;~~

~~yarnNix = ./yarn.nix;~~

};

}

~~EOF~~

~~$ sed -i '1i#!/usr/bin/env node' app.js~~

~~$ chmod +x app.js~~

~~$ nix-build~~

~~$ result/bin/muellshack~~

~~</syntaxHighlight>~~

~~The complete diff can be found at [https://git.shackspace.de/rz/muellshack/commit/f5e498acd47695c4947dc1b5ddebfad2eee8d653 the respective diff]~~

~~== FAQ~~ ==

=== Using <code>npm install -g</code> fails ===

Line 139:

Line 99:

</pre>

One quick workaround for this is [~~https://nixos.wiki/wiki/~~Steam#~~steam-run~~ to use <code>steam-run</code>] to provide a placeholder FHS environment that *should* work; e.g. for the Cypress example above:

One quick workaround for this is [[Steam#FHS environment only| to use <code>steam-run</code>]] to provide a placeholder FHS environment that *should* work; e.g. for the Cypress example above:

<pre>

Line 151:

Line 111:

(Inspired by [https://discourse.nixos.org/t/how-to-make-nixos-so-easy-that-people-can-be-productive-up-front-without-having-to-first-learn-the-nix-language/5625 this discussion on discourse.nixos.org])

~~== Example nix shell for Node.js development ==~~

'''Google-fonts fetch failure with NextJS'''

`shell.nix~~` example~~:

Nextjs is a popular React framework and comes with built-in support with support for Google fonts. If a NPM project uses it, <syntaxhighlight lang="shell">

npm run build # which calls "next build"

~~{ pkgs ? import <nixpkgs> {} }~~:

</syntaxhighlight>will try to fetch and optimize the Google fonts during a nix build run, which will fail in Nix's isolated sandbox without internet:<syntaxhighlight lang="shell">

...

Running phase: buildPhase

Executing npmBuildHook

~~let~~

> nextjs-ollama-local-ai@0.1.0 build

~~lib = import <nixpkgs/lib~~>;

> next build

~~buildNodeJs = pkgs~~.~~callPackage <nixpkgs/pkgs/development/web/nodejs/nodejs~~.~~nix~~> ~~{};~~

~~nodejsVersion = lib~~.~~fileContents~~ ./.~~nvmrc;~~

▲ Next.js 14.1.0

~~nodejs~~ = ~~buildNodeJs {~~

Creating an optimized production build ...

~~enableNpm = false;~~

request to https://fonts.googleapis.com/css2?family=Inter:wght@100..900&display=swap failed, reason: getaddrinfo EAI_AGAIN fonts.googleapis.com

~~version = nodejsVersion;~~

at ClientRequest.<anonymous> (/build/source/node_modules/next/dist/compiled/node-fetch/index.js:1:66160)

~~sha256 = "1a0zj505nhpfcj19qvjy2hvc5a7gadykv51y0rc6032qhzzsgca2";~~

at ClientRequest.emit (node:events:518:28)

};

at TLSSocket.socketErrorListener (node:_http_client:500:9)

at TLSSocket.emit (node:events:518:28)

at emitErrorNT (node:internal/streams/destroy:169:8)

at emitErrorCloseNT (node:internal/streams/destroy:128:3)

at process.processTicksAndRejections (node:internal/process/task_queues:82:21) {

type: 'system',

errno: 'EAI_AGAIN',

code: 'EAI_AGAIN'

}

Failed to compile.

~~NPM_CONFIG_PREFIX = toString~~ ./~~npm_config_prefix;~~

src/app/layout.tsx

`next/font` error:

Failed to fetch `Inter` from Google Fonts.

~~in pkgs.mkShell {~~

> Build failed because of webpack errors

~~packages = with pkgs; [~~

~~nodejs~~

~~nodePackages.npm~~

];

~~inherit NPM_CONFIG_PREFIX~~;

ERROR: `npm build` failed

</syntaxhighlight>You have to patch the Javascript code <syntaxhighlight lang="javascript">

# In layout.tsx file replace

#

# import {Inter} from "next/font/google"; #or any other Google font like Inter

# const inter = Inter({ subsets: ["latin"] });

#

# with ("src:" must be relative to the src/app/layout.tsx file):

import localFont from "next/font/local";

const inter = localFont({ src: './Inter.ttf' });

</syntaxhighlight>and place the Google fonts from Nixpkgs into the project, e.g. in a <code>preBuild</code> phase:<syntaxhighlight lang="nix">

buildNpmPackage {

pname = "myproject";

version = "1.0.0";

...

~~shellHook~~ = ''

# see https://github.com/NixOS/nixpkgs/blob/master/pkgs/by-name/cr/crabfit-frontend/package.nix

~~export PATH=~~"${~~NPM_CONFIG_PREFIX~~}/~~bin:$PATH~~"

preBuild = ''

cp "${

google-fonts.override { fonts = [ "Inter" ]; }

}/share/fonts/truetype/Inter[slnt,wght].ttf" src/app/Inter.ttf

'';

...

}

</syntaxhighlight>You can take a look at what fonts are available in the Nix <code>google-fonts</code> package by calling:<syntaxhighlight lang="shell">

ls -ahl $(nix build --no-link --print-out-paths nixpkgs#google-fonts)/share/fonts/truetype/

</syntaxhighlight>Take a look at https://github.com/NixOS/nixpkgs/blob/master/pkgs/servers/homepage-dashboard/default.nix for further workarounds for Nextjs in Nix.

</~~syntaxhighlight~~>

== Tips and tricks ==

=== Packaging with <code>buildNpmPackage</code> ===

From the [https://nixos.org/manual/nixpkgs/stable/#javascript-tool-specific Nixpkgs manual]: "<code>buildNpmPackage</code> allows you to package npm-based projects in Nixpkgs without the use of an auto-generated dependencies file (as used in node2nix). It works by utilizing npm’s cache functionality – creating a reproducible cache that contains the dependencies of a project, and pointing npm to it."

'''To better understand what happens under the hood and see the latest features see'''

https://github.com/NixOS/nixpkgs/blob/master/pkgs/build-support/node/build-npm-package/default.nix

==== Packaging electron applications ====

When trying to <code>npm i</code> electron, by default electron will try to download binaries from the internet, which does not work in the Nix sandbox. To stop it from trying to access the internet, set the environment variable <code>ELECTRON_SKIP_BINARY_DOWNLOAD = "1";</code>.

For examples of packaging electron applications, search [https://github.com/search?q=buildNpmPackage+electron+repo%3ANixOS%2Fnixpkgs&type=code&l=NixOS%2Fnixpkgs Nixpkgs] for the terms "buildNpmPackage" and "electron".

=== Packaging with <code>yarn2nix</code> ===

yarn2nix uses the yarn nodejs tool to create a file called yarn.lock, which in return can be used by yarn2nix to generate a usable yarn expression.

This is what was needed to convert a small application server [https://git.shackspace.de/rz/muellshack/tree/3be09715911628b164fa1cf346387555ca26a5b1 shackspace muellshack]:

$ nix-shell -p yarn yarn2nix

$ yarn install

# creates yarn.lock

$ yarn2nix > yarn.nix

$ vim package.json

# add: "bin": "app.js",

$ cat > default.nix <<EOF

with (import <nixpkgs> {});

rec {

muellshack = mkYarnPackage {

name = "muellshack";

src = ./.;

packageJSON = ./package.json;

yarnLock = ./yarn.lock;

yarnNix = ./yarn.nix;

};

}

EOF

$ sed -i '1i#!/usr/bin/env node' app.js

$ chmod +x app.js

$ nix-build

$ result/bin/muellshack

</syntaxHighlight>

~~== Example nix flake shell for Node~~.~~js development ==~~

The complete diff can be found at [https://git.shackspace.de/rz/muellshack/commit/f5e498acd47695c4947dc1b5ddebfad2eee8d653 the respective diff]

=== Example nix flake shell for Node.js development ===

`flake.nix` example:

Line 193:

Line 225:

description = "example-node-js-flake";

inputs = {

flake-utils.url = "github:numtide/flake-utils";

};

outputs = { self, nixpkgs, flake-utils }:

flake-utils.lib.~~eachSystem [ "x86_64-linux" ]~~ (system:

flake-utils.lib.eachDefaultSystem (system:

let

pkgs = import nixpkgs {

inherit system;

};

buildNodeJs = pkgs.callPackage "${nixpkgs}/pkgs/development/web/nodejs/nodejs.nix" {

buildNodeJs = pkgs.callPackage "${<nixpkgs>}/pkgs/development/web/nodejs/nodejs.nix" {

python = pkgs.python3;

};

Line 210:

Line 242:

nodejs = buildNodeJs {

enableNpm = true;

version = "16.16.0";

version = "20.5.1";

sha256 = "~~FFFR7~~/~~Oyql6+czhACcUicag3QK5oepPJjGKM19UnNus~~=";

sha256 = "sha256-Q5xxqi84woYWV7+lOOmRkaVxJYBmy/1FSFhgScgTQZA=";

};

in rec {

Line 229:

Line 261:

</syntaxhighlight>

== Using nodePackages with a different node version ==

=== Using nodePackages with a different node version ===

Packages in {{ic|nixpkgs.nodePackages}} are built using {{ic|nixpkgs.nodejs}}, so if you [[Overlays|overlay that package]] to a different version, the {{ic|nodePackages}} will be built using that:

Line 240:

Line 272:

v16.17.1

</pre>

=== Override NodeJS package ===

Overriding a Nix package which is based on ''buildNpmPackage'' can be challeging because not only the source hash has to get changed but sometimes also the ''package-lock.json'' file and the ''npmDepsHash''.

Unfortunately it is not possible to directly access and change ''npmDepsHash'' inside ''overrideAttrs'', so this is an example workaround for changing the version, ''package-lock.json'' and hashes of the package ''eslint'':<syntaxhighlight lang="nix">

environment.systemPackages = [

(eslint.overrideAttrs (oldAttrs: rec {

version = "8.57.0";

src = fetchFromGitHub {

owner = "eslint";

repo = "eslint";

rev = "refs/tags/v${version}";

hash = "sha256-nXlS+k8FiN7rbxhMmRPb3OplHpl+8fWdn1nY0cjL75c=";

};

postPatch = ''

cp ${./package-lock.json} package-lock.json

'';

npmDepsHash = "sha256-DiXgAD0PvIIBxPAsdU8OOJIyvYI0JyPqu6sj7XN94hE=";

npmDeps = pkgs.fetchNpmDeps {

src = lib.fileset.toSource {

root = ./.;

fileset = lib.fileset.unions [

./package-lock.json

./package.json

];

};

name = "eslint-${version}-npm-deps";

hash = npmDepsHash;

};

}))

];

</syntaxhighlight>

== External Links ==