feat: siteFile content support File URL

example/helloworld-commonjs/app/controller/home.js

@@ -0,0 +1,3 @@
+exports.index = async function index(ctx) {
+  ctx.body = 'hello egg';
+};

example/helloworld-commonjs/app/router.js

@@ -0,0 +1,3 @@
+module.exports = app => {
+  app.get('/', 'home.index');
+};

example/helloworld-commonjs/config/config.js

@@ -0,0 +1 @@
+exports.keys = 'hello world';

example/helloworld-commonjs/config/plugin.js

@@ -0,0 +1,5 @@
+exports.schedule = {
+  enable: false,
+};
+
+exports.logrotator = false;

example/helloworld-commonjs/index.js

@@ -0,0 +1,19 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+const { once } = require('node:events');
+const { Application } = require('../../dist/commonjs/index');
+
+const app = new Application({
+  baseDir: process.cwd(),
+  mode: 'single',
+});
+
+async function main() {
+  await app.ready();
+  console.log('egg app ready');
+
+  const server = app.listen(7001);
+  await once(server, 'listening');
+  console.log(`egg app server listening at http://localhost:${server.address().port}`);
+}
+
+main();

example/helloworld-commonjs/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "hello-commonjs",
+  "type": "commonjs"
+}

package.json

@@ -20,7 +20,7 @@
   ],
   "dependencies": {
     "@eggjs/cookies": "^3.0.0",
-    "@eggjs/core": "^6.0.2",
+    "@eggjs/core": "^6.0.3",
     "@eggjs/utils": "^4.0.2",
     "@types/accepts": "^1.3.5",
     "accepts": "^1.3.8",
@@ -64,6 +64,7 @@
     "@types/mocha": "^10.0.7",
     "@types/ms": "^0.7.34",
     "@types/node": "22",
+    "@types/supertest": "^6.0.2",
     "address": "2",
     "assert-file": "1",
     "coffee": "5",
@@ -82,7 +83,7 @@
     "runscript": "2",
     "sdk-base": "^4.2.1",
     "spy": "^1.0.0",
-    "supertest": "^6.2.4",
+    "supertest": "^7.0.0",
     "tshy": "^3.0.2",
     "tshy-after": "1",
     "typescript": "5"

src/app/middleware/site_file.ts

@@ -1,4 +1,6 @@
 import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { readFile } from 'node:fs/promises';
 import type { EggCoreContext } from '@eggjs/core';
 import type { Next } from '../../lib/type.js';
 
@@ -7,9 +9,11 @@ export type SiteFileContentFun = (ctx: EggCoreContext) => Promise<Buffer | strin
 export interface SiteFileMiddlewareOptions {
   enable: boolean;
   cacheControl: string;
-  [key: string]: string | Buffer | boolean | SiteFileContentFun;
+  [key: string]: string | Buffer | boolean | SiteFileContentFun | URL;
 }
 
+const BUFFER_CACHE = Symbol('siteFile URL buffer cache');
+
 module.exports = (options: SiteFileMiddlewareOptions) => {
   return async function siteFile(ctx: EggCoreContext, next: Next) {
     if (ctx.method !== 'HEAD' && ctx.method !== 'GET') {
@@ -35,6 +39,23 @@ module.exports = (options: SiteFileMiddlewareOptions) => {
       return ctx.redirect(content);
     }
 
+    // URL
+    if (content instanceof URL) {
+      if (content.protocol !== 'file:') {
+        return ctx.redirect(content.href);
+      }
+      // protocol = file:
+      let buffer = Reflect.get(content, BUFFER_CACHE) as Buffer;
+      if (!buffer) {
+        buffer = await readFile(fileURLToPath(content));
+        Reflect.set(content, BUFFER_CACHE, buffer);
+      }
+      ctx.set('cache-control', options.cacheControl);
+      ctx.body = content;
+      ctx.type = path.extname(ctx.path);
+      return;
+    }
+
     // '/robots.txt': Buffer <xx..
     // content is buffer
     if (Buffer.isBuffer(content)) {

src/config/config.default.ts

@@ -1,5 +1,5 @@
-import fs from 'node:fs';
 import path from 'node:path';
+import { pathToFileURL } from 'node:url';
 import type { EggAppInfo } from '@eggjs/core';
 import type { EggAppConfig } from '../lib/type.js';
 
@@ -189,7 +189,7 @@ export default (appInfo: EggAppInfo) => {
   /**
    * The option of `siteFile` middleware
    *
-   * You can map some files using this options, it will response immdiately when matching.
+   * You can map some files using this options, it will response immediately when matching.
    *
    * @member {Object} Config#siteFile - key is path, and value is url or buffer.
    * @property {String} cacheControl - files cache , default is public, max-age=2592000
@@ -201,7 +201,7 @@ export default (appInfo: EggAppInfo) => {
    */
   config.siteFile = {
     enable: true,
-    '/favicon.ico': fs.readFileSync(path.join(__dirname, 'favicon.png')),
+    '/favicon.ico': pathToFileURL(path.join(__dirname, 'favicon.png')),
     // default cache in 30 days
     cacheControl: 'public, max-age=2592000',
   };

src/lib/core/messenger/IMessenger.ts

@@ -50,7 +50,7 @@ export interface IMessenger extends EventEmitter {
    * @param {String} to - let master know how to send message
    * @return {Messenger} this
    */
-  send(action: string, data: unknown | undefined, to: string): IMessenger;
+  send(action: string, data: unknown | undefined, to?: string): IMessenger;
 
   close(): void;
 

src/lib/core/messenger/ipc.ts

@@ -1,4 +1,3 @@
-
 import { EventEmitter } from 'node:events';
 import { debuglog } from 'node:util';
 import workerThreads from 'node:worker_threads';
@@ -107,7 +106,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @param {String} to - let master know how to send message
    * @return {Messenger} this
    */
-  send(action: string, data: unknown | undefined, to: string): Messenger {
+  send(action: string, data: unknown | undefined, to?: string): Messenger {
     sendmessage(process, {
       action,
       data,

src/lib/core/messenger/local.ts

@@ -93,7 +93,7 @@ export class Messenger extends EventEmitter implements IMessenger {
    * @param {String} to - let master know how to send message
    * @return {Messenger} this
    */
-  send(action: string, data: unknown | undefined, to: string): Messenger {
+  send(action: string, data: unknown | undefined, to?: string): Messenger {
     // use nextTick to keep it async as IPC messenger
     process.nextTick(() => {
       const { egg } = this;

src/lib/egg.ts

@@ -144,7 +144,9 @@ export class EggApplicationCore extends EggCore {
     this.messenger.once('egg-ready', () => {
       this.lifecycle.triggerServerDidReady();
     });
-    this.load();
+    this.lifecycle.registerBeforeStart(async () => {
+      await this.load();
+    }, 'load files');
   }
 
   protected async loadConfig() {

src/lib/type.ts

@@ -327,3 +327,10 @@ export interface EggAppConfig {
 
   [prop: string]: any;
 }
+
+export type {
+  EggLogger,
+} from 'egg-logger';
+export type {
+  ILifecycleBoot,
+} from '@eggjs/core';

test/app/middleware/site_file.test.js → test/app/middleware/site_file.test.ts

@@ -1,17 +1,15 @@
-'use strict';
+import { strict as assert } from 'node:assert';
+import { createApp, type MockApplication } from '../../utils.js';
 
-const assert = require('assert');
-const utils = require('../../utils');
-
-describe('test/app/middleware/site_file.test.js', () => {
-  let app;
+describe('test/app/middleware/site_file.test.ts', () => {
+  let app: MockApplication;
   before(() => {
-    app = utils.app('apps/middlewares');
+    app = createApp('apps/middlewares');
     return app.ready();
   });
   after(() => app.close());
 
-  it('should GET /favicon.ico 200', () => {
+  it.only('should GET /favicon.ico 200', () => {
     return app.httpRequest()
       .get('/favicon.ico')
       .expect(res => assert(res.headers['content-type'].includes('icon')))
@@ -74,9 +72,9 @@ describe('test/app/middleware/site_file.test.js', () => {
   });
 
   describe('custom favicon', () => {
-    let app;
+    let app: MockApplication;
     before(() => {
-      app = utils.app('apps/favicon');
+      app = createApp('apps/favicon');
       return app.ready();
     });
     after(() => app.close());
@@ -87,15 +85,30 @@ describe('test/app/middleware/site_file.test.js', () => {
         .expect(302)
         .expect(res => {
           assert(!res.headers['set-cookie']);
-          assert(res.headers.location === 'https://eggjs.org/favicon.ico');
+          assert.equal(res.headers.location, 'https://eggjs.org/favicon.ico');
         });
     });
   });
 
+  describe('custom favicon with Buffer content', () => {
+    let app: MockApplication;
+    before(() => {
+      app = createApp('apps/favicon-buffer');
+      return app.ready();
+    });
+    after(() => app.close());
+
+    it('should redirect https://eggjs.org/favicon.ico', () => {
+      return app.httpRequest()
+        .get('/favicon.ico')
+        .expect(200);
+    });
+  });
+
   describe('custom favicon with function', () => {
-    let app;
+    let app: MockApplication;
     before(() => {
-      app = utils.app('apps/favicon-function');
+      app = createApp('apps/favicon-function');
       return app.ready();
     });
     after(() => app.close());
@@ -112,9 +125,9 @@ describe('test/app/middleware/site_file.test.js', () => {
   });
 
   describe('siteFile.cacheControl = no-store', () => {
-    let app;
+    let app: MockApplication;
     before(() => {
-      app = utils.app('apps/siteFile-custom-cacheControl');
+      app = createApp('apps/siteFile-custom-cacheControl');
       return app.ready();
     });
     after(() => app.close());

test/asyncSupport.test.ts

@@ -1,7 +1,7 @@
 import { strict as assert } from 'node:assert';
 import { createApp, restore, MockApplication } from './utils.js';
 
-describe('test/asyncSupport.test.ts', () => {
+describe.only('test/asyncSupport.test.ts', () => {
   afterEach(restore);
   let app: MockApplication;
   before(async () => {

test/fixtures/apps/app-router/app/controller/home.js

@@ -1,3 +1,3 @@
-module.exports = function* () {
+module.exports = async function () {
   this.body = 'hello';
 };

test/fixtures/apps/app-router/config/config.default.js

@@ -1,3 +1 @@
-'use strict';
-
 exports.keys = 'test key';

test/fixtures/apps/app-router/config/plugin.js

@@ -0,0 +1,5 @@
+exports.schedule = {
+  enable: false,
+};
+
+exports.logrotator = false;

test/fixtures/apps/async-app/config/plugin.js

@@ -0,0 +1,5 @@
+exports.schedule = {
+  enable: false,
+};
+
+exports.logrotator = false;

test/fixtures/apps/favicon-buffer/app/controller/home.js

@@ -0,0 +1,3 @@
+module.exports = async function() {
+  this.body = 'home';
+};

test/fixtures/apps/favicon-buffer/app/router.js

@@ -0,0 +1,3 @@
+module.exports = app => {
+  app.get('/', app.controller.home);
+};

test/fixtures/apps/favicon-buffer/config/config.default.js

@@ -0,0 +1,5 @@
+exports.siteFile = {
+  '/favicon.ico': Buffer.from('https://eggjs.org/favicon.ico'),
+}
+
+exports.keys = 'foo';

test/fixtures/apps/favicon-buffer/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "favicon-buffer"
+}

test/fixtures/apps/middlewares/app/controller/error.js

@@ -1,5 +1,3 @@
-'use strict';
-
-module.exports = function*() {
+module.exports = async function() {
   foo.bar;
 };

test/fixtures/apps/middlewares/app/controller/home.js

@@ -1,5 +1,3 @@
-'use strict';
-
-module.exports = function*() {
+module.exports = async function() {
   this.body = 'home';
 };

test/fixtures/apps/middlewares/app/router.js

@@ -1,5 +1,3 @@
-'use strict';
-
 module.exports = app => {
   app.get('/', app.controller.home);
   app.get('/error', app.controller.error);

test/fixtures/apps/middlewares/config/config.default.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const fs = require('fs');
 const path = require('path');
 

test/fixtures/apps/middlewares/config/plugin.js

@@ -0,0 +1,5 @@
+exports.schedule = {
+  enable: false,
+};
+
+exports.logrotator = false;