@travetto/web-rpc 6.0.0-rc.3 → 6.0.0-rc.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/web-rpc",
-  "version": "6.0.0-rc.3",
+  "version": "6.0.0-rc.5",
   "description": "RPC support for a Web Application",
   "keywords": [
     "web",
@@ -28,7 +28,7 @@
   "dependencies": {
     "@travetto/config": "^6.0.0-rc.2",
     "@travetto/schema": "^6.0.0-rc.2",
-    "@travetto/web": "^6.0.0-rc.3"
+    "@travetto/web": "^6.0.0-rc.4"
   },
   "travetto": {
     "displayName": "Web RPC Support"

package/src/controller.ts

@@ -3,13 +3,18 @@ import { Any, AppError, Util } from '@travetto/runtime';
 import {
   HeaderParam, Controller, Undocumented, ExcludeInterceptors, ControllerRegistry,
   WebAsyncContext, Body, EndpointUtil, BodyParseInterceptor, Post, WebCommonUtil,
-  RespondInterceptor
+  RespondInterceptor, DecompressInterceptor
 } from '@travetto/web';
 
 @Controller('/rpc')
-@ExcludeInterceptors(val => !(val instanceof BodyParseInterceptor || val instanceof RespondInterceptor || val.category === 'global'))
+@ExcludeInterceptors(val => !(
+  val instanceof DecompressInterceptor ||
+  val instanceof BodyParseInterceptor ||
+  val instanceof RespondInterceptor ||
+  val.category === 'global'
+))
 @Undocumented()
-export class WebRpController {
+export class WebRpcController {
 
   @Inject()
   ctx: WebAsyncContext;
@@ -21,12 +26,10 @@ export class WebRpController {
   async onRequest(target: string, @HeaderParam('X-TRV-RPC-INPUTS') paramInput?: string, @Body() body?: Any): Promise<unknown> {
     const endpoint = ControllerRegistry.getEndpointById(target);
 
-    if (!endpoint) {
+    if (!endpoint || !endpoint.filter) {
       throw new AppError('Unknown endpoint', { category: 'notfound' });
     }
 
-    const bodyParamIdx = endpoint.params.findIndex((x) => x.location === 'body');
-
     const { request } = this.ctx;
 
     let params: unknown[];
@@ -36,6 +39,8 @@ export class WebRpController {
       params = Util.decodeSafeJSON(paramInput)!;
     } else if (Array.isArray(body)) { // Params passed via body
       params = body;
+
+      const bodyParamIdx = endpoint.params.findIndex((x) => x.location === 'body');
       if (bodyParamIdx >= 0) { // Re-assign body
         request.body = params[bodyParamIdx];
       }
@@ -49,6 +54,6 @@ export class WebRpController {
     WebCommonUtil.setRequestParams(request, final);
 
     // Dispatch
-    return await endpoint.filter!({ request: this.ctx.request });
+    return endpoint.filter({ request });
   }
 }

package/src/service.ts

@@ -30,6 +30,7 @@ export class WebRpcClientGeneratorService {
         const entry = RuntimeIndex.getEntry(Runtime.getSourceFile(x));
         return entry && entry.role === 'std';
       })
+      .filter(x => ControllerRegistry.get(x).documented !== false)
       .map(x => {
         const imp = ManifestModuleUtil.withOutputExtension(Runtime.getImport(x));
         const base = Runtime.workspaceRelative(RuntimeIndex.manifest.build.typesFolder);
@@ -49,7 +50,7 @@ export class WebRpcClientGeneratorService {
     const clientOutputFile = path.resolve(config.output, path.basename(clientSourceFile));
     const clientSourceContents = await fs.readFile(clientSourceFile, 'utf8');
 
-    const flavorSourceFile = RuntimeIndex.getFromImport(`@travetto/web-rpc/support/client/rpc-${config.type}.ts`)!.sourceFile;
+    const flavorSourceFile = RuntimeIndex.getFromImport(`@travetto/web-rpc/support/client/rpc-${config.type}.ts`)?.sourceFile ?? '<unknown>';
     const flavorOutputFile = path.resolve(config.output, path.basename(flavorSourceFile));
     const flavorSourceContents = (await fs.readFile(flavorSourceFile, 'utf8').catch(() => ''))
       .replaceAll(/^\s*\/\/\s*@ts-ignore[^\n]*\n/gsm, '')
@@ -57,7 +58,7 @@ export class WebRpcClientGeneratorService {
 
     const factoryOutputFile = path.resolve(config.output, 'factory.ts');
     const factorySourceContents = [
-      `import { ${clientFactory.name} } from './rpc.ts';`,
+      `import { ${clientFactory.name} } from './rpc';`,
       ...classes.map((n) => `import type { ${n.name} } from '${n.import}';`),
       '',
       `export const factory = ${clientFactory.name}<{`,

package/support/client/rpc.ts

@@ -11,6 +11,12 @@ const isBlobMap = (x: any): x is Record<string, Blob> => x && typeof x === 'obje
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const isBlobLike = (x: any): x is Record<string, Blob> | Blob => x instanceof Blob || isBlobMap(x);
 
+const extendHeaders = (base: RequestInit['headers'], toAdd: Record<string, string>): Headers => {
+  const headers = new Headers(base);
+  for (const [k, v] of Object.entries(toAdd)) { headers.set(k, v); }
+  return headers;
+};
+
 export type PreRequestHandler = (item: RequestInit) => Promise<RequestInit | undefined | void>;
 export type PostResponseHandler = (item: Response) => Promise<Response | undefined | void>;
 
@@ -66,11 +72,7 @@ function buildRequest<T extends RequestInit>(base: T, controller: string, endpoi
   return {
     ...base,
     method: 'POST',
-    path: `${controller}:${endpoint}`,
-    headers: {
-      ...base.headers,
-      'Content-Type': 'application/json',
-    }
+    path: `${controller}:${endpoint}`
   };
 }
 
@@ -147,10 +149,7 @@ export async function invokeFetch<T>(request: RpcRequest, ...params: unknown[]):
   try {
     const { body, headers } = getBody(params);
     core.body = body;
-    core.headers = {
-      ...core.headers ?? {},
-      ...headers
-    };
+    core.headers = extendHeaders(core.headers, headers);
 
     for (const fn of request.preRequestHandlers ?? []) {
       const computed = await fn(core);
@@ -175,13 +174,14 @@ export async function invokeFetch<T>(request: RpcRequest, ...params: unknown[]):
       core.signal = AbortSignal.any(signals);
     }
 
+    const url = typeof request.url === 'string' ? new URL(request.url) : request.url;
+    if (request.core?.path) {
+      url.pathname = `${url.pathname}/${request.core.path}`.replaceAll('//', '/');
+    }
+
     let resolved: Response | undefined;
     for (let i = 0; i <= (core.retriesOnConnectFailure ?? 0); i += 1) {
       try {
-        const url = typeof request.url === 'string' ? new URL(request.url) : request.url;
-        if (request.core?.path) {
-          url.pathname = `${url.pathname}/${request.core.path}`.replaceAll('//', '/');
-        }
         resolved = await fetch(url, core);
         break;
       } catch (err) {