/vercel-node-dev

An unofficial development CLI for Vercel applications targeting the Node.js runtime.

Primary LanguageTypeScriptMIT LicenseMIT

Deprecated

The Vercel team has done a great job on the latest version of the vercel dev server. 💃

🧸
vercel-node-dev

An unofficial development CLI for Vercel applications targeting the Node.js runtime.

Fast reloads, improved reliability, offline and debugger support.

npm MIT License Travis

 

Table of Contents

 

Features

  • Optimised for the Node.js runtime
  • Built against the Vercel specifications
  • Supports Vercel "Zero Config" approach
  • Supports both JavaScript or TypeScript lambdas
  • Supports the attaching of a debugger session against lambda execution
  • Supports Vercel custom routes configuration
  • Fast reloading for any changes to your lambdas
  • Extensively tested and verified via an integration test suite
  • Can be run offline
  • No need for a Vercel project to be configured prior to execution
  • Does not need to be installed as a local dependency

 

Motivation

Vercel provides its own development environment via the vercel dev command. Whilst this tool is powerful, I was experiencing the following issues:

  • Performance: The feedback loop when making changes to my lambdas was very slow. After making a change, the subsequent request to the lamda would result in a significant wait for the lambda to be rebuilt and then served.
  • Reliability: When making changes to my lambdas the build performance degraded over time, eventually resulting in them becoming unresponsive. The only way I was able to resolve this was to restart the vercel dev command, significantly impacting my development flow.
  • Debugging: I was unable to attach a debugger instance against my lambdas. Whilst I try not to overuse the debugger, preferring to leverage integration tests, there are times when a debugger session can work wonders at issue discovery.
  • Usability: There was a double hit for me here. Firstly, you need to have first set up / linked your project to a project configuration against Vercel. Secondly, and related to the first point, you need to be connected to the internet in order to use the tool.

The implementation of vercel-node-dev addresses these issues; focussing on the Node.js runtime, which allowed me to create a much more bespoke and optimised development tool.

 

Vercel vs Us?

This tool is not meant to be competitive!

It is released with good intentions and respect for the Vercel team and community, offering a temporary alternative for those who may be experiencing similar issues with their development flow.

The vercel dev command is still in beta. My belief is that the Vercel team will eventually address the issues above, at which point this CLI will be deprecated. Given that we are following the official Vercel specifications, this would be a zero impact move for those using this CLI. You would only need to switch to executing the official vercel dev command instead of this one.

 

Installation

We recommend installing this library globally. This will allow you to quickly and easily use it against any of your Vercel applications, without polluting them with additional dependencies.

npm install -g vercel-node-dev

After the installation two CLI commands will be available to you, namely;

  • vercel-node-dev
  • vnd - a shorter aliased version

 

Usage

Simply navigate to the root of the Vercel application and execute the CLI.

vercel-node-dev

Similar to the vercel dev command we will attempt to bind the development server against port 3000.

Open your web browser and browse to http://localhost:3000.

 

Supported Features

Below is a list of the official Vercel features that we support.

I don't add any additional API features in comparison to the official APIs.

The design goal of this tool is to support as much of the official API as possible, whilst providing an improved development experience.

We follows the design, API, and features of the official Node.js runtime as closely as possible.

The official docs and advanced usage docs should be used as your reference for understanding the above features in detail.

Todo

The following configuration options will be supported in the near future:

 

Supported Frameworks

I have tested the CLI against the following frameworks, utilising the "Zero Config" approach.

  • Create React App
  • Create React App + TypeScript
  • Gatsby
  • Vue.js
  • Svelte
  • Angular
  • Ember.js
  • Hugo
  • Preact
  • Docusaurus
  • Gridsome
  • Nuxt.js
  • Eleventy
  • Hexo

 

Limitations

Below is a list of the Vercel features that this CLI does not support. These limitations are intentional, and the likelihood is that I will not extend the CLI to support them.

  • Support for any of the other runtimes - i.e. Go, Ruby, Python, or bespoke.

    I feel like Node.js is where Vercel really shines, and IMO feel like they should have gone all in on Node.js rather than supporting an array of runtimes.

  • Support for any of the following vercel.json configuration options:

    Despair not! All of these configuration options can be represented via the routes configuration, which is supported.

  • Support for the raw AWS lambda API, which is currently supported by the official Node.js runtime

    As stated in their docs, this has been exposed to help clients with existing lambdas migrate over to their platform. I'm not convinced this alternative CLI should support this.

  • The bespoke Vercel 4XX / 5XX error pages.

    Meh. I return the expected error codes. I'd recommend you implement your own custom error pages in your UI anyways.

  • Support for disabling the Node.js helpers

    This has more of an impact on production environments, where you would want to hyper optimise lambda performance in some cases.

  • Support for Next.js projects.

    Next has it's own development server with bespoke features around the APIs and pages. I would recommend using the next dev command instead.

 

CLI Options

The CLI current supports the following options.

  • --debug-apis | -d

    Setting this flag will enable the debugger against your lambdas.

  • --debug-apis-port [number] | -o [number]

    Allows you to specify the port at which the debugger for your lambdas will run. By default it runs on port 9229.

  • --port [number] | -p [number]

    Allows you to specify the port at which the vercel-node-dev server will run. By default it will attempt to bind to port 3000.

  • --root [string] | -r [string]

    Allows you to specify the relative path at which your application code (APIs + UI) live. By default it will be ..

 

Specifying a custom develop command

If you aren't using one of the supported frameworks, or if you would like to customise the develop command, then you can add a dev script to your package.json:

{
  "scripts": {
    "dev": "my-dev-tool -p $PORT"
  }
}

Note: It is important that you pass through the $PORT environment variable as shown in the example above. This is so that your development server can be correctly managed by vercel-node-dev.

 

Debugging your Lambdas

You can enabled the debugger for your lambdas by providing the respective option to the CLI:

vercel-node-dev --debug-apis

This will start the development server, with the debugger instance running. By default the debugger runs on port 9229. You can change the port number via the --debug-apis-port option.

Once the debugger is running you can attach to it utilising your tool of choice.

Debugging via VSCode

Below is a set of code debug configurations, allowing you to either start the vercel-dev-node instance with the debugger attached, or to attach to an already executing debugger instance.

{
  "version": "0.2.0",
  "configurations": [
    // This will start vercel-node-dev with the debugger attached
    {
      "name": "Launch vercel-node-dev",
      "type": "node",
      "request": "launch",
      "program": "vercel-node-dev",
      "args": ["--debug-apis"],
      "skipFiles": ["<node_internals>/**"],
      "autoAttachChildProcesses": true,
      "protocol": "inspector"
    },
    // First run `vercel-node-dev --debug-apis` and then execute this debug
    // configuration in order to attach to the running debugger.
    {
      "name": "Attach to process",
      "type": "node",
      "request": "attach"
    }
  ]
}

 

Bonus: Unit Testing your Lambdas

This tool leverages another library I built, vercel-node-server, which allows you to create http instances of your lambdas. This opens up opportunities for you to write integration or unit tests for you lambdas.

Firstly, install the library as development dependency:

npm install -D vercel-node-server

You can then write tests for your lambdas similar to the one below:

import { createServer } from 'vercel-node-server';
import listen from 'test-listen';
import axios from 'axios';
import helloLambda from './api/hello';

let server;
let url;

beforeAll(async () => {
  server = createServer(routeUnderTest);
  url = await listen(server);
});

afterAll(() => {
  server.close();
});

it('should return the expected response', async () => {
  const response = await axios.get(url, { params: { name: 'Pearl' } });
  expect(response.data).toBe('Hello Pearl');
});