Adds support for use with other OTW archives

Allow changing the archive URL at runtime, and add tests for superlove

Author: gingerchew

package.json

@@ -39,7 +39,7 @@
     "coverage": "vitest run --coverage",
     "encode-mock-files": "ts-node-esm tests/mocks/scripts/encode-mock-files.mts",
     "redownload": "tsx tests/mocks/scripts/redownload-articles.mts",
-    "download": "tsx tests/mocks/scripts/download-ao3-url.mts"
+    "download": "tsx tests/mocks/scripts/download-archive-url.mts"
   },
   "repository": {
     "type": "git",

src/urls.ts

@@ -5,8 +5,26 @@ import {
 } from "./utils";
 import { WorkSummary } from "types/entities";
 
-const ARCHIVE_BASE_URL =
-  process.env.ARCHIVE_BASE_URL ?? "https://archiveofourown.org";
+declare global {
+  var archiveBaseUrl: string;
+}
+
+const DEFAULT_BASE_URL =
+  import.meta.env.ARCHIVE_BASE_URL ?? "https://archiveofourown.org";
+
+globalThis.archiveBaseUrl = DEFAULT_BASE_URL;
+
+export const setArchiveBaseUrl = (url: string) => {
+  globalThis.archiveBaseUrl = url;
+};
+
+export const getArchiveBaseUrl = () => {
+  return globalThis.archiveBaseUrl;
+};
+
+export const resetArchiveBaseUrl = () => {
+  globalThis.archiveBaseUrl = DEFAULT_BASE_URL;
+};
 
 export const getWorkUrl = ({
   workId,
@@ -38,33 +56,42 @@ export const getWorkUrl = ({
     workPath += `/chapters/${chapterId}`;
   }
 
-  return new URL(workPath, ARCHIVE_BASE_URL).href;
+  return new URL(workPath, getArchiveBaseUrl()).href;
 };
 
 export const getWorkIndexUrl = ({ workId }: { workId: string | number }) => {
   if (!isValidArchiveId(workId)) {
     throw new Error(`${workId} is not a valid work id`);
   }
-
-  return new URL(`works/${workId}/navigate`, ARCHIVE_BASE_URL).href;
+  return new URL(`works/${workId}/navigate`, getArchiveBaseUrl()).href;
 };
 
 export const getSeriesUrl = ({ seriesId }: { seriesId: string | number }) => {
   if (!isValidArchiveId(seriesId)) {
     throw new Error(`${seriesId} is not a valid series id`);
   }
 
-  return new URL(`series/${seriesId}`, ARCHIVE_BASE_URL).href;
+  return new URL(`series/${seriesId}`, getArchiveBaseUrl()).href;
 };
 
-export const getAsShortUrl = ({ url }: { url: string }) => {
-  if (!url.includes("archiveofourown")) {
-    throw new Error("We only support short URLs for AO3");
+export const getAsShortUrl = ({ url }: { url: string | URL }) => {
+  const longUrl = new URL(url);
+  if (longUrl.hostname !== "archiveofourown.org") {
+    throw new Error(
+      `Short URLs are only supported for AO3 (found: ${longUrl.hostname})`
+    );
   }
 
-  return url.replace(/archiveofourown/, "ao3");
+  longUrl.host = "ao3.org";
+  return longUrl.href;
 };
 
+/**
+ * Gets the download URLs for a work.
+ *
+ * Warning: while this method will return the download URLs for locked works,
+ * people may not be able to download them.
+ */
 export const getDownloadUrls = ({
   id,
   title,
@@ -75,7 +102,8 @@ export const getDownloadUrls = ({
 | Pick<WorkSummary, "id" | "title" | "updatedAt" | "publishedAt">
   | WorkSummary) => {
   const timestamp = new Date(updatedAt ?? publishedAt).valueOf();
-  const downloadLinkBase = new URL(`downloads/${id}/`, ARCHIVE_BASE_URL).href;
+  const downloadLinkBase = new URL(`downloads/${id}/`, getArchiveBaseUrl())
+    .href;
   const urlSafeTitle = title.replaceAll(/\s/g, "_");
 
   return {
@@ -88,7 +116,7 @@ export const getDownloadUrls = ({
 };
 
 export const getUserProfileUrl = ({ username }: { username: string }) =>
-  new URL(`/users/${encodeURI(username)}/profile`, ARCHIVE_BASE_URL).href;
+  new URL(`/users/${encodeURI(username)}/profile`, getArchiveBaseUrl()).href;
 
 const TOKEN_REPLACEMENTS_MAP = {
   "/": "*s*",
@@ -128,14 +156,14 @@ export const getTagUrl = (tagName: string) =>
       (char: string) =>
         isReplaceableToken(char) ? TOKEN_REPLACEMENTS_MAP[char] : char
     )}/`,
-    ARCHIVE_BASE_URL
+    getArchiveBaseUrl()
   ).href;
 
 export const getTagWorksFeedUrl = (tagName: string) =>
   new URL(`works`, getTagUrl(tagName)).href;
 
 export const getTagWorksFeedAtomUrl = (tagId: string) =>
-  new URL(`tags/${tagId}/feed.atom`, ARCHIVE_BASE_URL).href;
+  new URL(`tags/${tagId}/feed.atom`, getArchiveBaseUrl()).href;
 
 export const getWorkDetailsFromUrl = ({
   url,

…sts/mocks/data/series/1728802/index.html …mocks/data/ao3/series/1728802/index.htmltests/mocks/data/series/1728802/index.html renamed to tests/mocks/data/ao3/series/1728802/index.html tests/mocks/data/series/1728802/index.html renamed to tests/mocks/data/ao3/series/1728802/index.html

@@ -33,7 +33,7 @@
 <script src="/javascripts/livevalidation_standalone.js"></script>
 
 <meta name="csrf-param" content="authenticity_token" />
-<meta name="csrf-token" content="GQRPbM2AGgehAcOGV1gGAGAnMa541tjABraViOEQxyHPFxoEmn_vzlhTVxGcefUdywJPTJtXP8opgOy7JAlYGw" />
+<meta name="csrf-token" content="D9ixzuNWg9CQlL0P9ecIvSzdPhqOvoGXJtVEqcLdUoiZI2VAD-mdC4tTRBDF41Y-nDPND9rdV-yXMk0DT1lR7A" />
 
 
   </head>
@@ -56,7 +56,7 @@ <h1 class="heading">
         <a id="login-dropdown" href="/users/login">Log In</a>
       </p>
       <div id="small_login" class="simple login">
-	<form class="new_user" id="new_user_session_small" action="/users/login" accept-charset="UTF-8" method="post"><input type="hidden" name="authenticity_token" value="D7bxQsKav-3k9z4m76o9mdCYXqxWK2YV1vUz8tSJGZoohFcERHYrTAuGRZMyQp2geHM96yDnqJaX-K95qYNfsQ" autocomplete="off" />
+	<form class="new_user" id="new_user_session_small" action="/users/login" accept-charset="UTF-8" method="post"><input type="hidden" name="authenticity_token" value="XYVBrUY1h41nf1NMdTl7VY8KShe5VlITL9_fFXv4YjFJ9oUolvrUJGQSAdgBpicS9r8uShR40ozlMSWlQP8ONA" autocomplete="off" />
   <dl>
     <dt><label for="user_session_login_small">Username or email:</label></dt>
     <dd><input autocomplete="on" id="user_session_login_small" type="text" name="user[login]" /></dd>
@@ -137,7 +137,7 @@ <h1 class="heading">
     <p>
       <label class="landmark" for="site_search">Work Search</label>
       <input class="text" id="site_search" aria-describedby="site_search_tooltip" type="text" name="work_search[query]" />
-      <span class="tip" role="tooltip" id="site_search_tooltip">tip: hetalia f/f sort:kudos</span>
+      <span class="tip" role="tooltip" id="site_search_tooltip">tip: &quot;uchiha sasuke/uzumaki naruto&quot; angst kudos&gt;10</span>
       <span class="submit actions"><input type="submit" value="Search" class="button" /></span>
     </p>
   </fieldset>
@@ -237,7 +237,7 @@ <h5 class="fandoms heading">
     <!--required tags-->
     <ul class="required-tags">
 <li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="rating-notrated rating" title="Not Rated"><span class="text">Not Rated</span></span></a></li>
-<li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="warning-choosenotto warnings" title="Choose Not To Use Archive Warnings"><span class="text">Choose Not To Use Archive Warnings</span></span></a></li>
+<li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="warning-choosenotto warnings" title="Creator Chose Not To Use Archive Warnings"><span class="text">Creator Chose Not To Use Archive Warnings</span></span></a></li>
 <li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="category-gen category" title="Gen"><span class="text">Gen</span></span></a></li>
 <li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="complete-yes iswip" title="Complete Work"><span class="text">Complete Work</span></span></a></li>
 </ul>
@@ -281,13 +281,13 @@ <h6 class="landmark heading">Series</h6>
     <dd class="comments"><a href="/works/23977417?show_comments=true#comments">27</a></dd>
 
     <dt class="kudos">Kudos:</dt>
-    <dd class="kudos"><a href="/works/23977417#kudos">548</a></dd>
+    <dd class="kudos"><a href="/works/23977417#kudos">551</a></dd>
 
     <dt class="bookmarks">Bookmarks:</dt>
     <dd class="bookmarks"><a href="/works/23977417/bookmarks">79</a></dd>
 
   <dt class="hits">Hits:</dt>
-  <dd class="hits">8,055</dd>
+  <dd class="hits">8,072</dd>
 
   </dl>
 
@@ -320,7 +320,7 @@ <h5 class="fandoms heading">
     <!--required tags-->
     <ul class="required-tags">
 <li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="rating-notrated rating" title="Not Rated"><span class="text">Not Rated</span></span></a></li>
-<li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="warning-choosenotto warnings" title="Choose Not To Use Archive Warnings"><span class="text">Choose Not To Use Archive Warnings</span></span></a></li>
+<li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="warning-choosenotto warnings" title="Creator Chose Not To Use Archive Warnings"><span class="text">Creator Chose Not To Use Archive Warnings</span></span></a></li>
 <li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="category-het category" title="F/M"><span class="text">F/M</span></span></a></li>
 <li> <a class="help symbol question modal" title="Symbols key" href="/help/symbols-key.html"><span class="complete-yes iswip" title="Complete Work"><span class="text">Complete Work</span></span></a></li>
 </ul>
@@ -364,13 +364,13 @@ <h6 class="landmark heading">Series</h6>
     <dd class="comments"><a href="/works/24121558?show_comments=true#comments">20</a></dd>
 
     <dt class="kudos">Kudos:</dt>
-    <dd class="kudos"><a href="/works/24121558#kudos">412</a></dd>
+    <dd class="kudos"><a href="/works/24121558#kudos">413</a></dd>
 
     <dt class="bookmarks">Bookmarks:</dt>
     <dd class="bookmarks"><a href="/works/24121558/bookmarks">98</a></dd>
 
   <dt class="hits">Hits:</dt>
-  <dd class="hits">7,724</dd>
+  <dd class="hits">7,755</dd>
 
   </dl>
 
@@ -447,13 +447,13 @@ <h6 class="landmark heading">Series</h6>
     <dd class="comments"><a href="/works/24597715?show_comments=true#comments">17</a></dd>
 
     <dt class="kudos">Kudos:</dt>
-    <dd class="kudos"><a href="/works/24597715#kudos">1,091</a></dd>
+    <dd class="kudos"><a href="/works/24597715#kudos">1,094</a></dd>
 
     <dt class="bookmarks">Bookmarks:</dt>
     <dd class="bookmarks"><a href="/works/24597715/bookmarks">118</a></dd>
 
   <dt class="hits">Hits:</dt>
-  <dd class="hits">11,323</dd>
+  <dd class="hits">11,354</dd>
 
   </dl>
 
@@ -499,7 +499,7 @@ <h4 class="heading">Contact Us</h4>
       <h4 class="heading">Development</h4>
       <ul class="menu">
           <li>
-            <a href="https://github.com/otwcode/otwarchive/commits/v0.9.427.1">otwarchive v0.9.427.1</a>
+            <a href="https://github.com/otwcode/otwarchive/commits/v0.9.429.1">otwarchive v0.9.429.1</a>
           </li>
         <li><a href="/known_issues">Known Issues</a></li>
         <li>
@@ -589,5 +589,5 @@ <h4 class="heading">Development</h4>
 </script>
 
 
-  <script>(function(){function c(){var b=a.contentDocument||a.contentWindow.document;if(b){var d=b.createElement('script');d.innerHTML="window.__CF$cv$params={r:'97c130c4697f7ede',t:'MTc1NzM2MzI4Ny4wMDAwMDA='};var a=document.createElement('script');a.nonce='';a.src='/cdn-cgi/challenge-platform/scripts/jsd/main.js';document.getElementsByTagName('head')[0].appendChild(a);";b.getElementsByTagName('head')[0].appendChild(d)}}if(document.body){var a=document.createElement('iframe');a.height=1;a.width=1;a.style.position='absolute';a.style.top=0;a.style.left=0;a.style.border='none';a.style.visibility='hidden';document.body.appendChild(a);if('loading'!==document.readyState)c();else if(window.addEventListener)document.addEventListener('DOMContentLoaded',c);else{var e=document.onreadystatechange||function(){};document.onreadystatechange=function(b){e(b);'loading'!==document.readyState&&(document.onreadystatechange=e,c())}}}})();</script></body>
+  <script>(function(){function c(){var b=a.contentDocument||a.contentWindow.document;if(b){var d=b.createElement('script');d.innerHTML="window.__CF$cv$params={r:'983c9e6f887f27d8',t:'MTc1ODY1NzUzNy4wMDAwMDA='};var a=document.createElement('script');a.nonce='';a.src='/cdn-cgi/challenge-platform/scripts/jsd/main.js';document.getElementsByTagName('head')[0].appendChild(a);";b.getElementsByTagName('head')[0].appendChild(d)}}if(document.body){var a=document.createElement('iframe');a.height=1;a.width=1;a.style.position='absolute';a.style.top=0;a.style.left=0;a.style.border='none';a.style.visibility='hidden';document.body.appendChild(a);if('loading'!==document.readyState)c();else if(window.addEventListener)document.addEventListener('DOMContentLoaded',c);else{var e=document.onreadystatechange||function(){};document.onreadystatechange=function(b){e(b);'loading'!==document.readyState&&(document.onreadystatechange=e,c())}}}})();</script></body>
 </html>