-
Notifications
You must be signed in to change notification settings - Fork 212
fix(ai): reject ignored analytics filter scopes #723
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| import { expect, test } from "bun:test"; | ||
| import { discoverQueryTypesTool } from "./discover-query-types"; | ||
|
|
||
| test("discovery exposes custom error context and its effective ordering", async () => { | ||
| const result = await discoverQueryTypesTool.execute?.( | ||
| { search: "recent_errors" }, | ||
| { toolCallId: "discovery", messages: [] } | ||
| ); | ||
| expect(result).toMatchObject({ | ||
| types: [ | ||
| expect.objectContaining({ | ||
| name: "recent_errors", | ||
| defaultOrder: "timestamp DESC", | ||
| outputFields: expect.arrayContaining([ | ||
| { name: "timestamp", type: "datetime" }, | ||
| { name: "message", type: "string" }, | ||
| ]), | ||
| }), | ||
| ], | ||
| }); | ||
| }); | ||
|
|
||
| test("discovery distinguishes an unordered aggregate from undocumented custom SQL", async () => { | ||
| const result = await discoverQueryTypesTool.execute?.( | ||
| { search: "session_metrics" }, | ||
| { toolCallId: "discovery", messages: [] } | ||
| ); | ||
| expect(result).toMatchObject({ | ||
| types: [ | ||
| expect.objectContaining({ | ||
| name: "session_metrics", | ||
| defaultOrder: null, | ||
| outputFields: expect.arrayContaining([ | ||
| { name: "avg_session_duration", type: "number", unit: "seconds" }, | ||
| ]), | ||
| }), | ||
| ], | ||
| }); | ||
| const unknown = await discoverQueryTypesTool.execute?.( | ||
| { search: "session_list" }, | ||
| { toolCallId: "discovery", messages: [] } | ||
| ); | ||
| expect(unknown).toMatchObject({ | ||
| types: [ | ||
| expect.objectContaining({ | ||
| defaultOrder: "Built-in ordering is undocumented; omit orderBy.", | ||
| outputFields: null, | ||
| }), | ||
| ], | ||
| }); | ||
| }); |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| import { afterEach, describe, expect, it, vi } from "vitest"; | ||
| import { asSchema } from "ai"; | ||
| import { SimpleQueryBuilder } from "../../query/simple-builder"; | ||
| import { discoverQueryTypesTool } from "./discover-query-types"; | ||
| import { getDataTool } from "./get-data"; | ||
|
|
||
| const options = { | ||
| toolCallId: "query-contract-test", | ||
| messages: [], | ||
| experimental_context: { | ||
| currentDateTime: "2026-09-05T00:00:00Z", | ||
| websiteId: "site-test", | ||
| websiteDomain: "example.com", | ||
| timezone: "UTC", | ||
| }, | ||
| }; | ||
|
|
||
| afterEach(() => vi.restoreAllMocks()); | ||
|
|
||
| describe("analytics tool contract", () => { | ||
| it.each([ | ||
| { target: "event" }, | ||
| { having: false }, | ||
| ])("rejects unsupported filter scope instead of silently stripping it: %o", async (scope) => { | ||
| const schema = asSchema(getDataTool.inputSchema); | ||
| if (!schema.validate) throw new Error("Missing tool schema validator"); | ||
| const result = await schema.validate({ | ||
| queries: [ | ||
| { | ||
| type: "custom_events_by_path", | ||
| filters: [ | ||
| { | ||
| field: "event_name", | ||
| op: "eq", | ||
| value: "activation_completed", | ||
| ...scope, | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }); | ||
| expect(result.success).toBe(false); | ||
| }); | ||
|
|
||
| it("exposes the exact continuation selector contract before the model queries", async () => { | ||
| if (!discoverQueryTypesTool.execute) | ||
| throw new Error("Missing discovery tool"); | ||
| const result = await discoverQueryTypesTool.execute( | ||
| { search: "error_route_continuation_comparison" }, | ||
| options | ||
| ); | ||
| expect(result).toMatchObject({ | ||
| types: [ | ||
| { | ||
| name: "error_route_continuation_comparison", | ||
| requiredAnyFilter: ["message", "path"], | ||
| allowedFilterOperators: { message: ["eq"], path: ["eq"] }, | ||
| }, | ||
| ], | ||
| }); | ||
| }); | ||
|
|
||
| it("returns the measured scope and distinguishes a truncated result from its query row count", async () => { | ||
| const execute = vi | ||
| .spyOn(SimpleQueryBuilder.prototype, "execute") | ||
| .mockImplementation(function () { | ||
| const compiled = this.compile(); | ||
| expect(compiled.params).toMatchObject({ f0: "activation_completed" }); | ||
| expect(compiled.sql).toContain("event_name = {f0:String}"); | ||
| return Promise.resolve( | ||
| Array.from({ length: 25 }, (_, index) => ({ | ||
| name: `/step-${index}`, | ||
| total_events: 1, | ||
| })) | ||
| ); | ||
| }); | ||
| if (!getDataTool.execute) throw new Error("Missing data tool"); | ||
| const result = await getDataTool.execute( | ||
| { | ||
| queries: [ | ||
| { | ||
| type: "custom_events_by_path", | ||
| from: "2026-08-29", | ||
| to: "2026-09-04", | ||
| filters: [ | ||
| { field: "event_name", op: "eq", value: "activation_completed" }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| options | ||
| ); | ||
| expect(result).toMatchObject({ | ||
| results: { | ||
| custom_events_by_path: { | ||
| websiteId: "site-test", | ||
| from: "2026-08-29", | ||
| to: "2026-09-04", | ||
| filters: [ | ||
| { field: "event_name", op: "eq", value: "activation_completed" }, | ||
| ], | ||
| returnedRows: 20, | ||
| rowCount: 25, | ||
| truncated: true, | ||
| }, | ||
| }, | ||
| }); | ||
| expect(execute).toHaveBeenCalledOnce(); | ||
| }); | ||
| }); |
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
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
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Discovery advertises every global analytics filter for every builder, but
uptime_time_seriesdoes not consumefilterConditions. A model following this contract can submit an advertised filter such ascountry; validation accepts it, but the custom SQL applies only site and timestamp predicates. The result therefore contains unfiltered uptime data even though the requested scope appears to have been applied.Knowledge Base Used: Analytics query engine