https://github.com/e0ipso/subrequests-json-merger

Subrequests JSON Merger allows you to use Subrequests and return a JSON document instead of a multipart/related response.
https://github.com/e0ipso/subrequests-json-merger

Last synced: 2 months ago
JSON representation

Subrequests JSON Merger allows you to use Subrequests and return a JSON document instead of a multipart/related response.

• Host: GitHub
• URL: https://github.com/e0ipso/subrequests-json-merger
• Owner: e0ipso
• License: gpl-2.0
• Created: 2017-08-18T15:09:54.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-06-02T23:57:39.000Z (over 4 years ago)
• Last Synced: 2024-10-24T00:13:17.809Z (2 months ago)
• Language: JavaScript
• Size: 893 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Subrequests JSON Merger

[![Coverage Status](https://coveralls.io/repos/github/e0ipso/subrequests-json-merger/badge.svg)](https://coveralls.io/github/e0ipso/subrequests-json-merger)

[![Known Vulnerabilities](https://snyk.io/test/github/e0ipso/subrequests-json-merger/badge.svg)](https://snyk.io/test/github/e0ipso/subrequests-json-merger)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![Greenkeeper badge](https://badges.greenkeeper.io/e0ipso/subrequests-json-merger.svg)](https://greenkeeper.io/)

[![Build Status](https://travis-ci.org/e0ipso/subrequests-json-merger.svg?branch=master)](https://travis-ci.org/e0ipso/subrequests-json-merger)

This module allow you to alter the format of the single response you get from

Subrequests. Instead of merging the sub-responses into a `multipart/related`

HTTP response, using this module we can merge them into a JSON object.

This JSON object will be keyed by request ID (possible expanded because of

JSONPath queries). Each top-level value is an object itself. Such objects

contain the `headers` and the `body` of the response.

## Usage

Inject the merger into subrequests when making a request.

```js

const JsonReponse = require('subrequests-json-merger');

subrequests.request(

  blueprint,

  new HttpRequestor(),

  JsonReponse // Make Subrequests produce a JSON document with all the responses.

)

.then(singleResponse => doYourStuff(singleResponse));

```

Using the example in the Subrequests module you will get the following output:

```json

{

  "req1": {

    "headers": {

      "content-length": "23",

      "…": "…",

      "x-subrequest-id": "req1",

      "Content-ID": ""

    },

    "body": "{\n  \"my-key\": \"lorem\"\n}"

  },

  "req2": {

    "headers": {

      "x-frame-options": "deny",

      "…": "…",

      "x-subrequest-id": "req2",

      "Content-ID": ""

    },

    "body": "{\n  \"runs\": {\n  \"in\": \"parallel\"\n  }\n}"

  },

  "req1.1#uri{0}": {

    "headers": {

      "x-frame-options": "deny",

      "…": "…",

      "x-subrequest-id": "req1.1#uri{0}",

      "Content-ID": ""

    },

    "body": "{\n  \"akward\": [\"moar\", \"hip\", \"tests\"]\n}"

  },

  "req1.1.1#uri{0}": {

    "headers": {

      "connection": "close",

      "x-cache": "HIT",

      "source-age": "179",

      "…": "…",

      "x-subrequest-id": "req1.1.1#uri{0}",

      "Content-ID": ""

    },

    "body": "[\n  {\n  \"ha\": \"li\"\n  }\n]"

  },

  "req1.1.1#uri{1}": {

    "headers": {

      "content-type": "text/plain; charset=utf-8",

      "cache-control": "max-age=300",

      "…": "…",

      "x-subrequest-id": "req1.1.1#uri{1}",

      "Content-ID": ""

    },

    "body": "true"

  },

  "req1.1.1#uri{2}": {

    "headers": {

      "content-security-policy": "default-src 'none'; style-src 'unsafe-inline'",

      "…": "…",

      "x-subrequest-id": "req1.1.1#uri{2}",

      "Content-ID": ""

    },

    "body": "{\n  \"we need\": \"nonsensical strings\"\n}"

  }

}

```