add Body generic to Request, add GraphQL example

v1rtl · v1rtl · commit dfca7471768a · 2021-03-14T16:34:52.000+03:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -16,6 +16,8 @@ jobs:
       - uses: denolib/setup-deno@v2
         with:
           deno-version: v1.8
+      - name: Cache Dependencies
+        run: deno cache deps.ts
       - name: Create tests
         run: deno test -A --no-check --location http://127.0.1 --unstable --coverage=coverage ./tests -q
       - name: Create coverage report
diff --git a/egg.json b/egg.json
@@ -4,7 +4,7 @@
   "entry": "./app.ts",
   "description": "0-legacy, tiny & fast web framework as a replacement of Express",
   "homepage": "https://github.com/talentlessguy/tinyhttp-deno",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "files": [
     "./*.ts",
     "./utils/*.ts",
diff --git a/examples/graphql/README.md b/examples/graphql/README.md
@@ -0,0 +1,20 @@
+# tinyhttp GraphQL example
+
+Simple GraphQL server example with tinyhttp and [gql](https://github.com/deno-libs/gql).
+
+## Run
+
+```sh
+deno run --allow-read --allow-net server.ts
+```
+
+Then in another terminal:
+
+```sh
+$ curl -X POST localhost:3000/graphql -d '{ "query": "{ hello }" }'
+{
+  "data": {
+    "hello": "Hello World!"
+  }
+}
+```
diff --git a/examples/graphql/server.ts b/examples/graphql/server.ts
@@ -0,0 +1,23 @@
+import { App } from '../../mod.ts'
+import { GraphQLHTTP } from 'https://deno.land/x/gql/mod.ts'
+import { GraphQLSchema, GraphQLString, GraphQLObjectType } from 'https://deno.land/x/graphql_deno@v15.0.0/mod.ts'
+
+const schema = new GraphQLSchema({
+  query: new GraphQLObjectType({
+    name: 'Query',
+    fields: {
+      hello: {
+        type: GraphQLString,
+        resolve() {
+          return 'Hello World!'
+        }
+      }
+    }
+  })
+})
+
+const app = new App()
+
+app.post('/graphql', GraphQLHTTP({ schema }))
+
+app.listen(3000, () => console.log(`☁  Started on http://localhost:3000`))
diff --git a/request.ts b/request.ts
@@ -3,7 +3,7 @@ import { ServerRequest } from 'https://deno.land/std@0.88.0/http/server.ts'
 import { App } from './app.ts'
 import { QueryParams, Ranges, Protocol, AcceptsReturns, Middleware } from './types.ts'
 
-export interface Request extends ServerRequest, tinyhttp.Request {
+export interface Request<Body = Record<string, unknown>> extends ServerRequest, tinyhttp.Request {
   path: string
   originalUrl: string
   query: QueryParams
@@ -36,5 +36,5 @@ export interface Request extends ServerRequest, tinyhttp.Request {
     remoteAddress: string
   }
 
-  parsedBody?: Record<string, unknown>
+  parsedBody?: Body
 }
diff --git a/tests/modules/send.test.ts b/tests/modules/send.test.ts
@@ -51,28 +51,43 @@ describe('send(body)', () => {
     // @ts-ignore
     await fetch.get('/').expect(null)
   })
-  /*  it('should remove some headers for 204 status', async () => {
+  /* it('should remove some headers for 204 status', async () => {
     const { fetch } = InitAppAndTest((req, res) => {
       res.status = 204
 
       send(req, res)('Hello World')
     })
 
-    await fetch.get('/').expect('Content-Length', '').expect('Content-Type', '').expect('Transfer-Encoding', '')
+    await fetch
+      .get('/')
+      .expect('Content-Length', '')
+      .expect('Content-Type', '')
+      .expect('Transfer-Encoding', '')
+      .expect('')
   })
   it('should remove some headers for 304 status', async () => {
-    const { fetch } = InitAppAndTest((req, res) => {
-      res.status = 304
-
-      send(req, res)('Hello World')
-    })
+    const { fetch } = InitAppAndTest(
+      (req, res) => {
+        res.status = 304
+        res.headers?.delete('Content-Type')
+        send(req, res)('Hello World')
+      },
+      '/',
+      {},
+      'get'
+    )
 
-    await fetch.get('/').expect('Content-Length', '').expect('Content-Type', '').expect('Transfer-Encoding', '')
-  })
-  it("should set Content-Type to application/octet-stream for buffers if the header hasn't been set before", async () => {
+    await fetch
+      .get('/')
+      .expect('Content-Length', '')
+      .expect('Content-Type', '')
+      .expect('Transfer-Encoding', '')
+      .expect('')
+  }) */
+  /* it("should set Content-Type to application/octet-stream for buffers if the header hasn't been set before", async () => {
     const { fetch } = InitAppAndTest((req, res) => send(req, res)(new TextEncoder().encode('Hello World')).end())
 
-    await fetch.get('/').set('Content-Type', '').expect('Content-Type', 'application/octet-stream')
+    await fetch.get('/').expect('Content-Type', 'application/octet-stream')
   }) */
 })
 
diff --git a/tests/util.ts b/tests/util.ts
@@ -16,10 +16,15 @@ export const BindToSuperDeno = <Req extends Request, Res extends Response>(app:
   return fetch
 }
 
-export const InitAppAndTest = (handler: Handler, route = '/', settings: AppConstructor<Request, Response> = {}) => {
+export const InitAppAndTest = (
+  handler: Handler,
+  route = '/',
+  settings: AppConstructor<Request, Response> = {},
+  method: 'get' | 'post' | 'use' = 'use'
+) => {
   const app = new App<unknown, Request, Response>(settings)
 
-  app.use(route, handler)
+  app[method](route, handler)
 
   return { fetch: BindToSuperDeno(app), app }
 }
diff --git a/types.ts b/types.ts
@@ -17,7 +17,7 @@ interface Range {
   end: number
 }
 
-export type Handler = RHandler<Request, Response>
+export type Handler<Req = Request> = RHandler<Req, Response>
 
 export type {
   QueryParams,

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@ import { ServerRequest } from 'https://deno.land/std@0.88.0/http/server.ts'`
`3`	`3`	`import { App } from './app.ts'`
`4`	`4`	`import { QueryParams, Ranges, Protocol, AcceptsReturns, Middleware } from './types.ts'`
`5`	`5`
`6`		`-export interface Request extends ServerRequest, tinyhttp.Request {`
	`6`	`+export interface Request<Body = Record<string, unknown>> extends ServerRequest, tinyhttp.Request {`
`7`	`7`	`path: string`
`8`	`8`	`originalUrl: string`
`9`	`9`	`query: QueryParams`
`@@ -36,5 +36,5 @@ export interface Request extends ServerRequest, tinyhttp.Request {`
`36`	`36`	`remoteAddress: string`
`37`	`37`	`}`
`38`	`38`
`39`		`- parsedBody?: Record<string, unknown>`
	`39`	`+ parsedBody?: Body`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ interface Range {`
`17`	`17`	`end: number`
`18`	`18`	`}`
`19`	`19`
`20`		`-export type Handler = RHandler<Request, Response>`
	`20`	`+export type Handler<Req = Request> = RHandler<Req, Response>`
`21`	`21`
`22`	`22`	`export type {`
`23`	`23`	`QueryParams,`