Allow to specify Tideflow URL via cli

Author: Jose Constela

README.md

@@ -16,11 +16,12 @@ npm i -g @tideflowio/tideflow-agent
     Usage: index [options]
 
     Options:
-      -v, --version                          output the version number
-      -c, --concurrency [concurrency]        Max number of jobs the agent should process concurrently
-      -t, --token [token]                    Authentication token
-      --noupdate                             Opt-out of update version check
-      -h, --help                             output usage information
+      -v, --version                       output the version number
+      -c, --concurrency [concurrency]     Max number of jobs the agent should process concurrently
+      -t, --token [token]                 Authentication token
+      -u, --url [url]                     Tideflow url
+      --noupdate                          Opt-out of update version check
+      -h, --help                          output usage information
 
     Examples:
       $ tideflow-agent --help
@@ -29,14 +30,14 @@ npm i -g @tideflowio/tideflow-agent
 You can also run the agent without installing it, via npx.
 
 ```bash
-npx @tideflowio/tideflow-agent -t [token]
+npx @tideflowio/tideflow-agent -t [token] -u tideflow.example.com
 ```
 
 ## Environment variables
 
 ```bash
 # Specify the URL to connect to the Tideflow's platform.
-# Optional. Defaults to localhost:1337
+# Optional. Defaults to localhost:1337 if no -u parameter set
 # Example: http://subdomain.example.com:1337
 TF_AGENT_URL
 ```

agent.js

@@ -1,6 +1,7 @@
 const pjson = require('./package.json')
 const io = require('socket.io-client')
 const colors = require('colors')
+const url = require('url')
 const pretty = require('./helpers/pretty')
 const runner = require('./runner')
 const os = require('os')
@@ -20,12 +21,16 @@ module.exports.exec = (program) => {
 
   let agent = {}
 
+  const URL = program.url || process.env.TF_AGENT_URL || 'http://localhost:1337'
+
+  const parse = url.parse(URL)
+  if (!parse.hostname) { throw new Error(`"${URL}" is not a valid url`) }
+
   // Shows welcome messages
-  console.log(pretty.logo())
+  console.log(pretty.logo(pjson))
   console.log(` || Tideflow.io - agent ${pjson.version}`.blue)
   console.log(` || Using ${concurrency} as concurrency`.yellow)
-
-  const URL = process.env.TF_AGENT_URL || 'http://localhost:1337'
+  console.log(` || Target URL ${URL}`.yellow)
 
   const socket = io(`${URL}?token=${program.token}`)
 

helpers/pretty.js

@@ -1,11 +1,11 @@
 /**
  * Returns a pretty logo for terminal
  */
-module.exports.logo = () => {
+module.exports.logo = (pjson) => {
   return `                                       
   _   _   _     ___ _             _     
  | |_|_|_| |___|  _| |___ _ _ _  |_|___ 
  |  _| | . | -_|  _| | . | | | |_| | . |
- |_| |_|___|___|_| |_|___|_____|_|_|___|
+ |_| |_|___|___|_| |_|___|_____|_|_|___| ${pjson.version}
                                         `
 }

index.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 'use strict'
 const program = require('commander')
+const url = require('url')
 const os = require('os')
 const pkg = require('./package.json')
 
@@ -15,6 +16,11 @@ program
   .option('-t, --token [token]', 'Authentication token', (v) => {
     return v || process.env.TIDEFLOWIO_AGENT_TOKEN
   })
+  .option('-u, --url [url]', 'Tideflow url', (v) => {
+    const parse = url.parse(v)
+    if (!parse.hostname) { throw new Error(`"${URL}" is not a valid url`) }
+    return v
+  })
   .option('--noupdate', 'Opt-out of update version check')
 
 // must be before .parse() since
@@ -23,7 +29,7 @@ program
 program.on('--help', function(){
   console.log('')
   console.log('Examples:')
-  console.log('  $ tideflow-agent -t agent-auth-token')
+  console.log('  $ tideflow-agent -u http://mytideflow.example.com -t agent-auth-token')
   console.log('  $ tideflow-agent -c 16 -t agent-auth-token')
   console.log('  $ tideflow-agent --help')
   console.log('  $ tideflow-agent -h')

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tideflowio/tideflow-agent",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Tideflow.io's agent",
   "main": "index.js",
   "keywords": [