refactor: Split context types more thoroughly

Author: Peeja

src/middleware/withAuthorizedSpace.js

@@ -8,7 +8,8 @@ import * as serve from '../capabilities/serve.js'
  * @import { IpfsUrlContext, Middleware } from '@web3-storage/gateway-lib'
  * @import { LocatorContext } from './withLocator.types.js'
  * @import { AuthTokenContext } from './withAuthToken.types.js'
- * @import { SpaceContext, DelegationsStorageContext } from './withAuthorizedSpace.types.js'
+ * @import { SpaceContext, DelegationsStorageContext, DelegationProofsContext } from './withAuthorizedSpace.types.js'
+ * @import { GatewayIdentityContext } from './withGatewayIdentity.types.js'
  */
 
 /**
@@ -20,13 +21,12 @@ import * as serve from '../capabilities/serve.js'
  * @throws {Error} If the locator fails in any other way.
  * @type {(
  *   Middleware<
- *     LocatorContext & IpfsUrlContext & AuthTokenContext & DelegationsStorageContext & SpaceContext,
- *     LocatorContext & IpfsUrlContext & AuthTokenContext & DelegationsStorageContext,
- *     {}
+ *     LocatorContext & IpfsUrlContext & AuthTokenContext & GatewayIdentityContext & DelegationProofsContext & DelegationsStorageContext & SpaceContext,
+ *     LocatorContext & IpfsUrlContext & AuthTokenContext & GatewayIdentityContext & DelegationProofsContext & DelegationsStorageContext
  *   >
  * )}
  */
-export function withAuthorizedSpace(handler) {
+export function withAuthorizedSpace (handler) {
   return async (request, env, ctx) => {
     const { locator, dataCid } = ctx
     const locRes = await locator.locate(dataCid.multihash)
@@ -67,14 +67,23 @@ export function withAuthorizedSpace(handler) {
         ...ctx,
         space: selectedSpace,
         delegationProofs,
-        locator: locator.scopeToSpaces([selectedSpace]),
+        locator: locator.scopeToSpaces([selectedSpace])
       })
     } catch (error) {
       // If all Spaces failed to authorize, throw the first error.
       if (
         error instanceof AggregateError &&
         error.errors.every((e) => e instanceof Unauthorized)
       ) {
+        if (env.DEBUG === 'true') {
+          console.log(
+            [
+              'Authorization Failures:',
+              ...error.errors.map((e) => e.message)
+            ].join('\n\n')
+          )
+        }
+
         throw new HttpError('Not Found', { status: 404, cause: error })
       } else {
         throw error
@@ -89,15 +98,15 @@ export function withAuthorizedSpace(handler) {
  * {@link DelegationsStorageContext.delegationsStorage}.
  *
  * @param {Ucanto.DID} space
- * @param {AuthTokenContext & DelegationsStorageContext} ctx
+ * @param {AuthTokenContext & DelegationsStorageContext & GatewayIdentityContext} ctx
  * @returns {Promise<Ucanto.Result<{space: Ucanto.DID, delegationProofs: Ucanto.Delegation[]}, Ucanto.Failure>>}
  */
 const authorize = async (space, ctx) => {
   // Look up delegations that might authorize us to serve the content.
   const relevantDelegationsResult = await ctx.delegationsStorage.find({
     audience: ctx.gatewayIdentity.did(),
     can: serve.transportHttp.can,
-    with: space,
+    with: space
   })
 
   if (relevantDelegationsResult.error) return relevantDelegationsResult
@@ -109,9 +118,9 @@ const authorize = async (space, ctx) => {
       audience: ctx.gatewayIdentity,
       with: space,
       nb: {
-        token: ctx.authToken,
+        token: ctx.authToken
       },
-      proofs: relevantDelegationsResult.ok,
+      proofs: relevantDelegationsResult.ok
     })
     .delegate()
 
@@ -120,7 +129,7 @@ const authorize = async (space, ctx) => {
     capability: serve.transportHttp,
     authority: ctx.gatewayIdentity,
     principal: Verifier,
-    validateAuthorization: () => ok({}),
+    validateAuthorization: () => ok({})
   })
   if (accessResult.error) {
     return accessResult
@@ -129,7 +138,7 @@ const authorize = async (space, ctx) => {
   return {
     ok: {
       space,
-      delegationProofs: relevantDelegationsResult.ok,
-    },
+      delegationProofs: relevantDelegationsResult.ok
+    }
   }
 }

src/middleware/withAuthorizedSpace.types.ts

@@ -1,11 +1,11 @@
 import * as Ucanto from '@ucanto/interface'
 import { Context as MiddlewareContext } from '@web3-storage/gateway-lib'
-import { GatewayIdentityContext as GatewayIdentityContext } from './withGatewayIdentity.types.js'
 
-export interface DelegationsStorageContext
-  extends MiddlewareContext,
-    GatewayIdentityContext {
+export interface DelegationsStorageContext extends MiddlewareContext {
   delegationsStorage: DelegationsStorage
+}
+
+export interface DelegationProofsContext extends MiddlewareContext {
   /**
    * The delegation proofs to use for the egress record
    * The proofs must be valid for the space and the owner of the space

src/middleware/withDelegationStubs.js

@@ -21,7 +21,7 @@ import { Delegation, Schema } from '@ucanto/core'
  *
  * @type {(
  *   Middleware<
- *     MiddlewareContext & LocatorContext & DelegationsStorageContext,
+ *     MiddlewareContext & LocatorContext & GatewayIdentityContext & DelegationsStorageContext,
  *     MiddlewareContext & LocatorContext & GatewayIdentityContext,
  *     {}
  *   >
@@ -49,10 +49,9 @@ export const withDelegationStubs = (handler) => async (request, env, ctx) => {
   return handler(request, env, {
     ...ctx,
     delegationsStorage: { find: async () => ({ ok: stubDelegations }) },
-    delegationProofs: [], // Delegation proofs are set by withAuthorizedSpace handler
     locator:
       stubSpace && Schema.did({ method: 'key' }).is(stubSpace)
         ? ctx.locator.scopeToSpaces([stubSpace])
-        : ctx.locator,
+        : ctx.locator
   })
 }

src/middleware/withEgressClient.types.ts

@@ -1,7 +1,7 @@
 import { Environment as MiddlewareEnvironment, Context as MiddlewareContext } from '@web3-storage/gateway-lib'
 import { DIDKey, UnknownLink } from '@ucanto/principal/ed25519'
 import { GatewayIdentityContext } from './withGatewayIdentity.types.js'
-import { DelegationsStorageContext } from './withAuthorizedSpace.types.js'
+import { DelegationsStorageContext, DelegationProofsContext } from './withAuthorizedSpace.types.js'
 
 export interface Environment extends MiddlewareEnvironment {
   FF_EGRESS_TRACKER_ENABLED: string
@@ -13,7 +13,8 @@ export interface Environment extends MiddlewareEnvironment {
 export interface EgressClientContext
   extends MiddlewareContext,
     GatewayIdentityContext,
-    DelegationsStorageContext {
+    DelegationsStorageContext,
+    DelegationProofsContext {
   egressClient: EgressClient
 }