Skip to content

Commit fda43ba

Browse files
vweeversvweevers
committed
Initial
0 parents  commit fda43ba

8 files changed

+272
-0
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
package-lock.json
3+
.nyc_output

‎.travis.yml

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
language: node_js
2+
3+
node_js:
4+
- 10
5+
- 12
6+
- 14
7+
8+
services:
9+
- xvfb
10+
11+
notifications:
12+
email: false

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright © 2020-present Airtap contributors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+99
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# airtap-electron
2+
3+
**Electron [browser provider](https://github.com/airtap/browser-provider).**
4+
5+
[![npm status](http://img.shields.io/npm/v/airtap-electron.svg)](https://www.npmjs.org/package/airtap-electron)
6+
[![node](https://img.shields.io/node/v/airtap-electron.svg)](https://www.npmjs.org/package/airtap-electron)
7+
[![Travis build status](https://img.shields.io/travis/com/airtap/electron.svg?label=travis)](http://travis-ci.com/airtap/electron)
8+
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
9+
10+
## Table of Contents
11+
12+
<details><summary>Click to expand</summary>
13+
14+
- [Usage](#usage)
15+
- [Programmatic](#programmatic)
16+
- [With Airtap](#with-airtap)
17+
- [API](#api)
18+
- [`Electron()`](#electron)
19+
- [Browser options](#browser-options)
20+
- [Install](#install)
21+
- [License](#license)
22+
23+
</details>
24+
25+
## Usage
26+
27+
### Programmatic
28+
29+
```js
30+
const Electron = require('airtap-electron')
31+
const provider = new Electron()
32+
33+
// Get a list of desired browsers (there's just 1 here)
34+
const wanted = [{ name: 'electron' }]
35+
const manifests = await provider.manifests(wanted)
36+
37+
// Instantiate a browser
38+
const target = { url: 'http://localhost:3000' }
39+
const browser = provider.browser(manifests[0], target)
40+
41+
await browser.open()
42+
```
43+
44+
### With [Airtap](https://github.com/airtap/airtap)
45+
46+
```yaml
47+
providers:
48+
- airtap-electron
49+
50+
browsers:
51+
- name: electron
52+
```
53+
54+
This provider also exposes a [`supports`](https://github.com/airtap/browser-manifest#supports) property to match on:
55+
56+
```yaml
57+
browsers:
58+
- name: electron
59+
supports:
60+
headless: true
61+
```
62+
63+
## API
64+
65+
### `Electron()`
66+
67+
Constructor. Returns an instance of [`browser-provider`](https://github.com/airtap/browser-provider).
68+
69+
### Browser options
70+
71+
- `headless` (boolean, default true): run in headless mode
72+
- `window` (object): custom options to pass to [`BrowserWindow()`](https://www.electronjs.org/docs/api/browser-window#new-browserwindowoptions)
73+
- `devtools` (object): custom options to pass to [`openDevTools()`](https://www.electronjs.org/docs/api/web-contents#contentsopendevtoolsoptions) (unless `headless`)
74+
75+
In Airtap these can be set like so:
76+
77+
```yaml
78+
browsers:
79+
- name: electron
80+
options:
81+
headless: false
82+
window:
83+
webPreferences:
84+
sandbox: true
85+
devtools:
86+
mode: detach
87+
```
88+
89+
## Install
90+
91+
Electron must be installed separately. With [npm](https://npmjs.org) do:
92+
93+
```
94+
npm install airtap-electron electron
95+
```
96+
97+
## License
98+
99+
[MIT](LICENSE) © 2020-present Airtap contributors

‎electron.js

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
'use strict'
2+
3+
const { app, BrowserWindow } = require('electron')
4+
const { manifest, target } = JSON.parse(process.argv[2])
5+
6+
app.on('ready', function () {
7+
if (target.file) {
8+
// that would be nice (to run tests in electron main)
9+
} else {
10+
const { headless, window, devtools } = manifest.options
11+
const win = new BrowserWindow({ show: !headless, ...window })
12+
13+
if (!headless) {
14+
win.webContents.openDevTools(devtools)
15+
}
16+
17+
win.loadURL(target.url)
18+
}
19+
})

‎index.js

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
'use strict'
2+
3+
const Provider = require('browser-provider')
4+
const Browser = require('abstract-browser')
5+
const bin = require('electron')
6+
const version = require('electron/package.json').version
7+
const spawn = require('child_process').spawn
8+
const path = require('path')
9+
const kProcess = Symbol('kProcess')
10+
11+
class ElectronProvider extends Provider.promises {
12+
async _manifests () {
13+
return [{
14+
name: 'electron',
15+
title: `Electron ${version}`,
16+
version,
17+
options: { headless: true },
18+
supports: { headless: true }
19+
}]
20+
}
21+
22+
_browser (manifest, target) {
23+
return new ElectronBrowser(manifest, target)
24+
}
25+
}
26+
27+
class ElectronBrowser extends Browser {
28+
constructor (manifest, target) {
29+
super(manifest, target)
30+
this[kProcess] = null
31+
}
32+
33+
_open (cb) {
34+
const opts = { manifest: this.manifest, target: this.target }
35+
const entry = path.join(__dirname, 'electron.js')
36+
const args = [entry, JSON.stringify(opts)]
37+
38+
this[kProcess] = spawn(bin, args, {
39+
stdio: 'ignore'
40+
})
41+
42+
this[kProcess].on('close', (code, signal) => {
43+
this[kProcess] = null
44+
if (code) this.emit('error', new Error(`Electron exited with code ${code}`))
45+
else if (signal) this.emit('error', new Error(`Electron exited by signal ${signal}`))
46+
else this.emit('error', new Error('Premature exit'))
47+
})
48+
49+
cb()
50+
}
51+
52+
_close (cb) {
53+
if (this[kProcess]) {
54+
this[kProcess].removeAllListeners('close')
55+
this[kProcess].on('close', function (code) {
56+
if (code) cb(new Error(`Electron exited with code ${code}`))
57+
else cb()
58+
})
59+
this[kProcess].kill()
60+
this[kProcess] = null
61+
} else {
62+
cb()
63+
}
64+
}
65+
}
66+
67+
module.exports = ElectronProvider

‎package.json

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
{
2+
"name": "airtap-electron",
3+
"version": "0.0.0",
4+
"description": "Electron browser provider",
5+
"license": "MIT",
6+
"author": "Vincent Weevers",
7+
"scripts": {
8+
"test": "standard && hallmark && depcheck && npm run test:unit",
9+
"test:unit": "cross-env DEBUG=airtap* nyc node test",
10+
"fix:js": "standard --fix",
11+
"fix:md": "hallmark --fix"
12+
},
13+
"files": [
14+
"index.js",
15+
"electron.js"
16+
],
17+
"dependencies": {
18+
"abstract-browser": "^1.0.0",
19+
"browser-provider": "^1.1.0"
20+
},
21+
"devDependencies": {
22+
"airtap": "github:airtap/airtap#d8da4f6",
23+
"cross-env": "^7.0.2",
24+
"depcheck": "^1.2.0",
25+
"electron": "^9.2.0",
26+
"hallmark": "^3.0.0",
27+
"nyc": "^15.1.0",
28+
"standard": "^14.3.4",
29+
"tape": "^5.0.1"
30+
},
31+
"keywords": [
32+
"airtap",
33+
"browser",
34+
"browser-provider",
35+
"electron",
36+
"test"
37+
],
38+
"repository": "airtap/electron",
39+
"bugs": "https://github.com/airtap/electron/issues",
40+
"homepage": "https://github.com/airtap/electron",
41+
"engines": {
42+
"node": ">=10.2"
43+
}
44+
}

‎test.js

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
'use strict'
2+
3+
const test = require('tape')
4+
const integration = require('airtap/test/integration')
5+
const Provider = require('.')
6+
7+
integration(test, Provider)

0 commit comments

Comments
 (0)