index.js 9.1 KB

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