From 9dce960d9ad6b1972b6b4f410c0fa40d2f5a30b9 Mon Sep 17 00:00:00 2001
From: Yusuke Tanaka <wing0920@gmail.com>
Date: Tue, 9 Jul 2024 23:03:50 +0900
Subject: [PATCH] fix: add user-agent to outbound fetch requests (#210)

This commit adds a special `User-Agent` header to outbound fetch requests.

Currently the user-agent header that upstream servers see is `Deno/1.40.4` which
is a common value across all requests made from deployments on Deno Deploy.
Having a special user-agent in docland will help upstreams easily identify
requests coming from docland.
---
 docs.ts                 | 24 +++++++++++++++++++-----
 middleware/notFound.tsx |  2 +-
 routes/doc.tsx          | 11 -----------
 3 files changed, 20 insertions(+), 17 deletions(-)

diff --git a/docs.ts b/docs.ts
index 40df513..4d1094d 100644
--- a/docs.ts
+++ b/docs.ts
@@ -135,7 +135,7 @@ export async function checkRedirect(
     finalSpecifier = cached.specifier;
   } else {
     try {
-      const res = await fetch(specifier, { redirect: "follow" });
+      const res = await pkgFetch(specifier, { redirect: "follow" });
       if (res.status !== 200) {
         // ensure that resources are not leaked
         await res.arrayBuffer();
@@ -289,7 +289,7 @@ export async function getPackageDescription(
   pkg: string,
 ): Promise<string | undefined> {
   if (!cachedPackageData.has(pkg)) {
-    const res = await fetch(`${DENO_API}${pkg}`);
+    const res = await pkgFetch(`${DENO_API}${pkg}`);
     let body: ApiModuleData | undefined;
     if (res.status === 200) {
       body = await res.json();
@@ -308,7 +308,7 @@ async function getPackageMeta(
   }
   const versionCache = cachedPackageMeta.get(pkg)!;
   if (!versionCache.get(version)) {
-    const res = await fetch(
+    const res = await pkgFetch(
       `${S3_BUCKET}${pkg}/versions/${version}/meta/meta.json`,
     );
     if (res.status === 200) {
@@ -325,7 +325,7 @@ export async function getPackageVersions(
   pkg: string,
 ): Promise<PackageVersions | undefined> {
   if (!cachedPackageVersions.has(pkg)) {
-    const res = await fetch(`${S3_BUCKET}${pkg}/meta/versions.json`);
+    const res = await pkgFetch(`${S3_BUCKET}${pkg}/meta/versions.json`);
     if (res.status === 200) {
       const packageVersions = await res.json() as PackageVersions;
       cachedPackageVersions.set(pkg, packageVersions);
@@ -431,7 +431,7 @@ async function load(
           cachedSpecifiers.add(specifier);
           return cachedResources.get(specifier);
         }
-        const response = await fetch(String(url), { redirect: "follow" });
+        const response = await pkgFetch(String(url), { redirect: "follow" });
         if (response.status !== 200) {
           // ensure that resources are not leaked
           await response.arrayBuffer();
@@ -551,3 +551,17 @@ function mergeEntries(entries: DocNode[]) {
   }
   return merged;
 }
+
+/** Fetch a URL, adding a user agent header to the request. */
+function pkgFetch(
+  url: string | URL,
+  init: RequestInit = {},
+): Promise<Response> {
+  const DENO_DOC_USER_AGENT = "DenoDoc/1.0.0 (https://doc.deno.land)";
+
+  const hdr = new Headers(init.headers);
+  hdr.set("User-Agent", DENO_DOC_USER_AGENT);
+  init.headers = hdr;
+
+  return fetch(url, init);
+}
diff --git a/middleware/notFound.tsx b/middleware/notFound.tsx
index 8340130..34fbaee 100644
--- a/middleware/notFound.tsx
+++ b/middleware/notFound.tsx
@@ -1,6 +1,6 @@
 // Copyright 2021 the Deno authors. All rights reserved. MIT license.
 /** @jsx h */
-import { getStyleTag, h, Helmet, renderSSR, Status, tw } from "../deps.ts";
+import { getStyleTag, h, Helmet, renderSSR, Status } from "../deps.ts";
 import type { Middleware } from "../deps.ts";
 import { sheet } from "../shared.ts";
 import { getBody } from "../util.ts";
diff --git a/routes/doc.tsx b/routes/doc.tsx
index 8e4b5ec..c86c75f 100644
--- a/routes/doc.tsx
+++ b/routes/doc.tsx
@@ -21,7 +21,6 @@ import {
   getLatest,
   getPackageDescription,
   getStaticIndex,
-  type IndexStructure,
   maybeCacheStatic,
 } from "../docs.ts";
 import { sheet, store } from "../shared.ts";
@@ -46,16 +45,6 @@ function isPackageHost(host: string): boolean {
   return host.toLowerCase() === "deno.land";
 }
 
-/**
- * Return `true` if the index structure has "children" entries that can be
- * displayed as an index, otherwise `false`.
- */
-function hasSubEntries(indexStructure: IndexStructure, path: string): boolean {
-  return [...indexStructure.entries.keys()].some((key) =>
-    key.startsWith(path) && key !== path
-  );
-}
-
 export const packageGetHead: RouterMiddleware<DocRoutes> = (ctx, next) => {
   let { host, item, path } = ctx.params;
   let { search } = ctx.request.url;