Supertest with Proxy Support

Common errors

• TypeError [ERR_UNKNOWN_FILE_EXTENSION]: Unknown file extension ".js" for /path/to/node_modules/supertest-with-proxy/index.js

  cause Attempting to import a CommonJS-only package using ES Module `import` syntax in an ESM project.
  fix Change `import request from 'supertest-with-proxy';` to `const request = require('supertest-with-proxy');`.

• supertest-with-proxy is not a function

  cause This error can occur if `require('supertest-with-proxy')` returns `undefined` or an unexpected value, often due to Node.js version incompatibility or an issue during module loading.
  fix Ensure your Node.js version is compatible (though old versions are specified, newer ones might break it). Reinstall the package (`npm install supertest-with-proxy`) to rule out corrupted node_modules. Check for conflicting dependencies or global Node.js module issues.

Warnings

• breaking The package has not been updated in over six years and is considered abandoned. This means no new features, bug fixes, or security patches will be released, potentially leading to critical vulnerabilities or incompatibility with modern environments.
  Fix: Consider migrating to actively maintained alternatives or implementing proxy logic directly within standard `supertest` setups (e.g., using global-agent or a custom `superagent` wrapper).
• gotcha The `engines.node` field specifies `>=6.0.0`, which is an extremely old Node.js version. Running this package on recent Node.js versions (e.g., Node.js 16, 18, 20+) may lead to unexpected behavior or runtime errors due to breaking changes in Node.js itself.
  Fix: Thoroughly test on your target Node.js version. Be prepared for potential compatibility issues and consider alternative proxy solutions for `supertest`.
• gotcha The package's README points to a specific fork of `supertest` (`tauheedkhan/supertest` or `soniajasuja/supertest`) rather than the official, actively maintained `supertest` package. This suggests it might be tightly coupled to an older or specific `supertest` version, leading to potential API inconsistencies or a lack of support for features introduced in newer `supertest` releases.
  Fix: Verify compatibility with the `supertest` version you intend to use. If issues arise, you might be forced to downgrade `supertest` or explore alternative proxy integration methods for testing.

Install

• npm install supertest-with-proxy npm
• yarn add supertest-with-proxy yarn
• pnpm add supertest-with-proxy pnpm

Imports

• request
  wrong:

  import request from 'supertest-with-proxy';

  correct:

  const request = require('supertest-with-proxy');

  This library is primarily CommonJS (CJS). ESM import syntax will lead to errors.
• request
  wrong:

  const { request } = require('supertest-with-proxy');

  correct:

  const request = require('supertest-with-proxy');

  The library exports a single function as its default, not named exports. Destructuring will result in an undefined 'request'.
• request
  wrong:

  import { request } from 'supertest-with-proxy';

  correct:

  const request = require('supertest-with-proxy');

  Incorrect usage for both CJS-only package and trying to import a non-existent named export.

Quickstart

This example demonstrates how to use `supertest-with-proxy` to test an Express.js application's `/user` endpoint, routing the request through a specified proxy server and asserting the response.

const request = require('supertest-with-proxy');
const express = require('express');

const app = express();

app.get('/user', function(req, res) {
  res.status(200).json({ name: 'john' });
});

request(app)
  .get('/user')
  .proxy('http://example.com')
  .expect('Content-Type', /json/)
  .expect('Content-Length', '15')
  .expect(200)
  .end(function(err, res) {
    if (err) throw err;
    console.log('Test passed for user endpoint with proxy.');
  });