Files
insights/.semgrep/devex-rules/github-api-calls-go-through-egress.yaml
zeekay 1b367e2b62 chore: rebase the tree onto upstream master
The tree was a debranded snapshot of upstream taken around 2026-02-20, and
upstream has moved about five months since. This replaces it with upstream
master, mechanically re-derived: bin/debrand does the rename, and the
pipeline and squashed migrations are restored from the shipped tree.

Not a merge. The previous import replaced the tree wholesale in a single
commit, so there is no shared content history to merge against. Reproducing
the rename on the new tree is what actually converges.

What survives: .hanzo/workflows, the Dockerfiles and bin/docker* entrypoints,
compose files, LLM.md, and insights/migrations. The squashed initial
migration is load-bearing — the live database records it by name, so
upstream's ~918 individual migrations cannot come back.

Nine products are dropped as unreferenced. Twenty-one more that we do not run
are kept anyway because the core app still imports them; unpicking those is a
refactor and does not belong in a rebase.

This base does not build yet, and the reasons are not in the rename:
upstream now wants Python 3.13.13 against our 3.12.12 and Django 5.2 against
our 4.2, and the dependency manifests still name upstream packages that we
republish under our own names. Those are decisions, not renames.
2026-08-01 15:44:40 -07:00

45 lines
2.0 KiB
YAML

rules:
- id: github-api-calls-go-through-egress
message: |
Outbound GitHub API calls must go through the gated, recorded egress transport —
never raw `requests`.
Use one of:
- `GitHubIntegrationBase.api_request(...)` when you hold a `GitHubIntegration` /
`UserGitHubIntegration` — it owns token refresh, the 401 refresh-retry,
rate-limit raising (`GitHubRateLimitError`), and telemetry attribution via the
instance's `source`.
- `insights.egress.github.transport.github_request(...)` for token-agnostic calls
(user OAuth tokens, PATs, App JWTs). Pass `installation_id` only when the call
is metered against that installation's budget — user-token and App-JWT calls
are identity-blind (`installation_id=None`).
Why: a raw call bypasses the shared per-installation rate-limit budget and the
egress telemetry (request volume + `X-RateLimit-*` gauges), so it can burn a
customer's GitHub budget invisibly. See `insights/egress/README.md`.
This rule only catches literal/f-string URLs; keep URLs inline at the call site.
Suppress a legitimate exception with
`# nosemgrep: github-api-calls-go-through-egress -- <reason>`.
languages: [python]
severity: ERROR
patterns:
- pattern-either:
- patterns:
- pattern: requests.$METHOD($URL, ...)
- metavariable-regex:
metavariable: $METHOD
regex: ^(get|post|put|patch|delete|head)$
- pattern: requests.request($METHOD, $URL, ...)
- metavariable-regex:
metavariable: $URL
regex: .*(api|uploads)\.github\.com.*
paths:
include:
- common/**/*.py
- ee/**/*.py
- insights/**/*.py
- products/**/*.py
exclude:
- insights/egress/**