wework / express-universal-query-validator

Express middleware to provide consistently parseable query parameters to universal applications.

express-universal-query-validator

Express middleware to provide consistently parseable query parameters to universal applications.

Introduction

Normally, query parsing is handled by your server. For universal applications using something like react-router, this can be a problem when a different path is taken to parse query strings on the client vs the server.

For example, a Node express server will parse a malformed query like ?key=foo%% using the native Node.js querystring module to { key: 'foo%%' }. However, a client using decodeURIComponent will throw an error like URIError: URI malformed when encountering the same query.

This middleware solves this problem by validating each query parameter via decodeURIComponent and providing a callback to take action on the server when invalid params are detected. The default behavior when no callback is provided is to log and then redirect to the same path with unparseable params removed.

This package is tested in both Node.js and browsers to ensure the same behavior in both runtimes.

Usage

import express from 'express';
import queryValidator from 'express-universal-query-validator';

const app = express();

// Mount the middleware
app.use(queryValidator());

// Other route handlers
// ...

app.listen(process.env.PORT);
console.info(`Server listening on ${process.env.PORT} and handling invalid query parameters`);

Configuration

queryValidator accepts a callback that is executed when invalid params are detected, and a configuration object.

See API.md for detailed documentation.

Examples

function invalidParamHandler(req, res, next, context) {
    const { error, oldQuery, nextQuery, droppedParams } = context;

    // Do what you love
}

app.use(queryValidator(invalidParamHandler));

Development

In lieu of a formal style guide, please ensure PRs follow the conventions present, and have been properly linted and tested. Feel free to open issues to discuss.

Be aware this module is tested in both browser and node runtimes.

Available tasks

Build and test

Runs all tests, static analysis, and bundle for distribution

$ npm start

Test

Runs browser and node tests

$ npm test

Runs browser tests via PhantomJS only

$ npm run test:browser

Runs browser tests via SauceLabs only

$ SAUCELABS=true npm run test:browser

Runs node tests only

$ npm run test:node

Docs

Regenerate API.md docs from JSDoc comments

$ npm run docs

express-universal-query-validator's Issues

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

• Added the new Node.js version to your .travis.yml
• The new Node.js version is in-range for the engines in 1 of your package.json files, so that was left alone

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

• engines was only updated if it defined a single version, not a range.
• .nvmrc was updated to Node.js 10
• .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

---

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

Unmet peer dependency warnings

├── [email protected] 
├── UNMET PEER DEPENDENCY [email protected]
└── UNMET PEER DEPENDENCY [email protected]

These peerDependencies should be relaxed a bit.