chore(devex): register canonical /api/projects/ route for env-only endpoints#60407
Merged
webjunkie merged 6 commits intoJun 1, 2026
Merged
Conversation
Contributor
|
Size Change: 0 B Total Size: 80.8 MB ℹ️ View Unchanged
|
webjunkie
force-pushed
the
chore/devex-add-project-routes-for-env-only-endpoints
branch
2 times, most recently
from
177ea8d to
b3d71f8
Compare
assign-reviewers-posthog
Bot
requested review from
a team,
TueHaulund,
ablaszkiewicz,
cat-ph,
fasyy612,
hpouillot and
nicowaltz
and removed request for
a team
webjunkie
removed request for
MattBro,
arnohillen,
fercgomes,
ksvat and
rafaeelaudibert
Contributor
Author
|
Woops, sorry for all these pings! |
webjunkie
force-pushed
the
chore/devex-add-project-routes-for-env-only-endpoints
branch
from
28611eb to
4fd1fdc
Compare
gantoine
approved these changes
May 29, 2026
Contributor
|
🎭 Playwright report · View test results →
These issues are not necessarily caused by your changes. |
webjunkie
force-pushed
the
chore/devex-add-project-routes-for-env-only-endpoints
branch
from
cdc3457 to
69f4ebb
Compare
…dpoints The project↔environment split was rolled back; /api/projects/:team_id/ is the canonical path, /api/environments/:team_id/ is preserved as a backward-compat alias. The OpenAPI postprocess hook in posthog.api.documentation already auto-marks the env side as deprecated whenever a matching project path exists — but a long list of endpoints added after the rollback never got a project-side registration, so they appear only under /api/environments/ and never get the deprecated flag. Add a register_team_nested_viewset helper (mirrors the existing grandfathered helper but with project_ as the canonical basename) and convert every env-only call site to dual-register. The env routes keep working unchanged; the new project routes become the canonical path. Also fix a pre-existing basename collision: my_notifications used basename "project_notifications", which collided with the new project-side notifications registration. Renamed to "project_my_notifications" (no callers use the basename via reverse()). Two existing manual dual-registrations are left as-is: error_tracking/releases and error_tracking/symbol_sets. After this lands, run hogli build:openapi to regenerate the schema and frontend types; the env paths get deprecated: true and Orval will generate the project-side functions as canonical.
…version Regenerates frontend types after the env-only -> dual-route registration change. The newly dual-registered endpoints now have /api/projects/-based canonical URLs in the generated Orval client — the env paths are still in the OpenAPI schema (marked deprecated) but Orval omits them, so the generated TypeScript exposes only the project-side functions. Touched 31 generated files across products that gained a project-side registration (llm_analytics, notifications, messaging, marketing_analytics, desktop_recordings, revenue_analytics, conversations, tracing, user_interviews, replay_vision, mcp_store, posthog_ai, data_modeling, data_warehouse, customer_analytics, metrics, web_analytics, core_events, platform_features). Three products fail orval validation with SELF_REFERENCE on PropertyGroupFilterValue (logs, error_tracking, product_analytics). This is a recursive-schema validator issue independent of the URL change — product_analytics fails identically with zero files touched here. Their api.zod.ts files still regenerated successfully, only api.ts was skipped. Worth a separate follow-up to investigate why the opaqueRecursiveSchemas step in bin/generate-openapi-types.mjs doesn't catch PropertyGroupFilterValue for these three.
Two rules: - `no-environments-router-register` (ERROR, python): bans direct `environments_router.register(...)` calls in `posthog/api/__init__.py`. Forces new team-nested endpoints through `projects_router.register` directly or via `register_team_nested_viewset` (which dual-registers and auto-deprecates the env alias). The two helper bodies are exempted via `pattern-not-inside`. The two pre-existing manual dual-registrations for error_tracking/releases and error_tracking/symbol_sets carry inline nosemgrep markers because their env/project sides use different parent lookups (team_id vs project_id) and don't fit the helper's shape. - `no-environments-api-urls-frontend` (ERROR, ts/js): bans hand-coded `/api/environments/...` URL strings in frontend code. The 16 existing legacy files are listed in `paths.exclude` as the migration backlog — removing a file from that list re-enables the gate for it. Standard exclusions cover tests, mocks, stories, generated, and the toolbar.
webjunkie
force-pushed
the
chore/devex-add-project-routes-for-env-only-endpoints
branch
from
69f4ebb to
d6a79f8
Compare
Contributor
|
👋 Visual changes detected for this PR. Review and approve in PostHog Visual Review If these changes are unexpected, they may be caused by a flaky test or a broken snapshot on master. Don't approve — rerun the job or wait for a fix. |
…ject-routes-for-env-only-endpoints # Conflicts: # services/mcp/src/api/generated.ts
The endpoint isn't codegen'd because the @action on TeamViewSet lacks @extend_schema (same as experiments_config). Backend route resolves on both surfaces; swap the hand-coded URL to the canonical project path so it stops tripping the no-environments-api-urls-frontend rule. Adding schema annotations on the backend would unlock codegen and let the nosemgrep comment go away entirely — left as a follow-up.
Contributor
Author
|
@mendral-app can you help assess whether the URL endpoint adjustments are causing the CI failures in this branch? or if these are pre-existing flakes or make flakes that surface only now? |
webjunkie
deleted the
chore/devex-add-project-routes-for-env-only-endpoints
branch
Contributor
|
Hey @webjunkie! I investigated the CI failures on this branch. Here's the breakdown: Failures Summary
DetailsJest test (EE - 1) — Pre-existing flakeThe Evidence: Visual Review — Needs manual approvalThe VR run detected 13-20 visual changes across 3341 snapshots. Given your PR regenerates OpenAPI types across 31 frontend files, these are most likely caused by subtle rendering differences in auto-generated type documentation or component prop displays. These need review/approval at the Visual Review UI. TL;DRYour URL endpoint adjustments are NOT causing the CI failures. The Jest failure is a pre-existing network mock flake, and the Visual Review changes just need manual approval (likely expected given the type regeneration scope of this PR). A re-run of the Jest job should go green. |
webjunkie
added a commit
that referenced
this pull request
Jun 1, 2026
PR #60407 dual-routed ~46 previously env-only team-nested viewsets so both /api/projects/:team_id/ and /api/environments/:team_id/ resolve, then marked the env half deprecated. Orval emits the project URL as canonical in the generated TypeScript client, so any story/test that still mocks /api/environments/...stem.../ no longer matches the request — loaders return undefined and the scene falls through to NotFound (visible in the 13 visual review diffs on the merged PR, e.g. the AI skill scene). Swap mock URLs from /api/environments/...stem.../ to /api/projects/ for the flipped stems only (accounts, approval_policies, llm_skills, error_tracking, logs, notifications, etc. — see /tmp/flipped_stems.txt). Untouched: any env URL for a non-flipped endpoint (persons/properties etc), and any line marked `// nosemgrep: no-environments-api-urls-frontend`. Scope: - 23 .stories.tsx files (94 swaps) - 20 .test.ts/.test.tsx files (123 swaps) - MSW handlers, scene testUtils, one playwright spec (13 swaps)
DanielVisca
added a commit
that referenced
this pull request
Jun 1, 2026
…vironments/ PR #60407 rewrote the frontend URL from `api/environments/.../logs_config/` to `api/projects/.../logs_config/` to align with the canonical-project-route direction, but the backend action lives on `TeamViewSet` as an `@action` which is only mounted under `environments_router`. The projects router uses `ProjectViewSet` (a different class), so the rewritten URL hit the catch-all 404 in production. Fix it properly by mirroring the action on `ProjectViewSet` so both routes resolve. The shared body is extracted to `handle_logs_config()` so the two viewsets stay in sync. Both routes operate on the same env-scoped `TeamLogsConfig` keyed by `team_id` — the project-side action looks up `project.passthrough_team`, matching the pattern used by `reset_token` and the other existing project-side actions. Frontend is restored to `api/projects/...` per #60407's canonical direction. Tests are parameterized across both URL prefixes plus a cross-route consistency assertion that confirms writes via one prefix are readable via the other. Generated-By: PostHog Code Task-Id: a0cd1bfc-9b19-4b30-9123-6488d22b3f6a
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
After the project↔environment split was rolled back,
/api/projects/:team_id/...is the canonical path and/api/environments/:team_id/...is a backward-compat alias. The OpenAPI postprocess hook inposthog/api/documentation.pyalready auto-marks the env sidedeprecated: truewhenever a matching project route exists, and Orval skips deprecated operations — so dual-registered endpoints get a clean project-side TS client.But a long list of endpoints added after the rollback never got a project-side registration. They only appear under
/api/environments/, never get the deprecation flag, and the canonical surface for them never makes it into the generated frontend client.Follows #60406, which fixed the misleading guidance that led to this.
Changes
register_team_nested_viewset(prefix, viewset, basename, parents_query_lookups)inposthog/api/__init__.py. Mirror of the existing grandfather helper but takesproject_*basenames and registers projects (canonical) plus environments (auto-deprecated alias).posthog/api/__init__.pyto use the new helper. Includesvision/quotawhich landed on master while this PR was open. Three captured-router parents (accounts/notebooks,user_interview_topics/interviewees,vision/scanners/observations) got tuple-unpack conversions so their nested children also get parallel project-side registrations.my_notifications's basename wasproject_notifications(mismatch with its prefix), which collided with the new project-sidenotificationsroute. Renamed toproject_my_notifications— no callers use the basename viareverse().frontend/src/generated/and the per-productproducts/*/frontend/generated/types for everything affected..semgrep/devex-rules/:no-environments-router-register(Python, ERROR): bans directenvironments_router.register(...)inposthog/api/__init__.py. Helper bodies are exempted viapattern-not-inside. Two genuine edge cases (error_tracking/releases,error_tracking/symbol_sets) carry inlinenosemgrepmarkers — their env/project sides use different parent lookups (team_idvsproject_id) and don't fit the helper's shape.no-environments-api-urls-frontend(TS/JS, ERROR): bans hand-coded/api/environments/...URL strings in product frontend code. 16 legacy files are listed inpaths.excludeas the existing migration backlog — removing a file from that list re-enables the gate for it. Standard exclusions for tests, mocks, stories, generated, and toolbar.How did you test this code?
Agent-authored PR. Verified:
llm_prompts,evaluations,notifications,marketing_analytics,vision/scanners,accounts), env-side and project-side URL counts match.hogli build:openapiproduces all 55 product API clients with no failures, idempotent across two consecutive runs.Publish to changelog?
no
Docs update
In-tree docstring + skill files updated in #60406.
🤖 Agent context
Authored by Claude Code (Opus 4.7). Workflow:
environments_router.register(...)call inposthog/api/__init__.py, skips ones already manually paired with aprojects_router.registerfor the same prefix, and rewrites the rest toregister_team_nested_viewset(...)with aproject_*basename. Captured-router parents become tuple unpackings and their nested children get parallel project-side calls emitted.vision/quota) — also converted. Thellm_analytics→ai_observabilityrename was applied to the semgrep rule D exclude list.posthog/api/documentation.pyfor aSELF_REFERENCEfailure onPropertyGroupFilterValuein three products (logs, error_tracking, product_analytics). On rebase, that turned out to be redundant — master already handles recursive schemas via theopaqueDeepSchemasmechanism infrontend/bin/generate-openapi-types.mjs(PR feat(devex): generate Zod validation schemas from OpenAPI spec #54698). The fix commit was dropped.Decisions explicitly considered and rejected:
register_grandfathered_environment_nested_viewset— 50+ call sites, mostly noise. Existing helper still works correctly; only its docstring was stale (fixed in chore(devex): fix env-vs-project canonical guidance #60406).prefer-codegen-api-style nosemgrep escape pattern to rule D — path exclusions are cleaner for this case because the existing offenders are file-scoped, not line-scoped.Things not done in this PR:
error_tracking/{releases,symbol_sets}endpoints have different parent lookups on their env vs project sides (team_id vs project_id), so they're genuinely two different routes, not aliases. Left them as manual dual-registrations withnosemgrepmarkers explaining why.deprecated: truefrom the OpenAPI schema into JSDoc@deprecatedtags on the env-side functions. The functions are simply omitted from the generated client (deprecated operations are filtered out during grouping), which is good enough — but if surface visibility for the deprecation flag in TS becomes a concern, it'd be a separate small change to the Orval config.