mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-11-22 15:10:00 +08:00
## Description Removes the anonymous-telemetry **beacon** — the only external, third-party data flow Headroom ever initiated. When telemetry was opted in, it POSTed aggregate `/stats` to a hardcoded **Supabase** REST endpoint (with an embedded anon API key in the source). For enterprise/on-prem deployments this is exactly the kind of vendor-controlled data egress a security review flags, so it's gone entirely — **zero "Supabase" references remain in the codebase.** What stays (by design): the **local** telemetry collector + the `HEADROOM_TELEMETRY` opt-in (it only feeds `/stats` and `/v1/telemetry` — nothing leaves the process), **OpenTelemetry export** (`HEADROOM_OTEL_METRICS_*`, so operators send operational metrics to *their own* collector), and the license usage reporter (your own domain, license-key-gated). Also fixes the contact domain: `headroom.dev` → `headroomlabs.ai` everywhere. Closes # (no tracking issue) ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [x] Code refactoring (no functional changes) > Non-breaking: `HEADROOM_TELEMETRY` is still accepted (now gates local collection only). The only behavior change is that no telemetry is ever sent externally. ## Changes Made - **Deleted the Supabase beacon**: `TelemetryBeacon` class, `_SUPABASE_URL`/`_SUPABASE_KEY`/`_TABLE`/`_ENDPOINT`, the JSONB projection helper, the proxy-lifespan beacon wiring, the `SUPABASE_` install env passthrough, and `tests/test_strategy_stats_supabase.py`. - **Kept** the local opt-in predicate (`is_telemetry_enabled` etc.) in `beacon.py` — still used by the local collector + CLI — reworded to "local only". - **Retained** the single-worker-owner file lock (the cc-switch reconciler depends on it); updated its comments to drop the beacon framing. - `/stats` `anon_telemetry_shipping` is now always `False` (nothing ships externally); startup log reworded to "Local telemetry". - Reworded remaining "Supabase" comments in `collector.py`, `context.py`, `prometheus_metrics.py`, and two test docstrings. - Contact domain: `security@headroom.dev` → `security@headroomlabs.ai`, `conduct@headroom.dev` → `conduct@headroomlabs.ai`, FUNDING.yml sponsor URL. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check`) - [x] Type checking passes (`mypy`) - [x] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text $ grep -rniI "supabase" --include=*.py --include=*.md --include=*.mdx . # (excl .venv/sbom) >>> ZERO Supabase references $ grep -rniI "headroom.dev" . >>> ZERO headroom.dev references $ ruff check <changed files> -> All checks passed! $ ruff format --check <changed files> -> 10 files already formatted $ mypy <changed telemetry files> -> Success: no issues found $ pytest tests/test_telemetry.py tests/test_telemetry_warning.py \ tests/test_proxy_telemetry_env.py tests/test_compression_observability.py \ tests/test_paths.py tests/test_paths_backward_compat.py -q ============================= 173 passed in 6.67s ============================== ``` ## Real Behavior Proof - **Environment:** macOS, Python 3.12 (`.venv`). - **Exact command / steps:** repo-wide grep for `supabase`/`headroom.dev`; `create_app(...)` driven through a full `TestClient` lifespan (startup + shutdown) in `test_proxy_telemetry_env.py`; `/stats` exercised in `test_telemetry_warning.py`. - **Observed result:** zero `supabase`/`headroom.dev` strings remain; the proxy starts and shuts down cleanly with the beacon removed (the worker-owner lock + reconciler still elect a single owner); `/stats.anon_telemetry_shipping` is `False` even with `HEADROOM_TELEMETRY=on`; local collector + OTEL paths unchanged. - **Not tested:** no live network call was ever made (the point — the external POST is gone). OTEL export and the license reporter were not exercised (unchanged by this PR). ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [ ] I have updated the CHANGELOG.md if applicable ## Additional Notes - The license usage reporter (`reporter.py` → `app.headroomlabs.ai`) is intentionally **kept** — it's license-key-gated (dormant for unlicensed/OSS deployments) and goes to your own domain, not a third party. - Docs/CHANGELOG left unchecked: a couple of docs mention the telemetry beacon and may want a follow-up note that it now collects locally only; happy to add.
134 lines
5.4 KiB
Markdown
134 lines
5.4 KiB
Markdown
# Contributor Covenant Code of Conduct
|
|
|
|
## Our Pledge
|
|
|
|
We as members, contributors, and leaders pledge to make participation in our
|
|
community a harassment-free experience for everyone, regardless of age, body
|
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
identity and expression, level of experience, education, socio-economic status,
|
|
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
identity and orientation.
|
|
|
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
diverse, inclusive, and healthy community.
|
|
|
|
## Our Standards
|
|
|
|
Examples of behavior that contributes to a positive environment for our
|
|
community include:
|
|
|
|
* Demonstrating empathy and kindness toward other people
|
|
* Being respectful of differing opinions, viewpoints, and experiences
|
|
* Giving and gracefully accepting constructive feedback
|
|
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
and learning from the experience
|
|
* Focusing on what is best not just for us as individuals, but for the overall
|
|
community
|
|
|
|
Examples of unacceptable behavior include:
|
|
|
|
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
any kind
|
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
* Public or private harassment
|
|
* Publishing others' private information, such as a physical or email address,
|
|
without their explicit permission
|
|
* Other conduct which could reasonably be considered inappropriate in a
|
|
professional setting
|
|
|
|
## Enforcement Responsibilities
|
|
|
|
Community leaders are responsible for clarifying and enforcing our standards of
|
|
acceptable behavior and will take appropriate and fair corrective action in
|
|
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
or harmful.
|
|
|
|
Community leaders have the right and responsibility to remove, edit, or reject
|
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
decisions when appropriate.
|
|
|
|
## Scope
|
|
|
|
This Code of Conduct applies within all community spaces, and also applies when
|
|
an individual is officially representing the community in public spaces.
|
|
Examples of representing our community include using an official email address,
|
|
posting via an official social media account, or acting as an appointed
|
|
representative at an online or offline event.
|
|
|
|
## Enforcement
|
|
|
|
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
reported to the community leaders responsible for enforcement at
|
|
**conduct@headroomlabs.ai**.
|
|
|
|
All complaints will be reviewed and investigated promptly and fairly.
|
|
|
|
All community leaders are obligated to respect the privacy and security of the
|
|
reporter of any incident.
|
|
|
|
## Enforcement Guidelines
|
|
|
|
Community leaders will follow these Community Impact Guidelines in determining
|
|
the consequences for any action they deem in violation of this Code of Conduct:
|
|
|
|
### 1. Correction
|
|
|
|
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
unprofessional or unwelcome in the community.
|
|
|
|
**Consequence**: A private, written warning from community leaders, providing
|
|
clarity around the nature of the violation and an explanation of why the
|
|
behavior was inappropriate. A public apology may be requested.
|
|
|
|
### 2. Warning
|
|
|
|
**Community Impact**: A violation through a single incident or series of
|
|
actions.
|
|
|
|
**Consequence**: A warning with consequences for continued behavior. No
|
|
interaction with the people involved, including unsolicited interaction with
|
|
those enforcing the Code of Conduct, for a specified period of time. This
|
|
includes avoiding interactions in community spaces as well as external channels
|
|
like social media. Violating these terms may lead to a temporary or permanent
|
|
ban.
|
|
|
|
### 3. Temporary Ban
|
|
|
|
**Community Impact**: A serious violation of community standards, including
|
|
sustained inappropriate behavior.
|
|
|
|
**Consequence**: A temporary ban from any sort of interaction or public
|
|
communication with the community for a specified period of time. No public or
|
|
private interaction with the people involved, including unsolicited interaction
|
|
with those enforcing the Code of Conduct, is allowed during this period.
|
|
Violating these terms may lead to a permanent ban.
|
|
|
|
### 4. Permanent Ban
|
|
|
|
**Community Impact**: Demonstrating a pattern of violation of community
|
|
standards, including sustained inappropriate behavior, harassment of an
|
|
individual, or aggression toward or disparagement of classes of individuals.
|
|
|
|
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
community.
|
|
|
|
## Attribution
|
|
|
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
version 2.1, available at
|
|
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
|
|
Community Impact Guidelines were inspired by
|
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
|
|
For answers to common questions about this code of conduct, see the FAQ at
|
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
[https://www.contributor-covenant.org/translations][translations].
|
|
|
|
[homepage]: https://www.contributor-covenant.org
|
|
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
[FAQ]: https://www.contributor-covenant.org/faq
|
|
[translations]: https://www.contributor-covenant.org/translations
|