feat: add configurable redirect

packages/edge-gateway/README.md

@@ -16,6 +16,7 @@
     wrangler secret put LOKI_URL --env $(whoami) # Get from Loki
     wrangler secret put LOKI_TOKEN --env $(whoami) # Get from Loki
     wrangler secret put CDN_GATEWAYS_RACE --env $(whoami) # JSON String with array of CDN Gateways URLs (eg. echo -e '["https://freeway.dag.haus"]' | wrangler secret ...)
+    wrangler secret put IPFS_GATEWAY_REDIRECT_HOSTNAME --env $(whoami) # string with domain to redirect if not possible to resolve within CDN (eg. echo -e 'dweb.link' | wrangler secret ...)
     wrangler secret put IPFS_GATEWAYS_RACE_L1 --env $(whoami) # JSON String with array of IPFS Gateways URLs (eg. echo -e '["https://ipfs.io","https://dagula.dag.haus"]' | wrangler secret ...)
     wrangler secret put IPFS_GATEWAYS_RACE_L2 --env $(whoami) # JSON String with array of IPFS Gateways URLs (eg. echo -e '["https://cf.dag.haus","https://w3link.mypinata.cloud"]' | wrangler secret ...)
     wrangler secret put CID_VERIFIER_AUTHORIZATION_TOKEN --env $(whoami) # Get from 1Password

packages/edge-gateway/src/bindings.d.ts

@@ -24,6 +24,7 @@ export interface EnvInput {
   CDN_GATEWAYS_RACE: string
   DENYLIST: Fetcher
   DENYLIST_URL: string
+  IPFS_GATEWAY_REDIRECT_HOSTNAME?: string
   IPFS_GATEWAYS_RACE_L1: string
   IPFS_GATEWAYS_RACE_L2: string
   GATEWAY_HOSTNAME: string
@@ -48,6 +49,7 @@ export interface EnvTransformed {
   IPFS_GATEWAY_HOSTNAME: string
   IPNS_GATEWAY_HOSTNAME: string
   cdnGateways: Array<string>
+  ipfsGatewayRedirectHostname?: string
   ipfsGatewaysL1: Array<string>
   ipfsGatewaysL2: Array<string>
   sentry?: Toucan

packages/edge-gateway/src/env.js

@@ -37,6 +37,9 @@ export function envAll (request, env, ctx) {
   // Set CDN Gateways
   env.cdnGateways = parseGatewayUrls(env.CDN_GATEWAYS_RACE, DEFAULT_CDN_GATEWAYS, env)
 
+  // Set public IPFS gateway redirect URL if configured
+  env.ipfsGatewayRedirectHostname = env.IPFS_GATEWAY_REDIRECT_HOSTNAME
+
   // Set Layer 1 racer
   env.ipfsGatewaysL1 = parseGatewayUrls(env.IPFS_GATEWAYS_RACE_L1, DEFAULT_RACE_L1_GATEWAYS, env)
   env.gwRacerL1 = createGatewayRacer(env.ipfsGatewaysL1, {

packages/edge-gateway/src/gateway.js

@@ -115,7 +115,16 @@ export async function gatewayGet (request, env, ctx) {
     )
   }
 
-  // 3rd layer resolution - Public Gateways race
+  // 3rd layer resolution - Redirect to Public Gateway if set
+  if (env.ipfsGatewayRedirectHostname) {
+    const url = new URL(
+      `https://${cid}.ipfs.${env.ipfsGatewayRedirectHostname}${pathname}${search}`
+    )
+
+    return Response.redirect(url.toString(), 303)
+  }
+
+  // 4th layer resolution - Public Gateways race
   const {
     response: winnerGwResponse,
     url: winnerUrl,

packages/edge-gateway/src/version.js

@@ -12,6 +12,7 @@ export async function versionGet (request, env) {
     commit: env.COMMITHASH,
     branch: env.BRANCH,
     raceGatewaysL1: env.ipfsGatewaysL1,
-    raceGatewaysL2: env.ipfsGatewaysL2
+    raceGatewaysL2: env.ipfsGatewaysL2,
+    ipfsGatewayRedirectHostname: env.ipfsGatewayRedirectHostname
   })
 }

packages/edge-gateway/test/mocks/package.json

@@ -2,4 +2,4 @@
   "name": "mocks",
   "version": "1.0.0",
   "description": "just here to fix cjs loading"
-}
+}

packages/edge-gateway/test/redirect.spec.js

@@ -0,0 +1,83 @@
+import { test, getMiniflare } from './utils/setup.js'
+
+const IPFS_GATEWAY_REDIRECT_HOSTNAME = 'dweb.link'
+
+// Create a new Miniflare environment for each test
+test.before((t) => {
+  t.context = {
+    mf: getMiniflare({
+      IPFS_GATEWAY_REDIRECT_HOSTNAME
+    })
+  }
+})
+
+test('Redirects if redirect hostname set', async (t) => {
+  const { mf } = t.context
+  const url = 'https://bafkreihl44bu5rqxctfvl3ahcln7gnjgmjqi7v5wfwojqwriqnq7wo4n7u.ipfs.localhost:8787/'
+  const response = await mf.dispatchFetch(url)
+
+  t.is(response.status, 303)
+  t.is(
+    response.headers.get('location'),
+    url.replace('localhost:8787', IPFS_GATEWAY_REDIRECT_HOSTNAME)
+  )
+})
+
+test('Redirects if redirect hostname set with pathname', async (t) => {
+  const { mf } = t.context
+  const url = 'https://bafkreihl44bu5rqxctfvl3ahcln7gnjgmjqi7v5wfwojqwriqnq7wo4n7u.ipfs.localhost:8787/file.txt'
+  const response = await mf.dispatchFetch(url)
+
+  t.is(response.status, 303)
+  t.is(
+    response.headers.get('location'),
+    url.replace('localhost:8787', IPFS_GATEWAY_REDIRECT_HOSTNAME)
+  )
+})
+
+test('Redirects if redirect hostname set with query', async (t) => {
+  const { mf } = t.context
+  const url = 'https://bafkreihl44bu5rqxctfvl3ahcln7gnjgmjqi7v5wfwojqwriqnq7wo4n7u.ipfs.localhost:8787/?format=car'
+  const response = await mf.dispatchFetch(url)
+
+  t.is(response.status, 303)
+  t.is(
+    response.headers.get('location'),
+    url.replace('localhost:8787', IPFS_GATEWAY_REDIRECT_HOSTNAME)
+  )
+})
+
+test('Redirects if redirect hostname set with pathname and query', async (t) => {
+  const { mf } = t.context
+  const url = 'https://bafkreihl44bu5rqxctfvl3ahcln7gnjgmjqi7v5wfwojqwriqnq7wo4n7u.ipfs.localhost:8787/file.txt?format=car'
+  const response = await mf.dispatchFetch(url)
+
+  t.is(response.status, 303)
+  t.is(
+    response.headers.get('location'),
+    url.replace('localhost:8787', IPFS_GATEWAY_REDIRECT_HOSTNAME)
+  )
+})
+
+test('should get from cdn gateways race if they can resolve before redirecting', async (t) => {
+  const url =
+    'https://bafkreihl44bu5rqxctfvl3ahcln7gnjgmjqi7v5wfwojqwriqnq7wo4n7u.ipfs.localhost:8787'
+
+  const mf = getMiniflare({
+    CDN_GATEWAYS_RACE: '["http://localhost:9082"]',
+    IPFS_GATEWAY_REDIRECT_HOSTNAME
+  })
+
+  const response = await mf.dispatchFetch(
+    url
+  )
+  await response.waitUntil()
+  t.is(await response.text(), 'Hello dot.storage! 😎')
+
+  // Validate content headers
+  t.is(response.headers.get('content-length'), '23')
+
+  // Validate x-dotstorage headers
+  t.is(response.headers.get('x-dotstorage-resolution-layer'), 'dotstorage-race')
+  t.is(response.headers.get('x-dotstorage-resolution-id'), 'http://localhost:9082')
+})