Record, Replay, and Stub HTTP Interactions.
Switch branches/tags
v1.2.0 @pollyjs/utils@1.0.3 @pollyjs/utils@1.0.2 @pollyjs/utils@1.0.1 @pollyjs/utils@1.0.0 @pollyjs/utils@0.1.1 @pollyjs/utils@0.1.0 @pollyjs/persister@1.0.4 @pollyjs/persister@1.0.3 @pollyjs/persister@1.0.2 @pollyjs/persister@1.0.1 @pollyjs/persister@1.0.0 @pollyjs/persister@0.2.1 @pollyjs/persister@0.2.0 @pollyjs/persister@0.1.0 @pollyjs/persister-rest@1.0.5 @pollyjs/persister-rest@1.0.4 @pollyjs/persister-rest@1.0.3 @pollyjs/persister-rest@1.0.2 @pollyjs/persister-rest@1.0.1 @pollyjs/persister-rest@1.0.0 @pollyjs/persister-local-storage@1.0.5 @pollyjs/persister-local-storage@1.0.4 @pollyjs/persister-local-storage@1.0.3 @pollyjs/persister-local-storage@1.0.2 @pollyjs/persister-local-storage@1.0.1 @pollyjs/persister-local-storage@1.0.0 @pollyjs/persister-fs@1.0.5 @pollyjs/persister-fs@1.0.4 @pollyjs/persister-fs@1.0.3 @pollyjs/persister-fs@1.0.2 @pollyjs/persister-fs@1.0.1 @pollyjs/persister-fs@1.0.0 @pollyjs/node-server@1.0.3 @pollyjs/node-server@1.0.2 @pollyjs/node-server@1.0.1 @pollyjs/node-server@1.0.0 @pollyjs/node-server@0.4.0 @pollyjs/node-server@0.3.0 @pollyjs/node-server@0.2.0 @pollyjs/node-server@0.1.0 @pollyjs/node-server@0.0.2 @pollyjs/node-server@0.0.1 @pollyjs/ember@1.0.5 @pollyjs/ember@1.0.4 @pollyjs/ember@1.0.3 @pollyjs/ember@1.0.2 @pollyjs/ember@1.0.1 @pollyjs/ember@1.0.0 @pollyjs/ember@0.4.2 @pollyjs/ember@0.4.1 @pollyjs/ember@0.4.0 @pollyjs/ember@0.3.1 @pollyjs/ember@0.3.0 @pollyjs/ember@0.2.1 @pollyjs/ember@0.2.0 @pollyjs/ember@0.1.0 @pollyjs/ember@0.0.2 @pollyjs/ember@0.0.1 @pollyjs/core@1.1.4 @pollyjs/core@1.1.3 @pollyjs/core@1.1.2 @pollyjs/core@1.1.1 @pollyjs/core@1.1.0 @pollyjs/core@1.0.0 @pollyjs/core@0.5.0 @pollyjs/core@0.4.0 @pollyjs/core@0.3.0 @pollyjs/core@0.2.0 @pollyjs/core@0.1.0 @pollyjs/core@0.0.2 @pollyjs/core@0.0.1 @pollyjs/cli@1.0.3 @pollyjs/cli@1.0.2 @pollyjs/cli@1.0.1 @pollyjs/cli@1.0.0 @pollyjs/cli@0.2.1 @pollyjs/cli@0.2.0 @pollyjs/cli@0.1.1 @pollyjs/cli@0.1.0 @pollyjs/cli@0.0.2 @pollyjs/cli@0.0.1 @pollyjs/adapter@1.1.3 @pollyjs/adapter@1.1.2 @pollyjs/adapter@1.1.1 @pollyjs/adapter@1.1.0 @pollyjs/adapter@1.0.0 @pollyjs/adapter@0.3.1 @pollyjs/adapter@0.3.0 @pollyjs/adapter@0.2.0 @pollyjs/adapter@0.1.0 @pollyjs/adapter@0.0.2 @pollyjs/adapter@0.0.1 @pollyjs/adapter-xhr@1.0.5 @pollyjs/adapter-xhr@1.0.4 @pollyjs/adapter-xhr@1.0.3 @pollyjs/adapter-xhr@1.0.2 @pollyjs/adapter-xhr@1.0.1 @pollyjs/adapter-xhr@1.0.0 @pollyjs/adapter-puppeteer@1.1.4
Nothing to show
Clone or download
Permalink
Failed to load latest commit information.
build-scripts chore: Remove class properties babel plugin and babel-eslint (#134) Nov 11, 2018
docs docs: Document Jest & Jasmine support using setup-polly-jest (#135) Nov 13, 2018
examples docs: Document Jest & Jasmine support using setup-polly-jest (#135) Nov 13, 2018
packages/@pollyjs chore: Bump package dependencies (#137) Nov 16, 2018
tests chore: Improve eslint glob and add lint-staged (#132) Nov 10, 2018
.eslintignore chore: Bump dev dependencies (#131) Nov 10, 2018
.eslintrc.js chore: Remove class properties babel plugin and babel-eslint (#134) Nov 11, 2018
.gitignore docs: Examples (#112) Sep 20, 2018
.prettierrc chore: Bump dev dependencies (#131) Nov 10, 2018
.travis.yml ci: Remove before_script Aug 14, 2018
CHANGELOG.md chore: Publish Sep 16, 2018
CONTRIBUTING.md chore: Remove yarn bootstrap (#96) Aug 14, 2018
LICENSE chore: Initial commit. Jun 1, 2018
OSSMETADATA chore: Initial commit. Jun 1, 2018
README.md docs: Improve Quick Start documentation (#123) Oct 31, 2018
commitlint.config.js revert: Revert "Update commitlint.config.js" Jun 8, 2018
jest.config.js test: Fix hanging jest test case (#130) Nov 9, 2018
lerna.json chore: Bump dev dependencies (#131) Nov 10, 2018
package.json chore: Remove class properties babel plugin and babel-eslint (#134) Nov 11, 2018
rollup.config.js feat: Convert recordings to be HAR compliant (#45) Jul 1, 2018
testem.js chore(ember): Bump ember version to 3.5 (#133) Nov 10, 2018
yarn.lock chore: Bump package dependencies (#137) Nov 16, 2018

README.md

Polly.JS

Record, Replay, and Stub HTTP Interactions

Build Status license

Polly.JS is a standalone, framework-agnostic JavaScript library that enables recording, replaying, and stubbing of HTTP interactions. By tapping into multiple request APIs across both Node & the browser, Polly.JS is able to mock requests and responses with little to no configuration while giving you the ability to take full control of each request with a simple, powerful, and intuitive API.

Interested in contributing or just seeing Polly in action? Head over to CONTRIBUTING.md to learn how to spin up the project!

Why Polly?

Keeping fixtures and factories in parity with your APIs can be a time consuming process. Polly alleviates this by recording and maintaining actual server responses without foregoing flexibility.

  • Record your test suite's HTTP interactions and replay them during future test runs for fast, deterministic, accurate tests.
  • Use Polly's client-side server to modify or intercept requests and responses to simulate different application states (e.g. loading, error, etc.).

Features

  • 🚀 Node & Browser Support
  • ⚡️️ Simple, Powerful, & Intuitive API
  • 💎 First Class Mocha & QUnit Test Helpers
  • 🔥 Intercept, Pass-Through, and Attach Events
  • 📼 Record to Disk or Local Storage
  • Slow Down or Speed Up Time

Getting Started

Check out the Quick Start documentation to get started.

Usage

Lets take a look at what an example test case would look like using Polly.

import { Polly } from '@pollyjs/core';
import XHRAdapter from '@pollyjs/adapter-xhr';
import FetchAdapter from '@pollyjs/adapter-fetch';
import RESTPersister from '@pollyjs/persister-rest';

/*
  Register the adapters and persisters we want to use. This way all future
  polly instances can access them by name.
*/
Polly.register(XHRAdapter);
Polly.register(FetchAdapter);
Polly.register(RESTPersister);

describe('Netflix Homepage', function() {
  it('should be able to sign in', async function() {
    /*
      Create a new polly instance.

      Connect Polly to both fetch and XHR browser APIs. By default, it will
      record any requests that it hasn't yet seen while replaying ones it
      has already recorded.
    */
    const polly = new Polly('Sign In', {
      adapters: ['xhr', 'fetch'],
      persister: 'rest'
    });
    const { server } = polly;

    /* Intercept all Google Analytic requests and respond with a 200 */
    server
      .get('/google-analytics/*path')
      .intercept((req, res) => res.sendStatus(200));

    /* Pass-through all GET requests to /coverage */
    server.get('/coverage').passthrough();

    /* start: pseudo test code */
    await visit('/login');
    await fillIn('email', 'polly@netflix.com');
    await fillIn('password', '@pollyjs');
    await submit();
    /* end: pseudo test code */

    expect(location.pathname).to.equal('/browse');

    /*
      Calling `stop` will persist requests as well as disconnect from any
      connected browser APIs (e.g. fetch or XHR).
    */
    await polly.stop();
  });
});

The above test case would generate the following HAR file which Polly will use to replay the sign-in response when the test is rerun:

{
  "log": {
    "_recordingName": "Sign In",
    "browser": {
      "name": "Chrome",
      "version": "67.0"
    },
    "creator": {
      "name": "Polly.JS",
      "version": "0.5.0",
      "comment": "persister:rest"
    },
    "entries": [
      {
        "_id": "06f06e6d125cbb80896c41786f9a696a",
        "_order": 0,
        "cache": {},
        "request": {
          "bodySize": 51,
          "cookies": [],
          "headers": [
            {
              "name": "content-type",
              "value": "application/json; charset=utf-8"
            }
          ],
          "headersSize": 97,
          "httpVersion": "HTTP/1.1",
          "method": "POST",
          "postData": {
            "mimeType": "application/json; charset=utf-8",
            "text": "{\"email\":\"polly@netflix.com\",\"password\":\"@pollyjs\"}"
          },
          "queryString": [],
          "url": "https://netflix.com/api/v1/login"
        },
        "response": {
          "bodySize": 0,
          "content": {
            "mimeType": "text/plain; charset=utf-8",
            "size": 0
          },
          "cookies": [],
          "headers": [],
          "headersSize": 0,
          "httpVersion": "HTTP/1.1",
          "redirectURL": "",
          "status": 200,
          "statusText": "OK"
        },
        "startedDateTime": "2018-06-29T17:31:55.348Z",
        "time": 11,
        "timings": {
          "blocked": -1,
          "connect": -1,
          "dns": -1,
          "receive": 0,
          "send": 0,
          "ssl": -1,
          "wait": 11
        }
      }
    ],
    "pages": [],
    "version": "1.2"
  }
}

Credits

In alphabetical order:

We're hiring!

Join the Netflix Studio & Content Engineering teams to help us build projects like this!

Open Roles:

License

Copyright (c) 2018 Netflix, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.