refactor(network): move network utils to cli-framework

Author: imhoffd

packages/@ionic/cli-framework/src/definitions.ts

@@ -1,8 +1,12 @@
+import * as os from 'os';
+
 import * as minimistType from 'minimist';
 import { Chalk } from 'chalk';
 
 import { AliasedMap } from './utils/object';
 
+export type NetworkInterface = { device: string; } & os.NetworkInterfaceInfo;
+
 export interface Colors {
   /**
    * Used to mark text as important. Comparable to HTML's <strong>.

packages/@ionic/cli-utils/src/lib/utils/__tests__/network.ts renamed to packages/@ionic/cli-framework/src/utils/__tests__/network.ts

@@ -1,11 +1,11 @@
 import * as osSpy from 'os';
-import { getSuitableNetworkInterfaces } from '../network';
+import { getExternalIPv4Interfaces } from '../network';
 
-describe('@ionic/cli-utils', () => {
+describe('@ionic/cli-framework', () => {
 
-  describe('lib/utils/network', () => {
+  describe('utils/network', () => {
 
-    describe('getSuitableNetworkInterfaces', () => {
+    describe('getExternalIPv4Interfaces', () => {
 
       const networkInterfaces1 = {};
 
@@ -30,21 +30,21 @@ describe('@ionic/cli-utils', () => {
 
       it('should return empty array if no network interfaces', () => {
         spyOn(osSpy, 'networkInterfaces').and.callFake(() => networkInterfaces1);
-        const result = getSuitableNetworkInterfaces();
+        const result = getExternalIPv4Interfaces();
         expect(result).toEqual([]);
       });
 
       it('should return empty array if unsuitable network interfaces found', () => {
         spyOn(osSpy, 'networkInterfaces').and.callFake(() => networkInterfaces2);
-        const result = getSuitableNetworkInterfaces();
+        const result = getExternalIPv4Interfaces();
         expect(result).toEqual([]);
       });
 
       it('should find the suitable network interface', () => {
         spyOn(osSpy, 'networkInterfaces').and.callFake(() => networkInterfaces3);
-        const result = getSuitableNetworkInterfaces();
+        const result = getExternalIPv4Interfaces();
         expect(result.length).toEqual(1);
-        expect(result[0].deviceName).toEqual('eth0');
+        expect(result[0].device).toEqual('eth0');
       });
 
     });

packages/@ionic/cli-utils/src/lib/utils/network.ts renamed to packages/@ionic/cli-framework/src/utils/network.ts

@@ -1,20 +1,20 @@
 import * as os from 'os';
 import * as net from 'net';
 
-import { NetworkInterface } from '../../definitions';
+import { NetworkInterface } from '../definitions';
 
 export const ERROR_NETWORK_ADDRESS_NOT_AVAIL = 'NETWORK_ADDRESS_NOT_AVAIL';
 
-export function getSuitableNetworkInterfaces(): NetworkInterface[] {
+export function getExternalIPv4Interfaces(): NetworkInterface[] {
   const networkInterfaces = os.networkInterfaces();
   const devices: NetworkInterface[] = [];
 
-  for (const deviceName of Object.keys(networkInterfaces)) {
-    const networkInterface = networkInterfaces[deviceName];
+  for (const device of Object.keys(networkInterfaces)) {
+    const networkInterface = networkInterfaces[device];
 
     for (const networkAddress of networkInterface) {
       if (!networkAddress.internal && networkAddress.family === 'IPv4') {
-        devices.push({ deviceName, ...networkAddress });
+        devices.push({ device, ...networkAddress });
       }
     }
   }
@@ -35,8 +35,6 @@ export async function findClosestOpenPort(port: number, host?: string): Promise<
 }
 
 export async function isPortAvailable(port: number, host?: string): Promise<boolean> {
-  const net = await import('net');
-
   return new Promise<boolean>((resolve, reject) => {
     const tester = net.createServer()
       .once('error', (err: any) => {

packages/@ionic/cli-utils/src/definitions.ts

@@ -1,5 +1,4 @@
 import * as fs from 'fs';
-import * as os from 'os';
 
 import * as crossSpawnType from 'cross-spawn';
 import * as inquirerType from 'inquirer';
@@ -645,7 +644,7 @@ export interface ServeDetails {
   localAddress: string;
   externalAddress: string;
   port: number;
-  externalNetworkInterfaces: NetworkInterface[];
+  externalNetworkInterfaces: framework.NetworkInterface[];
   externallyAccessible: boolean;
 }
 
@@ -836,8 +835,6 @@ export interface ResolvedStarterTemplate extends StarterTemplate {
   archive: string;
 }
 
-export type NetworkInterface = { deviceName: string; } & os.NetworkInterfaceInfo;
-
 export interface IPCMessage {
   type: 'telemetry';
   data: { command: string; args: string[]; };

packages/@ionic/cli-utils/src/lib/project/angular/serve.ts

@@ -9,6 +9,7 @@ import * as split2 from 'split2';
 import { ParsedArgs, unparseArgs } from '@ionic/cli-framework';
 import { onBeforeExit } from '@ionic/cli-framework/utils/process';
 import { pathAccessible } from '@ionic/cli-framework/utils/fs';
+import { findClosestOpenPort, isHostConnectable } from '@ionic/cli-framework/utils/network';
 
 import { AngularServeOptions, CommandLineInputs, CommandLineOptions, CommandMetadata, ServeDetails } from '../../../definitions';
 import { OptionGroup } from '../../../constants';
@@ -97,13 +98,9 @@ ${chalk.cyan('[2]')}: ${chalk.bold('https://github.com/angular/angular-cli/wiki/
   }
 
   async serveProject(options: AngularServeOptions): Promise<ServeDetails> {
-    const { findClosestOpenPort, isHostConnectable } = await import('../../utils/network');
     const [ externalIP, availableInterfaces ] = await this.selectExternalIP(options);
 
-    debug('finding closest port to %d', options.port);
-    const ngPort = await findClosestOpenPort(options.port, '0.0.0.0');
-    options.port = ngPort;
-
+    const ngPort = options.port = await findClosestOpenPort(options.port, '0.0.0.0');
     const { program } = await this.serveCommandWrapper(options);
 
     debug('waiting for connectivity with ng serve (%dms timeout)', NG_SERVE_CONNECTIVITY_TIMEOUT);

packages/@ionic/cli-utils/src/lib/project/common.ts

@@ -1,5 +1,6 @@
 import chalk from 'chalk';
 import * as Debug from 'debug';
+import { ERROR_NETWORK_ADDRESS_NOT_AVAIL, findClosestOpenPort } from '@ionic/cli-framework/utils/network';
 
 import { FatalException } from '../errors';
 
@@ -18,8 +19,6 @@ export interface Ports {
  * "dev logger" server.
  */
 export async function findOpenIonicPorts(address: string, ports: Ports): Promise<Ports> {
-  const { ERROR_NETWORK_ADDRESS_NOT_AVAIL, findClosestOpenPort } = await import('../utils/network');
-
   try {
     const [ port, livereloadPort, notificationPort ] = await Promise.all([
       findClosestOpenPort(ports.port, '0.0.0.0'),

packages/@ionic/cli-utils/src/lib/project/ionic-angular/serve.ts

@@ -6,6 +6,7 @@ import * as split2 from 'split2';
 import { ParsedArgs, unparseArgs } from '@ionic/cli-framework';
 import { onBeforeExit } from '@ionic/cli-framework/utils/process';
 import { str2num } from '@ionic/cli-framework/utils/string';
+import { isHostConnectable } from '@ionic/cli-framework/utils/network';
 
 import { CommandLineInputs, CommandLineOptions, CommandMetadata, IonicAngularServeOptions, ServeDetails } from '../../../definitions';
 import { OptionGroup } from '../../../constants';
@@ -76,7 +77,6 @@ export class ServeRunner extends BaseServeRunner<IonicAngularServeOptions> {
   }
 
   async serveProject(options: IonicAngularServeOptions): Promise<ServeDetails> {
-    const { isHostConnectable } = await import('../../utils/network');
     const [ externalIP, availableInterfaces ] = await this.selectExternalIP(options);
     const { port, livereloadPort, notificationPort } = await findOpenIonicPorts(options.address, options);
 

packages/@ionic/cli-utils/src/lib/project/ionic1/serve.ts

@@ -9,6 +9,7 @@ import * as proxyMiddlewareType from 'http-proxy-middleware'; // tslint:disable-
 
 import { onBeforeExit } from '@ionic/cli-framework/utils/process';
 import { str2num } from '@ionic/cli-framework/utils/string';
+import { isHostConnectable } from '@ionic/cli-framework/utils/network';
 
 import { CommandLineInputs, CommandLineOptions, CommandMetadata, Ionic1ServeOptions, ProjectFileProxy, ServeDetails } from '../../../definitions';
 import { OptionGroup } from '../../../constants';
@@ -108,7 +109,6 @@ export class ServeRunner extends BaseServeRunner<Ionic1ServeOptions> {
   }
 
   async serveProject(options: Ionic1ServeOptions): Promise<ServeDetails> {
-    const { isHostConnectable } = await import('../../utils/network');
     const [ externalIP, availableInterfaces ] = await this.selectExternalIP(options);
     const { port, livereloadPort, notificationPort } = await findOpenIonicPorts(options.address, options);
 

packages/@ionic/cli-utils/src/lib/serve.ts

@@ -7,12 +7,14 @@ import * as lodash from 'lodash';
 import * as through2 from 'through2';
 import * as split2 from 'split2';
 
+import { NetworkInterface } from '@ionic/cli-framework';
 import { BaseError } from '@ionic/cli-framework/lib/errors';
 import { onBeforeExit } from '@ionic/cli-framework/utils/process';
 import { str2num } from '@ionic/cli-framework/utils/string';
 import { fsReadJsonFile } from '@ionic/cli-framework/utils/fs';
+import { findClosestOpenPort, getExternalIPv4Interfaces } from '@ionic/cli-framework/utils/network';
 
-import { CommandLineInputs, CommandLineOptions, CommandMetadata, CommandMetadataOption, DevAppDetails, IConfig, ILogger, IProject, IShell, IonicEnvironment, LabServeDetails, NetworkInterface, ProjectType, PromptModule, ServeDetails, ServeOptions } from '../definitions';
+import { CommandLineInputs, CommandLineOptions, CommandMetadata, CommandMetadataOption, DevAppDetails, IConfig, ILogger, IProject, IShell, IonicEnvironment, LabServeDetails, ProjectType, PromptModule, ServeDetails, ServeOptions } from '../definitions';
 import { isCordovaPackageJson } from '../guards';
 import { ASSETS_DIRECTORY, OptionGroup, PROJECT_FILE } from '../constants';
 import { FatalException, RunnerException, RunnerNotFoundException } from './errors';
@@ -250,30 +252,23 @@ export abstract class ServeRunner<T extends ServeOptions> extends Runner<T, Serv
   }
 
   async gatherDevAppDetails(options: T, details: ServeDetails): Promise<DevAppDetails | undefined> {
-    const { findClosestOpenPort } = await import('./utils/network');
-
     if (options.devapp) {
-      const { getSuitableNetworkInterfaces } = await import('./utils/network');
       const { computeBroadcastAddress } = await import('./devapp');
 
-      const availableInterfaces = getSuitableNetworkInterfaces();
-
       // TODO: There is no accurate/reliable/realistic way to identify a WiFi
       // network uniquely in NodeJS. But this is where we could detect new
       // networks and prompt the dev if they want to "trust" it (allow binding to
       // 0.0.0.0 and broadcasting).
 
-      const interfaces = availableInterfaces
-        .map(i => ({
-          ...i,
-          broadcast: computeBroadcastAddress(i.address, i.netmask),
-        }));
-
-      return {
-        port: details.port,
-        commPort: await findClosestOpenPort(DEFAULT_DEVAPP_COMM_PORT, '0.0.0.0'),
-        interfaces,
-      };
+      const interfaces = getExternalIPv4Interfaces()
+        .map(i => ({ ...i, broadcast: computeBroadcastAddress(i.address, i.netmask) }));
+
+      const { port } = details;
+
+      // the comm server always binds to 0.0.0.0 to target every possible interface
+      const commPort = await findClosestOpenPort(DEFAULT_DEVAPP_COMM_PORT, '0.0.0.0');
+
+      return { port, commPort, interfaces };
     }
   }
 
@@ -336,8 +331,6 @@ export abstract class ServeRunner<T extends ServeOptions> extends Runner<T, Serv
   }
 
   async runLab(options: T, details: ServeDetails): Promise<LabServeDetails> {
-    const { findClosestOpenPort } = await import('./utils/network');
-
     const labDetails: LabServeDetails = {
       protocol: options.ssl ? 'https' : 'http',
       address: options.labHost,
@@ -445,13 +438,11 @@ export abstract class ServeRunner<T extends ServeOptions> extends Runner<T, Serv
   }
 
   async selectExternalIP(options: T): Promise<[string, NetworkInterface[]]> {
-    const { getSuitableNetworkInterfaces } = await import('./utils/network');
-
     let availableInterfaces: NetworkInterface[] = [];
     let chosenIP = options.address;
 
     if (options.address === BIND_ALL_ADDRESS) {
-      availableInterfaces = getSuitableNetworkInterfaces();
+      availableInterfaces = getExternalIPv4Interfaces();
 
       if (availableInterfaces.length === 0) {
         if (options.externalAddressRequired) {
@@ -475,7 +466,7 @@ export abstract class ServeRunner<T extends ServeOptions> extends Runner<T, Serv
             name: 'promptedIp',
             message: 'Please select which IP to use:',
             choices: availableInterfaces.map(i => ({
-              name: `${i.address} ${chalk.dim(`(${i.deviceName})`)}`,
+              name: `${i.address} ${chalk.dim(`(${i.device})`)}`,
               value: i.address,
             })),
           });