feat: Move JSON conversion away from route handlers

Author: joachimvh

packages/uma/.componentsignore

@@ -3,6 +3,7 @@
   "AccessToken",
   "Authorization",
   "Authorizer",
+  "Buffer",
   "Error",
   "EventEmitter",
   "Map",
@@ -13,5 +14,6 @@
   "ReType",
   "ScopeDescription",
   "Ticket",
-  "URL"
+  "URL",
+  "WeakMap"
 ]

packages/uma/bin/demo.ts

@@ -38,7 +38,7 @@ export const launch: () => Promise<void> = async () => {
   await manager.configRegistry.register(configPath);
 
   const umaServer: ServerInitializer = await manager.instantiate('urn:uma:default:NodeHttpServer',{variables});
-  await umaServer.handle();
+  await umaServer.handleSafe();
 
 };
 

packages/uma/bin/main.ts

@@ -38,7 +38,7 @@ export const launch: () => Promise<void> = async () => {
   await manager.configRegistry.register(configPath);
 
   const umaServer: ServerInitializer = await manager.instantiate('urn:uma:default:NodeHttpServer',{variables});
-  await umaServer.handle();
+  await umaServer.handleSafe();
 
 };
 

packages/uma/config/default.json

@@ -82,19 +82,23 @@
         "includeQueryString": true
       },
       "httpHandler": {
-        "@id": "urn:uma:default:RoutedHttpRequestHandler",
-        "@type": "RoutedHttpRequestHandler",
-        "routes": [
-          { "@id": "urn:uma:default:UmaConfigRoute" },
-          { "@id": "urn:uma:default:JwksRoute" },
-          { "@id": "urn:uma:default:TokenRoute" },
-          { "@id": "urn:uma:default:PermissionRegistrationRoute" },
-          { "@id": "urn:uma:default:ResourceRegistrationRoute" },
-          { "@id": "urn:uma:default:ResourceRegistrationOpsRoute" },
-          { "@id": "urn:uma:default:IntrospectionRoute" }
-        ],
-        "defaultHandler": {
-          "@type": "DefaultRequestHandler"
+        "@id": "urm:uma:default:JsonFormHttpHandler",
+        "@type": "JsonFormHttpHandler",
+        "handler": {
+          "@id": "urn:uma:default:RoutedHttpRequestHandler",
+          "@type": "RoutedHttpRequestHandler",
+          "routes": [
+            { "@id": "urn:uma:default:UmaConfigRoute" },
+            { "@id": "urn:uma:default:JwksRoute" },
+            { "@id": "urn:uma:default:TokenRoute" },
+            { "@id": "urn:uma:default:PermissionRegistrationRoute" },
+            { "@id": "urn:uma:default:ResourceRegistrationRoute" },
+            { "@id": "urn:uma:default:ResourceRegistrationOpsRoute" },
+            { "@id": "urn:uma:default:IntrospectionRoute" }
+          ],
+          "defaultHandler": {
+            "@type": "DefaultRequestHandler"
+          }
         }
       }
     },

packages/uma/src/index.ts

@@ -50,12 +50,17 @@ export * from './views/Permission';
 export * from './views/ResourceDescription';
 export * from './views/ScopeDescription';
 
-/* Replace the following with CSS types */
-
 // HTTP
 export * from './util/http/identifier/BaseTargetExtractor';
 export * from './util/http/models/HttpHandler';
 export * from './util/http/models/HttpHandlerRoute';
 export * from './util/http/server/ErrorHandler';
+export * from './util/http/server/JsonFormHttpHandler';
 export * from './util/http/server/NodeHttpRequestResponseHandler';
 export * from './util/http/server/RoutedHttpRequestHandler';
+
+// Util
+export * from './util/ConvertUtil';
+export * from './util/HttpMessageSignatures';
+export * from './util/Result';
+export * from './util/ReType';

packages/uma/src/routes/Config.ts

@@ -8,17 +8,17 @@ export enum ResponseType {
   Token = 'token',
   Code = 'code',
   IDToken = 'id_token'
-};
+}
 // eslint-enable
 
 export type OAuthConfiguration = {
-    issuer: string,
-    jwks_uri?: string,
-    token_endpoint?: string,
-    grant_types_supported?: string[],
-    dpop_signing_alg_values_supported?: string[],
-    response_types_supported?: ResponseType[]
-    scopes_supported?: string[]
+  issuer: string,
+  jwks_uri?: string,
+  token_endpoint?: string,
+  grant_types_supported?: string[],
+  dpop_signing_alg_values_supported?: string[],
+  response_types_supported?: ResponseType[]
+  scopes_supported?: string[]
 }
 
 export type UmaConfiguration = OAuthConfiguration & {
@@ -44,18 +44,11 @@ export class ConfigRequestHandler extends HttpHandler {
     super();
   }
 
-  /**
-   * Returns the endpoint's UMA configuration
-   *
-   * @param {HttpHandlerContext} context - an irrelevant incoming context
-   * @return {Observable<HttpHandlerResponse>} - the mock response
-   */
-  async handle(context: HttpHandlerContext): Promise<HttpHandlerResponse> {
+  public async handle(context: HttpHandlerContext): Promise<HttpHandlerResponse> {
     this.logger.info(`Received discovery request at '${context.request.url}'`);
 
     return {
-      body: JSON.stringify(this.getConfig()),
-      headers: {'content-type': 'application/json'},
+      body: this.getConfig(),
       status: 200,
     };
   }

packages/uma/src/routes/Default.ts

@@ -1,21 +1,15 @@
 import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 
 /**
- * Default route handler
+ * Default route handler that returns a 404.
  */
 export class DefaultRequestHandler extends HttpHandler {
-  /**
-     * Default request handler returning a 404 error
-     * @param {HttpHandlerContext} input
-     * @return {Observable<HttpHandlerResponse<any>>}
-     */
   async handle(input: HttpHandlerContext): Promise<HttpHandlerResponse<any>> {
     return {
-      body: JSON.stringify({
+      body: {
         'status': 404,
         'error': 'Not Found',
-      }),
-      headers: {'content-type': 'application/json'},
+      },
       status: 404,
     };
   }

packages/uma/src/routes/Introspection.ts

@@ -1,15 +1,8 @@
-
-import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
+import { BadRequestHttpError, getLoggerFor, KeyValueStorage, UnauthorizedHttpError } from '@solid/community-server';
 import { AccessToken } from '../tokens/AccessToken';
 import { JwtTokenFactory } from '../tokens/JwtTokenFactory';
 import { SerializedToken } from '../tokens/TokenFactory';
-import {
-  BadRequestHttpError,
-  getLoggerFor,
-  JwkGenerator, KeyValueStorage,
-  UnauthorizedHttpError,
-  UnsupportedMediaTypeHttpError
-} from '@solid/community-server';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 import { verifyRequest } from '../util/HttpMessageSignatures';
 
 /**
@@ -27,29 +20,13 @@ export class IntrospectionHandler extends HttpHandler {
   constructor(
     private readonly tokenStore: KeyValueStorage<string, AccessToken>,
     private readonly jwtTokenFactory: JwtTokenFactory,
-    private readonly keyGen: JwkGenerator,
   ) {
     super();
   }
 
-  /**
-  * Handle incoming requests for token introspection
-  * @param {HttpHandlerContext} param0
-  * @return {Observable<HttpHandlerResponse<any>>}
-  */
   async handle({request}: HttpHandlerContext): Promise<HttpHandlerResponse<any>> {
     if (!await verifyRequest(request)) throw new UnauthorizedHttpError();
 
-    if (request.headers['content-type'] !== 'application/x-www-form-urlencoded') {
-      throw new UnsupportedMediaTypeHttpError(
-          'Only Media Type "application/x-www-form-urlencoded" is supported for this route.');
-    }
-
-    if (request.headers['accept'] !== 'application/json') {
-      throw new UnsupportedMediaTypeHttpError(
-          'Only "application/json" can be served by this route.');
-    }
-
     if (!request.body || !(request.body instanceof Object)) {
       throw new BadRequestHttpError('Missing request body.');
     }
@@ -60,14 +37,12 @@ export class IntrospectionHandler extends HttpHandler {
 
       const jwt = this.opaqueToJwt(opaqueToken);
       return {
-        headers: {'content-type': 'application/json'},
         status: 200,
         body: jwt,
       };
     } catch (e) {
       throw new BadRequestHttpError('Invalid request body.');
     }
-
   }
 
   private async opaqueToJwt(opaque: string): Promise<SerializedToken> {

packages/uma/src/routes/Jwks.ts

@@ -1,5 +1,5 @@
-import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 import { getLoggerFor, JwkGenerator } from '@solid/community-server';
+import { HttpHandler, HttpHandlerContext, HttpHandlerResponse } from '../util/http/models/HttpHandler';
 
 /**
  * An HttpHandler used for returning the configuration
@@ -8,32 +8,20 @@ import { getLoggerFor, JwkGenerator } from '@solid/community-server';
 export class JwksRequestHandler extends HttpHandler {
   protected readonly logger = getLoggerFor(this);
 
-  /**
-   * Yields a new request handler for JWKS
-   * @param {JwksKeyHolder} keyholder - the keyholder to be used for serving JWKS
-   */
   public constructor(
     private readonly generator: JwkGenerator
   ) {
     super();
   }
 
-  /**
-     * Returns the JSON Web KeySet for specified keyholder
-     * @param {HttpHandlerContext} context - an irrelevant incoming context
-     * @return {Observable<HttpHandlerResponse>} - the JWKS response
-     */
   async handle(context: HttpHandlerContext): Promise<HttpHandlerResponse> {
     this.logger.info(`Received JWKS request at '${context.request.url}'`);
 
     const key = await this.generator.getPublicKey();
 
     return {
       status: 200,
-      headers: {
-        'content-type': 'application/json'
-      },
-      body: JSON.stringify({ keys: [ key ] }),
+      body: { keys: [ key ] },
     };
   }
 }

packages/uma/src/routes/ResourceRegistration.ts

@@ -4,8 +4,7 @@ import {
   getLoggerFor,
   KeyValueStorage,
   MethodNotAllowedHttpError,
-  UnauthorizedHttpError,
-  UnsupportedMediaTypeHttpError
+  UnauthorizedHttpError
 } from '@solid/community-server';
 import { randomUUID } from 'node:crypto';
 import {
@@ -14,9 +13,9 @@ import {
   HttpHandlerRequest,
   HttpHandlerResponse
 } from '../util/http/models/HttpHandler';
-import { ResourceDescription } from '../views/ResourceDescription';
-import { reType } from '../util/ReType';
 import { extractRequestSigner, verifyRequest } from '../util/HttpMessageSignatures';
+import { reType } from '../util/ReType';
+import { ResourceDescription } from '../views/ResourceDescription';
 
 type ErrorConstructor = { new(msg: string): Error };
 
@@ -29,20 +28,12 @@ type ErrorConstructor = { new(msg: string): Error };
 export class ResourceRegistrationRequestHandler extends HttpHandler {
   protected readonly logger = getLoggerFor(this);
 
-  /**
-   * @param {RequestingPartyRegistration[]} resourceServers - Pod Servers to be registered with the UMA AS
-   */
   constructor(
     private readonly resourceStore: KeyValueStorage<string, ResourceDescription>,
   ) {
     super();
   }
 
-  /**
-  * Handle incoming requests for resource registration
-  * @param {HttpHandlerContext} param0
-  * @return {Observable<HttpHandlerResponse<PermissionRegistrationResponse>>}
-  */
   async handle({ request }: HttpHandlerContext): Promise<HttpHandlerResponse<any>> {
     const signer = await extractRequestSigner(request);
 
@@ -62,10 +53,6 @@ export class ResourceRegistrationRequestHandler extends HttpHandler {
   private async handlePost(request: HttpHandlerRequest): Promise<HttpHandlerResponse<any>> {
     const { headers, body } = request;
 
-    if (headers['content-type'] !== 'application/json') {
-      throw new UnsupportedMediaTypeHttpError('Only Media Type "application/json" is supported for this route.');
-    }
-
     try {
       reType(body, ResourceDescription);
     } catch (e) {
@@ -80,13 +67,10 @@ export class ResourceRegistrationRequestHandler extends HttpHandler {
 
     return ({
       status: 201,
-      headers: {
-        'content-type': 'application/json'
-      },
-      body: JSON.stringify({
+      body: {
         _id: resource,
         user_access_policy_uri: 'TODO: implement policy UI',
-      }),
+      },
     })
   }
 
@@ -99,10 +83,7 @@ export class ResourceRegistrationRequestHandler extends HttpHandler {
 
     this.logger.info(`Deleted resource ${parameters.id}.`);
 
-    return ({
-      status: 204,
-      headers: {},
-    });
+    return { status: 204 };
   }
 
   /**