index.js 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. var fs = require('fs')
  2. var path = require('path')
  3. var which = require('which')
  4. function isJSFlags (flag) {
  5. return flag.indexOf('--js-flags=') === 0
  6. }
  7. function sanitizeJSFlags (flag) {
  8. var test = /--js-flags=(['"])/.exec(flag)
  9. if (!test) {
  10. return flag
  11. }
  12. var escapeChar = test[1]
  13. var endExp = new RegExp(escapeChar + '$')
  14. var startExp = new RegExp('--js-flags=' + escapeChar)
  15. return flag.replace(startExp, '--js-flags=').replace(endExp, '')
  16. }
  17. var ChromeBrowser = function (baseBrowserDecorator, args) {
  18. baseBrowserDecorator(this)
  19. var flags = args.flags || []
  20. var userDataDir = args.chromeDataDir || this._tempDir
  21. this._getOptions = function (url) {
  22. // Chrome CLI options
  23. // http://peter.sh/experiments/chromium-command-line-switches/
  24. flags.forEach(function (flag, i) {
  25. if (isJSFlags(flag)) {
  26. flags[i] = sanitizeJSFlags(flag)
  27. }
  28. })
  29. return [
  30. '--user-data-dir=' + userDataDir,
  31. // https://github.com/GoogleChrome/chrome-launcher/blob/master/docs/chrome-flags-for-tools.md#--enable-automation
  32. '--enable-automation',
  33. '--no-default-browser-check',
  34. '--no-first-run',
  35. '--disable-default-apps',
  36. '--disable-popup-blocking',
  37. '--disable-translate',
  38. '--disable-background-timer-throttling',
  39. // on macOS, disable-background-timer-throttling is not enough
  40. // and we need disable-renderer-backgrounding too
  41. // see https://github.com/karma-runner/karma-chrome-launcher/issues/123
  42. '--disable-renderer-backgrounding',
  43. '--disable-device-discovery-notifications'
  44. ].concat(flags, [url])
  45. }
  46. }
  47. // Return location of chrome.exe file for a given Chrome directory (available: "Chrome", "Chrome SxS").
  48. function getChromeExe (chromeDirName) {
  49. // Only run these checks on win32
  50. if (process.platform !== 'win32') {
  51. return null
  52. }
  53. var windowsChromeDirectory, i, prefix
  54. var suffix = '\\Google\\' + chromeDirName + '\\Application\\chrome.exe'
  55. var prefixes = [process.env.LOCALAPPDATA, process.env.PROGRAMFILES, process.env['PROGRAMFILES(X86)']]
  56. for (i = 0; i < prefixes.length; i++) {
  57. prefix = prefixes[i]
  58. try {
  59. windowsChromeDirectory = path.join(prefix, suffix)
  60. fs.accessSync(windowsChromeDirectory)
  61. return windowsChromeDirectory
  62. } catch (e) {}
  63. }
  64. return windowsChromeDirectory
  65. }
  66. var ChromiumBrowser = function (baseBrowserDecorator, args) {
  67. baseBrowserDecorator(this)
  68. var flags = args.flags || []
  69. var userDataDir = args.chromeDataDir || this._tempDir
  70. this._getOptions = function (url) {
  71. // Chromium CLI options
  72. // http://peter.sh/experiments/chromium-command-line-switches/
  73. flags.forEach(function (flag, i) {
  74. if (isJSFlags(flag)) {
  75. flags[i] = sanitizeJSFlags(flag)
  76. }
  77. })
  78. return [
  79. '--user-data-dir=' + userDataDir,
  80. '--no-default-browser-check',
  81. '--no-first-run',
  82. '--disable-default-apps',
  83. '--disable-popup-blocking',
  84. '--disable-translate',
  85. '--disable-background-timer-throttling'
  86. ].concat(flags, [url])
  87. }
  88. }
  89. // Return location of Chromium's chrome.exe file.
  90. function getChromiumExe (chromeDirName) {
  91. // Only run these checks on win32
  92. if (process.platform !== 'win32') {
  93. return null
  94. }
  95. var windowsChromiumDirectory, i, prefix
  96. var suffix = '\\Chromium\\Application\\chrome.exe'
  97. var prefixes = [process.env.LOCALAPPDATA, process.env.PROGRAMFILES, process.env['PROGRAMFILES(X86)']]
  98. for (i = 0; i < prefixes.length; i++) {
  99. prefix = prefixes[i]
  100. try {
  101. windowsChromiumDirectory = path.join(prefix, suffix)
  102. fs.accessSync(windowsChromiumDirectory)
  103. return windowsChromiumDirectory
  104. } catch (e) {}
  105. }
  106. return windowsChromiumDirectory
  107. }
  108. function getBin (commands) {
  109. // Don't run these checks on win32
  110. if (process.platform !== 'linux') {
  111. return null
  112. }
  113. var bin, i
  114. for (i = 0; i < commands.length; i++) {
  115. try {
  116. if (which.sync(commands[i])) {
  117. bin = commands[i]
  118. break
  119. }
  120. } catch (e) {}
  121. }
  122. return bin
  123. }
  124. function getChromeDarwin (defaultPath) {
  125. if (process.platform !== 'darwin') {
  126. return null
  127. }
  128. try {
  129. var homePath = path.join(process.env.HOME, defaultPath)
  130. fs.accessSync(homePath)
  131. return homePath
  132. } catch (e) {
  133. return defaultPath
  134. }
  135. }
  136. ChromeBrowser.prototype = {
  137. name: 'Chrome',
  138. DEFAULT_CMD: {
  139. linux: getBin(['google-chrome', 'google-chrome-stable']),
  140. darwin: getChromeDarwin('/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'),
  141. win32: getChromeExe('Chrome')
  142. },
  143. ENV_CMD: 'CHROME_BIN'
  144. }
  145. ChromeBrowser.$inject = ['baseBrowserDecorator', 'args']
  146. function headlessGetOptions (url, args, parent) {
  147. var mergedArgs = parent.call(this, url, args).concat([
  148. '--headless',
  149. '--disable-gpu',
  150. '--disable-dev-shm-usage'
  151. ])
  152. var isRemoteDebuggingFlag = function (flag) {
  153. return flag.indexOf('--remote-debugging-port=') !== -1
  154. }
  155. return mergedArgs.some(isRemoteDebuggingFlag)
  156. ? mergedArgs
  157. : mergedArgs.concat(['--remote-debugging-port=9222'])
  158. }
  159. var ChromeHeadlessBrowser = function (baseBrowserDecorator, args) {
  160. ChromeBrowser.apply(this, arguments)
  161. var parentOptions = this._getOptions
  162. this._getOptions = function (url) {
  163. return headlessGetOptions.call(this, url, args, parentOptions)
  164. }
  165. }
  166. ChromeHeadlessBrowser.prototype = {
  167. name: 'ChromeHeadless',
  168. DEFAULT_CMD: {
  169. linux: getBin(['google-chrome', 'google-chrome-stable']),
  170. darwin: getChromeDarwin('/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'),
  171. win32: getChromeExe('Chrome')
  172. },
  173. ENV_CMD: 'CHROME_BIN'
  174. }
  175. ChromeHeadlessBrowser.$inject = ['baseBrowserDecorator', 'args']
  176. function canaryGetOptions (url, args, parent) {
  177. // disable crankshaft optimizations, as it causes lot of memory leaks (as of Chrome 23.0)
  178. var flags = args.flags || []
  179. var augmentedFlags
  180. var customFlags = '--nocrankshaft --noopt'
  181. flags.forEach(function (flag) {
  182. if (isJSFlags(flag)) {
  183. augmentedFlags = sanitizeJSFlags(flag) + ' ' + customFlags
  184. }
  185. })
  186. return parent.call(this, url).concat([augmentedFlags || '--js-flags=' + customFlags])
  187. }
  188. var ChromeCanaryBrowser = function (baseBrowserDecorator, args) {
  189. ChromeBrowser.apply(this, arguments)
  190. var parentOptions = this._getOptions
  191. this._getOptions = function (url) {
  192. return canaryGetOptions.call(this, url, args, parentOptions)
  193. }
  194. }
  195. ChromeCanaryBrowser.prototype = {
  196. name: 'ChromeCanary',
  197. DEFAULT_CMD: {
  198. linux: getBin(['google-chrome-canary', 'google-chrome-unstable']),
  199. darwin: getChromeDarwin('/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary'),
  200. win32: getChromeExe('Chrome SxS')
  201. },
  202. ENV_CMD: 'CHROME_CANARY_BIN'
  203. }
  204. ChromeCanaryBrowser.$inject = ['baseBrowserDecorator', 'args']
  205. var ChromeCanaryHeadlessBrowser = function (baseBrowserDecorator, args) {
  206. ChromeCanaryBrowser.apply(this, arguments)
  207. var parentOptions = this._getOptions
  208. this._getOptions = function (url) {
  209. return headlessGetOptions.call(this, url, args, parentOptions)
  210. }
  211. }
  212. ChromeCanaryHeadlessBrowser.prototype = {
  213. name: 'ChromeCanaryHeadless',
  214. DEFAULT_CMD: {
  215. linux: getBin(['google-chrome-canary', 'google-chrome-unstable']),
  216. darwin: getChromeDarwin('/Applications/Google Chrome Canary.app/Contents/MacOS/Google Chrome Canary'),
  217. win32: getChromeExe('Chrome SxS')
  218. },
  219. ENV_CMD: 'CHROME_CANARY_BIN'
  220. }
  221. ChromeCanaryHeadlessBrowser.$inject = ['baseBrowserDecorator', 'args']
  222. ChromiumBrowser.prototype = {
  223. name: 'Chromium',
  224. DEFAULT_CMD: {
  225. // Try chromium-browser before chromium to avoid conflict with the legacy
  226. // chromium-bsu package previously known as 'chromium' in Debian and Ubuntu.
  227. linux: getBin(['chromium-browser', 'chromium']),
  228. darwin: '/Applications/Chromium.app/Contents/MacOS/Chromium',
  229. win32: getChromiumExe()
  230. },
  231. ENV_CMD: 'CHROMIUM_BIN'
  232. }
  233. ChromiumBrowser.$inject = ['baseBrowserDecorator', 'args']
  234. var ChromiumHeadlessBrowser = function (baseBrowserDecorator, args) {
  235. ChromiumBrowser.apply(this, arguments)
  236. var parentOptions = this._getOptions
  237. this._getOptions = function (url) {
  238. return headlessGetOptions.call(this, url, args, parentOptions)
  239. }
  240. }
  241. ChromiumHeadlessBrowser.prototype = {
  242. name: 'ChromiumHeadless',
  243. DEFAULT_CMD: {
  244. // Try chromium-browser before chromium to avoid conflict with the legacy
  245. // chromium-bsu package previously known as 'chromium' in Debian and Ubuntu.
  246. linux: getBin(['chromium-browser', 'chromium']),
  247. darwin: '/Applications/Chromium.app/Contents/MacOS/Chromium',
  248. win32: getChromiumExe()
  249. },
  250. ENV_CMD: 'CHROMIUM_BIN'
  251. }
  252. var DartiumBrowser = function () {
  253. ChromeBrowser.apply(this, arguments)
  254. var checkedFlag = '--checked'
  255. var dartFlags = process.env.DART_FLAGS || ''
  256. var flags = dartFlags.split(' ')
  257. if (flags.indexOf(checkedFlag) === -1) {
  258. flags.push(checkedFlag)
  259. process.env.DART_FLAGS = flags.join(' ')
  260. }
  261. }
  262. DartiumBrowser.prototype = {
  263. name: 'Dartium',
  264. DEFAULT_CMD: {},
  265. ENV_CMD: 'DARTIUM_BIN'
  266. }
  267. DartiumBrowser.$inject = ['baseBrowserDecorator', 'args']
  268. // PUBLISH DI MODULE
  269. module.exports = {
  270. 'launcher:Chrome': ['type', ChromeBrowser],
  271. 'launcher:ChromeHeadless': ['type', ChromeHeadlessBrowser],
  272. 'launcher:ChromeCanary': ['type', ChromeCanaryBrowser],
  273. 'launcher:ChromeCanaryHeadless': ['type', ChromeCanaryHeadlessBrowser],
  274. 'launcher:Chromium': ['type', ChromiumBrowser],
  275. 'launcher:ChromiumHeadless': ['type', ChromiumHeadlessBrowser],
  276. 'launcher:Dartium': ['type', DartiumBrowser]
  277. }
  278. module.exports.test = {
  279. isJSFlags: isJSFlags,
  280. sanitizeJSFlags: sanitizeJSFlags,
  281. headlessGetOptions: headlessGetOptions,
  282. canaryGetOptions: canaryGetOptions
  283. }