feat: Expanded .percy.yml configuration support (#257)

* add page pool size to constants

* add page pool size to asset discovery options

* add agent configuration to .percy.yml test file

* refactored how we handle constants. Moved them to be in with the services they are for. Started to add asset discovery options from the configuration file

* assert that asset discovery configuration values make it through

* refactor agent configuration

* cleanup

* further refactoring configuration handling

* refactor away default configuration values from the ConfigurationService

* expand test coverage for ConfigurationService

* default min height should be 1024

* actually set the default file value

* set page pool size to ideal values learned through some performance testing

* remove console.log

* shift type packages to devDependencies

package.json

@@ -22,14 +22,12 @@
     "@oclif/config": "^1",
     "@oclif/plugin-help": "^2",
     "@oclif/plugin-not-found": "^1.2",
-    "@types/express": "^4.16.0",
-    "@types/js-yaml": "^3.11.2",
-    "@types/puppeteer": "^1.6.0",
     "axios": "^0.18.1",
     "body-parser": "^1.18.3",
     "colors": "^1.3.2",
     "cors": "^2.8.4",
     "cross-spawn": "^6.0.5",
+    "deepmerge": "^3.2.1",
     "express": "^4.16.3",
     "generic-pool": "^3.7.1",
     "globby": "^9.2.0",
@@ -54,13 +52,18 @@
     "@types/chai": "^4.1.4",
     "@types/chai-http": "^3.0.5",
     "@types/cheerio": "^0.22.11",
+    "@types/colors": "^1.2.1",
     "@types/cors": "^2.8.4",
+    "@types/deepmerge": "^2.2.0",
+    "@types/express": "^4.16.0",
     "@types/cross-spawn": "^6.0.0",
     "@types/generic-pool": "^3.1.9",
     "@types/http-server": "^0.10.0",
+    "@types/js-yaml": "^3.11.2",
     "@types/mocha": "^5.2.5",
     "@types/nock": "^10.0.2",
     "@types/node": "^12.0.0",
+    "@types/puppeteer": "^1.6.0",
     "@types/sinon": "^7.0.12",
     "@types/sinon-chai": "^3.2.0",
     "babel-loader": "^8.0.6",

src/commands/exec.ts

@@ -1,6 +1,7 @@
 import {flags} from '@oclif/command'
 import * as spawn from 'cross-spawn'
-import Constants from '../services/constants'
+import { DEFAULT_CONFIGURATION } from '../configuration/configuration'
+import ConfigurationService from '../services/configuration-service'
 import PercyCommand from './percy-command'
 
 export default class Exec extends PercyCommand {
@@ -16,12 +17,12 @@ export default class Exec extends PercyCommand {
   static flags = {
     'network-idle-timeout': flags.integer({
       char: 't',
-      default: Constants.NETWORK_IDLE_TIMEOUT,
+      default: DEFAULT_CONFIGURATION.agent['asset-discovery']['network-idle-timeout'],
       description: 'asset discovery network idle timeout (in milliseconds)',
     }),
     'port': flags.integer({
       char: 'p',
-      default: Constants.PORT,
+      default: DEFAULT_CONFIGURATION.agent.port,
       description: 'port',
     }),
   }
@@ -32,8 +33,6 @@ export default class Exec extends PercyCommand {
     const {argv} = this.parse(Exec)
     const {flags} = this.parse(Exec)
 
-    const port = flags.port as number
-    const networkIdleTimeout = flags['network-idle-timeout'] as number
     const command = argv.shift()
 
     if (!command) {
@@ -44,7 +43,8 @@ export default class Exec extends PercyCommand {
     }
 
     if (this.percyWillRun()) {
-      await this.agentService.start({port, networkIdleTimeout})
+      const configuration = new ConfigurationService().applyFlags(flags)
+      await this.agentService.start(configuration)
       this.logStart()
     }
 

src/commands/health-check.ts

@@ -1,6 +1,5 @@
 import {Command, flags} from '@oclif/command'
-import * as colors from 'colors'
-import Constants from '../services/constants'
+import {DEFAULT_CONFIGURATION} from '../configuration/configuration'
 import healthCheck from '../utils/health-checker'
 
 export default class HealthCheck extends Command {
@@ -10,7 +9,7 @@ export default class HealthCheck extends Command {
   static flags = {
     port: flags.integer({
       char: 'p',
-      default: Constants.PORT,
+      default: DEFAULT_CONFIGURATION.agent.port,
       description: 'port',
     }),
   }

src/commands/percy-command.ts

@@ -1,6 +1,6 @@
 import {Command} from '@oclif/command'
 import * as winston from 'winston'
-import AgentService from '../services/agent-service'
+import {AgentService} from '../services/agent-service'
 import ProcessService from '../services/process-service'
 import logger from '../utils/logger'