@travetto/web-http 7.1.4 → 8.0.0-alpha.1

package/README.md

@@ -16,7 +16,7 @@ yarn add @travetto/web-http
 This module provides basic for running [http](https://nodejs.org/api/http.html). [https](https://nodejs.org/api/https.html)  and [http2](https://nodejs.org/api/http2.html) servers, along with support for tls key generation during development.
 
 ## Running a Server
-By default, the framework provides a default [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L98) for [WebHttpServer](https://github.com/travetto/travetto/tree/main/module/web-http/src/types.ts#L19) that will follow default behaviors, and spin up the server.
+By default, the framework provides a default [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L27) for [WebHttpServer](https://github.com/travetto/travetto/tree/main/module/web-http/src/types.ts#L19) that will follow default behaviors, and spin up the server.
 
 **Terminal: Standard application**
 ```bash
@@ -123,23 +123,24 @@ export class WebHttpConfig {
   @Ignore()
   fetchUrl: string;
 
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     this.tls ??= (this.httpVersion === '2' || !!this.tlsKeys);
     this.port = (this.port < 0 ? await NetUtil.getFreePort() : this.port);
-    this.bindAddress ||= await NetUtil.getLocalAddress();
+    this.bindAddress ||= NetUtil.getLocalAddress();
 
     if (!this.tls) {
       // Clear out keys if tls is not set
       this.tlsKeys = undefined;
     } else if (!this.tlsKeys) {
       if (Runtime.production) {
-        throw new AppError('Default tls keys are only valid for development use, please specify a config value at web.tls.keys');
+        throw new RuntimeError('Default tls keys are only valid for development use, please specify a config value at web.tls.keys');
       }
       this.tlsKeys = await WebTlsUtil.generateKeyPair();
     } else {
       if (this.tlsKeys.key.length < 100) { // We have files or resources
-        this.tlsKeys.key = (await RuntimeResources.read(this.tlsKeys.key, true)).toString('utf8');
-        this.tlsKeys.cert = (await RuntimeResources.read(this.tlsKeys.cert, true)).toString('utf8');
+        this.tlsKeys.key = await RuntimeResources.readText(this.tlsKeys.key);
+        this.tlsKeys.cert = await RuntimeResources.readText(this.tlsKeys.cert);
       }
     }
 
@@ -149,7 +150,7 @@ export class WebHttpConfig {
 ```
 
 ### Creating a Custom CLI Entry Point
-To customize a Web server, you may need to construct an entry point using the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L98) decorator. This could look like:
+To customize a Web server, you may need to construct an entry point using the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/registry/decorator.ts#L27) decorator. This could look like:
 
 **Code: Application entry point for Web Applications**
 ```typescript
@@ -203,7 +204,7 @@ Initialized {
     }
   },
   runtime: {
-    production: true,
+    production: false,
     role: 'std',
     debug: false,
     resourcePaths: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/web-http",
-  "version": "7.1.4",
+  "version": "8.0.0-alpha.1",
   "type": "module",
   "description": "Web HTTP Server Support",
   "keywords": [
@@ -27,11 +27,11 @@
     "directory": "module/web-http"
   },
   "dependencies": {
-    "@travetto/web": "^7.1.4"
+    "@travetto/web": "^8.0.0-alpha.1"
   },
   "peerDependencies": {
-    "@travetto/cli": "^7.1.4",
-    "@travetto/test": "^7.1.4"
+    "@travetto/cli": "^8.0.0-alpha.1",
+    "@travetto/test": "^8.0.0-alpha.1"
   },
   "peerDependenciesMeta": {
     "@travetto/test": {

package/src/config.ts

@@ -1,7 +1,8 @@
 import { Config, EnvVar } from '@travetto/config';
 import { Ignore, Secret } from '@travetto/schema';
-import { AppError, Runtime, RuntimeResources } from '@travetto/runtime';
+import { RuntimeError, Runtime, RuntimeResources } from '@travetto/runtime';
 import { NetUtil } from '@travetto/web';
+import { PostConstruct } from '@travetto/di';
 
 import type { WebSecureKeyPair } from './types.ts';
 import { WebTlsUtil } from './tls.ts';
@@ -45,23 +46,24 @@ export class WebHttpConfig {
   @Ignore()
   fetchUrl: string;
 
-  async postConstruct(): Promise<void> {
+  @PostConstruct()
+  async finalizeConfig(): Promise<void> {
     this.tls ??= (this.httpVersion === '2' || !!this.tlsKeys);
     this.port = (this.port < 0 ? await NetUtil.getFreePort() : this.port);
-    this.bindAddress ||= await NetUtil.getLocalAddress();
+    this.bindAddress ||= NetUtil.getLocalAddress();
 
     if (!this.tls) {
       // Clear out keys if tls is not set
       this.tlsKeys = undefined;
     } else if (!this.tlsKeys) {
       if (Runtime.production) {
-        throw new AppError('Default tls keys are only valid for development use, please specify a config value at web.tls.keys');
+        throw new RuntimeError('Default tls keys are only valid for development use, please specify a config value at web.tls.keys');
       }
       this.tlsKeys = await WebTlsUtil.generateKeyPair();
     } else {
       if (this.tlsKeys.key.length < 100) { // We have files or resources
-        this.tlsKeys.key = (await RuntimeResources.read(this.tlsKeys.key, true)).toString('utf8');
-        this.tlsKeys.cert = (await RuntimeResources.read(this.tlsKeys.cert, true)).toString('utf8');
+        this.tlsKeys.key = await RuntimeResources.readText(this.tlsKeys.key);
+        this.tlsKeys.cert = await RuntimeResources.readText(this.tlsKeys.cert);
       }
     }
 

package/src/http.ts

@@ -2,11 +2,10 @@ import type net from 'node:net';
 import http from 'node:http';
 import http2 from 'node:http2';
 import https from 'node:https';
-import { pipeline } from 'node:stream/promises';
 import { TLSSocket } from 'node:tls';
 
 import { WebBodyUtil, WebCommonUtil, type WebDispatcher, WebRequest, WebResponse } from '@travetto/web';
-import { BinaryUtil, castTo, ShutdownManager } from '@travetto/runtime';
+import { type BinaryType, BinaryUtil, castTo, ShutdownManager } from '@travetto/runtime';
 
 import type { WebSecureKeyPair, WebServerHandle } from './types.ts';
 
@@ -119,7 +118,7 @@ export class WebHttpUtil {
         httpQuery: Object.fromEntries(new URLSearchParams(query)),
       },
       headers: request.headers,
-      body: WebBodyUtil.markRaw(request)
+      body: WebBodyUtil.markRawBinary(request)
     });
   }
 
@@ -127,18 +126,14 @@ export class WebHttpUtil {
    * Send WebResponse to outbound http response
    */
   static async respondToServerResponse(webResponse: WebResponse, response: HttpResponse): Promise<void> {
-    const binaryResponse = new WebResponse({ context: webResponse.context, ...WebBodyUtil.toBinaryMessage(webResponse) });
+    const binaryResponse = new WebResponse<BinaryType>({ context: webResponse.context, ...WebBodyUtil.toBinaryMessage(webResponse) });
     binaryResponse.headers.forEach((value, key) => response.setHeader(key, value));
     response.statusCode = WebCommonUtil.getStatusCode(binaryResponse);
-    const body = binaryResponse.body;
 
-    if (BinaryUtil.isReadable(body)) {
-      await pipeline(body, response);
-    } else {
-      if (body) {
-        // Weird type union that http2 uses
-        'stream' in response ? response.write(body) : response.write(body);
-      }
+    if (binaryResponse.body) {
+      await BinaryUtil.pipeline(binaryResponse.body, response);
+    }
+    if (!response.closed) {
       response.end();
     }
   }

package/support/cli.web_http.ts

@@ -1,6 +1,6 @@
 import { Runtime, toConcrete } from '@travetto/runtime';
 import { DependencyRegistryIndex } from '@travetto/di';
-import { CliCommand, type CliCommandShape } from '@travetto/cli';
+import { CliCommand, CliDebugIpcFlag, CliModuleFlag, CliProfilesFlag, CliRestartOnChangeFlag, type CliCommandShape } from '@travetto/cli';
 import { NetUtil } from '@travetto/web';
 import { Registry } from '@travetto/registry';
 
@@ -9,7 +9,7 @@ import type { WebHttpServer } from '../src/types.ts';
 /**
  * Run a web server
  */
-@CliCommand({ runTarget: true, with: { debugIpc: 'optional', restartOnChange: true, module: true, profiles: true } })
+@CliCommand()
 export class WebHttpCommand implements CliCommandShape {
 
   /** Port to run on */
@@ -18,7 +18,19 @@ export class WebHttpCommand implements CliCommandShape {
   /** Kill conflicting port owner */
   killConflict?: boolean = Runtime.localDevelopment;
 
-  preMain(): void {
+  @CliModuleFlag({ short: 'm' })
+  module: string;
+
+  @CliProfilesFlag()
+  profile: string[];
+
+  @CliRestartOnChangeFlag()
+  restartOnChange: boolean = true;
+
+  @CliDebugIpcFlag()
+  debugIpc?: boolean;
+
+  finalize(): void {
     if (this.port) {
       process.env.WEB_HTTP_PORT = `${this.port}`;
     }

package/support/test/dispatcher.ts

@@ -1,16 +1,11 @@
-import type { Readable } from 'node:stream';
-import { buffer } from 'node:stream/consumers';
-
 import { Inject, Injectable } from '@travetto/di';
 import { type WebFilterContext, WebResponse, type WebDispatcher, WebBodyUtil } from '@travetto/web';
-import { castTo } from '@travetto/runtime';
+import { BinaryUtil, castTo } from '@travetto/runtime';
 
 import { WebTestDispatchUtil } from '@travetto/web/support/test/dispatch-util.ts';
 
 import type { WebHttpConfig } from '../../src/config.ts';
 
-const toBuffer = (src: Buffer | Readable) => Buffer.isBuffer(src) ? src : buffer(src);
-
 /**
  * Support for invoking http requests against the server
  */
@@ -23,7 +18,9 @@ export class FetchWebDispatcher implements WebDispatcher {
   async dispatch({ request }: WebFilterContext): Promise<WebResponse> {
     const baseRequest = await WebTestDispatchUtil.applyRequestBody(request);
     const finalPath = WebTestDispatchUtil.buildPath(baseRequest);
-    const body: RequestInit['body'] = WebBodyUtil.isRaw(request.body) ? await toBuffer(request.body) : castTo(request.body);
+    const body: RequestInit['body'] = WebBodyUtil.isRawBinary(request.body) ?
+      await BinaryUtil.toBinaryArray(request.body) :
+      castTo(request.body);
     const { context: { httpMethod: method }, headers } = request;
 
     const response = await fetch(
@@ -33,7 +30,7 @@ export class FetchWebDispatcher implements WebDispatcher {
 
     return await WebTestDispatchUtil.finalizeResponseBody(
       new WebResponse({
-        body: Buffer.from(await response.arrayBuffer()),
+        body: await response.arrayBuffer(),
         context: { httpStatusCode: response.status },
         headers: response.headers
       })