npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

facilmock

v2.0.0

Published

Module to stub endpoints for Expressjs apps running. Useful when you need to temporarily mock services for testing reasons.

Downloads

2

Readme

facilmock

Exposes an API to mock endpoints for ExpressJS apps. It is a handy way to temporarily change the behavior of your mocked service calls.

Commitizen friendly Build Status semantic-release - codecov.io - npm monthly downloads

Dev Dependencies

Useful for developers, Continous integration. Use case:

  • You stubbed your backend with an ExpressJS app. You have a service that returns 200, {name: 'Leonardo'}. You wish to simulate a failure scenario for the first call 500, {error: 'server is down. Click here to retry.'}. Now you want the service call to return a success for a retry() or any subsequent calls.

  • in summary, facilmock can temporary change the behavior of a service call via REST API call to your own stub ExpressJS. When you wish you can again, via REST API call, reset all tempory behavior. Please refer to exmaples bellow.

How it works

Once module added, it seats in front of every request to your expressJS app.

If facilmock can match the request method and url from mocked endpoints, it will return the status code and response pre configured by you.

When facilmock can't match anyting, things will as usual like facilmock doens't even exist.

Installation

npm install facilmock --save-dev

This module is appropriated for development use only.

Usage

Assuming you already have your running and middlewares configured, all you need is load facilmock module:

    var express = require('express');
    var app = express();

    //facilmock loaded at this point.
    var facilmock = require('facilmock')(app);

    //existing mocked endpoint
    app.get('/api/get-user-info', function(req, res) {
      res.json('{"name": "leonardo correa"}').status(200);
    });

    //more endpoints here...

    server = app.listen(7777, function () {
      console.log('>>> Express App is running on http://%s:%s', server.address().address, server.address().port);
      done();
    });

Facilmock is just a couple of expressjs middlewares. So order here matters as any expressjs app. Assuming you are using this module from your test, you now need to stub your endpoints:

  var request = require('supertest');
  var url = 'http://localhost:7777'
  request(url).post('/mockme')
    .send({'method': 'GET', 'url': '/api/get-user-info', 'response': {'code': '200', 'content': {'name': 'some other name'} } })
    .end(function(err, res) {
      done();
  });

Or test this service failure:

  var request = require('supertest');
  var url = 'http://localhost:7777'
  request(url).post('/mockme')
    .send({'method': 'GET', 'url': '/api/get-user-info', 'response': {'code': '400', 'content': 'invalid request or server is down' } })
    .end(function(err, res) {
      done();
  });

Note I am using supertest to perform the request against facilmock

Don't forget: if you are dealing with cross domain services calls, you may be interested in those lines too:

app.all('/*', function(req, res, next) {
  res.header("Access-Control-Allow-Origin", "*");
  res.header("Access-Control-Request-Method", "GET, PUT, POST, OPTIONS");
  res.header("Access-Control-Allow-Methods", "OPTIONS, GET, PUT, POST, DELETE");
  res.header("Access-Control-Allow-Headers", "Origin, X-Requested-With, Content-Type, Accept");
  next();
});

Those are not part of this module and is totally related to your use case. So add those lines to your ExpressJS app if this is your case.

Facilmock API

facilmock has only three methods on the API and they are extremelly intuitive:

- POST a JSON to /mockme;       return json with all stubbed end-points.
- GET         to /getmocks;     return json with all stubbed end-points.
- GET         to /resetmocks;   clear up mocked endpoint and return the current adn empty json object.

Tests

  npm test

About this

There are lots of further features that could be implemented. However facilmock solves my problem at the moment. If you need anyting more sofisticated, please send me a pull request. This package is not supposed to replace any other testing framework.

Contributing

Please refer to the Contributor Guidelines and Conduct of Code from AngularJs project.

Leonardo Correa