test: Adds c8 and moves to 100% LoC coverage

Author: thecodedrift

.c8rc.json

@@ -0,0 +1,3 @@
+{
+  "exclude": ["*.env.*", "*.config.*", "test/mocks/*"]
+}

.gitignore

@@ -14,4 +14,7 @@ dist/
 archive/
 .DS_Code
 *.Identifier
-node_modules
+node_modules
+
+# https://github.com/avajs/ava/blob/main/docs/recipes/code-coverage.md
+coverage

package.json

@@ -10,7 +10,7 @@
     "build": "tsup",
     "clean": "shx rm -rf dist",
     "prepare": "husky install",
-    "test": "ava",
+    "test": "c8 ava",
     "typecheck": "tsc --noEmit",
     "yeet": "release-it"
   },
@@ -59,6 +59,7 @@
     "@commitlint/config-conventional": "^15.0.0",
     "@types/node": "^18.15.11",
     "ava": "^4.3.0",
+    "c8": "^7.13.0",
     "cross-fetch": "^3.1.5",
     "dotenv": "^16.0.3",
     "esbuild": "0.17.16",

pnpm-lock.yaml

@@ -105,7 +105,7 @@ export class MongoClient {
     this.fetch = customFetch?.fetch ?? globalThis.fetch;
     const HeaderClass = customFetch?.Headers ?? globalThis.Headers;
 
-    if (!this.fetch || !HeaderClass) {
+    if (!this.fetch || typeof this.fetch !== "function" || !HeaderClass) {
       throw new Error(
         "No viable fetch() found. Please provide a fetch interface"
       );
@@ -445,7 +445,7 @@ export class Collection<TSchema = Document> {
       try {
         errorText = ((await response.json()) as { error: string })?.error;
       } catch {
-        // ignore failed parsing of response text
+        /* c8 ignore next */
       }
 
       const fallbackMessage = {

src/client.ts

@@ -0,0 +1,70 @@
+import test from "ava";
+import fetch, { Request, Response, Headers } 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({
+      endpoint: BASE_URL,
+      dataSource: "test-datasource",
+      auth: { apiKey: "validApiKey" },
+      // @ts-expect-error intentionally knocking out the fetch interface
+      fetch: "not a fetch interface",
+    });
+  });
+});
+
+test("requires a valid auth method", (t) => {
+  t.throws(() => {
+    const c = new MongoClient({
+      endpoint: BASE_URL,
+      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,
+    });
+  });
+});
+
+test("accepts an api key for auth", (t) => {
+  const c = new MongoClient({
+    endpoint: BASE_URL,
+    dataSource: "test-datasource",
+    auth: { apiKey: "validApiKey" },
+    fetch: fetchInterface,
+  });
+  t.pass();
+});
+
+test("accepts a jwt token for auth", (t) => {
+  const c = new MongoClient({
+    endpoint: BASE_URL,
+    dataSource: "test-datasource",
+    auth: { jwtTokenString: "passed through to mongo api" },
+    fetch: fetchInterface,
+  });
+  t.pass();
+});
+
+test("accepts an email and password for auth", (t) => {
+  const c = new MongoClient({
+    endpoint: BASE_URL,
+    dataSource: "test-datasource",
+    auth: { email: "[email protected]", password: "validPassword" },
+    fetch: fetchInterface,
+  });
+  t.pass();
+});
+
+test("accepts a bearer token for auth", (t) => {
+  const c = new MongoClient({
+    endpoint: BASE_URL,
+    dataSource: "test-datasource",
+    auth: { bearerToken: "passed through to mongo api" },
+    fetch: fetchInterface,
+  });
+  t.pass();
+});

test/configure.spec.ts

@@ -255,7 +255,7 @@ test("auth: bad auth results in 401 from Mongo", async (t) => {
   const { data, error } = await c
     .db("test-db")
     .collection<TestDocument>("test-collection")
-    .findOne({ _id: new ObjectId("6193504e1be4ab27791c8133") });
+    .find({ _id: new ObjectId("6193504e1be4ab27791c8133") });
 
   t.is(data, undefined);
   t.truthy(error instanceof MongoDataAPIError);