Use node-fetch instead of request for default transport

.nvmrc

@@ -0,0 +1 @@
+18

docs.md

@@ -1,4 +1,4 @@
-# HttpTranport
+# HttpTransport
 
 >  A flexible, modular REST client built for ease-of-use and resilience
 
@@ -32,7 +32,7 @@ PATCH, DELETE, HEAD are also supported.
 
 #### Query strings
 
-Make a HTTP GET request specifiying query strings using `.query`
+Make a HTTP GET request specifying query strings using `.query`
 
 Single query string
 ```js
@@ -62,7 +62,7 @@ Multiple query strings:
 
 #### Headers
 
-Make a HTTP GET request specifiying request headers using `.headers`
+Make a HTTP GET request specifying request headers using `.headers`
 
 Add a single header:
 ```js
@@ -176,7 +176,7 @@ Middleware are functions that can be executed with before and after a request. M
 * Terminate a request early e.g for caching purposes
 * Modify the response object e.g format the response body 
 
-Middlware can be executed **per request** using the `.use` method:
+Middleware can be executed **per request** using the `.use` method:
 ```js
     const exampleMiddleware = require('exampleMiddleware');
 
@@ -193,7 +193,7 @@ Middlware can be executed **per request** using the `.use` method:
     }
 ```
 
-Middlware can also be executed **for every request** using the `.use` of the client builder. The client builder is created using the `createBuilder` method:
+Middleware can also be executed **for every request** using the `.use` of the client builder. The client builder is created using the `createBuilder` method:
 
 ```js
     const exampleMiddleware = require('exampleMiddleware');
@@ -214,7 +214,7 @@ Middlware can also be executed **for every request** using the `.use` of the cli
 
 For writing middleware, see the [offical guide](/~https://github.com/koajs/koa/blob/master/docs/guide.md)
 
-#### Offical HttpTransport middleware
+#### Official HttpTransport middleware
 See [Caching](/~https://github.com/bbc/http-transport-cache)
 
 See [Collapsing](/~https://github.com/bbc/http-transport-request-collapse)

index.d.ts

@@ -1,4 +1,5 @@
-import * as request from "request";
+import * as fetch from "node-fetch";
+import FetchTransport from "./lib/transport/node-fetch";
 
 export declare function createBuilder(
   transport?: Transport
@@ -85,7 +86,7 @@ export declare class Response {
   url: string;
   statusCode: number;
   body: Body;
-  httpResponse?: request.Response;
+  httpResponse?: fetch.Response;
   readonly length: number;
   static create(opts?: JsonResponse): Response;
   addHeader(key: string, value: string): Request;
@@ -102,7 +103,6 @@ export declare class HttpTransportBuilder<
   use<ContextExtra = {}>(
     fn: Plugin<ContextExtra, ContextCurrent>
   ): HttpTransportBuilder<ContextExtra & ContextCurrent>;
-  asCallback(): HttpTransportBuilder<ContextCurrent>;
   createClient(): HttpTransportClient<ContextCurrent>;
 }
 
@@ -146,7 +146,7 @@ declare class Context {
   addPlugin(plugin: Plugin): Context;
 }
 
-export declare class defaultTransport extends RequestTransport {
+export declare class defaultTransport extends FetchTransport {
   constructor(
     params: request.RequestAPI<
       request.Request,
@@ -155,8 +155,11 @@ export declare class defaultTransport extends RequestTransport {
     >
   );
 }
-export declare class RequestTransport extends Transport {
+export declare class FetchTransport extends Transport {
   constructor(
+    agentOpts: {
+
+    }
     params: request.RequestAPI<
       request.Request,
       request.CoreOptions,
@@ -168,10 +171,10 @@ export declare class RequestTransport extends Transport {
 export declare class Transport {
   toError(err: ErrorObject, ctx: Context): Error;
   createError(err: ErrorObject, ctx: Context): Error;
-  execute(ctx: Context): Promise<RequestTransport>;
+  execute(ctx: Context): Promise<FetchTransport>;
   onError(ctx: Context): Function;
   toOptions(ctx: Context): RequestOptions;
-  toResponse(ctx: Context, from: request.Response): Response;
+  toResponse(ctx: Context, from: fetch.Response): Response;
   makeRequest(ctx: Context, opts: RequestOptions): Promise<Response>;
 }
 

index.js

@@ -1,10 +1,10 @@
 'use strict';
 
 const HttpTransportBuilder = require('./lib/builder');
-const DefaultTransport = require('./lib/transport/request');
+const DefaultTransport = require('./lib/transport/node-fetch');
 
 module.exports.defaultTransport = DefaultTransport;
-module.exports.RequestTransport = DefaultTransport;
+module.exports.FetchTransport = DefaultTransport;
 module.exports.builder = HttpTransportBuilder;
 module.exports.transport = require('./lib/transport/transport');
 module.exports.context = require('./lib/context');

lib/builder.js

@@ -2,7 +2,6 @@
 
 const _ = require('lodash');
 
-const CallbackDecorator = require('./callbacks/decorator');
 const HttpTransportClient = require('./client');
 
 function validatePlugin(plugin) {
@@ -16,7 +15,6 @@ class HttpTransportBuilder {
    * @param {Transport} transport - Transport instance.
    */
   constructor(transport) {
-    this._callback = false;
     this._transport = transport;
     this._defaults = {
       plugins: []
@@ -26,7 +24,7 @@ class HttpTransportBuilder {
   /**
    * Sets a default user agent
    *
-   * @param {string} agent - user agant
+   * @param {string} agent - user agent
    * @return a HttpTransportBuilder instance
    * @example
    * const httpTransport = require('@bbc/http-transport');
@@ -89,19 +87,6 @@ class HttpTransportBuilder {
     return this;
   }
 
-  /**
-   * Callbackify the client
-   *
-   * @return a HttpTransport instance supporting callbacks
-   * @example
-   *
-   * const client = httpTransport.asCallback().createClient();
-   */
-  asCallback() {
-    this._callback = true;
-    return this;
-  }
-
   /**
    * Instantiates a HttpTransport
    *
@@ -112,11 +97,7 @@ class HttpTransportBuilder {
    * const client = httpTransport.createClient();
    */
   createClient() {
-    const transportClient = new HttpTransportClient(this._transport, this._defaults);
-    if (this._callback) {
-      return new CallbackDecorator(transportClient);
-    }
-    return transportClient;
+    return new HttpTransportClient(this._transport, this._defaults);
   }
 }
 

lib/client.js

@@ -1,6 +1,5 @@
 'use strict';
 
-const _ = require('lodash');
 const compose = require('koa-compose');
 const context = require('./context');
 const rejectedPromise = require('./rejectedPromise');
@@ -11,11 +10,11 @@ class HttpTransportClient {
   /**
    * Create a HttpTransport.
    * @param {Transport} transport - Transport instance.
-   * @param {object} defaults - default configutation
+   * @param {object} defaults - default configuration
    */
   constructor(transport, defaults) {
     this._transport = transport;
-    this._instancePlugins = _.get(defaults, 'plugins', []);
+    this._instancePlugins = defaults.plugins || [];
     this._defaults = defaults;
     this._initContext();
     bind(this);

lib/context.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const _ = require('lodash');
-
 const Request = require('./request');
 const Response = require('./response');
 const packageInfo = require('../package');
@@ -21,8 +19,7 @@ class Context {
   }
 
   get retryAttempts() {
-    if (_.isUndefined(this._retryAttempts)) return [];
-    return this._retryAttempts;
+    return this._retryAttempts || [];
   }
 
   set retryAttempts(retryAttempts) {
@@ -38,9 +35,9 @@ class Context {
   }
 
   _applyDefaults(defaults) {
-    this.userAgent = _.get(defaults, 'ctx.userAgent', USER_AGENT);
-    this.retries = _.get(defaults, 'ctx.retries', RETRIES);
-    this.retryDelay = _.get(defaults, 'ctx.retryDelay', RETRY_DELAY);
+    this.userAgent = defaults.ctx?.userAgent || USER_AGENT;
+    this.retries = defaults.ctx?.retries || RETRIES;
+    this.retryDelay = defaults.ctx?.retryDelay || RETRY_DELAY;
   }
 
   static create(defaults) {

lib/middleware/logger.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const _ = require('lodash');
-
 function isRetry(ctx) {
   const attempts = ctx.retryAttempts || [];
   return attempts.length > 0;
@@ -12,7 +10,7 @@ function isCriticalError(ctx) {
 }
 
 function hasElapsedTime(ctx) {
-  return !_.isUndefined(_.get(ctx, 'res.elapsedTime'));
+  return !!ctx.res?.elapsedTime;
 }
 
 function getBaseMessage(ctx) {
@@ -29,11 +27,8 @@ function createRequestMessage(ctx) {
 }
 
 function createRetryMessage(ctx) {
-  const res = ctx.res;
-  const attempts = ctx.retryAttempts;
-
-  const message = `Attempt ${attempts.length} ${getBaseMessage(ctx)}`;
-  if (hasElapsedTime(ctx)) return `${message} ${res.elapsedTime} ms`;
+  const message = `Attempt ${ctx.retryAttempts.length} ${getBaseMessage(ctx)}`;
+  if (hasElapsedTime(ctx)) return `${message} ${ctx.res.elapsedTime} ms`;
 
   return message;
 }

lib/response.js

@@ -1,7 +1,5 @@
 'use strict';
 
-const _ = require('lodash');
-
 const REQUIRED_PROPERTIES = [
   'url',
   'body',