Make tests for series independent of page changes by mocking API requests

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bobaboard/ao3.js",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "A NodeJS API for scraping AO3 data",
   "type": "module",
   "types": "./dist/index.d.ts",

src/series/getters.ts

@@ -1,7 +1,6 @@
 import { Author, Series, SeriesWorkSummary } from "types/entities";
-import { SeriesPage, WorkPage } from "../page-loaders";
 import { CheerioAPI, load } from "cheerio";
-import { getWorkDetailsFromUrl, getWorkUrl } from "src/urls";
+import { SeriesPage, WorkPage } from "../page-loaders";
 import {
   getWorkBookmarkCount,
   getWorkHits,
@@ -11,6 +10,7 @@ import {
   getWorkTotalChapters,
   getWorkWordCount,
 } from "src/works/work-getters";
+import { getWorkDetailsFromUrl, getWorkUrl } from "src/urls";
 
 const monthMap: { [month: string]: string } = {
   Jan: "01",
@@ -65,7 +65,7 @@ export const getSeriesDescription = (
 export const getSeriesNotes = ($seriesPage: SeriesPage): string | null => {
   const notes = $seriesPage("dl.series dd:nth-of-type(5)");
   if (notes.prevAll().first().text().trim() === "Notes:") {
-    return notes.html().trim();
+    return notes.html()!.trim();
   } else {
     return null;
   }
@@ -136,7 +136,7 @@ const getSeriesWork = (workHtml: string): SeriesWorkSummary => {
   const publishedChapters = getWorkPublishedChapters($$work);
 
   const url = $work("a[href*='/works/']").attr("href") as string;
-  const id = getWorkDetailsFromUrl({ url }).workId
+  const id = getWorkDetailsFromUrl({ url }).workId;
 
   return {
     id,

src/works/work-getters.ts

@@ -152,9 +152,9 @@ export const getWorkSeries = ($workPage: WorkPage): BasicSeries[] => {
     const link = seriesHtml.find("a:not(.next, .previous)");
 
     series[index] = {
-      id: link.attr("href").replace("/series/", ""),
+      id: link.attr("href")!.replace("/series/", ""),
       name: link.text().trim(),
-      index: matches.length > 0 ? parseInt(matches[0]) : -1,
+      index: matches!.length > 0 ? parseInt(matches![0]) : -1,
     };
   });
 

tests/mocks/handlers.ts

@@ -3,6 +3,7 @@ import allHandlers from "./handlers/all";
 import feedHandlers from "./handlers/tags/feed";
 import nameHandlers from "./handlers/tags/name";
 import profileHandlers from "./handlers/users/profile";
+import seriesHandlers from "./handlers/series";
 import tagWorksHandlers from "./handlers/tags/works";
 import workPageHandlers from "./handlers/works";
 import worksHandlers from "./handlers/works";
@@ -17,5 +18,6 @@ export default [
   nameHandlers,
   workPageHandlers,
   worksNavigateHandlers,
+  seriesHandlers,
   allHandlers,
 ];

tests/mocks/handlers/series/index.ts

@@ -0,0 +1,25 @@
+import { fileURLToPath } from "url";
+import filenamify from "filenamify";
+import fs from "fs";
+import path from "path";
+import { rest } from "msw";
+
+const SERIES_DATA_DIR = path.resolve(
+  fileURLToPath(import.meta.url),
+  "../../../data/series"
+);
+
+export default rest.all(
+  "https://archiveofourown.org/series/:series_id",
+  (req, res, ctx) => {
+    const html = fs.readFileSync(
+      path.resolve(
+        SERIES_DATA_DIR,
+        filenamify(req.params.series_id as string),
+        "index.html"
+      )
+    );
+
+    return res(ctx.set("Content-Type", "text/html"), ctx.body(html));
+  }
+);

tests/series.test.ts

@@ -9,9 +9,9 @@ describe("Fetches series information", () => {
     expect(series).toMatchObject({
       id: "2270465",
       name: "OG Titan",
-      begunAt: "2021-04-11",
+      startedAt: "2021-04-11",
       updatedAt: "2023-02-13",
-      creators: [{ username: "MyHero", pseud: "MyHero" }],
+      authors: [{ username: "MyHero", pseud: "MyHero" }],
       description:
         "<p>My potentially related stories about the relationship between the OG Titans. Probably focused on Dick Grayson.</p>",
       notes: null,
@@ -354,22 +354,6 @@ describe("Fetches series information", () => {
           stats: { bookmarks: 28, kudos: 242, hits: 1 },
         },
       ],
-      workTitles: [
-        "Away from all of Reality",
-        "Code B",
-        "Donna Troy Loves You",
-        "Rockin Robin",
-        "Realistic Exit Strategy",
-        "You starting down the road leaving me again",
-      ],
-      workUrls: [
-        "https://archiveofourown.org/works/30604247",
-        "https://archiveofourown.org/works/30794750",
-        "https://archiveofourown.org/works/30914645",
-        "https://archiveofourown.org/works/31221131",
-        "https://archiveofourown.org/works/35757790",
-        "https://archiveofourown.org/works/44149795",
-      ],
     });
   });
 

types/entities.ts

@@ -41,7 +41,13 @@ export interface User {
 export interface SeriesWorkSummary
   extends Omit<
     WorkSummary,
-    "category" | "publishedAt" | "rating" | "tags" | "stats" | "locked"
+    | "category"
+    | "publishedAt"
+    | "rating"
+    | "tags"
+    | "stats"
+    | "locked"
+    | "series"
   > {
   url: string;
   tags: Omit<WorkSummary["tags"], "warnings">;