fix: Removes unnessary objects from fetch ponyfill requirement

This removes Request, Response, and Headers as hard requirements for
the MongoClient API. This makes it easier to use a library like
node-fetch or cross-fetch. The `headers` property may now also be
a POJO, similar to node's OutgoingHttpHeaders.

Author: thecodedrift

CHANGELOG.md

@@ -7,13 +7,18 @@ All notable changes to this project will be documented in this file. This projec
 ### Added
 
 - Created a `CHANGELOG.md` for changelog tracking
+- Enabled support for plain JS objects in `headers`
 
 ### Fixed
 
 ### Changed
 
+- Removed requirement for `Request` and `Response` in the custom fetch interface
+
 ### Removed
 
+- Dropped `node-fetch` for `cross-fetch` in tests to minimze type assertions
+
 ## [0.1.2] - 2023-05-01
 
 ### Added

README.md

@@ -128,6 +128,8 @@ const client = new MongoClient(options);
   - `options.endpoint` - `string | URL` an endpoint for sending requests to. Your Data API Endpoint is available at your Mongo Data API UI `https://cloud.mongodb.com/v2/<projectId>#/dataAPI`, where `<projectId>` is your project ID. A single Data API is usable for the entire project, with individual data sources routing to specific atlas instances.
   - `options.dataSource` - `string` the `Data Source` for your Data API. On the Data API UI, this is the "Data Source" column, and usually is either a 1:1 mapping of your cluster name, or the default `mongodb-atlas` if you enabled Data API through the Atlas Admin UI.
   - `options.auth` - `AuthOptions` one of the authentication methods, either api key, email & password, or a custom JWT string. At this time, only [Credential Authentication](https://www.mongodb.com/docs/atlas/api/data-api/#credential-authentication) is supported.
+  - `options.fetch?` - A custom `fetch` function conforming to the [native fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). We recommend [cross-fetch](https://www.npmjs.com/package/cross-fetch), as it asserts a complaint `fetch()` interface and avoids you having to do `fetch: _fetch as typeof fetch` to satisfy the TypeScript compiler
+  - `options.headers?` - Additional [Headers](https://developer.mozilla.org/en-US/docs/Web/API/Headers) to include with the request. May also be a simple object of key/value pairs.
 
 ## Select a Database
 

package.json

@@ -66,7 +66,6 @@
     "husky": "^7.0.4",
     "lint-staged": "13.0.3",
     "msw": "^1.2.1",
-    "node-fetch": "^3.3.1",
     "npm-run-all": "^4.1.5",
     "release-it": "^15.10.2",
     "shx": "^0.3.4",

pnpm-lock.yaml

@@ -1,3 +1,4 @@
+import { type OutgoingHttpHeaders } from "node:http";
 import { EJSON } from "bson";
 import type {
   Sort,
@@ -25,13 +26,6 @@ export type {
   WithoutId,
 } from "mongodb";
 
-export type CustomFetch = {
-  fetch: typeof fetch;
-  Request: typeof Request;
-  Response: typeof Response;
-  Headers: typeof Headers;
-};
-
 // eslint-disable-next-line @typescript-eslint/ban-types
 type Nullable<T> = T | null;
 
@@ -66,12 +60,12 @@ export type MongoClientConstructorOptions = {
    * a `fetch()` function, as well as the `Request`, `Response`, and `Headers` classes. These
    * are available in most ponyfills and polyfills, including node-fetch.
    */
-  fetch?: CustomFetch;
+  fetch?: typeof fetch;
   /**
    * Provide a custom Headers object for the request. In some situations such as testing,
    * this allows you to control the response from the mock server.
    */
-  headers?: Headers;
+  headers?: OutgoingHttpHeaders | Headers;
 };
 
 /**
@@ -90,7 +84,7 @@ export class MongoClient {
   endpoint: string;
 
   fetch: typeof fetch;
-  headers: Headers;
+  headers: HeadersInit;
 
   constructor({
     auth,
@@ -102,38 +96,45 @@ export class MongoClient {
     this.dataSource = dataSource;
     this.endpoint = endpoint instanceof URL ? endpoint.toString() : endpoint;
 
-    this.fetch = customFetch?.fetch ?? globalThis.fetch;
-    const HeaderClass = customFetch?.Headers ?? globalThis.Headers;
+    this.fetch = customFetch ?? globalThis.fetch;
+    this.headers = {};
 
-    if (!this.fetch || typeof this.fetch !== "function" || !HeaderClass) {
+    // accept a node-style or whatwg headers object with .keys() and .get()
+    if (typeof headers?.keys === "function") {
+      for (const key of headers.keys()) {
+        this.headers[key] = (
+          typeof headers.get === "function" ? headers.get(key) : headers[key]
+        ) as string;
+      }
+    }
+
+    if (!this.fetch || typeof this.fetch !== "function") {
       throw new Error(
         "No viable fetch() found. Please provide a fetch interface"
       );
     }
 
-    this.headers = headers ?? new HeaderClass();
-
-    this.headers.set("Content-Type", "application/ejson");
-    this.headers.set("Accept", "application/ejson");
+    this.headers["Content-Type"] = "application/ejson";
+    this.headers.Accept = "application/ejson";
 
     if ("apiKey" in auth) {
-      this.headers.set("apiKey", auth.apiKey);
+      this.headers.apiKey = auth.apiKey;
       return;
     }
 
     if ("jwtTokenString" in auth) {
-      this.headers.set("jwtTokenString", auth.jwtTokenString);
+      this.headers.jwtTokenString = auth.jwtTokenString;
       return;
     }
 
     if ("email" in auth && "password" in auth) {
-      this.headers.set("email", auth.email);
-      this.headers.set("password", auth.password);
+      this.headers.email = auth.email;
+      this.headers.password = auth.password;
       return;
     }
 
     if ("bearerToken" in auth) {
-      this.headers.set("Authorization", `Bearer ${auth.bearerToken}`);
+      this.headers.Authorization = `Bearer ${auth.bearerToken}`;
       return;
     }
 

src/client.ts

@@ -1,10 +1,8 @@
 import test from "ava";
-import fetch, { Request, Response, Headers } from "cross-fetch";
+import fetch from "cross-fetch";
 import { MongoClient } from "../src/client.js";
 import { BASE_URL } from "./mocks/handlers.js";
 
-const fetchInterface = { fetch, Request, Response, Headers };
-
 test("requires a fetch interface", (t) => {
   t.throws(() => {
     const c = new MongoClient({
@@ -24,7 +22,7 @@ test("requires a valid auth method", (t) => {
       dataSource: "test-datasource",
       // @ts-expect-error bypassing type check to throw error on bad auth method
       auth: { notValid: "not a valid auth method" },
-      fetch: fetchInterface,
+      fetch,
     });
   });
 });
@@ -34,7 +32,7 @@ test("accepts an api key for auth", (t) => {
     endpoint: BASE_URL,
     dataSource: "test-datasource",
     auth: { apiKey: "validApiKey" },
-    fetch: fetchInterface,
+    fetch,
   });
   t.pass();
 });
@@ -44,7 +42,7 @@ test("accepts a jwt token for auth", (t) => {
     endpoint: BASE_URL,
     dataSource: "test-datasource",
     auth: { jwtTokenString: "passed through to mongo api" },
-    fetch: fetchInterface,
+    fetch,
   });
   t.pass();
 });
@@ -54,7 +52,7 @@ test("accepts an email and password for auth", (t) => {
     endpoint: BASE_URL,
     dataSource: "test-datasource",
     auth: { email: "[email protected]", password: "validPassword" },
-    fetch: fetchInterface,
+    fetch,
   });
   t.pass();
 });
@@ -64,7 +62,7 @@ test("accepts a bearer token for auth", (t) => {
     endpoint: BASE_URL,
     dataSource: "test-datasource",
     auth: { bearerToken: "passed through to mongo api" },
-    fetch: fetchInterface,
+    fetch,
   });
   t.pass();
 });

test/configure.spec.ts

@@ -1,5 +1,5 @@
 import anyTest, { type TestFn, type ExecutionContext } from "ava";
-import fetch, { Request, Response, Headers } from "cross-fetch";
+import fetch, { Headers } from "cross-fetch";
 import { type RequestHandler } from "msw";
 import { MongoClient, ObjectId } from "../src/client.js";
 import { MongoDataAPIError } from "../src/errors.js";
@@ -38,12 +38,7 @@ const createMongoClient = (headers?: Headers) => {
     endpoint: BASE_URL,
     dataSource: "test-datasource",
     auth: { apiKey: "validApiKey" },
-    fetch: {
-      fetch,
-      Request,
-      Response,
-      Headers,
-    },
+    fetch,
     headers,
   });
   return c;
@@ -222,12 +217,7 @@ test("auth: disabled data source results in 400 from Mongo", async (t) => {
     endpoint: BASE_URL,
     dataSource: "test-datasource-disabled",
     auth: { apiKey: "validApiKey" },
-    fetch: {
-      fetch,
-      Request,
-      Response,
-      Headers,
-    },
+    fetch,
   });
   const { data, error } = await c
     .db("test-db")
@@ -245,12 +235,7 @@ test("auth: bad auth results in 401 from Mongo", async (t) => {
     endpoint: BASE_URL,
     dataSource: "test-datasource",
     auth: { apiKey: "inValidApiKey" },
-    fetch: {
-      fetch,
-      Request,
-      Response,
-      Headers,
-    },
+    fetch,
   });
   const { data, error } = await c
     .db("test-db")
@@ -269,12 +254,7 @@ test("auth: bad client ID results in 404 from Mongo", async (t) => {
       "https://data.mongodb-api.com/app/invalidClientAppId/endpoint/data/v1",
     dataSource: "test-datasource",
     auth: { apiKey: "validApiKey" },
-    fetch: {
-      fetch,
-      Request,
-      Response,
-      Headers,
-    },
+    fetch,
   });
   const { data, error } = await c
     .db("test-db")