Repository navigation
feat: accept SQL_QUERY dashboard filters in the API, external API, and MCP - #3674
karl-power wants to merge 3 commits into
Conversation
…d MCP Validate a SQL query filter's connection on save, and let the external API and MCP read and write the filter. - Reject dashboard saves whose SQL_QUERY filter names a connection outside the team, skipping a connection the stored filter already used - Map the filter's connection to connectionId in the external API and MCP, and stop hiding the type there - Check filter connections in the external API's connection validation - Warn in MCP about source-only macros, unclosed macros, and unknown variables in the filter's SQL - Document the filter in the MCP tool descriptions, prompts, and OpenAPI spec Refs HDX-5524
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🦋 Changeset detectedLatest commit: e5c0930 The changes in this PR will be included in the next version bump. This PR includes changesets to release 3 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 |
Duplicate code analysis1 new clone introduced by this PR.
If one of these duplicates a helper that already exists, import it instead jscpd compared this branch against |
PR Review
1 finding(s): 🔴 0 critical · 🟠 0 major · 🔵 1 minor None could be anchored to changed lines; they are listed below. Findings outside the changed lines1 minor
Severity is the reviewer's own estimate and is used for ordering, not filtering. No finding blocks merge automatically; a maintainer decides. |
Deep ReviewThe change adds ✅ No critical issues found. 🟡 P2 -- recommended
🔵 P3 nitpicks (2)
Reviewers (9): correctness, security, adversarial, api-contract, kieran-typescript, testing, maintainability, previous-comments, project-standards. Testing gaps: External-API update path for No finding blocks merge automatically. A maintainer will expect P0/P1 findings in code this PR changes to be fixed; P2/P3 are your call -- fix or reply. Never fix findings about surrounding code here; reply instead. Do not widen the PR. How to respond |
E2E Test Results✅ All tests passed • 467 passed • 1 skipped • 1025s
Tests ran across 4 shards in parallel. |
|
Review follow-up:
|
🔴 Tier 4 — CriticalTouches authentication, tenancy data models, the public API or shipped database config — or substantially changes the query rendering engine, background tasks, the OTel pipeline, image build, or release CI. Why this tier:
Review process: Deep review from a domain expert. Synchronous walkthrough may be required. Stats
|
Summary
Lets the API, external API v2, and MCP save and return
SQL_QUERYdashboard filters, and checks their connection on save. This is the second of four PRs; the dropdown still has no values and the UI can't create the filter yet.SQL_QUERYfilter whose connection doesn't belong to the team. A connection the stored filter with the same ID already used is skipped, matching how filter sources are checked.connectionIdfield, translated to and from the internalconnection. The PR 1 stopgap that hid the type is removed;ADHOCstays hidden.sourceId.$__sourceTableor$__filters(the filter has no source), leaves a macro unclosed, or references an unknown variable.$__filter(<column>, $<variable>)for reading another filter's selection.openapi.jsonis regenerated.How to reproduce
Starting point:
yarn dev, with the MCP server connected.On the base branch (#3672):
clickstack_save_dashboardwith a filter{ "type": "SQL_QUERY", "name": "Service", "connectionId": "<connection ID>", "sqlTemplate": "SELECT DISTINCT ServiceName FROM default.otel_logs WHERE $__timeFilter(Timestamp) ORDER BY 1", "variableName": "svc" }.On this branch:
connectionId.$__filter(ServiceName, $svc)and runclickstack_query_tilewith and withoutvariableValues: [{ "name": "svc", "values": ["<service>"] }]. The tile narrows to that service only when a value is selected.connectionId: "000000000000000000000000". The call fails with "Could not find the following connection IDs".sqlTemplate: "SELECT 1 FROM $__sourceTable". The dashboard saves and returns a warning that the filter has no source.How to test on Vercel preview
N/A — non-UI change
References