jsproxy-server-stub v0.0.3

jsproxy

A http proxy used to cache request in order to provide a standalone development environment

Setup

In order to create the endpoints at your local the file ./config.json have to configured properly once that one will be used during the runtime to reach out the real server.

Configuration Example

{
  "multipleResponseEnable": true,
  "runningMode": "recorder",
  "nodes": [
    {
      "configs": [
        {
          "server": "remoteServerAddress",
          "url": "/wsi/services",
          "mediaType": "text/xml",
          "targetPort": 8590
        }
      ],
      "cache": true,
      "srcPort": 8590,
      "https": {
        "enable": false,
        "keyFile": "privkey.pem",
        "certFile": "cert.pem",
        "caFile": "cert.pem"
      }
    },
    {
      "configs": [
        {
          "server": "127.0.0.1",
          "url": "/products",
          "mediaType": "application/json",
          "targetPort": 8081
        },
        {
          "server": "127.0.0.1",
          "url": "/items",
          "mediaType": "application/json",
          "targetPort": 8081
        }
      ],
      "srcPort": 8080,
      "cache": true
    }
  ]
}

Multiple Response Support

The configuration key multipleResponseEnable is utilized in order to provide support for multiple response upon the same request.

By default this configuration is set to false

For instance:

Read -> Update -> Read

Running Mode

The running mode is used to define the proxy behavior and the possibles values are:

• recorder: the proxy only populates the cache and never provides response using the cache
• playback: the proxy only provides the response based on existing cache if the cache doesn't have the response an error is returned
  • If the node is set as cache: falsethe local cache won't be used and is this case the southbound won't be called
• dual: the proxy read and write towards cache

Configuration Endpoint

There is a configuration endpoint available in order to set some context on proxy service. The default port is 7001 but is possible to define during initialization, such as:

$ node src/bin.js -p 8087

The endpoint is http://{server}:{port}/jsproxy/v1/configuration and POST method is expected.

• Context Configuration: this configuration is used as part of database PK entries in order to group by context each registry based on a operation context. The default value is a empty string (""). In order to configure this value POST upon JSProxy Configuration endpoint, such as:

{
    "context": {
        "key": "myOperationIdentifier"
    }
}

Cache

The cache is persisted upon SQLite Database

HTTPS

The https termination is supported and the settings are done by ./config.json file upon each node that will be exposed. If the https configuration is not part of the configuration the plain HTTP termination will be used.

For example

{
  "nodes": [
    {
      "configs": [
        {
          "server": "remoteServerAddress",
          "url": "/wsi/services",
          "mediaType": "text/xml",
          "targetPort": 8590
        }
      ],
      "cache": true,
      "srcPort": 8590,
      "https": {
        "enable": false,
        "keyFile": "privkey.pem",
        "certFile": "cert.pem",
        "caFile": "cert.pem"
      }
    }]
}

Try it out without real server

To try in local with no server available the json-server can be used, like

$npm install json-server
$json-server --watch restApiResources.json -p 8080

Running

To run the app just prompt

$ npm install
$ node src/bin.js -c myContext -m playback

Where:
-c: context to run (will be used to generate db file name and db key)
-m: runningMode (the possible values are: dual, playback, recorder)

To check supported arguments prompt

$ node src/bin.js -h