feat: add random free port (midwayjs#4371)

* feat: support random port

* fix: lint

* fix: cycle dep

Author: czy88840616

packages/web-express/src/framework.ts

@@ -29,7 +29,7 @@ import {
   MidwayExpressMiddlewareService,
 } from './middlewareService';
 import { debuglog } from 'util';
-import { sendData } from './util';
+import { getFreePort, sendData } from './util';
 const debug = debuglog('midway:debug');
 
 @Framework()
@@ -189,8 +189,13 @@ export class MidwayExpressFramework extends BaseFramework<
     // register httpServer to applicationContext
     this.applicationContext.registerObject(HTTP_SERVER_KEY, this.server);
 
-    const customPort =
+    let customPort =
       process.env.MIDWAY_HTTP_PORT ?? this.configurationOptions.port;
+
+    if (customPort === 0) {
+      customPort = await getFreePort();
+    }
+
     if (customPort) {
       new Promise<void>(resolve => {
         const args: any[] = [customPort];
@@ -391,7 +396,7 @@ export class MidwayExpressFramework extends BaseFramework<
     return this.server;
   }
 
-  public getPort() {
+  public getPort(): string {
     return process.env.MIDWAY_HTTP_PORT;
   }
 

packages/web-express/src/util.ts

@@ -1,7 +1,24 @@
+import { AddressInfo, createServer } from 'net';
+
 export function sendData(res, data) {
   if (typeof data === 'number') {
     res.status(res.statusCode).send('' + data);
   } else {
     res.status(res.statusCode).send(data);
   }
 }
+
+export async function getFreePort() {
+  return new Promise<number>((resolve, reject) => {
+    const server = createServer();
+    server.listen(0, () => {
+      try {
+        const port = (server.address() as AddressInfo).port;
+        server.close();
+        resolve(port);
+      } catch (err) {
+        reject(err);
+      }
+    });
+  });
+}

packages/web-express/test/index.test.ts

@@ -1,5 +1,5 @@
 import { closeApp, creatApp, createHttpRequest } from './utils';
-import { IMidwayExpressApplication, MidwayExpressMiddlewareService } from '../src';
+import { IMidwayExpressApplication, MidwayExpressMiddlewareService, Framework } from '../src';
 import { createLightApp } from '@midwayjs/mock';
 
 describe('/test/feature.test.ts', () => {
@@ -336,4 +336,21 @@ describe('/test/feature.test.ts', () => {
     expect(result.status).toEqual(403);
     await closeApp(app);
   });
+
+  it('should test get free port', async () => {
+    const app = await createLightApp('', {
+      imports: require('../src'),
+      globalConfig: {
+        keys: '12345',
+        express: {
+          port: 0,
+        }
+      }
+    });
+
+    const port = (app.getFramework() as Framework).getPort();
+    expect(port).not.toBe('0');
+    console.log(process.env.MIDWAY_HTTP_PORT);
+    await closeApp(app);
+  });
 });

packages/web-koa/src/framework.ts

@@ -29,6 +29,7 @@ import { Server } from 'http';
 import { setupOnError } from './onerror';
 import * as qs from 'qs';
 import * as querystring from 'querystring';
+import { getFreePort } from './utils';
 
 const COOKIES = Symbol('context#cookies');
 
@@ -312,8 +313,13 @@ export class MidwayKoaFramework extends BaseFramework<
     }
 
     // set port and listen server
-    const customPort =
+    let customPort =
       process.env.MIDWAY_HTTP_PORT ?? this.configurationOptions.port;
+
+    if (customPort === 0) {
+      customPort = await getFreePort();
+    }
+
     if (customPort) {
       new Promise<void>(resolve => {
         const args: any[] = [customPort];
@@ -349,7 +355,7 @@ export class MidwayKoaFramework extends BaseFramework<
     return this.server;
   }
 
-  public getPort() {
+  public getPort(): string {
     return process.env.MIDWAY_HTTP_PORT;
   }
 

packages/web-koa/src/utils.ts

@@ -1,3 +1,5 @@
+import { AddressInfo, createServer } from 'net';
+
 export function detectStatus(err) {
   // detect status
   let status = err.status || 500;
@@ -160,3 +162,18 @@ export function escapeHtml(string) {
 
   return lastIndex !== index ? html + str.substring(lastIndex, index) : html;
 }
+
+export async function getFreePort() {
+  return new Promise<number>((resolve, reject) => {
+    const server = createServer();
+    server.listen(0, () => {
+      try {
+        const port = (server.address() as AddressInfo).port;
+        server.close();
+        resolve(port);
+      } catch (err) {
+        reject(err);
+      }
+    });
+  });
+}

packages/web-koa/test/index.test.ts

@@ -1,5 +1,5 @@
 import { closeApp, creatApp, createHttpRequest } from './utils';
-import { IMidwayKoaApplication } from '../src';
+import { IMidwayKoaApplication, Framework } from '../src';
 import { Controller, Get, makeHttpRequest } from '@midwayjs/core';
 import { createLightApp } from '@midwayjs/mock';
 
@@ -481,6 +481,25 @@ describe('/test/feature.test.ts', () => {
     await closeApp(app);
   });
 
+  it('should test get random port', async () => {
+    const app = await createLightApp('', {
+      imports: [
+        require('../src'),
+      ],
+      globalConfig: {
+        keys: '123',
+        koa: {
+          port: 0,
+        }
+      }
+    });
+
+    const port = (app.getFramework() as Framework).getPort();
+    expect(port).not.toBe('0');
+
+    await closeApp(app);
+  });
+
   describe('test query parser', () => {
     @Controller()
     class HomeController {

packages/web/src/framework/web.ts

@@ -23,6 +23,7 @@ import { loggers, MidwayContextLogger } from '@midwayjs/logger';
 import { resolve } from 'path';
 import { Server } from 'net';
 import { debuglog } from 'util';
+import { AddressInfo, createServer } from 'net';
 
 const debug = debuglog('midway:debug');
 
@@ -274,7 +275,12 @@ export class MidwayWebFramework extends BaseFramework<
 
       const eggConfig = this.configService.getConfiguration('egg');
       if (!this.isClusterMode && eggConfig) {
-        const customPort = process.env.MIDWAY_HTTP_PORT ?? eggConfig.port;
+        let customPort = process.env.MIDWAY_HTTP_PORT ?? eggConfig.port;
+
+        if (customPort === 0) {
+          customPort = await getFreePort();
+        }
+
         if (customPort) {
           new Promise<void>(resolve => {
             const args: any[] = [customPort];
@@ -333,3 +339,18 @@ export class MidwayWebFramework extends BaseFramework<
     this.server = server;
   }
 }
+
+async function getFreePort() {
+  return new Promise<number>((resolve, reject) => {
+    const server = createServer();
+    server.listen(0, () => {
+      try {
+        const port = (server.address() as AddressInfo).port;
+        server.close();
+        resolve(port);
+      } catch (err) {
+        reject(err);
+      }
+    });
+  });
+}