Skip to main content

Accelerator for npm, the Node.js package manager

Project description

https://travis-ci.org/xolox/python-npm-accel.svg?branch=master https://coveralls.io/repos/xolox/python-npm-accel/badge.svg?branch=master

The npm-accel program is a wrapper for npm (the Node.js package manager) that was created to optimize one specific use case: Creating a node_modules directory from a package.json file as quickly as possible.

It works on the assumption that you build node_modules directories more frequently then you change the contents of package.json files, because it computes a fingerprint of the dependencies and uses that fingerprint as a cache key, to cache the complete node_modules directory in a tar archive.

The program is intended to be used in environments that always or frequently start with an empty node_modules directory and need to populate the complete directory from scratch (e.g. continuous integration builds and deployments). I’m specifically not claiming that you will see any speed improvements if you’re updating existing node_modules directories.

The npm-accel program is currently tested on Python 2.6, 2.7, 3.4, 3.5 and PyPy (yes, it’s written in Python, deal with it :-P).

Status

The npm-accel project was developed and published in September ‘16 because I got fed up waiting for npm install to finish, specifically in the context of continuous integration builds and deployments (where you frequently start with an empty node_modules directory). It was developed in about a week without much prior knowledge about Node.js or npm, which explains why it’s written in Python :-P. On the one hand npm-accel hasn’t seen much actual use, on the other hand it has a test suite with about 95% test coverage and I was careful not to repeat the bugs I encountered in npm-cache and npm-fast-install while evaluating those tools :-).

To summarize: Give it a try, see if it actually speeds up your npm install use case and then decide whether you want to use it or not. The first releases of npm-accel are labeled as alpha releases because the program hasn’t seen much real world use (and I’m no expert in Node.js and npm).

Performance

The following table lists the output of npm-accel --benchmark (with some enhancements) against a private code base with about 30 dependencies listed in the package.json file (resulting in a 401 MB node_modules directory):

Approach Iteration Elapsed time Percentage
npm install 1/2 1 minute and 36 seconds 100.0%
npm install 2/2 1 minute and 40 seconds 104.1%
npm-accel 1/2 1 minute and 40 seconds 104.1%
npm-accel 2/2 7.26 seconds 7.5%
npm-cache install npm 1/2 3 minutes and 9 seconds 196.8%
npm-cache install npm 2/2 2 minutes and 9 seconds 134.3%
npm-fast-install 1/2 1 minute and 5 seconds 72.2%
npm-fast-install 2/2 1 minute and 6 seconds 73.3%

Some notes about this benchmark:

  • Each of the four installation methods is run twice. The first run starts with empty cache directories and is intended to “prime the cache”. The second run is intended to actually use the cache and should be able to do so quite effectively, given that the package.json file does not change between the two runs.
  • During the benchmark, the caching performed by npm-accel is only used in the fourth row of the table above. This is because the original point of the benchmark (for me) was to find out whether it was even worth it to develop and publish npm-accel. That is to say, if it wouldn’t have given a speed improvement it wasn’t worth my time, nor yours :-P.

Installation

The npm-accel package is available on PyPI which means installation should be as simple as:

$ pip install npm-accel

There’s actually a multitude of ways to install Python packages (e.g. the per user site-packages directory, virtual environments or just installing system wide) and I have no intention of getting into that discussion here, so if this intimidates you then read up on your options before returning to these instructions ;-).

Usage

There are two ways to use the npm-accel package: As the command line program npm-accel and as a Python API. For details about the Python API please refer to the API documentation available on Read the Docs. The command line interface is described below.

Usage: npm-accel [OPTIONS] [DIRECTORY]

The npm-accel program is a wrapper for npm (the Node.js package manager) that optimizes one specific use case: Building a “node_modules” directory from a “package.json” file as quickly as possible.

It works on the assumption that you build “node_modules” directories more frequently then you change the contents of “package.json” files, because it computes a fingerprint of the dependencies and uses that fingerprint as a cache key, to cache the complete “node_modules” directory in a tar archive.

Supported options:

Option Description
-p, --production Don’t install modules listed in “devDependencies”.
-i, --installer=NAME Set the installer to use. Supported values for NAME are “npm” (the default), “npm-cache” and “npm-fast-install”.
-c, --cache-directory=DIR Set the pathname of the directory where the npm-accel cache is stored.
-n, --no-cache Disallow writing to the cache managed by npm-accel (reading is still allowed though). This option does not disable caching performed by npm-cache and npm-fast-install.
-b, --benchmark

Benchmark and compare the following installation methods:

  1. npm install
  2. npm-accel
  3. npm-cache
  4. npm-fast-install

The first method performs no caching (except for the HTTP caching that’s native to npm) while the other three methods each manage their own cache (that is to say, the caching logic of npm-accel will only be used in the second method).

Warning: Benchmarking wipes the caches managed by npm, npm-accel, npm-cache and npm-fast-install in order to provide a fair comparison (you can override this in the Python API but not on the command line).

-r, --remote-host=SSH_ALIAS Operate on a remote system instead of the local system. The SSH_ALIAS argument gives the SSH alias of the remote host.
-v, --verbose Make more noise.
-q, --quiet Make less noise.
-h, --help Show this message and exit.

Future improvements

Automatic cache invalidation
Currently the ~/.cache/npm-accel directory will simply keep growing as new installations are added to the cache. Eventually I want npm-accel to automatically remove cache entries that are no longer being used. Given that “last accessed time” of files is frequently disabled in high performance situations like continuous integration environments and build servers I may need to enhance the cache directory with metadata per cache entry. I’m still thinking about the best way to approach this…
Accelerate installations with changes
Currently when the fingerprint (cache key) of the dependencies doesn’t match a cache entry, the complete caching mechanism is bypassed and a full npm install run is performed. It might be faster to unpack a previous (now invalid) cache entry corresponding to the same project and then run npm install && npm prune. Given the fact that defining “same project” might be non-trivial I’m not actually sure this is worth my time.
Dealing with optionalDependencies
I’ve never seen optionalDependencies in the wild but encountered them while browsing through the package.json documentation. Maybe these should be part of the computed cache keys aswell?

Contact

The latest version of npm-accel is available on PyPI and GitHub. The documentation is hosted on Read the Docs. For bug reports please create an issue on GitHub. If you have questions, suggestions, etc. feel free to send me an e-mail at peter@peterodding.com.

License

This software is licensed under the MIT license.

© 2016 Peter Odding.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for npm-accel, version 0.3
Filename, size File type Python version Upload date Hashes
Filename, size npm_accel-0.3-py2.py3-none-any.whl (22.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size npm-accel-0.3.tar.gz (16.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page