Document Your Project’s package.json File
The package.json file is the heart of any Node.js project, but it often goes entirely undocumented. In this post, I’ll review a few areas that are worth documenting, and how I like to do it.
nodejs
Setting up a Test FTP Server in Node
On a recent project, I had a need to create an FTP connection to a third-party server. Since we had no control over the server, I also wanted to setup a test FTP server that I could use to run our client against to make sure we could connect successfully. It turned out that implementing […]
Generating Excel Files using Node.js and ExcelJS
Recently, I was tasked with writing some code to generate Excel workbooks containing sales data. I implemented the code using a Node module called ExcelJS. I found that this module provides a simple interface to generating documents, and it also supports more advanced functions such as text formatting, borders, formulae, and more.
Managing Data Loaders in Node.js with Shared State
When developing software, it’s always tough to work with caching. While my team appreciates the efficiencies that Data Loader can provide for applications, we still struggle with the same problems that always come up when caching queries, mainly invalidating caches when a data set has changed.
Eliminate Circular Dependencies from Your JavaScript Project
Circular dependencies (also known as cyclic dependencies) occur when two or more modules reference each other. This could be a direct reference (A -> B -> A): // file a.ts import { b } from 'b'; ... export a; // file b.ts import { a } from 'a'; ... export b; or indirect (A -> […]
Extending the Heroku Timeout in Node.js
Heroku will terminate a request connection if no data is sent back to the client within 30 seconds. From Heroku’s Router – HTTP timeouts documentation: HTTP requests have an initial 30-second window in which the web process must return response data (either the completed response or some amount of response data to indicate that the […]
PDF Snapshot Testing with Node and GraphicsMagick
The task I am working on this week involves generating downloadable PDF files for customer and supplier orders. We’d like to drive the implementation using tests and be able to find any regressions in the code automatically. After looking at different alternatives for accomplishing this, we decided to try a visual snapshot approach similar to […]
Optimizing GraphQL Queries with DataLoader
In my post about GraphQL and the Apollo server tools, I primarily focused on setting up a simple GraphQL schema and set of resolvers, but did not go much deeper. The main example in that post defined a findBy method which simulated hitting a database, but for the sake of brevity, this detail was largely […]
Timing Your Queries in Knex.js for Node.js
While developing web applications, I keep a close eye on performance issues, particularly in database queries. In my latest project, I’ve been using Knex.js, a SQL query builder for Node.js. I developed a method of logging the queries executed by Knex.js as well as the execution times for each query. This method can be applied […]
Debugging ES6 Code in Node.js
I recently decided to use Node.js for my current project, and I also thought it would be a good idea to start off using ES6 (properly known as ECMAScript 2015). ES6 was a major addition to the language, and it was just formalized in June 2015. Since then, there has been a lot of effort […]