service-profile

Interactive mock server for profiling user scenarios

--- DEPRECATION NOTICE ---

This package has been moved to veggie

Installation

npm i -D service-profile

Add mock data routes to existing Express server

Create routes

Export an object that keys your service url to either:

• a static JSON object
• an express route that completes the request
• a file path

If you are using a path to a JSON file, the file will be loaded every time this url is reached. This allows you to edit your JSON file and have it sent without restarting your development server.

Add express routes to webpack-dev-server

// webpack.config.js
const serviceProfile = require('service-profile')
// ...
  devServer: {
    setup(app) {
      app.use(serviceProfile.router({ dir: 'services/**/*.js' }))
    }
  }
// ...

Run stand alone server

Run the server

mock-server -d services/**/*.js -p 1337 -t 1000

to serve from port 1337

Add proxies to webpack-dev-server

// webpack.config.js
// ...
  devServer: {
    proxy: {
      '/services': 'http://localhost:1337'
    }
  }
// ...

Use a REPL to access your live services

When using the mock router, you may want to change service responses without restarting the dev server. All service profile methods in return

Save profiles

TODO

Use in tests

The mock middleware can be used in karma via the following

// karma.conf.js
const mockMiddleware = require('service-profile').middleware
// ...
  middleware: ['serviceProfile'],
  plugins: [
    'karma-*',
    {
      'middleware:serviceProfile': [ 'factory', mockMiddleware ]
    }
  ]
// ...

This middleware will spawn an express server, as the binary would, and proxies all requests to that.

Changing profiles in tests

If you want to change profiles during tests, you will need to include service-profile from the browser field.

All service profile methods will return promises

// Note:
// When bundling for testing in browsers, your bundler will need to be configured
// to look for `browser` field of this package
import serviceProfile from 'service-profile'

block

before(() => {
  return serviceProfile.block('getUser')
})

blockAll

before(() => {
  return serviceProfile.blockAll()
})

reset

before(() => {
  return serviceProfile.reset('getUser')
})

resetAll

before(() => {
  return serviceProfile.resetAll()
})

loadProfile

before(() => {
  return serviceProfile.loadProfile('adminUser')
})

Configuration options

TODO