Clean up

Author: ije

server/app.ts

@@ -258,7 +258,7 @@ export class Application implements ServerApplication {
       skip: [
         /(^|\/|\\)\./,
         /\.d\.ts$/i,
-        /(\.|_)(test|spec|e2e)\.(tsx?|jsx?|mjs)?$/i
+        /(\.|_)(test|spec|e2e)\.[a-z]+$/i
       ]
     }
 
@@ -399,6 +399,7 @@ export class Application implements ServerApplication {
     }
   }
 
+  /** check the changed file whether it is a scoped module */
   private isScopedModule(url: string) {
     for (const ext of moduleExts) {
       if (url.endsWith('.' + ext)) {
@@ -452,14 +453,15 @@ export class Application implements ServerApplication {
     return this.config.plugins.filter(isLoaderPlugin)
   }
 
-  /** returns the module by given url. */
+  /** get the module by given url. */
   getModule(url: string): Module | null {
     if (this.#modules.has(url)) {
       return this.#modules.get(url)!
     }
     return null
   }
 
+  /** find the module by given name. */
   findModuleByName(name: string): Module | null {
     for (const ext of moduleExts) {
       const url = `/${util.trimPrefix(name, '/')}.${ext}`
@@ -470,6 +472,7 @@ export class Application implements ServerApplication {
     return null
   }
 
+  /** lookup style deps of given modules. */
   lookupStyleModules(...urls: string[]): Module[] {
     const mods: Module[] = []
     urls.forEach(url => {
@@ -483,10 +486,12 @@ export class Application implements ServerApplication {
     return mods
   }
 
+  /** get page route by given location. */
   getPageRoute(location: { pathname: string, search?: string }): [RouterURL, RouteModule[]] {
     return this.#pageRouting.createRouter(location)
   }
 
+  /** get api route by given location. */
   getAPIRoute(location: { pathname: string, search?: string }): [RouterURL, Module] | null {
     const router = this.#apiRouting.createRouter(location)
     if (router !== null) {
@@ -568,16 +573,19 @@ export class Application implements ServerApplication {
     return [status, html]
   }
 
+  /** get code injects */
   getCodeInjects(phase: 'compilation' | 'hmr' | 'ssr') {
     return this.#injects.get(phase)
   }
 
+  /** create a fs watcher.  */
   createFSWatcher(): EventEmitter {
     const e = new EventEmitter()
     this.#fsWatchListeners.push(e)
     return e
   }
 
+  /** remove the fs watcher.  */
   removeFSWatcher(e: EventEmitter) {
     e.removeAllListeners()
     const index = this.#fsWatchListeners.indexOf(e)
@@ -586,6 +594,7 @@ export class Application implements ServerApplication {
     }
   }
 
+  /** check the module whether it is hmrable. */
   isHMRable(url: string) {
     if (!this.isDev || util.isLikelyHttpURL(url)) {
       return false
@@ -730,7 +739,8 @@ export class Application implements ServerApplication {
     ]
   }
 
-  async resolveModule(url: string) {
+  /** read the module contents. */
+  async readModule(url: string) {
     const { content, contentType } = await this.fetchModule(url)
     const source = await this.precompile(url, content, contentType)
     if (source === null) {
@@ -739,6 +749,18 @@ export class Application implements ServerApplication {
     return source
   }
 
+  /** parse the export names of the module. */
+  async parseModuleExportNames(url: string): Promise<string[]> {
+    const source = await this.readModule(url)
+    const names = await parseExportNames(url, source.code, { sourceType: source.type })
+    return (await Promise.all(names.map(async name => {
+      if (name.startsWith('{') && name.startsWith('}')) {
+        return await this.parseModuleExportNames(name.slice(1, -1))
+      }
+      return name
+    }))).flat()
+  }
+
   /** default compiler options */
   get sharedCompileOptions(): TransformOptions {
     return {
@@ -1002,18 +1024,11 @@ export class Application implements ServerApplication {
     }
   }
 
-  async parseModuleExportNames(url: string): Promise<string[]> {
-    const source = await this.resolveModule(url)
-    const names = await parseExportNames(url, source.code, { sourceType: source.type })
-    return (await Promise.all(names.map(async name => {
-      if (name.startsWith('{') && name.startsWith('}')) {
-        return await this.parseModuleExportNames(name.slice(1, -1))
-      }
-      return name
-    }))).flat()
-  }
-
-  /** compile a moudle by given url, then cache on the disk. */
+  /**
+   * compile a moudle by given url, then cache on the disk.
+   * each moudle only be compiled once unless you set the
+   * `forceCompile` option to true.
+   */
   private async compile(
     url: string,
     options: {
@@ -1170,7 +1185,7 @@ export class Application implements ServerApplication {
             if (jsContent === '') {
               jsContent = await Deno.readTextFile(mod.jsFile)
             }
-            jsContent = this.replaceDepHash(jsContent, dep)
+            jsContent = this.updateImportUrls(jsContent, dep)
             if (!fsync) {
               fsync = true
             }
@@ -1179,23 +1194,26 @@ export class Application implements ServerApplication {
       }
     }
 
-    // update hash by deps
+    // update hash using deps status
     if (mod.deps.length > 0) {
       mod.hash = computeHash(mod.sourceHash + mod.deps.map(({ hash }) => hash).join(''))
     }
 
     if (fsync) {
-      await lazyRemove(util.trimSuffix(mod.jsFile, '.js') + '.bundling.js')
+      if (jsSourceMap) {
+        jsContent += `//# sourceMappingURL=${basename(mod.jsFile)}.map`
+      }
       await Promise.all([
         ensureTextFile(metaFile, JSON.stringify({
           url,
           deps: mod.deps,
           sourceHash: mod.sourceHash,
           isStyle: mod.isStyle ? true : undefined
         }, undefined, 2)),
-        ensureTextFile(mod.jsFile, jsContent + (jsSourceMap ? `//# sourceMappingURL=${basename(mod.jsFile)}.map` : '')),
+        ensureTextFile(mod.jsFile, jsContent),
         jsSourceMap ? ensureTextFile(mod.jsFile + '.map', jsSourceMap) : Promise.resolve(),
       ])
+      await lazyRemove(util.trimSuffix(mod.jsFile, '.js') + '.bundling.js')
     }
 
     return mod
@@ -1204,11 +1222,10 @@ export class Application implements ServerApplication {
   /** apply compilation side-effect caused by dependency graph breaking. */
   private async applyCompilationSideEffect(url: string, callback: (mod: Module) => void) {
     const { hash } = this.#modules.get(url)!
-
     for (const mod of this.#modules.values()) {
       for (const dep of mod.deps) {
         if (dep.url === url) {
-          const jsContent = this.replaceDepHash(
+          const jsContent = this.updateImportUrls(
             await Deno.readTextFile(mod.jsFile),
             { url, hash }
           )
@@ -1353,7 +1370,8 @@ export class Application implements ServerApplication {
     return ssr
   }
 
-  private replaceDepHash(jsContent: string, dep: DependencyDescriptor) {
+  /** update the hash in import url of deps. */
+  private updateImportUrls(jsContent: string, dep: DependencyDescriptor) {
     const s = `.js#${dep.url}@`
     return jsContent.split(s).map((p, i) => {
       if (i > 0 && p.charAt(6) === '"') {

server/cache.ts

@@ -2,29 +2,28 @@ import { ensureDir } from 'https://deno.land/[email protected]/fs/ensure_dir.ts'
 import { createHash } from 'https://deno.land/[email protected]/hash/mod.ts'
 import { join } from 'https://deno.land/[email protected]/path/mod.ts'
 import { existsFileSync } from '../shared/fs.ts'
-import util from '../shared/util.ts'
 import log from '../shared/log.ts'
+import util from '../shared/util.ts'
 import { getDenoDir } from './helper.ts'
 
-/** download and cache remote content */
+/** download and cache remote contents */
 export async function cache(url: string, options?: { forceRefresh?: boolean, retryTimes?: number }) {
-  const u = new URL(url)
-  const { protocol, hostname, port, pathname, search } = u
-  const isLocalhost = hostname === 'localhost' || hostname === '0.0.0.0' || hostname === '172.0.0.1'
+  const { protocol, hostname, port, pathname, search } = new URL(url)
+  const hashname = createHash('sha256').update(pathname + search).toString()
+  const isLocalhost = hostname === 'localhost' || hostname === '0.0.0.0' || hostname === '127.0.0.1'
   const cacheDir = join(
     await getDenoDir(),
     'deps',
     util.trimSuffix(protocol, ':'),
     hostname + (port ? '_PORT' + port : '')
   )
-  const hash = createHash('sha256').update(pathname + search).toString()
-  const contentFile = join(cacheDir, hash)
-  const metaFile = join(cacheDir, hash + '.metadata.json')
+  const contentFilepath = join(cacheDir, hashname)
+  const metaFilepath = join(cacheDir, hashname + '.metadata.json')
 
-  if (!options?.forceRefresh && !isLocalhost && existsFileSync(contentFile) && existsFileSync(metaFile)) {
+  if (!options?.forceRefresh && !isLocalhost && existsFileSync(contentFilepath) && existsFileSync(metaFilepath)) {
     const [content, meta] = await Promise.all([
-      Deno.readFile(contentFile),
-      Deno.readTextFile(metaFile),
+      Deno.readFile(contentFilepath),
+      Deno.readTextFile(metaFilepath),
     ])
     try {
       const { headers = {} } = JSON.parse(meta)
@@ -47,7 +46,7 @@ export async function cache(url: string, options?: { forceRefresh?: boolean, ret
       log.warn(`Download ${url} failed, retrying...`)
     }
     try {
-      const resp = await fetch(u.toString())
+      const resp = await fetch(url)
       if (resp.status >= 400) {
         return Promise.reject(new Error(resp.statusText))
       }
@@ -59,8 +58,8 @@ export async function cache(url: string, options?: { forceRefresh?: boolean, ret
           headers[key] = val
         })
         await ensureDir(cacheDir)
-        Deno.writeFile(contentFile, content)
-        Deno.writeTextFile(metaFile, JSON.stringify({ headers, url }, undefined, 2))
+        Deno.writeFile(contentFilepath, content)
+        Deno.writeTextFile(metaFilepath, JSON.stringify({ headers, url }, undefined, 2))
       }
       return {
         content,

server/helper.ts

@@ -1,5 +1,3 @@
-// @deno-types="https://deno.land/x/[email protected]/mod.d.ts"
-export { build as esbuild, stop as stopEsbuild } from 'https://deno.land/x/[email protected]/mod.js'
 import { dim, red, yellow } from 'https://deno.land/[email protected]/fmt/colors.ts'
 import { createHash } from 'https://deno.land/[email protected]/hash/mod.ts'
 import { relative } from 'https://deno.land/[email protected]/path/mod.ts'
@@ -9,13 +7,16 @@ import type { ServerPlugin, LoaderPlugin } from '../types.ts'
 import { VERSION } from '../version.ts'
 import { localProxy } from './localproxy.ts'
 
+// @deno-types="https://deno.land/x/[email protected]/mod.d.ts"
+export { build as esbuild, stop as stopEsbuild } from 'https://deno.land/x/[email protected]/mod.js'
+
 export const reLocaleID = /^[a-z]{2}(-[a-zA-Z0-9]+)?$/
 export const reFullVersion = /@v?\d+\.\d+\.\d+/i
 
 let __denoDir: string | null = null
 let __localProxy = false
 
-/** check whether should proxy https://deno.land/x/aleph on local. */
+/** check whether should proxy https://deno.land/x/aleph on localhost. */
 export function checkAlephDev() {
   const v = Deno.env.get('ALEPH_DEV')
   if (v !== undefined && !__localProxy) {
@@ -24,12 +25,12 @@ export function checkAlephDev() {
   }
 }
 
-/** check the plugin whether is a loader plugin. */
+/** check the plugin whether it is a loader. */
 export function isLoaderPlugin(plugin: LoaderPlugin | ServerPlugin): plugin is LoaderPlugin {
   return plugin.type === 'loader'
 }
 
-/** get deno dir. */
+/** get the deno cache dir. */
 export async function getDenoDir() {
   if (__denoDir !== null) {
     return __denoDir
@@ -100,7 +101,7 @@ export function computeHash(content: string | Uint8Array): string {
 }
 
 /**
- * colorful the bytes string
+ * coloring the bytes string
  * - dim: 0 - 1MB
  * - yellow: 1MB - 10MB
  * - red: > 10MB

server/oak.ts

@@ -1,4 +1,5 @@
-import type { Middleware, Context } from 'https://deno.land/x/oak/mod.ts'
+import type { Context } from 'https://deno.land/x/[email protected]/context.ts'
+import type { Middleware } from 'https://deno.land/x/[email protected]/middleware.ts'
 import { Application } from './app.ts'
 import { Server } from './server.ts'
 
@@ -7,8 +8,7 @@ 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)
+    server.handle(ctx.request.originalRequest)
     ctx.respond = false
   }
 }

server/stdserver.ts

@@ -12,7 +12,8 @@ export type ServeOptions = {
   /** 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`. */
+   * If not specified, defaults to `0.0.0.0`.
+   */
   hostname?: string
   /** Server certificate file. */
   certFile?: string