Check version information before runnning dev phone

package.json

@@ -17,6 +17,9 @@
     "phone",
     "twilio"
   ],
+  "engines": {
+    "twilio": ">=4.0.0"
+  },
   "author": "Twilio @twilio",
   "license": "MIT",
   "bugs": {

packages/plugin-dev-phone/package.json

@@ -14,13 +14,15 @@
     "@twilio/cli-core": "^6.0.0",
     "express": "^4.17.1",
     "get-port": "^5.1.1",
-    "open": "^8.4.0"
+    "open": "^8.4.0",
+    "semver": "^7.3.7"
   },
   "devDependencies": {
     "@oclif/dev-cli": "^1.22.2",
     "@oclif/test": "^1.2.5",
     "@twilio/cli-test": "^2.1.0",
     "@types/express": "^4.17.13",
+    "@types/semver": "^7.3.12",
     "chai": "^4.2.0",
     "eslint": "^8.3.0",
     "eslint-config-oclif": "^3.1.0",
@@ -33,7 +35,8 @@
     "typescript": "^4.6.2"
   },
   "engines": {
-    "node": ">=10.0.0"
+    "node": ">=10.0.0",
+    "twilio": ">=4.0.0"
   },
   "files": [
     "/oclif.manifest.json",

packages/plugin-dev-phone/src/commands/dev-phone.ts

@@ -5,12 +5,12 @@ import express from 'express';
 
 import { flags } from '@oclif/command';
 import { deployServerless, constants } from '../utils/create-serverless-util';
-import { getAvailablePort, isValidPort } from '../utils/helpers'
+import { getAvailablePort, isValidPort, meetsRequiredVersion } from '../utils/helpers'
 import { isSmsUrlSet, isVoiceUrlSet } from '../utils/phone-number-utils';
 const { TwilioClientCommand } = require('@twilio/cli-core').baseCommands;
 const { TwilioCliError } = require('@twilio/cli-core').services.error;
 const WebClientPath = path.resolve(require.resolve('@twilio-labs/dev-phone-ui'), '..')
-const { version } = require('../../package.json');
+const { engines, version } = require('../../package.json');
 
 // Types
 import { ServiceInstance as ServerlessServiceInstance } from 'twilio/lib/rest/serverless/v1/service'
@@ -57,6 +57,10 @@ class DevPhoneServer extends TwilioClientCommand {
     async run() {
         await super.run();
 
+        if(!meetsRequiredVersion(this.config.version, engines.twilio)) {
+            throw new TwilioCliError(`You're using Twilio CLI version ${this.config.version}. Please update your Twilio CLI to a version ${engines.twilio}. You can find instructions here: https://www.twilio.com/docs/twilio-cli/getting-started/install`)
+        }
+
         const props = this.parseProperties() || {};
         await this.validatePropsAndFlags(props, this.flags)
 

packages/plugin-dev-phone/src/utils/helpers.ts

@@ -1,4 +1,5 @@
 import getPort from 'get-port'
+import semver from 'semver'
 
 export function isValidPort (port:string) {
     const portRegex = /^((6553[0-5])|(655[0-2][0-9])|(65[0-4][0-9]{2})|(6[0-4][0-9]{3})|([1-5][0-9]{4})|([0-5]{0,5})|([0-9]{1,4}))$/gi;
@@ -8,4 +9,17 @@ export function isValidPort (port:string) {
 export async function getAvailablePort() {
     const availablePort = await getPort({port: [1337, 3000, 3001, 8000, 8080]})
     return availablePort
+}
+
+// Checks whether an actual version meets some requirement
+export function meetsRequiredVersion (actual: string, requirement: string) {
+    // ensure that the strings passed are actually valid semver values
+    const coercedActual = semver.coerce(actual)
+    const coercedRequirement = semver.coerce(requirement)
+    if (semver.valid(coercedActual) && semver.valid(coercedRequirement)) {
+        // @ts-ignore
+        return semver.gt(coercedActual, coercedRequirement) 
+    }
+
+    return false
 }