@dooboostore/simple-boot-http-server 1.0.15 → 1.0.17

package/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2016-21 these people
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.MD

@@ -1,7 +1,8 @@
-# SIMPLE-BOOT-HTTP-SERVER
+SIMPLE-BOOT-HTTP-SERVER
+===
 
 ### A lightweight and powerful HTTP web server framework for Node.js.
-![typescript](https://img.shields.io/badge/-typescript-black?logo=typescript) [![typescript](https://img.shields.io/badge/-npm-black?logo=npm)](https://www.npmjs.com/package/simple-boot-http-server) [![license](https://img.shields.io/badge/license-MIT-green)](LICENSE.md)
+![typescript](https://img.shields.io/badge/-typescript-black?logo=typescript) [![typescript](https://img.shields.io/badge/-npm-black?logo=npm)](https://www.npmjs.com/package/@dooboostore/simple-boot-http-server) [![license](https://img.shields.io/badge/license-MIT-green)](LICENSE.md)
 
 - **Declarative Routing**: Use decorators (`@Router`, `@Route`) to map URLs to classes and methods.
 - **HTTP Method Mapping**: Decorators for all standard HTTP methods (`@GET`, `@POST`, `@PUT`, `@DELETE`, etc.).
@@ -18,52 +19,10 @@
 
 ## 🚀 Quick Start
 
-```shell
-npm init -y
-npm install @dooboostore/simple-boot @dooboostore/simple-boot-http-server reflect-metadata
-tsc --init --experimentalDecorators --emitDecoratorMetadata
 ```
-
-```typescript
-// index.ts
-import 'reflect-metadata';
-import { SimpleBootHttpServer, HttpServerOption, RequestResponse, GET, Mimes } from '@dooboostore/simple-boot-http-server';
-import { Sim, Router, Route, RouterModule } from '@dooboostore/simple-boot';
-import { ReqHeader } from '@dooboostore/simple-boot-http-server/models/datas/ReqHeader';
-
-@Sim
-@Router({ path: '' })
-export class AppRouter {
-    @Route({ path: '/' })
-    @GET({ res: { contentType: Mimes.ApplicationJson } })
-    index(rr: RequestResponse, header: ReqHeader, routerModule: RouterModule) {
-        console.log('Request from:', header['user-agent']);
-        return { message: 'Welcome to Simple Boot HTTP Server!' };
-    }
-}
-
-const httpServerOption = new HttpServerOption({
-    listen: {
-        port: 3000,
-        listeningListener: (server, httpServer) => {
-            const address = httpServer.address();
-            console.log(`Server is running on http://localhost:${address.port}`);
-        }
-    }
-});
-
-const app = new SimpleBootHttpServer(httpServerOption);
-app.run();
-```
-
-```shell
-# Run the server
-npx ts-node index.ts
-# Server is running on http://localhost:3000
-
-# In another terminal
-curl http://localhost:3000
-# {"message":"Welcome to Simple Boot HTTP Server!"}
+npm init @dooboostore/simple-boot-http-server projectname
+cd projectname
+npm start
 ```
 
 # 😃 Examples
@@ -198,23 +157,57 @@ const option = new HttpServerOption({
 
 Define global exception handlers in an `Advice` class. This class is managed by `@Sim` and can catch errors thrown from anywhere in the application.
 
+### Preventing `ERR_HTTP_HEADERS_SENT`
+
+A common issue in asynchronous frameworks is the `ERR_HTTP_HEADERS_SENT` error. This occurs when an error is thrown *after* a response has already been sent by another part of the application (like a filter). The global exception handler then tries to send a *second* response, causing a crash.
+
+To prevent this, **always check if a response has already been sent** before sending a new one from your exception handler. The `RequestResponse` object provides the `resIsDone()` method for this purpose.
+
 ```typescript
-import { Sim, ExceptionHandler } from '@dooboostore/simple-boot';
-import { RequestResponse, NotFoundError } from '@dooboostore/simple-boot-http-server';
+import { Sim, ExceptionHandler, Inject, ExceptionHandlerSituationType } from '@dooboostore/simple-boot';
+import { RequestResponse, NotFoundError, HttpError, InternalServerError, Mimes, HttpStatus } from '@dooboostore/simple-boot-http-server';
 
 @Sim
 export class GlobalErrorHandler {
+
     @ExceptionHandler({ type: NotFoundError })
     handleNotFound(rr: RequestResponse, e: NotFoundError) {
+        // Critical check
+        if (rr.resIsDone()) {
+            console.error(`Not found error for URL: ${rr.reqUrl}, but response already sent.`, e);
+            return;
+        }
         rr.resStatusCode(404).resSetHeader('X-Error-Message', 'Resource not found');
         console.error(`Not found error for URL: ${rr.reqUrl}`, e);
+        rr.resEnd(JSON.stringify({ error: 'Resource not found' }));
     }
 
     @ExceptionHandler()
-    handleAll(rr: RequestResponse, e: any) {
-        console.error('An unexpected error occurred:', e);
-        // Avoid sending detailed error in production
-        rr.resStatusCode(500).resWriteJson({ error: 'Internal Server Error' });
+    async catch(@Inject({situationType: ExceptionHandlerSituationType.ERROR_OBJECT}) e: any, rr: RequestResponse) {
+        console.error(`GlobalAdvice.catch ${rr.reqUrl}`, e);
+
+        // Critical check to prevent writing to an already-sent response
+        if (rr.resIsDone()) {
+            return;
+        }
+
+        rr.resStatusCode(HttpStatus.InternalServerError);
+        rr.resSetHeader('Content-Type', Mimes.ApplicationJson);
+
+        let data = '';
+        if (e instanceof HttpError) {
+            rr.resStatusCode(e.status);
+            data = JSON.stringify(e);
+        } else if (e instanceof Error){
+            const error = new InternalServerError();
+            error.data = {message: e.message, stack: e.stack}; // Be careful with stack in production
+            data = JSON.stringify(error);
+        } else {
+            const error = new InternalServerError();
+            error.data = e;
+            data = JSON.stringify(error);
+        }
+        await rr.resEnd(data);
     }
 }
 

package/{SimpleBootHttpServer.d.ts → dist/cjs/SimpleBootHttpServer.d.ts}

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import { SimpleApplication } from '@dooboostore/simple-boot/SimpleApplication';
 import { HttpServerOption } from './option/HttpServerOption';
 import { ConstructorType } from '@dooboostore/core/types';

package/dist/cjs/SimpleBootHttpServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleBootHttpServer.d.ts","sourceRoot":"","sources":["../../src/SimpleBootHttpServer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,iBAAiB,EAAC,MAAM,4CAA4C,CAAC;AAC7E,OAAO,EAAC,gBAAgB,EAAC,MAAM,2BAA2B,CAAC;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAkB,MAAM,IAAI,UAAU,EAAiB,MAAM,MAAM,CAAA;AAC1E,OAAO,EAAE,MAAM,IAAI,WAAW,EAAsC,MAAM,OAAO,CAAC;AA0BlF,qBAAa,oBAAqB,SAAQ,iBAAiB;IAGpC,MAAM,EAAE,gBAAgB;IAFpC,MAAM,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;IACzC,OAAO,CAAC,cAAc,CAAiB;gBACpB,MAAM,GAAE,gBAAyC;IAM7D,GAAG,CAAC,gBAAgB,CAAC,EAAE,GAAG,CAAC,eAAe,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC;IAS5D,OAAO,CAAC,WAAW;CAwRtB"}