Support URLs as cache keys, fixes #33

Author: mrbbot

src/kv/cache.ts

@@ -1,4 +1,4 @@
-import { Headers, Request, Response } from "@mrbbot/node-fetch";
+import { Headers, Request, RequestInfo, Response } from "@mrbbot/node-fetch";
 import CachePolicy from "http-cache-semantics";
 import { KVClock, defaultClock } from "./helpers";
 import { KVStorageNamespace } from "./namespace";
@@ -15,8 +15,8 @@ export interface CachedResponse {
   body: string;
 }
 
-function normaliseRequest(req: string | Request): Request {
-  return typeof req === "string" ? new Request(req) : req;
+function normaliseRequest(req: RequestInfo): Request {
+  return req instanceof Request ? req : new Request(req);
 }
 
 // Normalises headers to object mapping lower-case names to single values.
@@ -55,7 +55,7 @@ export class Cache implements CacheInterface {
     this.#namespace = new KVStorageNamespace(storage, clock);
   }
 
-  async put(req: string | Request, res: Response): Promise<undefined> {
+  async put(req: RequestInfo, res: Response): Promise<undefined> {
     req = normaliseRequest(req);
 
     // Cloudflare ignores request Cache-Control
@@ -124,7 +124,7 @@ export class Cache implements CacheInterface {
   }
 
   async match(
-    req: string | Request,
+    req: RequestInfo,
     options?: CacheMatchOptions
   ): Promise<Response | undefined> {
     req = normaliseRequest(req);
@@ -145,7 +145,7 @@ export class Cache implements CacheInterface {
   }
 
   async delete(
-    req: string | Request,
+    req: RequestInfo,
     options?: CacheMatchOptions
   ): Promise<boolean> {
     req = normaliseRequest(req);

test/kv/cache.spec.ts

@@ -1,5 +1,5 @@
 import assert from "assert";
-import { HeadersInit } from "@mrbbot/node-fetch";
+import { HeadersInit, RequestInfo } from "@mrbbot/node-fetch";
 import anyTest, { Macro, TestInterface } from "ava";
 import {
   Cache,
@@ -34,7 +34,7 @@ const testResponse = new Response("value", {
 
 // Cache:* tests adapted from Cloudworker:
 // https://github.com/dollarshaveclub/cloudworker/blob/master/lib/runtime/cache/__tests__/cache.test.js
-const putMacro: Macro<[string | Request], Context> = async (t, req) => {
+const putMacro: Macro<[RequestInfo], Context> = async (t, req) => {
   const { storage, cache } = t.context;
   await cache.put(req, testResponse.clone());
 
@@ -54,6 +54,7 @@ const putMacro: Macro<[string | Request], Context> = async (t, req) => {
 putMacro.title = (providedTitle) => `Cache: puts ${providedTitle}`;
 test("request", putMacro, new Request("http://localhost:8787/test"));
 test("string request", putMacro, "http://localhost:8787/test");
+test("url request", putMacro, new URL("http://localhost:8787/test"));
 
 test("Cache: only puts GET requests", async (t) => {
   const { storage, cache } = t.context;
@@ -69,7 +70,7 @@ test("Cache: only puts GET requests", async (t) => {
   );
 });
 
-const matchMacro: Macro<[string | Request], Context> = async (t, req) => {
+const matchMacro: Macro<[RequestInfo], Context> = async (t, req) => {
   const { cache } = t.context;
   await cache.put(
     new Request("http://localhost:8787/test"),
@@ -87,6 +88,7 @@ const matchMacro: Macro<[string | Request], Context> = async (t, req) => {
 matchMacro.title = (providedTitle) => `Cache: matches ${providedTitle}`;
 test("request", matchMacro, new Request("http://localhost:8787/test"));
 test("string request", matchMacro, "http://localhost:8787/test");
+test("url request", matchMacro, new URL("http://localhost:8787/test"));
 
 test("Cache: only matches non-GET requests when ignoring method", async (t) => {
   const { cache } = t.context;
@@ -99,7 +101,7 @@ test("Cache: only matches non-GET requests when ignoring method", async (t) => {
   t.not(await cache.match(req, { ignoreMethod: true }), undefined);
 });
 
-const deleteMacro: Macro<[string | Request], Context> = async (t, req) => {
+const deleteMacro: Macro<[RequestInfo], Context> = async (t, req) => {
   const { storage, cache } = t.context;
   await cache.put(
     new Request("http://localhost:8787/test"),
@@ -113,6 +115,7 @@ const deleteMacro: Macro<[string | Request], Context> = async (t, req) => {
 deleteMacro.title = (providedTitle) => `Cache: deletes ${providedTitle}`;
 test("request", deleteMacro, new Request("http://localhost:8787/test"));
 test("string request", deleteMacro, "http://localhost:8787/test");
+test("url request", deleteMacro, new URL("http://localhost:8787/test"));
 
 test("Cache: only deletes non-GET requests when ignoring method", async (t) => {
   const { cache } = t.context;