Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/openwebdocs/mdn-bcd-collector
Data collection service for MDN's browser-compat-data
https://github.com/openwebdocs/mdn-bcd-collector
Last synced: about 2 months ago
JSON representation
Data collection service for MDN's browser-compat-data
- Host: GitHub
- URL: https://github.com/openwebdocs/mdn-bcd-collector
- Owner: openwebdocs
- License: apache-2.0
- Created: 2022-11-20T10:17:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T15:04:00.000Z (5 months ago)
- Last Synced: 2024-04-14T09:04:20.393Z (5 months ago)
- Language: TypeScript
- Homepage: https://mdn-bcd-collector.gooborg.com/
- Size: 13.9 MB
- Stars: 16
- Watchers: 6
- Forks: 13
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - openwebdocs/mdn-bcd-collector - Data collection service for MDN's browser-compat-data (others)
README
# MDN browser-compat-data collector
Data collection service for MDN's [browser-compat-data](https://github.com/mdn/browser-compat-data). Live at https://mdn-bcd-collector.gooborg.com/. Latest `main` available at https://staging.mdn-bcd-collector.gooborg.com/.
Feature detection tests are generated based on machine-readable data (Web IDL and CSS definitions) from web standards, with support for custom tests where needed. Results are submitted to the [mdn-bcd-results](https://github.com/openwebdocs/mdn-bcd-results) repository.
This service is part of an effort to [assist BCD updates with automation](https://github.com/mdn/browser-compat-data/issues/3308), and exists to run lots of small tests in browsers to determine the support status of a feature in a browser, and save those results.
## Copyright
© 2023 [Gooborg Studios](https://www.gooborg.com/) + [Open Web Docs](https://www.openwebdocs.org) + [various contributors](https://github.com/openwebdocs/mdn-bcd-collector/graphs/contributors), © 2020-2022 Google LLC, Mozilla Corporation and [Gooborg Studios](https://www.gooborg.com/).
This project is under the Apache License 2.0 license. See the LICENSE file for more details.
## Setup
This project requires Node.js 18 through 20.
```sh
npm install
```
## Updating BCD using the results
See [docs/update-bcd.md](./docs/update-bcd.md) for information on how to use the `update-bcd` script.
## Reviewing BCD changes
See [docs/reviewing-bcd-changes.md](./docs/reviewing-bcd-changes.md) for information on reviewing changes made by the collector.
## Running the server locally
```sh
npm run dev
```
(`dev`, as opposed to `start`, will use `ts-node` to run the TypeScript file, as well as automatically rebuild the tests and reload the server on file changes.)
To also handle HTTPS traffic, use the `--https-cert` and `--https-key` arguments:
```sh
npm run dev -- --https-cert=my-cert.pem --https-key=my-cert.key
```
## Running tests via Selenium WebDriver
A script has been provided which will collect all of the results for nearly all of the browsers, using the Selenium WebDriver to control your CTs, and download them to your computer (which can then be submitted as a PR). To run this script, you'll need a few prerequisites:
- A clone of [mdn-bcd-results](https://github.com/openwebdocs/mdn-bcd-results) adjacent to this folder's repository (or at least a folder at `../mdn-bcd-results`)
- At least one Selenium remote (ex. BrowserStack, SauceLabs, etc.)
### Define Selenium Hosts
In `secrets.json`, you'll need to add your Selenium remote(s). In the `selenium` object, define your remote(s) by setting the key as the service name (ex. "browserstack", "saucelabs", "lambdatest", "custom", etc.) and the value as either an object containing the username and key for known remotes, or simply a string of the remote URL. Your `secrets.json` should look something like this:
```json
{
"github": {
"token": "github-token-goes-here"
},
"selenium": {
"browserstack": {
"username": "example",
"key": "some-API-key-goes-here"
},
"saucelabs": {
"username": "example",
"key": "some-API-key-goes-here",
"region": "us-west-1"
},
"lambdatest": {
"username": "example",
"key": "some-API-key-goes-here"
},
"custom": "https://my.example.page.org/selenium/wd"
}
}
```
Currently, the Selenium hosts known to the script are:
- BrowserStack - requires `username` and `key`
- SauceLabs - requires `username`, `key`, and `region`
- LambdaTest - requires `username` and `key`
You may use other Selenium hosts, but please be aware that they have not been tested and you may experience unexpected results.
### Run the script
To test using the latest deployed version, run:
```sh
npm run selenium
```
You can also limit the browsers to test by defining browsers as arguments:
```sh
npm run selenium chrome
npm run selenium edge ie
```
Additionally, you can limit the browser versions by the year with the `--since` argument (default: 2020):
```sh
npm run selenium -- --since=2016
npm run selenium firefox -- --since=2000 # Grab all versions of Firefox
```
## Running the unit tests and linter
```sh
npm test
```
Code coverage reports can be viewed in a browser by running:
```sh
npm run coverage
```
## Cleaning up generated files
```sh
npm run clean
```