Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mozilla/classify-client
An optimized version of the classify client endpoint in Normandy
https://github.com/mozilla/classify-client
normandy product-delivery
Last synced: about 2 months ago
JSON representation
An optimized version of the classify client endpoint in Normandy
- Host: GitHub
- URL: https://github.com/mozilla/classify-client
- Owner: mozilla
- License: mpl-2.0
- Created: 2018-12-07T19:58:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T06:01:00.000Z (about 2 months ago)
- Last Synced: 2024-10-29T11:02:45.786Z (about 2 months ago)
- Topics: normandy, product-delivery
- Language: Rust
- Size: 515 KB
- Stars: 11
- Watchers: 10
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Classify Client
This is an optimized version of the classify client endpoint in [Normandy](https://github.com/mozilla/normandy).
## Dev instructions
This is a normal Cargo project, so after cloning the repository, you can build and run it with
```shell
$ cargo build
$ cargo run
```
This project should run on the latest stable version of Rust. Unstable features are not allowed.
### GeoIP Database
A GeoIP database will need to be provided. By default it is expected to be
found at `./GeoLite2-Country.mmdb`.
## Configuration
Via environment variables:
- `DEBUG`: Set to `"true"` to enable extra debugging options, such as a `/debug`
endpoint that shows internal server state (default: `"false"`).
- `GEOIP_DB_PATH`: path to GeoIP database (default: `"./GeoLite2-Country.mmdb"`)
- `HOST`: host to bind to (default: `"localhost"`)
- `HUMAN_LOGS`: set to `"true"` to use human readable logging (default: MozLog as JSON)
- `METRICS_TARGET`: The host and port to send statsd metrics to. May be a
hostname like `"metrics.example.com:8125"` or an IP like
`"127.0.0.1:8125"`. Port is required. (default: `"localhost:8125"`)
- `PORT`: port number to bind to (default: `"8000"`)
- `SENTRY_DSN`: report errors to a Sentry instance (default: `""`)
- `SENTRY_ENV`: Sentry environment (default: `"production"`)
- `SENTRY_SAMPLE_RATE`: Sentry sampling rate (default: `1.0`)
- `TRUSTED_PROXY_LIST`: A comma-separated list of CIDR ranges that trusted
proxies will be in. Supports both IPv4 and IPv6.
- `VERSION_FILE`: path to `version.json` file (default: `"./version.json"`)
- `API_KEYS_FILE`: path to `apiKeys.json` file for `/v1/country` endpoint (default: `"./apiKeys.json"`)
## Tests
Tests can be run with Cargo as well
```shell
$ cargo test
```
## Linting
Linting is handled via
[Therapist](https://therapist.readthedocs.io/en/latest/). After installing it,
enable the git hooks using either `therapist install` or `therapist install
--fix`. The `--fix` variant will automatically format your code upon commit.
The variant without `--fix` will simply show an error and ask you to reformat
the code using other means before committing. Therapist runs in CI.
The checks Therapist runs are:
* Rustfmt
* Clippy, using the `clippy::all` preset
## Former endpoints from Mozilla Location Services
Endpoints from the Mozilla Location Services project has been migrated to classify-client for continuity.
- `/v1/country` - Requires an api key.
- Downstream firefox builds can self select a key that matches this expression: `^firefox-downstream-\w{1,40}$`
- The API key is required here just to have rough usage metrics and allow us to reach out to project maintainers if needed in the future.
- `/v1/geolocate` - Intentionally not routed to return a 404
- `/v1/geosubmit` - Static 403 response
- `/v1/submit` - Static 403 response
- `/v2/geosubmit` - Static 403 response