Merge branch 'master' into add-test-redirect. The --location flag has been added to the test run for redirect_test.ts

Author: Craig Doremus

CONTRIBUTING.md

@@ -22,16 +22,16 @@ You will need [Deno](https://deno.land/) 1.8+.
 
 ```bash
 # ssr/development with HMR
-ALEPH_DEV=true deno run -A --import-map=./import_map.json cli.ts dev ./examples/hello-world -L debug
+ALEPH_DEV=true deno run -A --unstable --import-map=./import_map.json cli.ts dev ./examples/hello-world -L debug
 
 # ssr/production
-ALEPH_DEV=true deno run -A --import-map=./import_map.json cli.ts start ./examples/hello-world -L debug
+ALEPH_DEV=true deno run -A --unstable --import-map=./import_map.json cli.ts start ./examples/hello-world -L debug
 
 # ssg
-ALEPH_DEV=true deno run -A --import-map=./import_map.json cli.ts build ./examples/hello-world -L debug
+ALEPH_DEV=true deno run -A --unstable --import-map=./import_map.json cli.ts build ./examples/hello-world -L debug
 
 # run all tests
-deno test -A --location=http://127.0.0.1 --import-map=./import_map.json
+deno test -A --unstable --location=http://127.0.0.1 --import-map=./import_map.json
 ```
 
 ## Project Structure

cli/build.ts

@@ -1,4 +1,4 @@
-import { Application } from '../server/mod.ts'
+import { Application } from '../server/app.ts'
 
 export const helpMessage = `
 Usage:

cli/dev.ts

@@ -1,5 +1,6 @@
 import { getFlag, parsePortNumber } from '../server/helper.ts'
-import { Application, serve } from '../server/mod.ts'
+import { Application } from '../server/app.ts'
+import { serve } from '../server/stdserver.ts'
 
 export const helpMessage = `
 Usage:

cli/start.ts

@@ -1,5 +1,6 @@
 import { getFlag, parsePortNumber } from '../server/helper.ts'
-import { Application, serve } from '../server/mod.ts'
+import { Application } from '../server/app.ts'
+import { serve } from '../server/stdserver.ts'
 import log from '../shared/log.ts'
 
 export const helpMessage = `

server/api.ts

@@ -4,14 +4,11 @@ import type { MultipartFormData } from 'https://deno.land/[email protected]/mime/multip
 import { MultipartReader } from 'https://deno.land/[email protected]/mime/multipart.ts'
 import log from '../shared/log.ts'
 import type { APIRequest, ServerRequest, ServerResponse } from '../types.ts'
-
-let brotli: ((data: Uint8Array) => Uint8Array) | null = null
-let gzip: ((data: Uint8Array) => Uint8Array) | null = null
+import compress from './compress.ts'
 
 type Response = {
   status: number
   headers: Headers
-  compress: boolean
   done: boolean
 }
 
@@ -22,7 +19,7 @@ export class Request implements APIRequest {
   #cookies: ReadonlyMap<string, string>
   #resp: Response
 
-  constructor(req: ServerRequest, params: Record<string, string>, query: URLSearchParams, compress: boolean = true) {
+  constructor(req: ServerRequest, params: Record<string, string>, query: URLSearchParams) {
     this.#req = req
     this.#params = params
     this.#query = query
@@ -39,7 +36,6 @@ export class Request implements APIRequest {
       headers: new Headers({
         Server: 'Aleph.js',
       }),
-      compress,
       done: false
     }
   }
@@ -53,7 +49,7 @@ export class Request implements APIRequest {
   }
 
   get hostname(): string {
-    return (this.#req.conn.remoteAddr as Deno.NetAddr).hostname;
+    return (this.#req.conn.remoteAddr as Deno.NetAddr).hostname
   }
 
   get headers(): Headers {
@@ -172,39 +168,12 @@ export class Request implements APIRequest {
       contentType = 'text/plain; charset=utf-8'
       this.#resp.headers.set('Content-Type', contentType)
     }
-    if (this.#resp.compress) {
-      let shouldCompress = false
-      if (contentType) {
-        if (contentType.startsWith('text/')) {
-          shouldCompress = true
-        } else if (/^application\/(javascript|json|xml|wasm)/i.test(contentType)) {
-          shouldCompress = true
-        } else if (/^image\/svg\+xml/i.test(contentType)) {
-          shouldCompress = true
-        }
-      }
-      if (shouldCompress && body.length > 1024) {
-        const ae = this.headers.get('accept-encoding') || ''
-        if (ae.includes('br')) {
-          this.#resp.headers.set('Vary', 'Origin')
-          this.#resp.headers.set('Content-Encoding', 'br')
-          if (brotli === null) {
-            const { compress } = await import('https://deno.land/x/[email protected]/mod.ts')
-            brotli = compress
-          }
-          body = brotli(body)
-        } else if (ae.includes('gzip')) {
-          this.#resp.headers.set('Vary', 'Origin')
-          this.#resp.headers.set('Content-Encoding', 'gzip')
-          if (gzip === null) {
-            const denoflate = await import('https://deno.land/x/[email protected]/mod.ts')
-            gzip = (data: Uint8Array) => denoflate.gzip(data, undefined)
-          }
-          body = gzip(body)
-        }
-      }
+    if (contentType) {
+      body = compress.apply(this.#req, this.#resp, contentType, body)
+    }
+    if (!this.#resp.headers.has('Date')) {
+      this.#resp.headers.set('Date', (new Date).toUTCString())
     }
-    this.#resp.headers.set('Date', (new Date).toUTCString())
     this.#resp.done = true
     try {
       await this.respond({

server/compress.ts

@@ -0,0 +1,56 @@
+import type { ServerRequest, ServerResponse } from '../types.ts'
+
+const brotliMod = 'https://deno.land/x/[email protected]/mod.ts'
+const flateMod = 'https://deno.land/x/[email protected]/mod.ts'
+
+class Compression {
+  #brotli: ((data: Uint8Array) => Uint8Array) | null = null
+  #gzip: ((data: Uint8Array) => Uint8Array) | null = null
+  #ready: boolean = false
+
+  async init() {
+    if (this.#brotli === null) {
+      const { compress } = await import(brotliMod)
+      this.#brotli = compress
+    }
+    if (this.#gzip === null) {
+      const denoflate = await import(flateMod)
+      this.#gzip = (data: Uint8Array) => denoflate.gzip(data, undefined)
+    }
+    this.#ready = true
+  }
+
+  apply(req: ServerRequest, resp: ServerResponse, contentType: string, content: Uint8Array): Uint8Array {
+    if (!this.#ready) {
+      return content
+    }
+
+    let shouldCompress = false
+    if (contentType) {
+      if (contentType.startsWith('text/')) {
+        shouldCompress = true
+      } else if (/^application\/(javascript|json|xml|wasm)/i.test(contentType)) {
+        shouldCompress = true
+      } else if (/^image\/svg\+xml/i.test(contentType)) {
+        shouldCompress = true
+      }
+    }
+
+    if (shouldCompress && content.length > 1024) {
+      const ae = req.headers.get('accept-encoding') || ''
+      if (ae.includes('br') && this.#brotli !== null) {
+        resp.headers?.set('Vary', 'Origin')
+        resp.headers?.set('Content-Encoding', 'br')
+        return this.#brotli(content)
+      } else if (ae.includes('gzip') && this.#gzip !== null) {
+        resp.headers?.set('Vary', 'Origin')
+        resp.headers?.set('Content-Encoding', 'gzip')
+        return this.#gzip(content)
+      }
+    }
+
+    return content
+  }
+}
+
+export default new Compression()

server/config.ts

@@ -147,15 +147,22 @@ export async function loadAndUpgradeImportMap(workingDir: string): Promise<Impor
   for (const filename of Array.from(['import_map', 'import-map', 'importmap']).map(name => `${name}.json`)) {
     importMapFile = join(workingDir, filename)
     if (existsFileSync(importMapFile)) {
-      const data = JSON.parse(await Deno.readTextFile(importMapFile))
-      const imports: Record<string, string> = toPlainStringRecord(data.imports)
-      const scopes: Record<string, Record<string, string>> = {}
-      if (util.isPlainObject(data.scopes)) {
-        Object.entries(data.scopes).forEach(([scope, imports]) => {
-          scopes[scope] = toPlainStringRecord(imports)
-        })
+      try {
+        const data = JSON.parse(await Deno.readTextFile(importMapFile))
+        const imports: Record<string, string> = toPlainStringRecord(data.imports)
+        const scopes: Record<string, Record<string, string>> = {}
+        if (util.isPlainObject(data.scopes)) {
+          Object.entries(data.scopes).forEach(([scope, imports]) => {
+            scopes[scope] = toPlainStringRecord(imports)
+          })
+        }
+        Object.assign(importMap, { imports, scopes })
+      } catch (e) {
+        log.error(`invalid '${filename}':`, e.message)
+        if (!confirm('Continue?')) {
+          Deno.exit(1)
+        }
       }
-      Object.assign(importMap, { imports, scopes })
       break
     }
   }

server/mod.ts

@@ -1,2 +1,4 @@
 export * from './app.ts'
 export * from './server.ts'
+export * from './stdserver.ts'
+export * from './oak.ts'

server/oak.ts

@@ -0,0 +1,14 @@
+import type { Middleware, Context } from 'https://deno.land/x/oak/mod.ts'
+import { Application } from './app.ts'
+import { Server } from './server.ts'
+
+/** Create an oak middleware for Aleph server. */
+export function alephOak(app: Application): Middleware {
+  const server = new Server(app)
+
+  return (ctx: Context) => {
+    const req = ctx.request as any
+    server.handle(req.originalRequest || req.serverRequest)
+    ctx.respond = false
+  }
+}

server/server.ts

@@ -1,5 +1,4 @@
 import { join } from 'https://deno.land/[email protected]/path/mod.ts'
-import { serve as stdServe, serveTLS } from 'https://deno.land/[email protected]/http/server.ts'
 import { acceptWebSocket, isWebSocketCloseEvent } from 'https://deno.land/[email protected]/ws/mod.ts'
 import { trimModuleExt } from '../framework/core/module.ts'
 import { rewriteURL } from '../framework/core/routing.ts'
@@ -28,10 +27,10 @@ export class Server {
     }
 
     const app = this.#app
-    const { basePath, compress, headers, rewrites } = app.config
+    const { basePath, headers, rewrites } = app.config
     const url = rewriteURL(r.url, basePath, rewrites)
     const pathname = decodeURI(url.pathname)
-    const req = new Request(r, {}, url.searchParams, !app.isDev && compress)
+    const req = new Request(r, {}, url.searchParams)
 
     // set custom headers
     for (const key in headers) {
@@ -158,7 +157,7 @@ export class Server {
             const [{ params, query }, { jsFile, hash }] = route
             const { default: handle } = await import(`file://${jsFile}#${hash.slice(0, 6)}`)
             if (util.isFunction(handle)) {
-              await handle(new Request(req, params, query, !app.isDev && compress))
+              await handle(new Request(req, params, query))
             } else {
               req.status(500).json({ status: 500, message: 'bad api handler' })
             }
@@ -186,49 +185,3 @@ export class Server {
     }
   }
 }
-
-/** Options for creating a standard Aleph server. */
-export type ServeOptions = {
-  /** The Aleph Server Application to serve. */
-  app: Application
-  /** The port to listen on. */
-  port: number
-  /** A literal IP address or host name that can be resolved to an IP address.
-   * If not specified, defaults to `0.0.0.0`. */
-  hostname?: string
-  /** Server certificate file. */
-  certFile?: string
-  /** Server public key file. */
-  keyFile?: string
-}
-
-/** Create a standard Aleph server. */
-export async function serve({ app, port, hostname, certFile, keyFile }: ServeOptions) {
-  const server = new Server(app)
-  await app.ready
-
-  while (true) {
-    try {
-      let s: AsyncIterable<ServerRequest>
-      if (certFile && keyFile) {
-        s = serveTLS({ port, hostname, certFile, keyFile })
-      } else {
-        s = stdServe({ port, hostname })
-      }
-      log.info(`Server ready on http://${hostname || 'localhost'}:${port}${app.config.basePath}`)
-      for await (const r of s) {
-        server.handle(r)
-      }
-    } catch (err) {
-      if (err instanceof Deno.errors.AddrInUse) {
-        if (!app.isDev) {
-          log.fatal(`port ${port} already in use!`)
-        }
-        log.warn(`port ${port} already in use, try ${port + 1}...`)
-        port++
-      } else {
-        log.fatal(err.message)
-      }
-    }
-  }
-}