feat: add quiet option to disable logs

Author: pimlie

src/browser.js

@@ -20,7 +20,11 @@ export default class Browser extends Hookable {
 
     abstractGuard('Browser', new.target)
 
-    this.config = config
+    this.config = {
+      quiet: false,
+      ...config
+    }
+
     this.ready = false
 
     if (config.extendPage && typeof config.extendPage === 'function') {

src/utils/commands/static-server.js

@@ -24,7 +24,12 @@ export default class StaticServer {
       return
     }
 
-    browser.hook('start:before', () => StaticServer.start(browser.config.staticServer))
+    const config = {
+      quiet: browser.config.quiet,
+      ...browser.config.staticServer
+    }
+
+    browser.hook('start:before', () => StaticServer.start(config))
     browser.hook('close:after', StaticServer.stop)
   }
 
@@ -40,8 +45,10 @@ export default class StaticServer {
 
     StaticServer.server = app.listen(port, host)
 
-    // eslint-disable-next-line no-console
-    console.info(`tib: Static server started on http://${host}:${port}`)
+    if (!config.quiet) {
+      // eslint-disable-next-line no-console
+      console.info(`tib: Static server started on http://${host}:${port}`)
+    }
 
     config.host = host
     config.port = port

src/utils/commands/xvfb.js

@@ -32,7 +32,12 @@ export default class Xvfb {
       browser.config.xvfb = true
     }
 
-    browser.hook('start:before', () => Xvfb.start(typeof browser.config.xvfb === 'object' ? browser.config.xvfb : {}))
+    const config = {
+      quiet: browser.config.quiet,
+      ...browser.config.xvfb
+    }
+
+    browser.hook('start:before', () => Xvfb.start(config))
     browser.hook('close:after', Xvfb.stop)
   }
 
@@ -51,7 +56,7 @@ export default class Xvfb {
     return !!Xvfb.process && Xvfb.process.connected && !Xvfb.closed
   }
 
-  static start({ displayNum = 99, args = [] } = {}) {
+  static start({ displayNum = 99, args = [], quiet } = {}) {
     Xvfb.isSupported(true)
     Xvfb.closed = false
 
@@ -94,7 +99,9 @@ export default class Xvfb {
       if (code === 1) {
         const error = stderr.match(/\(EE\) (?!\(EE\))(.+?)$/m)[1] || stderr
         if (stderr.includes('already active for display')) {
-          console.warn(`Xvfb: ${error}`) // eslint-disable-line no-console
+          if (!quiet) {
+            console.warn(`Xvfb: ${error}`) // eslint-disable-line no-console
+          }
           return
         }
 

test/unit/command.static-server.test.js

@@ -92,6 +92,32 @@ describe('StaticServer', () => {
     expect(console.info).toHaveBeenCalled()
   })
 
+  test('should start static server but not warn when quiet', async () => {
+    jest.spyOn(console, 'info').mockImplementation(_ => _)
+
+    const use = jest.fn()
+    const listen = jest.fn()
+    StaticServer.express = jest.fn(() => ({ use, listen }))
+    StaticServer.serveStatic = jest.fn()
+
+    const staticServerConfig = {
+      quiet: true,
+      folder: 'test-folder',
+      host: 'test-host',
+      port: 667
+    }
+
+    await expect(StaticServer.start(staticServerConfig)).resolves.toBeUndefined()
+
+    expect(StaticServer.express).toHaveBeenCalled()
+    expect(use).toHaveBeenCalled()
+    expect(StaticServer.serveStatic).toHaveBeenCalledWith(staticServerConfig.folder)
+
+    expect(listen).toHaveBeenCalledWith(staticServerConfig.port, staticServerConfig.host)
+    // eslint-disable-next-line no-console
+    expect(console.info).not.toHaveBeenCalled()
+  })
+
   test('should stop static server', async () => {
     const close = jest.fn(cb => cb())
     StaticServer.server = { close }

test/unit/command.xvfb.test.js

@@ -111,7 +111,7 @@ describe('xvfb', () => {
     expect(Xvfb.isRunning()).toBe(false)
   })
 
-  test('should warn when Xvfb already running', () => {
+  test('should warn when Xvfb already running and quiet false', () => {
     jest.spyOn(os, 'platform').mockReturnValue('linux')
     const spy = jest.spyOn(console, 'warn').mockImplementation(() => {})
     jest.spyOn(cp, 'spawn').mockImplementation(() => {
@@ -142,6 +142,37 @@ Fatal server error:
     expect(Xvfb.isRunning()).toBe(false)
   })
 
+  test('should warn when Xvfb already running unless quiet', () => {
+    jest.spyOn(os, 'platform').mockReturnValue('linux')
+    const spy = jest.spyOn(console, 'warn').mockImplementation(() => {})
+    jest.spyOn(cp, 'spawn').mockImplementation(() => {
+      return {
+        connected: true,
+        on(type, fn) {
+          if (type === 'close') {
+            fn(1, 0)
+          }
+        },
+        stderr: {
+          on(type, fn) {
+            if (type === 'data') {
+              fn(`(EE)
+Fatal server error:
+(EE) Server is already active for display 99
+  If this server is no longer running, remove /tmp/.X99-lock
+  and start again.
+(EE)`)
+            }
+          }
+        }
+      }
+    })
+
+    Xvfb.start({ quiet: true })
+    expect(spy).not.toHaveBeenCalled()
+    expect(Xvfb.isRunning()).toBe(false)
+  })
+
   test('should warn when Xvfb failed to start', () => {
     jest.spyOn(os, 'platform').mockReturnValue('linux')
     jest.spyOn(cp, 'spawn').mockImplementation(() => {