Merge pull request #3 from SecJS/feat/len-add-context

feat/fix: Context request/response, root path matcher

Author: jlenon7

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@secjs/http",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "",
   "scripts": {
     "build": "tsc",
@@ -16,7 +16,8 @@
   "author": "João Lenon <lenonsec7@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@secjs/utils": "^1.2.8"
+    "@secjs/contracts": "^1.0.7",
+    "@secjs/utils": "^1.3.0"
   },
   "files": [
     "src/*.d.ts",

src/Contracts/HandlerContract.ts

@@ -1,6 +1,11 @@
 import { IncomingMessage, ServerResponse } from 'http'
 
+export interface Context {
+  request: IncomingMessage
+  response: ServerResponse
+}
+
 // TODO Move to @secjs/contracts
 export interface HandlerContract {
-  (request: IncomingMessage, response: ServerResponse): Promise<any> | any
+  (ctx: Context): Promise<any> | any
 }

src/constants.ts

@@ -1,4 +1,4 @@
-import { IncomingMessage, ServerResponse } from 'http'
+import { Context } from './Contracts/HandlerContract'
 
 export default {
   PORT: 4040,
@@ -12,10 +12,12 @@ export default {
     method: 'ALL',
     params: [],
     matcher: /\//,
-    handler: (request: IncomingMessage, response: ServerResponse): any => {
-      response.writeHead(404, { 'Content-Type': 'application/json' })
-      response.write(JSON.stringify({ message: 'Not found!' }))
-      response.end()
+    handler: (ctx: Context): any => {
+      ctx.response.writeHead(404, { 'Content-Type': 'application/json' })
+
+      ctx.response.write(JSON.stringify({ message: 'Not found!' }))
+
+      ctx.response.end()
     },
   },
 }

src/server.ts

@@ -9,7 +9,7 @@ export class Sec {
   private routeUtils: Route
 
   private nodeServer: Server
-  private routes: RouteContract[] = [constants.DEFAULT_ROUTE]
+  private routes: RouteContract[] = []
 
   private createRouteHandler(
     path: string,
@@ -40,9 +40,9 @@ export class Sec {
         const chosen =
           this.routes.find(
             route => route.matcher.test(url) && route.method === method,
-          ) || this.routes[0]
+          ) || constants.DEFAULT_ROUTE
 
-        return chosen.handler(request, response)
+        return chosen.handler({ request, response })
       },
     )
   }

tests/server.spec.ts

@@ -1,7 +1,7 @@
 import supertest from 'supertest'
 
 import { Sec } from '../src/server'
-import { IncomingMessage, ServerResponse } from 'http'
+import { Context } from './../src/Contracts/HandlerContract'
 
 describe('\n Server', () => {
   it('should be able to create a Http server using SecJS', async () => {
@@ -23,15 +23,12 @@ describe('\n Server', () => {
   it('should be able to create routes with handlers', async () => {
     const server = new Sec()
 
-    server.get(
-      '/tests',
-      (request: IncomingMessage, response: ServerResponse) => {
-        response.writeHead(200, { 'Content-Type': 'application/json' })
+    server.get('/tests', (ctx: Context) => {
+      ctx.response.writeHead(200, { 'Content-Type': 'application/json' })
 
-        response.write(JSON.stringify({ data: [{ id: 1, name: 'Test 1' }] }))
-        response.end()
-      },
-    )
+      ctx.response.write(JSON.stringify({ data: [{ id: 1, name: 'Test 1' }] }))
+      ctx.response.end()
+    })
 
     server.listen()
 
@@ -49,17 +46,14 @@ describe('\n Server', () => {
   it('should be able to create routes with params', async () => {
     const server = new Sec()
 
-    server.get(
-      '/tests/:id/unitaries/:unitaries_id',
-      (request: IncomingMessage, response: ServerResponse) => {
-        response.writeHead(200, { 'Content-Type': 'application/json' })
-
-        response.write(
-          JSON.stringify({ data: { id: 1, name: 'Unit Test 1', testId: 1 } }),
-        )
-        response.end()
-      },
-    )
+    server.get('/tests/:id/unitaries/:unitaries_id', (ctx: Context) => {
+      ctx.response.writeHead(200, { 'Content-Type': 'application/json' })
+
+      ctx.response.write(
+        JSON.stringify({ data: { id: 1, name: 'Unit Test 1', testId: 1 } }),
+      )
+      ctx.response.end()
+    })
 
     server.listen()
 

yarn.lock

@@ -565,10 +565,15 @@
   resolved "https://registry.yarnpkg.com/@secjs/contracts/-/contracts-1.0.4.tgz#79d8127afd3e42454f281ad4b4a58a1d2e49b44a"
   integrity sha512-yXzC2bCk5o+7EQUye79k8mB4fkzBsOvQYkhDAJtqjy04tR14znbp6gBqAOvU3OHkJ6DlbwWGmsVEfk98qVo+0w==
 
-"@secjs/utils@^1.2.8":
-  version "1.2.8"
-  resolved "https://registry.yarnpkg.com/@secjs/utils/-/utils-1.2.8.tgz#1d140945fe60d0bca59eeeb97a5ae37214a02653"
-  integrity sha512-hrbrXxDvIBnu0pJP0qwjmOhig5JOX3Ymf8S4h+oq3lKb33pc/yRE7dztPqdxVdgJFCOvTDW2WzVIzg1vQA7m5Q==
+"@secjs/contracts@^1.0.7":
+  version "1.0.7"
+  resolved "https://registry.yarnpkg.com/@secjs/contracts/-/contracts-1.0.7.tgz#d4ec704d6f5f6886635f7f1523c6ccae4ca44f8f"
+  integrity sha512-HFOKPRaPH0qJtfZXy7sci3fTzY0Akt7ySlJcp1wO4rBBy+OXgKnjpUucobRzIQfaM97WaaNr3QXcACQI/DHiVw==
+
+"@secjs/utils@^1.3.0":
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/@secjs/utils/-/utils-1.3.0.tgz#29aa1f7b15c740cf4f34a5a74eb959c2238e1c53"
+  integrity sha512-axuwtU6KM9Dk5pIA+00tVAgFhru7V9BXpdpaA0v2z0igte6NeIZkT1oKAJARYtXRKsAYDYZXru4xuSb1kZE/WQ==
   dependencies:
     "@secjs/contracts" "^1.0.4"
     uuid "^8.3.2"