fix: retry finding port when port is null and get ports in sequence (#1993)

Author: evilebottnawi

lib/utils/findPort.js

@@ -1,12 +1,26 @@
 'use strict';
 
-const{ getPortPromise }=require('portfinder');
+constpRetry=require('p-retry');
+constportfinder=require('portfinder');
 constdefaultPort=require('./defaultPort');
 constdefaultTo=require('./defaultTo');
 consttryParseInt=require('./tryParseInt');
 
+functionrunPortFinder(){
+returnnewPromise((resolve,reject)=>{
+portfinder.basePort=defaultPort;
+portfinder.getPort((error,port)=>{
+if(error){
+returnreject(error);
+}
+
+returnresolve(port);
+});
+});
+}
+
 functionfindPort(port){
-if(typeofport!=='undefined'){
+if(port){
 returnPromise.resolve(port);
 }
 
@@ -19,10 +33,7 @@ function findPort(port) {
 3
 );
 
-returngetPortPromise({
-port: defaultPort,
-stopPort: defaultPort+defaultPortRetry,
-});
+returnpRetry(runPortFinder,{retries: defaultPortRetry});
 }
 
 module.exports=findPort;

package-lock.json

@@ -51,6 +51,7 @@
 "killable": "^1.0.1",
 "loglevel": "^1.6.2",
 "opn": "^5.5.0",
+"p-retry": "^3.0.1",
 "portfinder": "^1.0.20",
 "schema-utils": "^1.0.0",
 "selfsigned": "^1.10.4",

package.json

@@ -1,3 +1,3 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`findPort util should throws the error when the port isn't found 1`] =`"No open ports found in between 8080 and 8085"`;
+exports[`findPort util should throws the error when the port isn't found 1`] =`"busy"`;

test/server/utils/__snapshots__/findPort.test.js.snap

@@ -1,6 +1,7 @@
 'use strict';
 
 consthttp=require('http');
+constportfinder=require('portfinder');
 constfindPort=require('../../../lib/utils/findPort');
 
 describe('findPort util',()=>{
@@ -23,7 +24,7 @@ describe('findPort util', () => {
 });
 
 functioncreateDummyServers(n){
-return[...newArray(n)].reduce((p,_,i)=>{
+return(Array.isArray(n) ? n : [...newArray(n)]).reduce((p,_,i)=>{
 returnp.then(()=>{
 returnnewPromise((resolve)=>{
 constserver=http.createServer();
@@ -42,25 +43,88 @@ describe('findPort util', () => {
 });
 });
 
-it('should retry finding the port for up to defaultPortRetry times',()=>{
-constretryCount=5;
+it.only('should returns the port when the port is null',()=>{
+constretryCount=2;
+
+process.env.DEFAULT_PORT_RETRY=2;
+
+returncreateDummyServers(retryCount)
+.then(()=>findPort(null))
+.then((port)=>{
+expect(port).toEqual(8080+retryCount);
+});
+});
+
+it('should returns the port when the port is undefined',()=>{
+constretryCount=2;
+
+process.env.DEFAULT_PORT_RETRY=2;
+
+return(
+createDummyServers(retryCount)
+// eslint-disable-next-line no-undefined
+.then(()=>findPort(undefined))
+.then((port)=>{
+expect(port).toEqual(8080+retryCount);
+})
+);
+});
+
+it('should retry finding the port for up to defaultPortRetry times (number)',()=>{
+constretryCount=3;
 
 process.env.DEFAULT_PORT_RETRY=retryCount;
 
 returncreateDummyServers(retryCount)
-.then(findPort)
+.then(()=>findPort())
 .then((port)=>{
 expect(port).toEqual(8080+retryCount);
 });
 });
 
+it('should retry finding the port for up to defaultPortRetry times (string)',()=>{
+constretryCount=3;
+
+process.env.DEFAULT_PORT_RETRY=`${retryCount}`;
+
+returncreateDummyServers(retryCount)
+.then(()=>findPort())
+.then((port)=>{
+expect(port).toEqual(8080+retryCount);
+});
+});
+
+it('should retry finding the port when serial ports are busy',()=>{
+constbusyPorts=[8080,8081,8082,8083];
+
+process.env.DEFAULT_PORT_RETRY=3;
+
+returncreateDummyServers(busyPorts)
+.then(()=>findPort())
+.then((port)=>{
+expect(port).toEqual(8080+busyPorts.length);
+});
+});
+
 it("should throws the error when the port isn't found",()=>{
-process.env.DEFAULT_PORT_RETRY=5;
+expect.assertions(1);
+
+constspy=jest
+.spyOn(portfinder,'getPort')
+.mockImplementation((callback)=>{
+returncallback(newError('busy'));
+});
 
-returncreateDummyServers(10)
-.then(findPort)
+constretryCount=1;
+
+process.env.DEFAULT_PORT_RETRY=0;
+
+returncreateDummyServers(retryCount)
+.then(()=>findPort())
 .catch((err)=>{
 expect(err.message).toMatchSnapshot();
+
+spy.mockRestore();
 });
 });
 });