Tests With Mocks and Recordings

matchRequestBy.ts

{
  method: true,
  headers: false,
  body: true,
  order: false,
  url: {
    protocol: false, 
    username: false,
    password: false,
    hostname: true, 
    port: false,
    pathname: true,
    query: true,
} 

polly.ts

import { Polly } from '@pollyjs/core'
import FSPersister from '@pollyjs/persister-fs'
import NodeHttpAdapter from '@pollyjs/adapter-node-http'
import { setupPolly } from 'setup-polly-jest'

Polly.register(NodeHttpAdapter)
Polly.register(FSPersister)

export const start = () => {
  setupPolly({
    mode: 'replay', /* Replay recordings if they exist */
    adapters: [ 'node-http' ],
    persister: 'fs',
    persisterOptions: { 
      fs: { recordingsDir: 'foo/bar' } /* File path to persist recordings */
    },
    expiresIn: '30d', /* Recordings expire in 30 days */
    expiryStrategy: 'warn', /* Console warning if a recording is expired. */ 
    matchRequestsBy: {/* Your configuration here. See below */}
  })
}

polly_ci_config.ts

{
 expiryStrategy: process.env.CI? 'warn' : 'record'
 recordIfMissing: process.env.CI? false : true
}

userService.test_1.ts

describe('UserService', () => {
  
  beforeEach(() => {
    APICall = jest
      .spyOn(APIService, 'get')
      .mockImplementation(userId => { /* mock endpoint response here */ })
  })

  test('should format successful response correctly, async () => {
    const actual = await UserService.getUserInfo("@helvantine")
    const expected = { /* Define formatted response here. */}
    expect(actual).toStrictEqual(expected)
  })
})

userService.test_2.ts

import * as Polly from './polly'
/* ... */

describe('UserService', () => {
  Polly.start()
  
  test('should format successful response correctly, async () => {
    const actual = await UserService.getUserInfo("@helvantine")
    const expected = { /* Define formatted response here. */}
    expect(actual).toStrictEqual(expected)
  })
})

userService.ts

class UserService {
  public getUserInfo = async (id) => {
    const response = await APIService.get(`/user?id=${id}`)
    return this.formatResponse(response)
  }
 
  private formatResponse = (response) => {
    /* Formatting logic here */
  }
}