feat: add HyperDX Labs for per-user opt-in to unfinished features - #2876
Draft
teeohhem wants to merge 3 commits into
Draft
feat: add HyperDX Labs for per-user opt-in to unfinished features#2876teeohhem wants to merge 3 commits into
teeohhem wants to merge 3 commits into
Conversation
Shipping a half-finished feature previously meant either holding a long-lived branch or adding a hardcoded constant to the app's config and redeploying to change it. Labs replaces that with a per-user toggle so unfinished work can merge to main default-off and the people who want it can turn it on themselves. Opt-ins are stored on the User document and surfaced via GET /me, so they follow a user across browsers and devices. Adding a lab is a single entry in packages/app/src/labs/registry.ts plus a useIsLabEnabled call; the server validates the shape of what it stores but deliberately does not know the lab id list, which is what keeps it to one file. The registry ships empty. This is the mechanism, not any experiment.
Drops the IS_LABS_ENABLED deployment gate so there is no flag to flip and no environment where the menu entry is missing. Local mode is the reason a gate existed: it has no API server and no user identity, so there is no account to hang an opt-in on and toggling would have failed. Opt-ins there go to localStorage under `hdx-labs` instead. The branch stays inside useLabs.ts, so nothing else knows which store is in play, and labs remain server-persisted wherever there is an account. One consequence for lab authors, now documented: a lab whose feature needs the API server must AND with !IS_LOCAL_MODE, because a local-mode user can now switch it on.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: 93313df The changes in this PR will be included in the next version bump. This PR includes changesets to release 4 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Contributor
Greptile SummaryThe PR adds a per-user HyperDX Labs mechanism with account-backed persistence and a localStorage fallback for local mode.
Confidence Score: 5/5The PR appears safe to merge. No blocking failure remains; the previously reported same-client replacement race is addressed by serializing Labs mutations in call order.
|
| Filename | Overview |
|---|---|
| packages/app/src/labs/useLabs.ts | Implements registry-derived Labs state, optimistic full-replacement persistence, local-mode storage, rollback, and serialized account writes. |
| packages/api/src/routers/api/me.ts | Exposes normalized Labs state through GET /me and adds authenticated, schema-validated replacement writes. |
| packages/api/src/controllers/user.ts | Adds a user-scoped whole-object update for persisted Labs selections. |
| packages/common-utils/src/types.ts | Defines the shared bounded Labs identifier, request, response, and state contracts. |
| packages/app/src/labs/LabsModal.tsx | Adds the user-facing Labs modal and registry-driven toggle controls. |
| packages/app/src/components/AppNav/AppNav.tsx | Integrates the Labs modal into the persistent application navigation. |
| packages/app/src/labs/tests/useLabs.test.tsx | Covers loading, derivation, pruning, optimistic writes, serialization, rollback, and gate behavior. |
| packages/api/src/routers/api/tests/me.int.test.ts | Covers persistence, replacement semantics, validation, serialization shape, authentication, and per-user scoping. |
Sequence Diagram
sequenceDiagram
participant User
participant Modal as Labs Modal
participant Hook as useLabs
participant Cache as React Query /me Cache
participant API as PATCH /me/labs
participant Mongo as User Document
User->>Modal: Toggle experiment
Modal->>Hook: setLabEnabled(id, value)
Hook->>Cache: Apply optimistic full replacement
Hook->>API: Queue serialized PATCH
API->>Mongo: Replace labs object
Mongo-->>API: Persisted labs
API-->>Hook: Updated labs
Hook->>Cache: Refetch /me after queue settles
Reviews (2): Last reviewed commit: "fix(app): serialize lab toggles so an ol..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
Contributor
E2E Test Results✅ All tests passed • 280 passed • 1 skipped • 1110s
Tests ran across 4 shards in parallel. |
Two quick toggles each sent an independently computed full replacement, so if
the first request's write landed after the second's, Mongo kept the older
payload and the newer lab silently reverted on the next /me refetch.
The mutation now carries a react-query scope, which sends same-scope mutations
one at a time in call order. Each queued payload is built after the previous
onMutate has written the cache, so serialized sends are cumulative rather than
conflicting. Covered by a regression test that fails without the scope.
Across two tabs or devices it is still last-write-wins, since those are
separate clients with separate queues. Documented rather than fixed.
Also drops the two eslint-disable comments the escape-hatch ratchet flagged:
typing the hdxServer test double as the jest.Mock it actually is removes the
need to assert a bare { json } stub into ky's generic ResponsePromise.
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
1 participant
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.
Summary
Shipping a half-finished feature currently means either holding a long-lived branch or adding a hardcoded constant to
packages/app/src/config.tsand redeploying to change it, which is whyIS_MTVIEWS_ENABLED = falseandNEXT_PUBLIC_ENABLE_DASHBOARD_VARIABLESboth exist today. HyperDX Labs replaces that with a per-user toggle, so unfinished work can merge tomaindefault-off and the people who want it can switch it on themselves. Opt-ins live on the User document and come down withGET /me, so they follow a user across browsers and devices; in local mode, where there is no account, they fall back to localStorage. Adding a lab is one entry inpackages/app/src/labs/registry.tsplus auseIsLabEnabled('id')call, with no API, schema, or migration change, and that one-file property is deliberate. The registry ships empty — this is the mechanism, not any experiment.Design notes
labs/__tests__/registry.test.tsparses every registry id againstLabIdSchemato catch it in CI instead.Schema.Types.Mixed, not a MongooseMap. AMap'stoJSON()returns a nativeMapunless given{ flattenMaps: true }, andGET /mehands the value straight tores.json(), so it would have serialized as{}forever (the same trap already documented inmodels/webhook.ts). There's a regression test pinning it.agent_docs/labs.md). A date-based test would fail on an unrelated PR and get its constant bumped within the hour; the registry being one short file is the actual anti-rot mechanism.Screenshots or video
No screenshot: with the registry empty, the modal renders only its empty state ("No experiments are available right now"). The user-visible surface in this PR is the HyperDX Labs entry in the nav user menu and that empty modal.
How to test on Vercel preview
Preview routes: /search
Steps:
data-testid="user-menu-trigger").Testing
PATCH /me/labshas integration coverage for the storage round-trip, full-replace semantics, per-user scoping, and rejection of ids containing_,.,$, uppercase, or__proto__. The hook has unit coverage for both stores, including the loading window, stale-id pruning, optimistic apply, and rollback-on-failure. The toggle-and-persist path was verified end-to-end against a temporary registry entry, but the committed E2E only covers the empty state, so the first real lab should add that assertion (LabsModalComponent.setLab()exists for it).