feat(core): remove freshnessTesting property because it makes no sense

v1rtl · v1rtl · commit 08cff9e507ad · 2021-07-03T16:15:52.000+03:00
diff --git a/examples/eta/index.ts b/examples/eta/index.ts
@@ -21,7 +21,8 @@ app.use(
       { name: 'Eta', func },
       {
         renderOptions: {
-          async: true
+          async: true,
+          cache: true
         }
       }
     )
diff --git a/examples/eta/package.json b/examples/eta/package.json
@@ -3,13 +3,13 @@
   "private": true,
   "dependencies": {
     "@tinyhttp/app": "workspace:*",
-    "eta": "^1.12.0"
-  },
-  "devDependencies": {
-    "ts-node": "^9.1.1"
+    "eta": "^1.12.2"
   },
   "scripts": {
-    "start": "ts-node index.ts"
+    "start": "esmo index.ts"
   },
-  "main": "index.js"
+  "main": "index.js",
+  "devDependencies": {
+    "esmo": "^0.7.3"
+  }
 }
diff --git a/package.json b/package.json
@@ -15,26 +15,26 @@
     "@commitlint/config-conventional": "^12.1.4",
     "@rollup/plugin-typescript": "^8.2.1",
     "@types/jest": "^26.0.23",
-    "@types/node": "^15.12.5",
-    "@typescript-eslint/eslint-plugin": "^4.28.0",
-    "@typescript-eslint/parser": "^4.28.0",
+    "@types/node": "^15.14.0",
+    "@typescript-eslint/eslint-plugin": "^4.28.1",
+    "@typescript-eslint/parser": "^4.28.1",
     "colorette": "^1.2.2",
     "decache": "^4.6.0",
     "eslint": "^7.29.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
     "eta": "^1.12.2",
-    "husky": "6.0.0",
-    "jest": "^27.0.5",
+    "husky": "7.0.0",
+    "jest": "^27.0.6",
     "jsonwebtoken": "^8.5.1",
     "prettier": "^2.3.2",
     "range-parser": "^1.2.1",
     "regexparam": "^2.0.0",
-    "rollup": "^2.52.3",
+    "rollup": "^2.52.7",
     "supertest-fetch": "^1.4.3",
     "ts-jest": "^27.0.3",
     "tslib": "^2.3.0",
-    "typescript": "^4.3.4"
+    "typescript": "^4.3.5"
   },
   "scripts": {
     "prerelease": "pnpm lint && pnpm build && pnpm test",
diff --git a/packages/app/src/app.ts b/packages/app/src/app.ts
@@ -34,7 +34,6 @@ const applyHandler =
  */
 export type AppSettings = Partial<{
   networkExtensions: boolean
-  freshnessTesting: boolean
   subdomainOffset: number
   bindAppToReqRes: boolean
   xPoweredBy: string | boolean
@@ -51,7 +50,7 @@ export type TemplateFunc<O> = (
   cb: (err: Error, html: unknown) => void
 ) => void
 
-export type TemplateEngineOptions<O = any> = Partial<{
+export type TemplateEngineOptions<O extends any> = Partial<{
   cache: boolean
   ext: string
   renderOptions: Partial<O>
diff --git a/packages/app/src/extend.ts b/packages/app/src/extend.ts
@@ -92,10 +92,8 @@ export const extendMiddleware =
     res.append = append<Response>(res)
     res.locals = res.locals || Object.create(null)
 
-    if (settings?.freshnessTesting) {
-      Object.defineProperty(req, 'fresh', { get: getFreshOrStale.bind(null, req, res) })
-      req.stale = !req.fresh
-    }
+    Object.defineProperty(req, 'fresh', { get: getFreshOrStale.bind(null, req, res), configurable: true })
+    req.stale = !req.fresh
 
     next()
   }
diff --git a/tests/core/app.test.ts b/tests/core/app.test.ts
@@ -914,34 +914,6 @@ describe('App settings', () => {
       await makeFetch(server)('/').expect(200)
     })
   })
-  describe('networkExtensions', () => {
-    it('enables req.fresh', async () => {
-      const etag = '123'
-      const { fetch } = InitAppAndTest(
-        (req, res) => {
-          res.set('ETag', etag).send(`${req.fresh ? 'fresh' : 'stale'}`)
-        },
-        '/',
-        'GET',
-        { settings: { freshnessTesting: true } }
-      )
-
-      await fetch('/', { headers: { 'If-None-Match': etag } }).expect(304)
-    })
-    it('disabled', async () => {
-      const etag = '123'
-      const { fetch } = InitAppAndTest(
-        (req, res) => {
-          res.set('ETag', etag).send(`${req.fresh ? 'fresh' : 'stale'}`)
-        },
-        '/',
-        'GET',
-        { settings: { freshnessTesting: false } }
-      )
-
-      await fetch('/', { headers: { 'If-None-Match': etag } }).expect(200, 'stale')
-    })
-  })
   describe('enableReqRoute', () => {
     it('attach current fn to req.route when enabled', async () => {
       const app = new App({ settings: { enableReqRoute: true } })
diff --git a/tests/core/request.test.ts b/tests/core/request.test.ts
@@ -139,8 +139,7 @@ describe('Request properties', () => {
         res.set('ETag', etag).send('stale')
       },
       '/',
-      'GET',
-      { settings: { freshnessTesting: true } }
+      'GET'
     )
 
     await fetch('/', { headers: { 'If-None-Match': etag } }).expectStatus(304)
diff --git a/tests/modules/send.test.ts b/tests/modules/send.test.ts
@@ -96,7 +96,7 @@ describe('send(body)', () => {
   it('should set 304 status for fresh requests', async () => {
     const etag = 'abc'
 
-    const app = new App({ settings: { freshnessTesting: true } })
+    const app = new App()
 
     const server = app.listen()
 

Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,8 @@ app.use(`
`21`	`21`	`{ name: 'Eta', func },`
`22`	`22`	`{`
`23`	`23`	`renderOptions: {`
`24`		`- async: true`
	`24`	`+ async: true,`
	`25`	`+ cache: true`
`25`	`26`	`}`
`26`	`27`	`}`
`27`	`28`	`)`
Original file line number	Diff line number	Diff line change
`@@ -139,8 +139,7 @@ describe('Request properties', () => {`
`139`	`139`	`res.set('ETag', etag).send('stale')`
`140`	`140`	`},`
`141`	`141`	`'/',`
`142`		`- 'GET',`
`143`		`- { settings: { freshnessTesting: true } }`
	`142`	`+ 'GET'`
`144`	`143`	`)`
`145`	`144`
`146`	`145`	`await fetch('/', { headers: { 'If-None-Match': etag } }).expectStatus(304)`