diff --git a/web-admin/src/features/alerts/metadata/AlertFilters.svelte b/web-admin/src/features/alerts/metadata/AlertFilters.svelte index a453573f7101..f610b69cc505 100644 --- a/web-admin/src/features/alerts/metadata/AlertFilters.svelte +++ b/web-admin/src/features/alerts/metadata/AlertFilters.svelte @@ -1,109 +1,62 @@
- {m.alert_filters_label({ count: String(filtersLength) })} -
- {#if filtersLength} - {#if hasTimeRange} - - {/if} - {#each currentDimensionFilters as { name, label, mode, selectedValues, inputText, isInclude } (name)} - {@const dimension = dimensionIdMap.get(name)} -
- {#if dimension?.column} - - {/if} -
- {/each} - {#if currentMeasureFilters.length > 0} - {#each currentMeasureFilters as { name, label, dimensionName, filter } (name)} -
- -
- {/each} - {/if} - {:else} -
- {m.alert_no_filters_heading()} -
- {/if} -
+ + {m.alert_filters_label({ count: String(filtersLength) })} + +
diff --git a/web-admin/src/features/bookmarks/Bookmarks.svelte b/web-admin/src/features/bookmarks/Bookmarks.svelte index 79e18b03f9bc..1b83e7dff0cc 100644 --- a/web-admin/src/features/bookmarks/Bookmarks.svelte +++ b/web-admin/src/features/bookmarks/Bookmarks.svelte @@ -42,7 +42,6 @@ export let organization: string; export let project: string; export let resource: { name: string; kind: ResourceKind }; - export let metricsViewNames: string[]; export let bookmarkData: { bookmarks: V1Bookmark[]; categorizedBookmarks: Bookmarks; @@ -260,7 +259,6 @@ {resource} {defaultUrlParams} {showFiltersOnly} - {metricsViewNames} onClose={() => { showDialog = false; bookmark = null; diff --git a/web-admin/src/features/bookmarks/BookmarksFormDialog.svelte b/web-admin/src/features/bookmarks/BookmarksFormDialog.svelte index 69a689de7a5c..b71ece2cc1f7 100644 --- a/web-admin/src/features/bookmarks/BookmarksFormDialog.svelte +++ b/web-admin/src/features/bookmarks/BookmarksFormDialog.svelte @@ -1,5 +1,5 @@ @@ -286,24 +284,12 @@ {m.bookmark_filters_inherited()} - {#if filterState && "uiFilters" in filterState} - - {:else if filterState} - {/if} @@ -317,7 +303,7 @@ { value: "true", label: m.bookmark_managed_bookmarks() }, ]} slot="manage-project" - tooltip={CategoryTooltip} + tooltip={m.bookmark_category_tooltip()} /> {#if showFiltersOnly} @@ -366,9 +352,9 @@ - {#if filterState} + {#if timeFilterState}
- {filterState.selectedTimeRange} + {timeFilterState.selectedTimeRange}
{/if} diff --git a/web-admin/src/features/bookmarks/CanvasBookmarks.svelte b/web-admin/src/features/bookmarks/CanvasBookmarks.svelte index f4bb8f2da534..48a2bfb3c645 100644 --- a/web-admin/src/features/bookmarks/CanvasBookmarks.svelte +++ b/web-admin/src/features/bookmarks/CanvasBookmarks.svelte @@ -1,17 +1,13 @@ - -{#if hasSomeFilter} -
- -
-

- {m.public_url_filters_locked_hidden()} -

- {#if canvasAppliedFiltersStore} -
- -
- {/if} -
-{/if} diff --git a/web-admin/src/features/public-urls/CreatePublicURLForm.svelte b/web-admin/src/features/public-urls/CreatePublicURLForm.svelte index 580a58d99cb4..f16ea2233745 100644 --- a/web-admin/src/features/public-urls/CreatePublicURLForm.svelte +++ b/web-admin/src/features/public-urls/CreatePublicURLForm.svelte @@ -1,11 +1,9 @@ {#if !url} @@ -204,17 +234,27 @@ {/if} - {#if isCanvas} - - {:else} - + {#if hasSomeFilter} +
+ +
+

+ {m.public_url_filters_locked_hidden()} +

+
+ +
+
+ + {#if isExplore} +

+ {m.public_url_measures_dimensions_limited()} +

+ {/if} {/if} + {:else} - + {/if} {#if currentTabIndex !== 2} - + {:else} - {/if} - - + {/if} diff --git a/web-common/src/features/canvas/inspector/filters/FiltersMapper.svelte b/web-common/src/features/canvas/inspector/filters/FiltersMapper.svelte index 8bdf4d327da4..1a398e0501a4 100644 --- a/web-common/src/features/canvas/inspector/filters/FiltersMapper.svelte +++ b/web-common/src/features/canvas/inspector/filters/FiltersMapper.svelte @@ -11,7 +11,7 @@ $: ({ specStore, type, - localFilters, + localExpressionFilters, localTimeControls, parent: { name: canvasName }, timeAndFilterStore, @@ -28,8 +28,13 @@ $: excludedDimensions = type === "leaderboard" - ? new Set((localParamValues as LeaderboardSpec).dimensions) - : new Set(); + ? Object.fromEntries( + (localParamValues as LeaderboardSpec).dimensions.map((d) => [ + d, + true, + ]), + ) + : {}; $: entries = Object.entries(inputParams) as [ AllKeys, @@ -55,9 +60,7 @@ {/if} {:else if config.type == "dimension_filters" && metricsView} { component.updateProperty("dimension_filters", newString); }} diff --git a/web-common/src/features/canvas/stores/canvas-entity.ts b/web-common/src/features/canvas/stores/canvas-entity.ts index 5fedd39791a5..cdaae6983ccf 100644 --- a/web-common/src/features/canvas/stores/canvas-entity.ts +++ b/web-common/src/features/canvas/stores/canvas-entity.ts @@ -16,6 +16,7 @@ import { type V1MetricsViewSpec, type V1Resource, type V1ThemeSpec, + getQueryServiceConvertExpressionToMetricsSQLQueryKey, } from "@rilldata/web-common/runtime-client"; import { derived, @@ -37,8 +38,6 @@ import { isChartComponentType, isTableComponentType, } from "../components/util"; -import { FilterManager, flattenExpression } from "./filter-manager"; -import { getFilterParam } from "./filter-state"; import { Grid } from "./grid"; import { TabGroup, type LayoutBlock } from "./tab-group"; import { getComparisonTypeFromRangeString } from "./time-state"; @@ -50,6 +49,10 @@ import { DEFAULT_DASHBOARD_WIDTH, namePrefixFromPath } from "../layout-util"; import { createCustomMapStore } from "@rilldata/web-common/lib/custom-map-store"; import type { RuntimeClient } from "@rilldata/web-common/runtime-client/v2"; import { queryServiceConvertExpressionToMetricsSQL } from "@rilldata/web-common/runtime-client"; +import { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; +import { convertExpressionToFilterParam } from "@rilldata/web-common/features/dashboards/url-state/filters/converters.ts"; +import { flattenExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; +import { CanvasDashboardConfigProvider } from "@rilldata/web-common/features/dashboards/providers/DashboardConfigProvider.svelte.ts"; export const lastVisitedState = new Map(); @@ -90,11 +93,12 @@ export class CanvasEntity { // Time state controls timeManager: TimeManager; - // Dimension and measure filter state - filterManager: FilterManager; - // Metrics view selectors metricsView: MetricsViewSelectors; + dashboardProvider: CanvasDashboardConfigProvider; + + // Expression filter manager + expressionFilterManager: ExpressionFilterManager; fileArtifact: FileArtifact | undefined; @@ -114,7 +118,6 @@ export class CanvasEntity { // This may sometimes be false due to discrepancy between two different ways // of storing the same state in the URL namely dimension IN (['value']) vs dimension IN ('value') defaultUrlParamsStore = writable(new URLSearchParams()); - viewingDefaultsStore: Readable; filtersEnabledStore = writable(true); _embeddedTheme = writable(undefined); _metricsViews = writable>({}); @@ -203,65 +206,21 @@ export class CanvasEntity { // override is applied. this.themeName.set(undefined); - this.processSpec(this.spec); - this.metricsView = new MetricsViewSelectors( this.client, this._metricsViews, ); + this.dashboardProvider = new CanvasDashboardConfigProvider( + this.client, + name, + ); - this.viewingDefaultsStore = derived( - [ - this.searchParams, - this.defaultUrlParamsStore, - this.filterManager.pinnedFilterKeysStore, - this.filterManager.defaultPinnedFilterKeysStore, - this.filterManager.requiredFilterKeysStore, - this.filterManager.defaultRequiredFilterKeysStore, - ], - ([ - $searchParams, - $defaultUrlParams, - pinnedFilters, - defaultPinnedFilterKeys, - requiredFilters, - defaultRequiredFilterKeys, - ]) => { - if ( - defaultPinnedFilterKeys.symmetricDifference(pinnedFilters).size > 0 - ) { - return false; - } - if ( - defaultRequiredFilterKeys.symmetricDifference(requiredFilters).size > - 0 - ) { - return false; - } - if ($defaultUrlParams.size === 0) { - return false; - } - - for (const [key, value] of $defaultUrlParams.entries()) { - if ($searchParams.get(key) !== value) { - // Ignore time range if not set - if ( - $searchParams.get(key) === null && - key === ExploreStateURLParams.TimeRange - ) { - continue; - } - return false; - } - } - for (const [key, value] of $searchParams.entries()) { - if ($defaultUrlParams.get(key) !== value) { - return false; - } - } - return true; - }, + this.expressionFilterManager = new ExpressionFilterManager( + this.dashboardProvider.metricsViewsProvider, + this.dashboardProvider.yamlConfigProvider, ); + + this.processSpec(this.spec); } checkAndSetMaxWidth = ({ maxWidth }: V1CanvasSpec) => { @@ -346,38 +305,7 @@ export class CanvasEntity { this.titleStore.set(validSpec.displayName ?? ""); - const defaultPreset = validSpec?.defaultPreset ?? {}; - const filterExpressions = defaultPreset.filterExpr ?? {}; - const pinnedFilters = validSpec?.pinnedFilters ?? []; - const requiredFilters = validSpec?.requiredFilters ?? []; - - if (metricsViews) { - if (this.filterManager) { - this.filterManager.updateConfig( - metricsViews, - pinnedFilters, - filterExpressions, - requiredFilters, - ); - } else { - this.filterManager = new FilterManager( - metricsViews, - this.instanceId, - pinnedFilters, - filterExpressions, - requiredFilters, - ); - // Clears the active component when a global filter changes through - // FilterManager.actions.* (user-driven filter UI). Pivot click-to-filter - // bypasses actions and mutates FilterState directly, so it does NOT - // trigger this callback; see pivot-click-to-filter.ts for details. - this.filterManager.onFilterChange = () => this.clearActiveComponent(); - } - } else { - // need to find a better way to initialize this in certain contextx - bgh - this.filterManager = new FilterManager({}, "", [], {}); - this.filterManager.onFilterChange = () => this.clearActiveComponent(); - } + // TODO: onFilterChange for non-pivot-click-to-filter and call this.clearActiveComponent. this.processRows({ canvas, components, metricsViews, filePath }); }; @@ -390,32 +318,40 @@ export class CanvasEntity { setTimeout(resolve, 100); }); - const pinnedFilters = get(this.filterManager.pinnedFilterKeysStore); - const requiredFilters = get(this.filterManager.requiredFilterKeysStore); + const pinnedFilters = Object.keys( + this.dashboardProvider.yamlConfigProvider.pinnedFilters, + ); + const requiredFilters = Object.keys( + this.dashboardProvider.yamlConfigProvider.requiredFilters, + ); // Persist pinned and required independently. Render-time treats a filter as // visible whenever it's in either set, so we don't dedupe here: doing so // would silently drop the pin flag if a user later toggled required off. - const pinnedNames = Array.from(pinnedFilters).map((f) => f.split("::")[1]); - const requiredNames = Array.from(requiredFilters).map( - (f) => f.split("::")[1], - ); + const pinnedNames = pinnedFilters + .map((f) => f.split("::").pop()) + .filter(Boolean) as string[]; + const requiredNames = requiredFilters + .map((f) => f.split("::").pop()) + .filter(Boolean) as string[]; const timeRange = get(this.timeManager.state.rangeStore); const comparisonOn = get(this.timeManager.state.showTimeComparisonStore); - const metricsViewFilters = get(this.filterManager.metricsViewFilters); - const filterNames = Array.from(metricsViewFilters.keys()); - const promises = Array.from(metricsViewFilters.values()).map((filters) => { - const parsed = get(filters.parsed); + const filterNames = Object.keys( + this.expressionFilterManager.managerByMetricsView, + ); + const promises = Object.values( + this.expressionFilterManager.managerByMetricsView, + ).map((manager) => { + const protoExpr = manager.expr as any; // TODO: expand toProto.ts::toExpressionProto to support subquery and convert. return queryClient.fetchQuery({ - queryKey: [ - "resolve-metrics-view-filter-expression", + queryKey: getQueryServiceConvertExpressionToMetricsSQLQueryKey( this.instanceId, - parsed.where, - ], + { expression: protoExpr }, + ), queryFn: () => queryServiceConvertExpressionToMetricsSQL(this.client, { - expression: parsed.where as any, + expression: protoExpr, }), }); }); @@ -543,7 +479,6 @@ export class CanvasEntity { if (redirected) return; } - this.filterManager.onUrlChange(searchParams); this.searchParams.set(searchParams); if (!isolated) { this.saveSnapshot(searchParams.toString()); @@ -621,6 +556,7 @@ export class CanvasEntity { const deployed = projectId; if (deployed) { + // TODO: bookmark specific code should only be in web-admin let homeBookmarkUrlSearch: string | undefined = undefined; try { // Only gets imported in admin context @@ -1088,7 +1024,7 @@ function getDefaults(defaultPreset: V1CanvasPreset) { ([metricsViewName, { expression }]) => { if (expression) { const flattened = flattenExpression(expression); - const urlFormat = getFilterParam(flattened, [], []); + const urlFormat = convertExpressionToFilterParam(flattened, []); if (urlFormat) { defaultSearchParams.set( diff --git a/web-common/src/features/canvas/stores/filter-manager.ts b/web-common/src/features/canvas/stores/filter-manager.ts deleted file mode 100644 index fea046dbb2f9..000000000000 --- a/web-common/src/features/canvas/stores/filter-manager.ts +++ /dev/null @@ -1,1134 +0,0 @@ -import { goto } from "$app/navigation"; -import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants"; -import type { MeasureFilterEntry } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry"; -import { type DimensionFilterItem } from "@rilldata/web-common/features/dashboards/state-managers/selectors/dimension-filters"; -import type { MeasureFilterItem } from "@rilldata/web-common/features/dashboards/state-managers/selectors/measure-filters"; -import type { - MetricsViewSpecDimension, - V1CanvasPresetFilterExpr, - V1Expression, - V1MetricsView, -} from "@rilldata/web-common/runtime-client"; -import { - V1Operation, - type MetricsViewSpecMeasure, -} from "@rilldata/web-common/runtime-client"; -import { - derived, - get, - writable, - type Readable, - type Writable, -} from "svelte/store"; -import { getDimensionDisplayName } from "../../dashboards/filters/getDisplayName"; -import { - createAndExpression, - flattenInExpressionValues, -} from "../../dashboards/stores/filter-utils"; -import { ExploreStateURLParams } from "../../dashboards/url-state/url-params"; -import type { ParsedFilters } from "./filter-state"; -import { FilterState } from "./filter-state"; - -export type UIFilters = { - dimensionFilters: Map; - measureFilters: Map; - complexFilters: V1Expression[]; - hasFilters: boolean; - hasClearableFilters: boolean; -}; - -export type MissingRequiredFilter = { - key: string; - name: string; - label: string; -}; - -export type MetricsViewName = string; -type DimensionName = string; -type MeasureName = string; - -type LookupKey = `${string}${typeof NAME_SEPARATOR}${string}`; - -// // A Lookup allows you to take a unique dimension/measure key (after namespace merging) -// // And find all the corresponding measures/dimensions across all metrics views -type UniqueLookup = Map>; - -export type DimensionLookup = UniqueLookup; -export type MeasureLookup = UniqueLookup; - -const MV_NAME_SEPARATOR = "//"; -const NAME_SEPARATOR = "::"; - -function getLookupKey(mvNames: string[], name: string): LookupKey { - return `${mvNames.sort().join(MV_NAME_SEPARATOR)}${NAME_SEPARATOR}${name}`; -} - -export class FilterManager { - metricsViewFilters = new StoreOfStores(); - pinnedFilterKeysStore = writable>(new Set()); - defaultPinnedFilterKeysStore = writable>(new Set()); - requiredFilterKeysStore = writable>(new Set()); - defaultRequiredFilterKeysStore = writable>(new Set()); - temporaryFilterKeysStore = writable>(new Map()); - - // Fires when a global filter mutation is committed (via actions or clearAllFilters). - onFilterChange?: () => void; - - allDimensionsStore = writable(new Map()); - allMeasuresStore = writable(new Map()); - - activeUIFiltersStore: Readable; - defaultUIFiltersStore: Readable; - - missingRequiredFiltersStore: Readable; - - filterMapStore: Readable>; - - dimensionsForMetricsView = writable( - new Map>(), - ); - measuresForMetricsView = writable( - new Map>(), - ); - - // Look up list of dimensions based on which combination of metrics views a measure is applicable for - // {{metrics_view_1}}//{{metrics_view_2}} will get you all the dimensions in metrics_view_1 and metrics_view_2 - uniqueMetricsViewGroupingToDimensionArrayStore = writable( - new Map(), - ); - - constructor( - metricsViews: Record, - public instanceId: string, - pinnedFilters?: string[], - defaultFilters?: V1CanvasPresetFilterExpr, - requiredFilters?: string[], - ) { - this.updateConfig( - metricsViews, - pinnedFilters, - defaultFilters, - requiredFilters, - ); - - this.defaultUIFiltersStore = derived( - [this.metricsViewFilters], - ([metricsViewFilters], set) => { - const stores = Array.from(metricsViewFilters.values()).map( - (f) => f.parsedDefaultFilters, - ); - derived( - [ - this.defaultPinnedFilterKeysStore, - this.allMeasuresStore, - this.allDimensionsStore, - ...stores, - ], - ([ - defaultPinnedFilterKeys, - allMeasures, - allDimensions, - ...filters - ]) => { - return this.convertToUIFilters( - filters, - new Map(), - defaultPinnedFilterKeys, - allMeasures, - allDimensions, - ); - }, - ).subscribe(set); - }, - ); - - this.activeUIFiltersStore = derived( - [this.metricsViewFilters], - ([metricsViewFilters], set) => { - const stores = Array.from(metricsViewFilters.values()).map( - (f) => f.parsed, - ); - - derived( - [ - this.pinnedFilterKeysStore, - this.temporaryFilterKeysStore, - this.requiredFilterKeysStore, - this.allMeasuresStore, - this.allDimensionsStore, - ...stores, - ], - ([ - pinnedFilters, - temporaryFilterKeys, - requiredFilters, - allMeasures, - allDimensions, - ...filters - ]) => { - return this.convertToUIFilters( - filters, - temporaryFilterKeys, - pinnedFilters, - allMeasures, - allDimensions, - requiredFilters, - ); - }, - ).subscribe(set); - }, - ); - - this.filterMapStore = derived( - [this.metricsViewFilters], - ([metricsViewFilters], set) => { - const stores = Array.from(metricsViewFilters.values()).map( - (f) => f.parsed, - ); - - derived(stores, (filters) => { - const map = new Map(); - filters.forEach((expr, i) => { - const mvName = Array.from(metricsViewFilters.keys())[i]; - map.set(mvName, expr.where); - }); - return map; - }).subscribe(set); - }, - ); - - this.missingRequiredFiltersStore = derived( - [this.requiredFilterKeysStore, this.activeUIFiltersStore], - ([requiredKeys, activeUIFilters]) => { - if (requiredKeys.size === 0) return []; - - const missing: MissingRequiredFilter[] = []; - requiredKeys.forEach((key) => { - const name = key.split(NAME_SEPARATOR)[1] ?? key; - const dimItem = activeUIFilters.dimensionFilters.get(key); - if (dimItem) { - if (isDimensionItemEmpty(dimItem)) { - missing.push({ key, name, label: dimItem.label || name }); - } - return; - } - - const measureItem = activeUIFilters.measureFilters.get(key); - if (measureItem) { - if (isMeasureItemEmpty(measureItem)) { - missing.push({ key, name, label: measureItem.label || name }); - } - return; - } - - // Required filter has no entry in the UI filter map at all => unsatisfied. - missing.push({ key, name, label: name }); - }); - return missing; - }, - ); - } - - createLocalFilterStore = (metricsViewName: string) => { - return new FilterState(metricsViewName, this, this.instanceId); - }; - - onUrlChange = (searchParams: URLSearchParams) => { - const legacyFilter = searchParams.get(ExploreStateURLParams.Filters); - - this.metricsViewFilters.forEach((filters, mvName) => { - const paramKey = `${ExploreStateURLParams.Filters}.${mvName}`; - const filterString = searchParams.get(paramKey) ?? legacyFilter ?? ""; - - filters.onFilterStringChange(filterString); - }); - }; - - updateConfig = ( - metricsViews: Record, - pinnedFilters?: string[], - defaultFilters?: V1CanvasPresetFilterExpr, - requiredFilters?: string[], - ): void => { - const dimensionNameToMetricsViewNames: Map< - DimensionName, - MetricsViewName[] - > = new Map(); - const measureNameToMetricsViewNames: Map = - new Map(); - - const exhaustiveMeasures: Map< - MetricsViewName, - Map - > = new Map(); - const exhaustiveDimensions: Map< - MetricsViewName, - Map - > = new Map(); - - Object.entries(metricsViews).forEach(([metricsViewName, metricsView]) => { - if (!metricsView) return; - - const { measures, dimensions } = metricsView.state?.validSpec || {}; - const dimensionsForMetricsView = new Map< - DimensionName, - MetricsViewSpecDimension - >(); - updateNameToMetricsViews( - dimensions?.filter((d) => d.type !== "DIMENSION_TYPE_TIME"), - (d) => d.name, - dimensionNameToMetricsViewNames, - dimensionsForMetricsView, - metricsViewName, - ); - - exhaustiveDimensions.set(metricsViewName, dimensionsForMetricsView); - - const measuresForMetricsView = new Map< - MeasureName, - MetricsViewSpecMeasure - >(); - updateNameToMetricsViews( - measures, - (m) => m.name, - measureNameToMetricsViewNames, - measuresForMetricsView, - metricsViewName, - ); - - exhaustiveMeasures.set(metricsViewName, measuresForMetricsView); - - let filterStore = this.metricsViewFilters.get(metricsViewName); - if (!filterStore) { - filterStore = new FilterState(metricsViewName, this, this.instanceId); - this.metricsViewFilters.set(metricsViewName, filterStore); - } - - const filter = defaultFilters?.[metricsViewName]; - filterStore.onDefaultExpressionChange( - flattenExpression(filter?.expression), - ); - }); - - const mergedDimensions = mergeFilters( - exhaustiveDimensions, - dimensionNameToMetricsViewNames, - "all", - ); - - const mergedMeasures = mergeFilters( - exhaustiveMeasures, - measureNameToMetricsViewNames, - "all", - ); - - const resolveFilterKey = (filterName: string): string | undefined => { - const metricsViewNames = new Set(); - this.metricsViewFilters.forEach((_, metricsViewName) => { - const dimensionsForView = exhaustiveDimensions.get(metricsViewName); - const measuresForView = exhaustiveMeasures.get(metricsViewName); - if (dimensionsForView?.has(filterName)) { - metricsViewNames.add(metricsViewName); - } - if (measuresForView?.has(filterName)) { - metricsViewNames.add(metricsViewName); - } - }); - if (metricsViewNames.size === 0) return undefined; - return getLookupKey(Array.from(metricsViewNames), filterName); - }; - - const requiredKeys = new Set(); - if (requiredFilters) { - requiredFilters.forEach((filterName) => { - const key = resolveFilterKey(filterName); - if (key) requiredKeys.add(key); - }); - } - this.requiredFilterKeysStore.set(requiredKeys); - this.defaultRequiredFilterKeysStore.set(new Set(requiredKeys)); - - // Pinned and required are tracked independently. convertToUIFilters renders - // a filter as visible whenever it's pinned OR required, so we don't fold - // required into the pinned set here. Doing so would mean toggling required - // off in the UI also drops the pin. - if (pinnedFilters) { - const pinnedKeys = new Set(); - pinnedFilters.forEach((filterName) => { - const key = resolveFilterKey(filterName); - if (key) pinnedKeys.add(key); - }); - this.pinnedFilterKeysStore.set(pinnedKeys); - this.defaultPinnedFilterKeysStore.set(new Set(pinnedKeys)); - } - - // Update stores - this.dimensionsForMetricsView.set(exhaustiveDimensions); - this.measuresForMetricsView.set(exhaustiveMeasures); - - this.allMeasuresStore.set(mergedMeasures); - - this.allDimensionsStore.set(mergedDimensions); - - this.uniqueMetricsViewGroupingToDimensionArrayStore.set( - createDimensionsForUniqueCombinationsOfMetricsViews(exhaustiveDimensions), - ); - }; - - getUIFiltersFromString = (filterString: string) => { - const searchParams = new URLSearchParams(filterString); - - const parsedFilters: ParsedFilters[] = []; - const legacyFilter = searchParams.get(ExploreStateURLParams.Filters); - - this.metricsViewFilters.forEach((filters, mvName) => { - const paramKey = `${ExploreStateURLParams.Filters}.${mvName}`; - const filterString = searchParams.get(paramKey) ?? legacyFilter ?? ""; - - const parsed = filters.parseFilterString(filterString); - parsedFilters.push(parsed); - }); - - return this.convertToUIFilters( - parsedFilters, - new Map(), - get(this.pinnedFilterKeysStore), - get(this.allMeasuresStore), - get(this.allDimensionsStore), - get(this.requiredFilterKeysStore), - ); - }; - - convertToUIFilters = ( - parsedFilters: ParsedFilters[], - temporaryFilterKeys: Map, - pinnedFilters: Set, - allMeasures: MeasureLookup, - allDimensions: DimensionLookup, - requiredFilters: Set = new Set(), - ): UIFilters => { - const parsedMap = new Map( - parsedFilters.map((p) => [p.metricsViewName, p]), - ); - - // Used for sorting - const fullFilterString = parsedFilters - .map((p) => p.urlFormat) - .join(" AND "); - - const merged = { - dimensionFilters: new Map(), - measureFilters: new Map(), - complexFilters: [], - hasFilters: false, - hasClearableFilters: false, - }; - - const metricsViewCombinationToDimensionMap = get( - this.uniqueMetricsViewGroupingToDimensionArrayStore, - ); - - allMeasures.forEach((measureMap, key) => { - const filters: MeasureFilterItem[] = []; - - const pinned = pinnedFilters.has(key); - const temporary = temporaryFilterKeys.has(key); - const required = requiredFilters.has(key); - - const metricsViewNames = measureMap ? Array.from(measureMap.keys()) : []; - const measureSpecs = Array.from(measureMap?.values() || []); - - measureMap.forEach((measure, metricsViewName) => { - const parsed = parsedMap.get(metricsViewName); - if (!parsed) return; - - const [metricsViewGroup, measureName] = key.split(NAME_SEPARATOR); - - const measureFilter = parsed.measureFilters.get(measure.name as string); - if (!measureFilter) { - if (pinned || temporary || required) { - filters.push({ - dimensionName: "", - dimensions: - metricsViewCombinationToDimensionMap.get(metricsViewGroup), - name: measureName, - label: measureSpecs[0].displayName ?? "", - pinned: pinned, - required: required, - measures: measureMap, - metricsViewNames: metricsViewNames, - }); - } - } else { - if (pinned) { - measureFilter.pinned = true; - } else { - measureFilter.pinned = false; - } - measureFilter.required = required; - filters.push({ - ...measureFilter, - dimensions: - metricsViewCombinationToDimensionMap.get(metricsViewGroup), - }); - } - }); - - if (filters.length === 0) return; - - const item: MeasureFilterItem = { - ...filters[0], - measures: measureMap, - }; - item.missingRequired = required && isMeasureItemEmpty(item); - merged.measureFilters.set(key, item); - }); - - // can improve efficiency at a later date - bgh - // iterate through all the unique dimension keys - allDimensions.forEach((dimensionMap, key) => { - const filters: DimensionFilterItem[] = []; - - const firstDimension = Array.from(dimensionMap.values())[0]; - - const pinned = pinnedFilters.has(key); - const temporary = temporaryFilterKeys.has(key); - const required = requiredFilters.has(key); - - // iterate through the merged dimensions under this unique key - dimensionMap.forEach((dimension, metricsViewName) => { - const parsed = parsedMap.get(metricsViewName); - - if (!parsed) return; - - const dimFilter = parsed.dimensionFilters.get(dimension.name as string); - - if (!dimFilter) { - if (pinned || temporary || required) { - const tempData: DimensionFilterItem = { - name: firstDimension.name || "", - label: getDimensionDisplayName(firstDimension), - mode: DimensionFilterMode.Select, - selectedValues: [], - dimensions: dimensionMap, - isInclude: true, - inputText: undefined, - pinned: pinned, - required: required, - }; - - filters.push(tempData); - } - } else { - if (pinned) { - dimFilter.pinned = true; - } else { - dimFilter.pinned = false; - } - dimFilter.required = required; - filters.push(dimFilter); - } - }); - - if (filters.length === 0) return; - if ( - filters.every( - (f) => - f.isInclude === filters[0].isInclude && f.mode === filters[0].mode, - ) - ) { - const item: DimensionFilterItem = { - ...filters[0], - dimensions: dimensionMap, - }; - item.missingRequired = required && isDimensionItemEmpty(item); - merged.dimensionFilters.set(key, item); - } else { - // mixed filters - need to resolve - } - }); - - merged.hasClearableFilters = parsedFilters.some( - (p) => p.dimensionFilters.size > 0 || p.measureFilters.size > 0, - ); - - merged.hasFilters = - merged.hasClearableFilters || - pinnedFilters.size > 0 || - temporaryFilterKeys.size > 0; - - // Sorting to ensure that pills don't jump around unnecessarily in the UI - // Can be optimized - bgh - const stickyKeys = Array.from( - new Set([...requiredFilters, ...pinnedFilters]), - ); - const sortedDimensionMap = new Map( - Array.from(merged.dimensionFilters.entries()).sort((a, b) => { - return sortMeasuresOrDimensions( - a[0], - b[0], - stickyKeys, - Array.from(temporaryFilterKeys.keys()), - fullFilterString, - ); - }), - ); - - const sortedMeasureMap = new Map( - Array.from(merged.measureFilters.entries()).sort((a, b) => { - return sortMeasuresOrDimensions( - a[0], - b[0], - stickyKeys, - Array.from(temporaryFilterKeys.keys()), - fullFilterString, - ); - }), - ); - - merged.measureFilters = sortedMeasureMap; - merged.dimensionFilters = sortedDimensionMap; - - return merged; - }; - - actions = { - applyDimensionContainsMode: async ( - dimensionName: string, - searchText: string, - metricsViewNames: string[], - ) => { - this.onFilterChange?.(); - this.checkTemporaryFilter(dimensionName, metricsViewNames); - const map = new Map(); - - metricsViewNames.forEach((name) => { - const filterClass = this.metricsViewFilters.get(name); - if (!filterClass) return; - const string = filterClass.applyDimensionContainsMode( - dimensionName, - searchText, - ); - - map.set(name, string || null); - }); - await this.applyFiltersToUrl(map); - }, - removeDimensionFilter: async ( - dimensionName: string, - metricsViewNames: string[], - ) => { - this.onFilterChange?.(); - this.checkTemporaryFilter(dimensionName, metricsViewNames); - this.checkPinnedFilter(dimensionName, metricsViewNames); - - const map = new Map(); - - metricsViewNames.forEach((name) => { - const filterClass = this.metricsViewFilters.get(name); - if (!filterClass) return; - const string = filterClass.removeDimensionFilter(dimensionName); - map.set(name, string || null); - }); - - await this.applyFiltersToUrl(map, true); - }, - addTemporaryFilter: (measureOrDimensionKey: string) => { - this.temporaryFilterKeysStore.update((tempFilters) => { - tempFilters.set(measureOrDimensionKey, true); - return tempFilters; - }); - - // Boolean controls whether the filter pill should open the dropdown automatically - // This removes the flag after 200ms - setTimeout(() => { - this.temporaryFilterKeysStore.update((tempFilters) => { - tempFilters.set(measureOrDimensionKey, false); - return tempFilters; - }); - }, 200); - }, - toggleDimensionFilterMode: async ( - dimensionName: string, - metricsViewNames: string[], - ) => { - this.onFilterChange?.(); - this.checkTemporaryFilter(dimensionName, metricsViewNames); - - const map = new Map(); - - metricsViewNames.forEach((name) => { - const filterClass = this.metricsViewFilters.get(name); - - if (!filterClass) return; - const string = filterClass.toggleDimensionFilterMode(dimensionName); - - if (!string) return; - - map.set(name, string); - }); - - await this.applyFiltersToUrl(map); - }, - applyDimensionInListMode: async ( - dimensionName: string, - values: string[], - metricsViewNames: string[], - ) => { - this.onFilterChange?.(); - this.checkTemporaryFilter(dimensionName, metricsViewNames); - const map = new Map(); - - metricsViewNames.forEach((name) => { - const filterClass = this.metricsViewFilters.get(name); - - if (!filterClass) return; - const string = filterClass.applyDimensionInListMode( - dimensionName, - values, - ); - - map.set(name, string || null); - }); - - await this.applyFiltersToUrl(map); - }, - toggleDimensionValueSelections: async ( - dimensionName: string, - dimensionValues: string[], - metricsViewNames: string[], - keepPillVisible?: boolean, - isExclusiveFilter?: boolean, - exclude?: boolean, - ) => { - this.onFilterChange?.(); - this.checkTemporaryFilter(dimensionName, metricsViewNames); - - const newFilters = new Map(); - - metricsViewNames.forEach((name) => { - const filterClass = this.metricsViewFilters.get(name); - - if (!filterClass) return; - - const string = filterClass.toggleDimensionValueSelections( - dimensionName, - dimensionValues, - keepPillVisible, - isExclusiveFilter, - exclude, - ); - - newFilters.set(name, string || null); - }); - - await this.applyFiltersToUrl(newFilters); - }, - setMeasureFilter: async ( - dimensionName: string, - filter: MeasureFilterEntry, - oldDimension: string, - metricsViewNames: string[], - ) => { - this.onFilterChange?.(); - this.checkTemporaryFilter(filter.measure, metricsViewNames); - - const newFilters = new Map(); - - metricsViewNames.forEach((name) => { - const filterClass = this.metricsViewFilters.get(name); - - if (!filterClass) return; - - const string = filterClass.setMeasureFilter( - dimensionName, - filter, - oldDimension, - ); - - newFilters.set(name, string || null); - }); - - await this.applyFiltersToUrl(newFilters); - }, - removeMeasureFilter: async ( - dimensionName: string, - measureName: string, - metricsViewNames: string[], - ) => { - this.onFilterChange?.(); - this.checkTemporaryFilter(measureName, metricsViewNames); - this.checkPinnedFilter(measureName, metricsViewNames); - - const newFilters = new Map(); - - metricsViewNames.forEach((name) => { - const filterClass = this.metricsViewFilters.get(name); - - if (!filterClass) return; - - const string = filterClass.removeMeasureFilter( - dimensionName, - measureName, - ); - - newFilters.set(name, string || null); - }); - - await this.applyFiltersToUrl(newFilters, true); - }, - toggleFilterPin: (name: string, metricsViewNames: string[]) => { - this.pinnedFilterKeysStore.update((pinned) => { - const key = getLookupKey(metricsViewNames, name); - const deleted = pinned.delete(key); - - if (!deleted) { - pinned.add(key); - } - - this.temporaryFilterKeysStore.update((tempFilters) => { - if (deleted) { - tempFilters.set(key, false); - } else { - tempFilters.delete(key); - } - - return tempFilters; - }); - return pinned; - }); - }, - toggleFilterRequired: (name: string, metricsViewNames: string[]) => { - const key = getLookupKey(metricsViewNames, name); - this.requiredFilterKeysStore.update((required) => { - if (required.has(key)) { - required.delete(key); - } else { - required.add(key); - } - return required; - }); - // Required pills render via either pinned or required, so clear any - // temporary-flag state so the pill doesn't accidentally collapse. - this.temporaryFilterKeysStore.update((tempFilters) => { - tempFilters.delete(key); - return tempFilters; - }); - }, - }; - - checkTemporaryFilter = ( - measureOrDimensionName: string, - metricsViewNames: string[], - ) => { - const key = getLookupKey(metricsViewNames, measureOrDimensionName); - const tempFilters = get(this.temporaryFilterKeysStore); - - const deleted = tempFilters.delete(key); - if (deleted) { - this.temporaryFilterKeysStore.set(tempFilters); - } - }; - - checkPinnedFilter = ( - measureOrDimensionName: string, - metricsViewNames: string[], - ) => { - const key = getLookupKey(metricsViewNames, measureOrDimensionName); - const pinnedFilters = get(this.pinnedFilterKeysStore); - - const deleted = pinnedFilters.delete(key); - if (deleted) { - this.pinnedFilterKeysStore.set(pinnedFilters); - } - }; - - // Unclear on what this actually should do - bgh - // Go to defaults or truly clear all filters? - clearAllFilters = async () => { - this.onFilterChange?.(); - this.temporaryFilterKeysStore.set(new Map()); - const existingParams = new URLSearchParams(window.location.search); - const filterParamsToDelete = Array.from(existingParams.keys()).filter( - (key) => key.startsWith(ExploreStateURLParams.Filters), - ); - filterParamsToDelete.forEach((key) => { - existingParams.delete(key); - }); - const string = existingParams.toString(); - if (string) { - await goto(`?${string}`); - return; - } else { - await goto(`?clear=true`); - } - }; - - applyFiltersToUrl = async ( - filters: Map, - allowFilterClear = false, - ) => { - const existingParams = new URLSearchParams(window.location.search); - - existingParams.delete("default"); - existingParams.delete("clear"); - existingParams.delete(ExploreStateURLParams.Filters); - - filters.forEach((filterString, mvName) => { - const paramKey = `${ExploreStateURLParams.Filters}.${mvName}`; - if (filterString === null) { - existingParams.delete(paramKey); - } else { - existingParams.set(paramKey, filterString); - } - }); - - const string = existingParams.toString(); - - if (!string) { - if (allowFilterClear) { - await goto(`?clear=true`); - return; - } else { - await goto(`?default=true`); - return; - } - } else { - await goto(`?${string}`); - } - }; -} - -/** - * Sorts filter items with the following priority: - * 1. Sticky items (required or pinned), following their order in stickyKeys - * 2. Regular filter items, following their appearance in the full filter string - * 3. Temporary items - */ -function sortMeasuresOrDimensions( - aKey: string, - bKey: string, - stickyKeys: string[], - temporaryFilterKeys: string[], - fullFilterString: string, -): number { - const isASticky = stickyKeys.includes(aKey); - const isBSticky = stickyKeys.includes(bKey); - const isATemporary = temporaryFilterKeys.includes(aKey); - const isBTemporary = temporaryFilterKeys.includes(bKey); - - if (isASticky && isBSticky) { - return stickyKeys.indexOf(aKey) - stickyKeys.indexOf(bKey); - } - if (isASticky !== isBSticky) { - return isASticky ? -1 : 1; - } - - if (isATemporary && isBTemporary) { - return ( - temporaryFilterKeys.indexOf(aKey) - temporaryFilterKeys.indexOf(bKey) - ); - } - if (isATemporary !== isBTemporary) { - return isATemporary ? 1 : -1; - } - - const aName = aKey.split(NAME_SEPARATOR)[1] || aKey; - const bName = bKey.split(NAME_SEPARATOR)[1] || bKey; - - const aIndex = fullFilterString.indexOf(aName); - const bIndex = fullFilterString.indexOf(bName); - - return aIndex - bIndex; -} - -function isDimensionItemEmpty(item: DimensionFilterItem): boolean { - const hasSelectedValues = (item.selectedValues?.length ?? 0) > 0; - const hasInputText = !!item.inputText && item.inputText.length > 0; - return !hasSelectedValues && !hasInputText; -} - -function isMeasureItemEmpty(item: MeasureFilterItem): boolean { - return !item.filter; -} - -// This should be deprecated eventually in favor of better support for variously formatted expressions -export function flattenExpression( - expression: V1Expression | undefined, -): V1Expression { - if (!expression) { - return createAndExpression([]); - } - - let root: V1Expression; - - // Ensure top level is an OPERATION_AND - if (!expression.cond || expression.cond.op !== V1Operation.OPERATION_AND) { - root = createAndExpression([expression]); - } else { - root = expression; - } - - const rootCond = root.cond; - if ( - !rootCond || - rootCond.op !== V1Operation.OPERATION_AND || - !Array.isArray(rootCond.exprs) - ) { - return root; - } - - // Recursively flatten all nested ANDs, preserving order - rootCond.exprs = flattenAndExprs(rootCond.exprs); - - // Normalize array-valued IN/NIN expressions into individual value expressions - rootCond.exprs = rootCond.exprs.map(flattenInExpressionValues); - - return root; -} - -function flattenAndExprs(exprs: V1Expression[]): V1Expression[] { - const result: V1Expression[] = []; - - for (const expr of exprs) { - const cond = expr.cond; - if ( - cond && - cond.op === V1Operation.OPERATION_AND && - Array.isArray(cond.exprs) - ) { - // Inline children in order - result.push(...flattenAndExprs(cond.exprs)); - } else { - result.push(expr); - } - } - - return result; -} - -// wip - bgh -function mergeFilters( - metricsViewItems: Map>, - locations: Map, - mergeStrategy: "all" = "all", -): UniqueLookup { - const merged = new Map>(); - - if (mergeStrategy === "all") { - locations.forEach((mvNames, name) => { - const key = getLookupKey(mvNames, name); - const dimMap = new Map(); - mvNames.forEach((mvName) => { - const dim = metricsViewItems.get(mvName)?.get(name); - if (dim) { - dimMap.set(mvName, dim); - } - }); - merged.set(key, dimMap); - }); - } - - return merged; -} - -class StoreOfStores { - private store: Writable>; - subscribe: Readable>["subscribe"]; - - constructor() { - this.store = writable>(new Map()); - this.subscribe = this.store.subscribe; - } - - forEach = ( - callback: (value: T, key: string, map: Map) => void, - ) => { - const map = get(this.store); - map.forEach(callback); - }; - - get(key: string): T | undefined { - const map = get(this.store); - return map.get(key); - } - - set(key: string, value: T) { - this.store.update((map) => { - const next = new Map(map); - next.set(key, value); - return next; - }); - } -} - -function getAllCombinations(items: string[]): string[][] { - const results: string[][] = []; - const n = items.length; - - function dfs(start: number, path: string[]) { - if (path.length > 0) { - results.push(structuredClone(path)); - } - - for (let i = start; i < n; i++) { - path.push(items[i]); - dfs(i + 1, path); - path.pop(); - } - } - - dfs(0, []); - - return results; -} - -function createDimensionsForUniqueCombinationsOfMetricsViews( - metricsViewMap: Map< - MetricsViewName, - Map - >, -) { - const metricsViewNames = Array.from(metricsViewMap.keys()).sort(); - - const allSortedCombinationsOfMetricsViewNames: string[][] = - getAllCombinations(metricsViewNames); - - const map = new Map(); - - allSortedCombinationsOfMetricsViewNames.forEach((group) => { - const dimensions: Map = new Map(); - const key = group.join(MV_NAME_SEPARATOR); - - group.forEach((mvName) => { - const dims = metricsViewMap.get(mvName); - - if (dims) { - dims.forEach((dim, dimName) => { - dimensions.set(dimName, dim); - }); - } - }); - - map.set(key, Array.from(dimensions.values())); - }); - - return map; -} - -function updateNameToMetricsViews( - specs: Spec[] | undefined, - getName: (spec: Spec) => Name | undefined, - nameToMetricsViewNames: Map, - nameToSpecForView: Map, - metricsViewName: MetricsViewName, -) { - specs?.forEach((spec) => { - const name = getName(spec); - if (!name) return; - - const existing = nameToMetricsViewNames.get(name) ?? []; - nameToMetricsViewNames.set(name, [...existing, metricsViewName]); - nameToSpecForView.set(name, spec); - }); -} diff --git a/web-common/src/features/canvas/stores/filter-state.ts b/web-common/src/features/canvas/stores/filter-state.ts deleted file mode 100644 index 23565eebe7f2..000000000000 --- a/web-common/src/features/canvas/stores/filter-state.ts +++ /dev/null @@ -1,649 +0,0 @@ -import { getFiltersFromText } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/dimension-search-text-utils"; -import type { MeasureFilterEntry } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry"; -import { - mergeDimensionAndMeasureFilters, - splitWhereFilter, -} from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; -import { toggleDimensionFilterValue } from "@rilldata/web-common/features/dashboards/state-managers/actions/dimension-filters.ts"; -import { - createAndExpression, - createInExpression, - createLikeExpression, - forEachIdentifier, - getValuesInExpression, - isExpressionUnsupported, - negateExpression, - sanitiseExpression, -} from "@rilldata/web-common/features/dashboards/stores/filter-utils"; -import type { - MetricsViewSpecDimension, - V1Expression, -} from "@rilldata/web-common/runtime-client"; -import { - type MetricsViewSpecMeasure, - V1Operation, -} from "@rilldata/web-common/runtime-client"; -import { get, writable, type Writable } from "svelte/store"; -import type { DimensionFilterItem } from "../../dashboards/state-managers/selectors/dimension-filters"; -import { DimensionFilterMode } from "../../dashboards/filters/dimension-filters/constants"; -import type { MeasureFilterItem } from "../../dashboards/state-managers/selectors/measure-filters"; -import type { DimensionThresholdFilter } from "../../dashboards/stores/explore-state"; -import { convertExpressionToFilterParam } from "../../dashboards/url-state/filters/converters"; -import { FilterManager, type UIFilters } from "./filter-manager"; -import { getDimensionDisplayName } from "../../dashboards/filters/getDisplayName"; -import { eventBus } from "@rilldata/web-common/lib/event-bus/event-bus"; - -export type ParsedFilters = ReturnType; - -export function initFilterBase(metricsViewName: string) { - return { - where: createAndExpression([]), - dimensionFilter: createAndExpression([]), - urlFormat: undefined as string | undefined, - metricsViewName, - dimensionsWithInListFilter: [], - dimensionThresholdFilters: [], - measureFilters: new Map(), - dimensionFilters: new Map(), - complexFilters: [] as V1Expression[], - hasFilters: false, - hasClearableFilters: false, - }; -} - -// Exists at the global and widget level on Canvas -export class FilterState { - parsed: Writable; - parsedDefaultFilters: Writable; - temporaryFilterKeys = writable(new Set()); - - constructor( - private metricsViewName: string, - private manager: FilterManager, - public instanceId: string, - ) { - this.parsed = writable(initFilterBase(this.metricsViewName)); - this.parsedDefaultFilters = writable(initFilterBase(this.metricsViewName)); - } - - setTemporaryFilterName = (key: string) => { - const keys = get(this.temporaryFilterKeys); - keys.add(key); - this.temporaryFilterKeys.set(keys); - - this.reprocessExistingFilters(); - }; - - reprocessExistingFilters = () => { - const parsed = get(this.parsed); - - this.parsed.set( - this.parseFilter({ - expr: parsed.where, - dimensionsWithInListFilter: parsed.dimensionsWithInListFilter, - }), - ); - }; - - onFilterStringChange(filterString: string) { - const { urlFormat } = get(this.parsed); - if (urlFormat === filterString) return; - - this.parsed.set(this.parseFilterString(filterString)); - } - - onDefaultExpressionChange = (expr: V1Expression | undefined) => { - expr = expr ?? createAndExpression([]); - - this.parsedDefaultFilters.set( - this.parseFilter({ - expr, - }), - ); - }; - - clearAllFilters = () => { - this.parsed.set(this.parseFilterString("")); - this.temporaryFilterKeys.set(new Set()); - return ""; - }; - - parseFilter({ - expr, - filterString, - dimensionsWithInListFilter, - }: { - expr: V1Expression; - filterString?: string; - dimensionsWithInListFilter?: string[]; - }): ParsedFilters { - const where = structuredClone(expr); - const { dimensionThresholdFilters, dimensionFilters } = - splitWhereFilter(expr); - - const isComplexFilter = false; - - filterString = - filterString || - getFilterParam( - expr, - dimensionThresholdFilters, - dimensionsWithInListFilter ?? [], - ) || - ""; - - dimensionsWithInListFilter = - dimensionsWithInListFilter ?? - getFiltersFromText(filterString).dimensionsWithInlistFilter; - - if (isComplexFilter) { - return { - urlFormat: filterString, - where: where, - dimensionFilter: dimensionFilters, - metricsViewName: this.metricsViewName, - dimensionsWithInListFilter, - dimensionThresholdFilters, - dimensionFilters: new Map(), - measureFilters: new Map(), - complexFilters: [expr], - hasClearableFilters: false, - hasFilters: false, - }; - } - - const dimensionMap = - get(this.manager.dimensionsForMetricsView).get(this.metricsViewName) ?? - new Map(); - const measureMap = - get(this.manager.measuresForMetricsView).get(this.metricsViewName) ?? - new Map(); - - const processed = processExpression({ - expr: dimensionFilters, - measureMap, - dimensionMap, - metricsViewName: this.metricsViewName, - dimensionsWithInListFilter, - dimensionThresholdFilters, - temporaryFilterKeys: get(this.temporaryFilterKeys), - }); - - return { - urlFormat: filterString, - where: where, - dimensionFilter: dimensionFilters, - metricsViewName: this.metricsViewName, - dimensionsWithInListFilter, - dimensionThresholdFilters, - ...processed, - complexFilters: [], - }; - } - - parseFilterString = (filterString: string | undefined) => { - const { expr, dimensionsWithInlistFilter: dimensionsWithInListFilter } = - getFiltersFromText(filterString ?? ""); - - return this.parseFilter({ expr, filterString, dimensionsWithInListFilter }); - }; - - removeDimensionFilter = (dimensionName: string) => { - const { - dimensionFilter: df, - dimensionThresholdFilters, - dimensionsWithInListFilter, - } = get(this.parsed); - const exprIdx = df.cond?.exprs?.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ); - if (!(exprIdx === undefined || exprIdx === -1)) { - df.cond?.exprs?.splice(exprIdx, 1); - } - - return getFilterParam( - df, - dimensionThresholdFilters, - dimensionsWithInListFilter, - ); - }; - - applyDimensionContainsMode = (dimensionName: string, searchText: string) => { - const { - dimensionFilter: wf, - dimensionThresholdFilters, - dimensionsWithInListFilter, - } = get(this.parsed); - - const exprIndex = wf.cond?.exprs?.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ); - - if (exprIndex === undefined || exprIndex === -1) { - wf.cond!.exprs!.push( - createLikeExpression(dimensionName, `%${searchText}%`, false), - ); - } else { - const operation = wf.cond!.exprs![exprIndex].cond!.op; - const isExclude = - operation === V1Operation.OPERATION_NLIKE || - operation === V1Operation.OPERATION_NIN; - wf.cond!.exprs![exprIndex] = createLikeExpression( - dimensionName, - `%${searchText}%`, - isExclude, - ); - } - return getFilterParam( - wf, - dimensionThresholdFilters, - dimensionsWithInListFilter, - ); - }; - - toggleDimensionFilterMode = (dimensionName: string) => { - const { - dimensionsWithInListFilter, - dimensionFilter: wf, - dimensionThresholdFilters, - } = get(this.parsed); - - if (!wf.cond?.exprs) return; - const exprIdx = wf.cond.exprs.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ); - if (exprIdx === -1) return; - wf.cond.exprs[exprIdx] = negateExpression(wf.cond.exprs[exprIdx]); - - return getFilterParam( - wf, - dimensionThresholdFilters, - dimensionsWithInListFilter, - ); - }; - - toggleDimensionValueSelections = ( - dimensionName: string, - dimensionValues: (string | null)[], - keepPillVisible?: boolean, - isExclusiveFilter?: boolean, - exclude: boolean = false, - ) => { - const { - dimensionFilter: wf, - dimensionsWithInListFilter, - dimensionThresholdFilters, - } = get(this.parsed); - - let exprIndex = - wf.cond?.exprs?.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ) ?? -1; - let expr = wf.cond?.exprs?.[exprIndex]; - - if (!expr?.cond?.exprs) { - expr = createInExpression(dimensionName, dimensionValues, exclude); - wf.cond?.exprs?.push(expr); - exprIndex = wf.cond!.exprs!.length - 1; - } else { - const wasLikeFilter = - expr?.cond?.op === V1Operation.OPERATION_LIKE || - expr?.cond?.op === V1Operation.OPERATION_NLIKE; - - const wasInListFilter = - dimensionsWithInListFilter.includes(dimensionName); - - if (wasLikeFilter || wasInListFilter) { - eventBus.emit("notification", { - message: "Converted filter type to Select", - link: { - text: "Undo", - href: window.location.href, - }, - }); - - if (wasInListFilter) { - const idx = dimensionsWithInListFilter.indexOf(dimensionName); - if (idx !== -1) { - dimensionsWithInListFilter.splice(idx, 1); - } - } - - if (dimensionValues.length) { - expr = createInExpression(dimensionName, dimensionValues, exclude); - wf.cond?.exprs?.splice(exprIndex, 1, expr); - } - } else if (expr) { - dimensionValues.forEach((dimensionValue) => { - toggleDimensionFilterValue( - expr!, - dimensionValue, - !!isExclusiveFilter, - ); - }); - - if (expr?.cond?.exprs?.length === 1) { - wf.cond?.exprs?.splice(exprIndex, 1); - } - } - } - - return getFilterParam( - wf, - dimensionThresholdFilters, - dimensionsWithInListFilter, - ); - }; - - /** - * Adds dimension values to the filter without removing existing ones. - * Unlike toggleDimensionValueSelections, this never removes a value - * that is already present; it only appends new values. - */ - addDimensionValueSelections = ( - dimensionName: string, - dimensionValues: (string | null)[], - ) => { - const { - dimensionFilter: wf, - dimensionsWithInListFilter, - dimensionThresholdFilters, - } = get(this.parsed); - - const exprIndex = - wf.cond?.exprs?.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ) ?? -1; - const expr = wf.cond?.exprs?.[exprIndex]; - - if (!expr?.cond?.exprs) { - // No existing filter for this dimension; create one - const newExpr = createInExpression(dimensionName, dimensionValues); - wf.cond?.exprs?.push(newExpr); - } else { - // Append only values not already in the filter - const existing = getValuesInExpression(expr); - const existingSet = new Set(existing); - for (const val of dimensionValues) { - if (!existingSet.has(val)) { - existing.push(val); - } - } - const ident = expr.cond.exprs[0]; - expr.cond.exprs = [ident, ...existing.map((v) => ({ val: v }))]; - } - - return getFilterParam( - wf, - dimensionThresholdFilters, - dimensionsWithInListFilter, - ); - }; - - applyDimensionInListMode = (dimensionName: string, values: string[]) => { - const { - dimensionFilter: wf, - dimensionThresholdFilters, - dimensionsWithInListFilter, - } = get(this.parsed); - const isExclude = false; - - const expr = createInExpression(dimensionName, values, isExclude); - - dimensionsWithInListFilter.push(dimensionName); - - const exprIndex = - wf.cond?.exprs?.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ) ?? -1; - if (exprIndex === undefined || exprIndex === -1) { - wf.cond!.exprs!.push(expr); - } else { - wf.cond!.exprs![exprIndex] = expr; - } - - return getFilterParam( - wf, - dimensionThresholdFilters, - dimensionsWithInListFilter, - ); - }; - - setMeasureFilter = ( - dimensionName: string, - filter: MeasureFilterEntry, - oldDimension: string, - ) => { - const { - dimensionThresholdFilters: dtfs, - dimensionsWithInListFilter, - dimensionFilter, - } = get(this.parsed); - - const dimIdx = dtfs.findIndex( - (dtf) => dtf.name === (oldDimension || dimensionName), - ); - let dimThresholdFilter = dtfs[dimIdx]; - - if (!dimThresholdFilter) { - dimThresholdFilter = { name: dimensionName, filters: [] }; - dtfs.push(dimThresholdFilter); - } else { - if (oldDimension && oldDimension !== dimensionName) { - dimThresholdFilter.name = dimensionName; - } - const filters = dimThresholdFilter.filters; - const exprIdx = filters.findIndex((f) => f.measure === filter.measure); - if (exprIdx !== -1) { - filters.splice(exprIdx, 1); - } - } - - const exprIdx = dimThresholdFilter.filters.findIndex( - (f) => f.measure === filter.measure, - ); - if (exprIdx === -1) { - dimThresholdFilter.filters.push(filter); - } else { - dimThresholdFilter.filters.splice(exprIdx, 1, filter); - } - - return getFilterParam(dimensionFilter, dtfs, dimensionsWithInListFilter); - }; - removeMeasureFilter = (dimensionName: string, measureName: string) => { - const { - dimensionThresholdFilters: dtfs, - dimensionsWithInListFilter, - dimensionFilter, - } = get(this.parsed); - - const dimIdx = dtfs.findIndex((dtf) => dtf.name === dimensionName); - const dimThresholdFilter = dtfs[dimIdx]; - - if (dimThresholdFilter) { - const filters = dimThresholdFilter.filters; - const exprIdx = filters.findIndex((f) => f.measure === measureName); - if (exprIdx !== -1) { - filters.splice(exprIdx, 1); - } - if (filters.length === 0) { - dtfs.splice(dimIdx, 1); - } - } - - return getFilterParam(dimensionFilter, dtfs, dimensionsWithInListFilter); - }; -} - -function processExpression({ - expr, - dimensionMap, - measureMap, - metricsViewName, - dimensionsWithInListFilter, - dimensionThresholdFilters, - temporaryFilterKeys, -}: { - expr: V1Expression; - measureMap: Map; - dimensionMap: Map; - metricsViewName: string; - dimensionsWithInListFilter: string[]; - dimensionThresholdFilters: DimensionThresholdFilter[]; - temporaryFilterKeys: Set; -}): UIFilters { - const isComplex = isExpressionUnsupported(expr); - const dimensionFilters = getDimensionFilterItemsMap( - dimensionMap, - expr, - dimensionsWithInListFilter, - metricsViewName, - ); - const measureFilters = getCanvasMeasureFiltersMap( - measureMap, - dimensionThresholdFilters, - ); - - const allDimensions = Array.from(dimensionMap.values()); - temporaryFilterKeys.forEach((key) => { - if (dimensionFilters.has(key)) { - temporaryFilterKeys.delete(key); - return; - } - const dimension = dimensionMap.get(key); - if (dimension) { - dimensionFilters.set(key, { - name: key, - label: getDimensionDisplayName(dimension), - dimensions: new Map([[metricsViewName, dimension]]), - selectedValues: [], - mode: DimensionFilterMode.Select, - isInclude: true, - pinned: false, - }); - } - - const measure = measureMap.get(key); - if (measureFilters.has(key)) { - temporaryFilterKeys.delete(key); - return; - } - if (measure) { - measureFilters.set(key, { - dimensionName: "", - dimensions: allDimensions, - name: key, - label: measure.displayName ?? "", - pinned: false, - measures: new Map([[metricsViewName, measure]]), - metricsViewNames: [metricsViewName], - }); - } - }); - return { - complexFilters: isComplex ? [expr] : [], - measureFilters: measureFilters, - dimensionFilters: dimensionFilters, - hasFilters: dimensionFilters.size > 0 || measureFilters.size > 0, - hasClearableFilters: dimensionFilters.size > 0 || measureFilters.size > 0, - }; -} - -export function getCanvasMeasureFiltersMap( - measureIdMap: Map, - dimensionThresholdFilters: DimensionThresholdFilter[], -): Map { - const map = new Map(); - - dimensionThresholdFilters.forEach((dtf) => { - const filter = dtf.filters[0]; - const measureName = filter.measure; - const measure = measureIdMap.get(measureName); - if (!measure) return; - - const entry: MeasureFilterItem = { - dimensionName: dtf.name, - name: measureName, - label: measure.displayName || measure.expression || filter.measure, - filter: filter, - }; - - map.set(measureName, entry); - }); - - return map; -} - -export function getDimensionFilterItemsMap( - dimensionIdMap: Map, - filter: V1Expression | undefined, - dimensionsWithInlistFilter: string[], - metricsViewName: string, -): Map { - if (!filter) return new Map(); - const filteredDimensions: Map = new Map(); - const addedDimension = new Set(); - - forEachIdentifier(filter, (e, ident) => { - if (addedDimension.has(ident) || !dimensionIdMap.has(ident)) return; - const dim = dimensionIdMap.get(ident); - - if (!dim) { - return; - } - addedDimension.add(ident); - - const op = e.cond?.op; - if (op === V1Operation.OPERATION_IN || op === V1Operation.OPERATION_NIN) { - const isInListMode = dimensionsWithInlistFilter.includes(ident); - filteredDimensions.set(ident, { - name: ident, - label: getDimensionDisplayName(dim), - dimensions: new Map([[metricsViewName, dim]]), - mode: isInListMode - ? DimensionFilterMode.InList - : DimensionFilterMode.Select, - selectedValues: getValuesInExpression(e), - isInclude: e.cond?.op === V1Operation.OPERATION_IN, - inputText: undefined, - pinned: false, - }); - } else if ( - op === V1Operation.OPERATION_LIKE || - op === V1Operation.OPERATION_NLIKE - ) { - filteredDimensions.set(ident, { - name: ident, - label: getDimensionDisplayName(dim), - mode: DimensionFilterMode.Contains, - selectedValues: [], - inputText: e.cond?.exprs?.[1]?.val?.toString?.() ?? "", - isInclude: e.cond?.op === V1Operation.OPERATION_LIKE, - dimensions: new Map([[metricsViewName, dim]]), - pinned: false, - }); - } - }); - - return filteredDimensions; -} - -export function getFilterParam( - whereFilter: V1Expression, - dtf: DimensionThresholdFilter[], - dimensionsWithInlistFilter: string[], -) { - const mergedFilters = - sanitiseExpression( - mergeDimensionAndMeasureFilters( - whereFilter ?? createAndExpression([]), - dtf, - ), - undefined, - ) ?? createAndExpression([]); - - return convertExpressionToFilterParam( - mergedFilters, - dimensionsWithInlistFilter, - ); -} diff --git a/web-common/src/features/components/charts/ChartContainer.svelte b/web-common/src/features/components/charts/ChartContainer.svelte index 288caff85abe..e61c3e225d0a 100644 --- a/web-common/src/features/components/charts/ChartContainer.svelte +++ b/web-common/src/features/components/charts/ChartContainer.svelte @@ -1,129 +1,147 @@ {#if $spec} @@ -137,13 +155,8 @@

{chartTitle}

{#if "metrics_view" in $spec} - {/if} - {#if showExploreLink && $exploreAvailability.isAvailable} + {#if showExploreLink && exploreAvailability.isAvailable} {/if} @@ -172,7 +185,7 @@ {chartType} chartSpec={$spec} {chartData} - measures={$measures} + measures={metricsViewProvider.measures} {themeMode} theme={currentTheme} isCanvas={true} diff --git a/web-common/src/features/dashboards/aggregation-request-utils.ts b/web-common/src/features/dashboards/aggregation-request-utils.ts index e7948991536b..9909d21052a6 100644 --- a/web-common/src/features/dashboards/aggregation-request-utils.ts +++ b/web-common/src/features/dashboards/aggregation-request-utils.ts @@ -1,10 +1,7 @@ import { getAggregationDimensionFromFieldName } from "@rilldata/web-common/features/dashboards/aggregation-request/dimension-utils.ts"; import { getComparisonRequestMeasures } from "@rilldata/web-common/features/dashboards/dashboard-utils.ts"; import { MeasureModifierSuffixRegex } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry.ts"; -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils.ts"; import { ComparisonModifierSuffixRegex } from "@rilldata/web-common/features/dashboards/pivot/types.ts"; -import { sanitiseExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; -import type { FiltersState } from "@rilldata/web-common/features/dashboards/stores/Filters.ts"; import type { TimeControlState } from "@rilldata/web-common/features/dashboards/stores/TimeControls.ts"; import { mapSelectedComparisonTimeRangeToV1TimeRange, @@ -56,22 +53,6 @@ export const aggregationRequestWithTimeRange = ( }; }; -export const aggregationRequestWithFilters = (filtersState: FiltersState) => { - return (aggregationRequest: V1MetricsViewAggregationRequest) => { - const whereFilter = sanitiseExpression( - mergeDimensionAndMeasureFilters( - filtersState.whereFilter, - filtersState.dimensionThresholdFilters, - ), - undefined, - ); - return { - ...aggregationRequest, - where: whereFilter, - }; - }; -}; - export const aggregationRequestWithRowsAndColumns = ({ exploreSpec, rows, diff --git a/web-common/src/features/dashboards/big-number/MeasuresContainer.svelte b/web-common/src/features/dashboards/big-number/MeasuresContainer.svelte index ec9c91749532..697a6fdc26ce 100644 --- a/web-common/src/features/dashboards/big-number/MeasuresContainer.svelte +++ b/web-common/src/features/dashboards/big-number/MeasuresContainer.svelte @@ -1,15 +1,15 @@ diff --git a/web-common/src/features/dashboards/dimension-table/DimensionDisplay.svelte b/web-common/src/features/dashboards/dimension-table/DimensionDisplay.svelte index 44ace3a8b1d1..2535f7cb924f 100644 --- a/web-common/src/features/dashboards/dimension-table/DimensionDisplay.svelte +++ b/web-common/src/features/dashboards/dimension-table/DimensionDisplay.svelte @@ -22,24 +22,21 @@ getComparisonRequestMeasures, getURIRequestMeasure, } from "../dashboard-utils"; - import { mergeDimensionAndMeasureFilters } from "../filters/measure-filters/measure-filter-utils"; import { getSort } from "../leaderboard/leaderboard-utils"; import { getFiltersForOtherDimensions } from "../selectors"; import { getMeasuresForDimensionOrLeaderboardDisplay } from "../state-managers/selectors/dashboard-queries"; import { dimensionSearchText } from "../stores/dashboard-stores"; - import { sanitiseExpression } from "../stores/filter-utils"; - import type { DimensionThresholdFilter } from "web-common/src/features/dashboards/stores/explore-state"; import DimensionHeader from "./DimensionHeader.svelte"; import DimensionTable from "./DimensionTable.svelte"; import { getDimensionFilterWithSearch } from "./dimension-table-utils"; + import { sanitiseExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; const queryLimit = 250; export let timeRange: V1TimeRange; export let comparisonTimeRange: V1TimeRange | undefined; - export let whereFilter: V1Expression; + export let whereFilter: V1Expression | undefined; export let metricsViewName: string; - export let dimensionThresholdFilters: DimensionThresholdFilter[]; export let visibleMeasureNames: string[]; export let timeControlsReady: boolean; export let dimension: MetricsViewSpecDimension; @@ -47,7 +44,6 @@ const { selectors: { - dimensionFilters: { unselectedDimensionValues }, dimensionTable: { virtualizedTableColumns, prepareDimTableRows }, sorting: { sortedAscending, sortType }, leaderboard: { @@ -55,15 +51,9 @@ leaderboardSortByMeasureName, }, }, - actions: { - dimensionsFilter: { - toggleDimensionValueSelection, - selectItemsInFilter, - deselectItemsInFilter, - }, - }, dashboardStore, validSpecStore, + expressionFilterManager, } = getStateManagers(); $: metricsViewSpec = $validSpecStore.data?.metricsView ?? {}; @@ -75,7 +65,7 @@ $: selectedValues = selectedDimensionValues( client, [metricsViewName], - $dashboardStore.whereFilter, + whereFilter, dimensionName, timeRange.start, timeRange.end, @@ -92,7 +82,7 @@ $leaderboardShowContextForAllMeasures ? null : $leaderboardSortByMeasureName, - dimensionThresholdFilters, + whereFilter, visibleMeasureNames, ).map((name) => ({ name }) as V1MetricsViewAggregationMeasure), @@ -126,11 +116,7 @@ (m) => !m.comparisonValue && !m.comparisonDelta && !m.comparisonRatio, ), where: sanitiseExpression( - mergeDimensionAndMeasureFilters( - getFiltersForOtherDimensions(whereFilter, dimensionName), - dimensionThresholdFilters, - ), - undefined, + getFiltersForOtherDimensions(whereFilter, dimensionName), ), timeRange, }, @@ -162,11 +148,6 @@ !!comparisonTimeRange, ); - $: where = sanitiseExpression( - mergeDimensionAndMeasureFilters(filterSet, dimensionThresholdFilters), - undefined, - ); - $: sortedQuery = createQueryServiceMetricsViewAggregation( client, { @@ -176,13 +157,13 @@ timeRange, comparisonTimeRange, sort, - where, + where: sanitiseExpression(filterSet), limit: queryLimit.toString(), offset: "0", }, { query: { - enabled: timeControlsReady && !!filterSet, + enabled: timeControlsReady, }, }, ); @@ -200,14 +181,20 @@ function onSelectItem(data: { index: number; meta: boolean }) { const label = tableRows[data.index][dimensionName] as string; - toggleDimensionValueSelection(dimensionName, label, false, data.meta); + expressionFilterManager.dimensionFilterAction( + dimensionName, + (dimensionManager) => dimensionManager.toggleValue(label, false), + ); } function toggleAllSearchItems() { const labels = tableRows.map((row) => row[dimensionName] as string); if (areAllTableRowsSelected) { - deselectItemsInFilter(dimensionName, labels); + expressionFilterManager.dimensionFilterAction( + dimensionName, + (dimensionManager) => dimensionManager.removeSelectedValues(labels), + ); eventBus.emit("notification", { message: m.dashboard_removed_items_filter({ @@ -216,11 +203,10 @@ }); return; } else { - const newValuesSelected = $unselectedDimensionValues( + const newValuesSelected = expressionFilterManager.dimensionFilterAction( dimensionName, - labels, + (dimensionManager) => dimensionManager.appendSelectedValues(labels), ); - selectItemsInFilter(dimensionName, labels); eventBus.emit("notification", { message: m.dashboard_added_items_filter({ count: newValuesSelected.length.toString(), diff --git a/web-common/src/features/dashboards/dimension-table/DimensionHeader.svelte b/web-common/src/features/dashboards/dimension-table/DimensionHeader.svelte index 5efabf64269d..b648dc3a9881 100644 --- a/web-common/src/features/dashboards/dimension-table/DimensionHeader.svelte +++ b/web-common/src/features/dashboards/dimension-table/DimensionHeader.svelte @@ -18,39 +18,51 @@ import StartPivotButton from "../toolbars/StartPivotButton.svelte"; import { getDimensionTableExportQuery } from "./dimension-table-export"; - export let dimensionName: string; - export let areAllTableRowsSelected = false; - export let isRowsEmpty = true; - export let searchText: string; - export let hideStartPivotButton = false; - export let onToggleSearchItems: () => void; + let { + dimensionName, + areAllTableRowsSelected, + isRowsEmpty, + searchText = $bindable(""), + hideStartPivotButton, + onToggleSearchItems, + }: { + dimensionName: string; + areAllTableRowsSelected: boolean; + isRowsEmpty: boolean; + searchText: string; + hideStartPivotButton: boolean; + onToggleSearchItems: () => void; + } = $props(); const stateManagers = getStateManagers(); const { selectors: { sorting: { sortedByDimensionValue }, dimensions: { getDimensionDisplayName }, - dimensionFilters: { isFilterExcludeMode }, measures: { visibleMeasures }, }, actions: { sorting: { toggleSort }, dimensions: { setPrimaryDimension }, - dimensionsFilter: { toggleDimensionFilterMode }, leaderboard: { toggleLeaderboardShowContextForAllMeasures }, }, timeRangeSummaryStore, dashboardStore, exploreName, + expressionFilterManager, } = stateManagers; const { adminServer, exports } = featureFlags; - $: exploreHasTimeDimension = !!$timeRangeSummaryStore.data; + let exploreHasTimeDimension = $derived(!!$timeRangeSummaryStore.data); - $: excludeMode = $isFilterExcludeMode(dimensionName); + let excludeMode = $derived( + expressionFilterManager.filterManagers.dimensions.find( + (dfm) => dfm.name === dimensionName, + )?.exclude ?? false, + ); - let isLeaderboardActionsOpen = false; + let isLeaderboardActionsOpen = $state(false); function resetSearchText() { searchText = ""; @@ -72,10 +84,13 @@ setPrimaryDimension(""); }; function toggleFilterMode() { - toggleDimensionFilterMode(dimensionName); + expressionFilterManager.dimensionFilterAction( + dimensionName, + (dimensionManager) => dimensionManager.toggleExclude(), + ); } - let showReplacePivotModal = false; + let showReplacePivotModal = $state(false); function startPivotForDimensionTable() { const pivot = $dashboardStore?.pivot; diff --git a/web-common/src/features/dashboards/dimension-table/DimensionTable.svelte b/web-common/src/features/dashboards/dimension-table/DimensionTable.svelte index 9bae458e94f2..03cd945c01b0 100644 --- a/web-common/src/features/dashboards/dimension-table/DimensionTable.svelte +++ b/web-common/src/features/dashboards/dimension-table/DimensionTable.svelte @@ -1,4 +1,4 @@ - - + + + +
+ + - -
- - - {#if dimensionColumn} - - {/if} -
- {#if rows.length} - - {/if}
- {/if} + {#if rows.length} + + + {/if} + {#if !rows.length} + {#if hasClearableFilters} + + {/if} + {/if} + + diff --git a/web-common/src/features/dashboards/filters/FilterButton.svelte b/web-common/src/features/dashboards/filters/FilterButton.svelte deleted file mode 100644 index 6a7bae4c3efb..000000000000 --- a/web-common/src/features/dashboards/filters/FilterButton.svelte +++ /dev/null @@ -1,99 +0,0 @@ - - - - - {#snippet child({ props })} - - - {m.dashboard_add_filter()} - - {/snippet} - - - { - setTemporaryFilterName(name); - }} - {selectableGroups} - selectedItems={[]} - {side} - /> - - - diff --git a/web-common/src/features/dashboards/filters/FilterChipsReadOnly.svelte b/web-common/src/features/dashboards/filters/FilterChipsReadOnly.svelte deleted file mode 100644 index a217c3ad1b7c..000000000000 --- a/web-common/src/features/dashboards/filters/FilterChipsReadOnly.svelte +++ /dev/null @@ -1,128 +0,0 @@ - - - -
- {#if displayTimeRange} - - {/if} - {#if dimensionFilters.length > 0} - {#each dimensionFilters as filterData (filterData.name)} - {@const dimension = filterData.dimensions.get(metricsViewNames[0])} - - {#if dimension} - - {/if} - - {/each} - {/if} - {#if measureFilters.length > 0} - {#each measureFilters as { name, label, dimensionName, filter } (name)} -
- -
- {/each} - {/if} -
- - diff --git a/web-common/src/features/dashboards/filters/Filters.svelte b/web-common/src/features/dashboards/filters/Filters.svelte index a047aebf6125..757e4f6f0134 100644 --- a/web-common/src/features/dashboards/filters/Filters.svelte +++ b/web-common/src/features/dashboards/filters/Filters.svelte @@ -1,15 +1,8 @@ @@ -516,98 +465,14 @@ {/if} -
- {#if !readOnly} - - {/if} -
- {#if isComplexFilter} - - {:else if !allDimensionFilters.length && !allMeasureFilters.length} -
- {m.dashboard_no_filters_selected()} -
- {:else} - {#each allDimensionFilters as filterData (filterData.name)} -
- - removeDimensionFilter(name)} - toggleDimensionFilterMode={async (name) => { - toggleDimensionFilterMode(name); - }} - toggleDimensionValueSelections={async ( - name, - values, - _metricsViewNames, - keepPillVisible, - isExclusiveFilter, - exclude, - ) => - toggleMultipleDimensionValueSelections( - name, - values, - keepPillVisible ?? true, - isExclusiveFilter, - exclude, - )} - applyDimensionInListMode={async (name, values) => - applyDimensionInListMode(name, values)} - applyDimensionContainsMode={async (name, searchText) => - applyDimensionContainsMode(name, searchText)} - isUrlTooLongAfterInListFilter={(values) => - isUrlTooLongAfterInListFilter(filterData.name, values)} - /> -
- {/each} - {#each allMeasureFilters as filterData (filterData.name)} -
- - removeMeasureFilter(filterData.dimensionName, filterData.name)} - onApply={({ dimension, oldDimension, filter }) => - handleMeasureFilterApply( - dimension, - filterData.name, - oldDimension, - filter, - )} - /> -
- {/each} - {/if} - - {#if !readOnly} - - - {#if hasFilters} - - {/if} - {/if} -
-
+ diff --git a/web-common/src/features/dashboards/filters/MetricsViewFilterManager.svelte.ts b/web-common/src/features/dashboards/filters/MetricsViewFilterManager.svelte.ts new file mode 100644 index 000000000000..bbefa88965bf --- /dev/null +++ b/web-common/src/features/dashboards/filters/MetricsViewFilterManager.svelte.ts @@ -0,0 +1,292 @@ +import { + type V1Expression, + V1Operation, +} from "@rilldata/web-common/runtime-client"; +import { DimensionFilterManager } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/DimensionFilterManager.svelte.ts"; +import { MeasureFilterManager } from "@rilldata/web-common/features/dashboards/filters/measure-filters/MeasureFilterManager.svelte.ts"; +import type { MetricsViewsProvider } from "@rilldata/web-common/features/metrics-views/providers/MetricsViewsProvider.svelte.ts"; +import { + createAndExpression, + createOrExpression, +} from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; +import { convertExpressionToFilterParam } from "@rilldata/web-common/features/dashboards/url-state/filters/converters.ts"; +import type { YAMLConfigProvider } from "@rilldata/web-common/features/dashboards/providers/YAMLConfigProvider.svelte.ts"; + +export type DimensionOrMeasureManager = + | DimensionFilterManager + | MeasureFilterManager; +export type AnyManager = DimensionOrMeasureManager | MetricsViewFilterManager; +export type AllManagers = { + dimensionManagers: DimensionFilterManager[]; + measureManagers: MeasureFilterManager[]; + joinerManagers: MetricsViewFilterManager[]; +}; + +/** + * Manager for an AND/OR expression for a metrics view. + */ +export class MetricsViewFilterManager { + public expr: V1Expression | undefined; + public dimensionOnlyExpr: V1Expression | undefined; + // String representation of the filter expression. Used to check duplicate expressions across metrics views. + public param: string; + + public managers: AllManagers; + public managerLookup: Record< + string, + (DimensionFilterManager | MeasureFilterManager)[] + >; + public hasSomeFilter: boolean; + public isComplexFilter: boolean; + + public constructor( + public readonly metricsViewName: string, + private readonly metricsViewsProvider: MetricsViewsProvider, + public type: + | typeof V1Operation.OPERATION_AND + | typeof V1Operation.OPERATION_OR, + managers: AllManagers, + public readonly inList: string[], + ) { + this.managers = $state(managers); + + this.expr = $derived(this.buildExpression(this.managers)); + this.dimensionOnlyExpr = $derived(this.buildDimensionOnlyExpression()); + this.param = $derived( + this.expr ? convertExpressionToFilterParam(this.expr, this.inList) : "", + ); + + this.managerLookup = $derived(this.buildManagerLookup()); + this.hasSomeFilter = $derived(Object.values(this.managerLookup).length > 0); + // Currently only single level AND joiner is supported where each dimension/measure has a single filter. + // Anything else is considered complex filter, and we only show an editable text box. + this.isComplexFilter = $derived( + this.type === V1Operation.OPERATION_OR || + Object.values(this.managerLookup).some( + (managers) => managers.length > 1, + ) || + this.managers.joinerManagers.length > 0, + ); + } + + public static parse( + metricsViewsProvider: MetricsViewsProvider, + metricsViewName: string, + expr: V1Expression | undefined, + dimensionsWithInlistFilter: string[], + existingManagers: Map, + yamlConfigProvider: YAMLConfigProvider | undefined, + ): AnyManager | undefined { + const op = expr?.cond?.op; + if (op === V1Operation.OPERATION_AND || op === V1Operation.OPERATION_OR) { + const dimensionManagers: DimensionFilterManager[] = []; + const measureManagers: MeasureFilterManager[] = []; + const joinerManagers: MetricsViewFilterManager[] = []; + const added = new Set(); + + const add = (manager: AnyManager, force: boolean) => { + if (manager.param && !existingManagers.has(manager.param)) { + manager = existingManagers.get(manager.param) ?? manager; + existingManagers.set(manager.param, manager); + } else if ( + !manager.param && + !(manager instanceof MetricsViewFilterManager) + ) { + manager = existingManagers.get(manager.name) ?? manager; + existingManagers.set( + (manager as DimensionOrMeasureManager).name, + manager, + ); + } + + if ( + manager instanceof DimensionFilterManager && + (!added.has(manager.name) || force) + ) { + added.add(manager.name); + dimensionManagers.push(manager); + } else if ( + manager instanceof MeasureFilterManager && + (!added.has(manager.name) || force) + ) { + added.add(manager.name); + measureManagers.push(manager); + } else if (manager instanceof MetricsViewFilterManager) { + joinerManagers.push(manager); + } + }; + + expr?.cond?.exprs?.forEach((e) => { + let manager = MetricsViewFilterManager.parse( + metricsViewsProvider, + metricsViewName, + e, + dimensionsWithInlistFilter, + existingManagers, + undefined, + ); + if (!manager) return; + // Prefer to share class for similar expressions. + // This is a hack to make a single filter across the metrics view work. + // TODO: find a better solution to share + manager = existingManagers.get(manager.param) ?? manager; + + add(manager, true); + }); + + // Add required and pinned filters when yamlConfigProvider is provided. + // yamlConfigProvider is only provided for the top level manager. + // TODO: handle advanced filters + if (yamlConfigProvider) { + Object.keys(yamlConfigProvider.requiredFilters) + .concat(Object.keys(yamlConfigProvider.pinnedFilters)) + .forEach((requiredFilter) => { + const manager = + DimensionFilterManager.createForMetricsViews( + metricsViewsProvider, + requiredFilter, + metricsViewName, + ) ?? + MeasureFilterManager.createForMetricsViews( + metricsViewsProvider, + requiredFilter, + metricsViewName, + ); + if (manager) add(manager, false); + }); + } + + return new MetricsViewFilterManager( + metricsViewName, + metricsViewsProvider, + op, + { + dimensionManagers, + measureManagers, + joinerManagers, + }, + dimensionsWithInlistFilter, + ); + } else { + const ident = expr?.cond?.exprs?.[0]?.ident ?? ""; + // Both filter types are keyed off a dimension: a dimension filter by the dimension it filters + // and a measure filter by the dimension its subquery groups by. + if (!metricsViewsProvider.dimensionSpecs[ident]?.[metricsViewName]) { + return undefined; + } + + const firstValueExpr = expr?.cond?.exprs?.[1]; + + if (firstValueExpr?.subquery) { + // Having a subquery means this is a measure filter. + const measureName = firstValueExpr.subquery.measures?.[0]; + if (!measureName) return undefined; + return MeasureFilterManager.createForMetricsViews( + metricsViewsProvider, + measureName, + metricsViewName, + firstValueExpr, + ); + } else { + // Everything else is a dimension filter for now. + return DimensionFilterManager.createForMetricsViews( + metricsViewsProvider, + ident, + metricsViewName, + expr, + dimensionsWithInlistFilter.includes(ident), + ); + } + } + } + + public maybeAddDimensionFilter( + dimensionFilterManager: DimensionFilterManager, + ) { + const dimensionName = dimensionFilterManager.name; + const alreadyAdded = !!this.managerLookup[dimensionName]; + const dimensionNotInMV = + !this.metricsViewsProvider.dimensionSpecs[dimensionName]?.[ + this.metricsViewName + ]; + if (alreadyAdded || dimensionNotInMV) return; + + this.managers = { + ...this.managers, + dimensionManagers: [ + ...this.managers.dimensionManagers, + dimensionFilterManager, + ], + }; + } + + public maybeAddMeasureFilter(measureFilterManager: MeasureFilterManager) { + const measureName = measureFilterManager.name; + const alreadyAdded = !!this.managerLookup[measureName]; + const measureNotInMV = + !this.metricsViewsProvider.measureSpecs[measureName]?.[ + this.metricsViewName + ]; + if (alreadyAdded || measureNotInMV) return; + + this.managers = { + ...this.managers, + measureManagers: [...this.managers.measureManagers, measureFilterManager], + }; + } + + private buildExpression(managers: AllManagers) { + const dimensionExprs = managers.dimensionManagers + .map((dfm) => dfm.expr) + .filter(Boolean) as V1Expression[]; + const measureExprs = managers.measureManagers + .map((mfm) => mfm.expr) + .filter(Boolean) as V1Expression[]; + const joinerExprs = managers.joinerManagers + .map((jm) => jm.expr) + .filter(Boolean) as V1Expression[]; + const exprs = dimensionExprs.concat(measureExprs).concat(joinerExprs); + if (exprs.length === 0) return undefined; + + if (this.type === V1Operation.OPERATION_AND) { + return createAndExpression(exprs); + } else { + return createOrExpression(exprs); + } + } + + private buildDimensionOnlyExpression() { + const dimensionExprs = this.managers.dimensionManagers + .map((dfm) => dfm.expr) + .filter(Boolean) as V1Expression[]; + if (dimensionExprs.length === 0) return undefined; + + if (this.type === V1Operation.OPERATION_AND) { + return createAndExpression(dimensionExprs); + } else { + return createOrExpression(dimensionExprs); + } + } + + private buildManagerLookup() { + const lookup = {} as Record< + string, + (DimensionFilterManager | MeasureFilterManager)[] + >; + this.managers.dimensionManagers.forEach((manager) => { + lookup[manager.name] ??= []; + lookup[manager.name].push(manager); + }); + this.managers.measureManagers.forEach((manager) => { + lookup[manager.name] ??= []; + lookup[manager.name].push(manager); + }); + this.managers.joinerManagers.forEach((manager) => { + Object.entries(manager.managerLookup).forEach(([name, managers]) => { + lookup[name] ??= []; + lookup[name].push(...managers); + }); + }); + return lookup; + } +} diff --git a/web-common/src/features/dashboards/filters/MissingRequiredFiltersMessage.svelte b/web-common/src/features/dashboards/filters/MissingRequiredFiltersMessage.svelte new file mode 100644 index 000000000000..152f3df25e21 --- /dev/null +++ b/web-common/src/features/dashboards/filters/MissingRequiredFiltersMessage.svelte @@ -0,0 +1,73 @@ + + +
+ +
diff --git a/web-common/src/features/dashboards/filters/ReadonlyExpressionFilters.svelte b/web-common/src/features/dashboards/filters/ReadonlyExpressionFilters.svelte new file mode 100644 index 000000000000..d6d1a463ca9a --- /dev/null +++ b/web-common/src/features/dashboards/filters/ReadonlyExpressionFilters.svelte @@ -0,0 +1,104 @@ + + +
+ {#if displayTimeRange} + + {/if} + + {#each nonEmptyDimensionManagers as dimensionManager (dimensionManager.name)} +
+ +
+ {/each} + + {#each nonEmptyMeasureManager as measureManager (measureManager.name)} +
+ +
+ {/each} +
+ + diff --git a/web-common/src/features/dashboards/filters/VerticalExpressionFilters.svelte b/web-common/src/features/dashboards/filters/VerticalExpressionFilters.svelte new file mode 100644 index 000000000000..28174040a0cb --- /dev/null +++ b/web-common/src/features/dashboards/filters/VerticalExpressionFilters.svelte @@ -0,0 +1,87 @@ + + +{#if !expressionFilterManager.isComplexFilter} +
+ + + +
+{/if} + +
+
+ {#if expressionFilterManager.isComplexFilter} + {#each Object.entries(expressionFilterManager.exprByMetricsView) as [mv, expr] (mv)} + + {/each} + {:else} + {#each expressionFilterManager.filterManagers.dimensions as dimensionManager (dimensionManager.name)} + + {/each} + + {#each expressionFilterManager.filterManagers.measures as measureManager (measureManager.name)} + + {/each} + {/if} +
+ +
+ {#if hasFilters} + + {/if} +
+
diff --git a/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilter.spec.ts b/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilter.spec.ts deleted file mode 100644 index a4520e25a431..000000000000 --- a/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilter.spec.ts +++ /dev/null @@ -1,700 +0,0 @@ -import { - addFilter, - useDashboardFetchMocksForComponentTests, -} from "@rilldata/web-common/features/dashboards/filters/test/filter-test-utils"; -import DimensionFilter from "@rilldata/web-common/features/dashboards/filters/dimension-filters/DimensionFilter.svelte"; -import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants"; -import { renderFilterComponent } from "@rilldata/web-common/features/dashboards/filters/test/render-filter-component"; -import { - createAndExpression, - createInExpression, - createLikeExpression, -} from "@rilldata/web-common/features/dashboards/stores/filter-utils"; -import { - AD_BIDS_EXPLORE_INIT, - AD_BIDS_EXPLORE_NAME, - AD_BIDS_METRICS_INIT, - AD_BIDS_METRICS_NAME, - AD_BIDS_PUBLISHER_DIMENSION, -} from "@rilldata/web-common/features/dashboards/stores/test-data/data"; -import { mockAnimationsForComponentTesting } from "@rilldata/web-common/lib/test/mock-animations"; -import { - RUNTIME_CONTEXT_KEY, - RuntimeClient, -} from "@rilldata/web-common/runtime-client/v2"; -import { - act, - fireEvent, - render, - screen, - waitFor, -} from "@testing-library/svelte"; -import { get } from "svelte/store"; -import { afterAll, beforeAll, describe, expect, it, vi } from "vitest"; - -// bits-ui 2.x Select uses PointerEvent APIs that jsdom doesn't support. -// Polyfill the missing types and methods so pointer-based interactions work in tests. -if (typeof globalThis.PointerEvent === "undefined") { - (globalThis as Record).PointerEvent = - class PointerEvent extends MouseEvent { - readonly pointerId: number; - readonly pointerType: string; - constructor( - type: string, - init?: PointerEventInit & Record, - ) { - super(type, init); - this.pointerId = (init?.pointerId as number) ?? 0; - this.pointerType = (init?.pointerType as string) ?? "mouse"; - } - }; -} -if (!HTMLElement.prototype.hasPointerCapture) { - HTMLElement.prototype.hasPointerCapture = () => false; -} -if (!HTMLElement.prototype.releasePointerCapture) { - HTMLElement.prototype.releasePointerCapture = () => {}; -} -if (!HTMLElement.prototype.scrollIntoView) { - HTMLElement.prototype.scrollIntoView = () => {}; -} - -/** - * bits-ui 2.x Select: open via keyboard (Space) on the trigger, then navigate - * with ArrowDown and select with Enter. Pointer events don't work reliably - * in jsdom because bits-ui's item ref tracking requires real layout. - */ -async function selectMode(name: RegExp) { - const trigger = document.getElementById("dimension-filter-mode-selector")!; - trigger.focus(); - // Open the select dropdown - await act(async () => { - await fireEvent.keyDown(trigger, { key: " " }); - }); - // Wait for options to appear - await waitFor(() => - expect(screen.getByRole("option", { name })).toBeVisible(), - ); - // bits-ui auto-highlights the current value on open. Navigate ArrowDown - // until the target option is highlighted, then press Enter to select. - const options = screen.getAllByRole("option"); - const targetIndex = options.findIndex((opt) => name.test(opt.textContent!)); - const highlightedOpt = options.findIndex((opt) => - opt.hasAttribute("data-highlighted"), - ); - const startIndex = highlightedOpt >= 0 ? highlightedOpt : -1; - const steps = - targetIndex >= startIndex - ? targetIndex - startIndex - : options.length - startIndex + targetIndex; - for (let i = 0; i < steps; i++) { - await act(async () => { - await fireEvent.keyDown(trigger, { key: "ArrowDown" }); - }); - } - await act(async () => { - await fireEvent.keyDown(trigger, { key: "Enter" }); - }); -} - -async function selectFirstMode() { - const trigger = document.getElementById("dimension-filter-mode-selector")!; - trigger.focus(); - await act(async () => { - await fireEvent.keyDown(trigger, { key: " " }); - }); - await waitFor(() => - expect(screen.getByRole("option", { name: /Select/ })).toBeVisible(), - ); - await act(async () => { - await fireEvent.keyDown(trigger, { key: "Home" }); - }); - await act(async () => { - await fireEvent.keyDown(trigger, { key: "Enter" }); - }); -} - -async function closeFilterMenu(label: string) { - await act(() => screen.getByLabelText(label).click()); - await waitFor(() => - expect(screen.queryByRole("menu")).not.toBeInTheDocument(), - ); -} - -async function waitForBodyScrollCleanup() { - await new Promise((resolve) => window.setTimeout(resolve, 30)); -} - -/** - * Returns the text content of the mode selector trigger button. - */ -function getModeSelectorText() { - return document.getElementById("dimension-filter-mode-selector")!.textContent; -} - -/** - * Returns the text of each item inside a DropdownMenu group, as an array. - * bits-ui 2.x renders items as adjacent elements without whitespace, so - * checking individual items is more reliable than toHaveTextContent. - */ -function getGroupItemTexts(groupLabel: string): string[] { - const group = screen.getByLabelText(groupLabel); - const items = group.querySelectorAll( - "[data-dropdown-menu-item], [data-dropdown-menu-checkbox-item]", - ); - return Array.from(items).map((el) => el.textContent?.trim() ?? ""); -} - -describe("DimensionFilter", () => { - mockAnimationsForComponentTesting(); - const mocks = useDashboardFetchMocksForComponentTests(); - - beforeAll(() => { - mocks.mockMetricsView(AD_BIDS_METRICS_NAME, AD_BIDS_METRICS_INIT); - mocks.mockMetricsExplore( - AD_BIDS_EXPLORE_NAME, - AD_BIDS_METRICS_INIT, - AD_BIDS_EXPLORE_INIT, - ); - }); - - afterAll(waitForBodyScrollCleanup); - - it("Select filter mode", async () => { - const { stateManagers } = renderFilterComponent(); - - // Add a filter pill for publisher - await addFilter("publisher"); - - // Once the pill is added and dropdown is open, select "Facebook" and "Google" - await waitFor(() => expect(screen.getByText("Facebook")).toBeVisible()); - await act(() => screen.getByText("Facebook").click()); - await act(() => screen.getByText("Google").click()); - - // Close the dropdown to apply the selections (Select mode applies on close) - await act(() => screen.getByLabelText("Open publisher filter").click()); - - // Assert that filters are now applied to the dashboard store - expect(get(stateManagers.dashboardStore).whereFilter).toEqual( - createAndExpression([ - createInExpression(AD_BIDS_PUBLISHER_DIMENSION, ["Facebook", "Google"]), - ]), - ); - - // Reopen the dropdown - await act(() => screen.getByLabelText("Open publisher filter").click()); - - // Change the mode to "Contains" and enter a search term "oo" - await selectMode(/Contains/); - await act(() => - fireEvent.input(screen.getByLabelText("publisher search list"), { - target: { value: "oo" }, - }), - ); - await waitFor(() => - expect(screen.getByLabelText("publisher result count")).toHaveTextContent( - "3 results", - ), - ); - // Pill changes to reflect the current state of the dropdown - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher Contains oo (3)", - ); - - // Close the dropdown. - await act(() => screen.getByLabelText("Open publisher filter").click()); - // "Contains" mode does not persist since Apply was not clicked - await waitFor(() => - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher Facebook +1 other", - ), - ); - - // Open the dropdown again - await act(() => screen.getByLabelText("Open publisher filter").click()); - // Switch to "In List" mode and enter a value "Facebook,Google,Apple" - await selectMode(/In List/); - await act(() => - fireEvent.input(screen.getByLabelText("publisher search list"), { - target: { value: "Facebook,Google,Apple" }, - }), - ); - await waitFor(() => - expect(screen.getByLabelText("publisher result count")).toHaveTextContent( - "2 of 3 matched", - ), - ); - expect(getGroupItemTexts("publisher results")).toEqual([ - "Facebook", - "Google", - "Apple", - ]); - // Pill changes to reflect the current state of the dropdown - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher In list (2 of 3)", - ); - - // Close the dropdown - await act(() => screen.getByLabelText("Open publisher filter").click()); - // "In List" mode does not persist since Apply was not clicked - await waitFor(() => - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher Facebook +1 other", - ), - ); - }); - - it("persists exclude operator when adding select values and toggling exclude", async () => { - const { stateManagers } = renderFilterComponent(); - - await addFilter("publisher"); - - await waitFor(() => expect(screen.getByText("Facebook")).toBeVisible()); - await act(() => screen.getByText("Facebook").click()); - await act(() => screen.getByText("Google").click()); - await act(() => - fireEvent.click(screen.getByLabelText("Include exclude toggle")), - ); - - expect(screen.getByLabelText("Include exclude toggle")).toHaveAttribute( - "data-state", - "checked", - ); - - await act(() => screen.getByLabelText("Open publisher filter").click()); - - expect(get(stateManagers.dashboardStore).whereFilter).toEqual( - createAndExpression([ - createInExpression( - AD_BIDS_PUBLISHER_DIMENSION, - ["Facebook", "Google"], - true, - ), - ]), - ); - }); - - it("creates new select filters with the current exclude mode", async () => { - const toggleDimensionFilterMode = vi.fn().mockResolvedValue(undefined); - const toggleDimensionValueSelections = vi.fn().mockResolvedValue(undefined); - - render(DimensionFilter, { - props: { - filterData: { - name: AD_BIDS_PUBLISHER_DIMENSION, - label: "Publisher", - mode: DimensionFilterMode.Select, - dimensions: new Map([[AD_BIDS_METRICS_NAME, {}]]), - selectedValues: [], - isInclude: true, - }, - expressionMap: new Map(), - openOnMount: true, - timeStart: undefined, - timeEnd: undefined, - timeDimension: undefined, - timeControlsReady: true, - removeDimensionFilter: vi.fn(), - applyDimensionInListMode: vi.fn(), - toggleDimensionValueSelections, - applyDimensionContainsMode: vi.fn(), - toggleDimensionFilterMode, - }, - context: new Map([ - [ - RUNTIME_CONTEXT_KEY, - new RuntimeClient({ host: "http://localhost", instanceId: "test" }), - ], - ]), - }); - - await waitFor(() => expect(screen.getByText("Facebook")).toBeVisible()); - await act(() => screen.getByText("Facebook").click()); - await act(() => - fireEvent.click(screen.getByLabelText("Include exclude toggle")), - ); - await closeFilterMenu("Open publisher filter"); - - expect(toggleDimensionFilterMode).not.toHaveBeenCalled(); - expect(toggleDimensionValueSelections).toHaveBeenCalledWith( - AD_BIDS_PUBLISHER_DIMENSION, - ["Facebook"], - [AD_BIDS_METRICS_NAME], - undefined, - undefined, - true, - ); - }); - - it("Contains filter mode", async () => { - const { stateManagers } = renderFilterComponent(); - - // Add a filter pill for publisher - await addFilter("publisher"); - - // Change the mode to "Contains" - await selectMode(/Contains/); - // No results yet. - await waitFor(() => - expect(screen.getByLabelText("publisher result count")).toHaveTextContent( - "0 results", - ), - ); - expect(screen.getByLabelText("publisher results")).toHaveTextContent( - "no results", - ); - - // Enter a search text "oo" - await act(() => - fireEvent.input(screen.getByLabelText("publisher search list"), { - target: { value: "oo" }, - }), - ); - // 3 results based on the mocked response. - await waitFor(() => - expect(screen.getByLabelText("publisher result count")).toHaveTextContent( - "3 results", - ), - ); - expect(getGroupItemTexts("publisher results")).toEqual([ - "Facebook", - "Google", - "Yahoo", - ]); - // Pill is updated as well. - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher Contains oo (3)", - ); - - // Apply to get the filter to take effect. - await act(() => screen.getByRole("button", { name: "Apply" }).click()); - - // Filter is added to the dashboard - expect(get(stateManagers.dashboardStore).whereFilter).toEqual( - createAndExpression([ - createLikeExpression(AD_BIDS_PUBLISHER_DIMENSION, "%oo%"), - ]), - ); - // Filter pill is persisted - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher Contains oo (3)", - ); - }); - - it("In-List filter mode using dropdown", async () => { - const { stateManagers } = renderFilterComponent(); - - // Add a filter pill for publisher - await addFilter("publisher"); - - // Change the mode to "In List" - await selectMode(/In List/); - // No results yet. - await waitFor(() => - expect(screen.getByLabelText("publisher result count")).toHaveTextContent( - "0 results", - ), - ); - expect(screen.getByLabelText("publisher results")).toHaveTextContent( - "no results", - ); - - // Enter a search term with commas - await act(() => - fireEvent.input(screen.getByLabelText("publisher search list"), { - target: { value: "Facebook,Google,Apple" }, - }), - ); - // 2 of 3 results matched based on mocked response. - await waitFor(() => - expect(screen.getByLabelText("publisher result count")).toHaveTextContent( - "2 of 3 matched", - ), - ); - expect(getGroupItemTexts("publisher results")).toEqual([ - "Facebook", - "Google", - "Apple", - ]); - // Pill is updated as well. - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher In list (2 of 3)", - ); - - // Adding a comma at the end doesnt add an extra element - await act(() => - fireEvent.input(screen.getByLabelText("publisher search list"), { - target: { value: "Facebook,Google,Apple," }, - }), - ); - // Same 2 of 3 matched results as before - await waitFor(() => - expect(screen.getByLabelText("publisher result count")).toHaveTextContent( - "2 of 3 matched", - ), - ); - expect(getGroupItemTexts("publisher results")).toEqual([ - "Facebook", - "Google", - "Apple", - ]); - - // Apply to get the filter to take effect. - await act(() => screen.getByRole("button", { name: "Apply" }).click()); - - // Filter is added to the dashboard - expect(get(stateManagers.dashboardStore).whereFilter).toEqual( - createAndExpression([ - createInExpression(AD_BIDS_PUBLISHER_DIMENSION, [ - "Facebook", - "Google", - "Apple", - ]), - ]), - ); - expect( - get(stateManagers.dashboardStore).dimensionsWithInlistFilter, - ).toEqual(["publisher"]); - // Filter pill is persisted - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher In list (2 of 3)", - ); - }); - - it("Select filter mode treats comma search text literally", async () => { - renderFilterComponent(); - - // Add a filter pill for publisher - await addFilter("publisher"); - - // Enter search text with commas. - await act(() => - fireEvent.input(screen.getByLabelText("publisher search list"), { - target: { value: "Facebook,Google,Apple" }, - }), - ); - - // Select mode should not auto-switch to In List. - expect(getModeSelectorText()).toContain("Select"); - expect( - screen.queryByLabelText("publisher result count"), - ).not.toBeInTheDocument(); - await waitFor(() => - expect(screen.getByLabelText("Open publisher filter")).toHaveTextContent( - "publisher", - ), - ); - }); - - it("checks In List URL length using selected and searched values", async () => { - const isUrlTooLongAfterInListFilter = vi.fn(() => false); - - render(DimensionFilter, { - props: { - filterData: { - name: AD_BIDS_PUBLISHER_DIMENSION, - label: AD_BIDS_PUBLISHER_DIMENSION, - mode: DimensionFilterMode.InList, - dimensions: new Map([[AD_BIDS_METRICS_NAME, {}]]), - selectedValues: ["Existing"], - }, - expressionMap: new Map(), - openOnMount: false, - timeStart: undefined, - timeEnd: undefined, - timeDimension: undefined, - timeControlsReady: false, - removeDimensionFilter: vi.fn(), - applyDimensionInListMode: vi.fn(), - toggleDimensionValueSelections: vi.fn(), - applyDimensionContainsMode: vi.fn(), - toggleDimensionFilterMode: vi.fn(), - isUrlTooLongAfterInListFilter, - }, - context: new Map([ - [ - RUNTIME_CONTEXT_KEY, - new RuntimeClient({ host: "http://localhost", instanceId: "test" }), - ], - ]), - }); - - await act(() => screen.getByLabelText("Open publisher filter").click()); - await act(() => - fireEvent.input(screen.getByLabelText("publisher search list"), { - target: { value: "Facebook,Google" }, - }), - ); - - expect(isUrlTooLongAfterInListFilter).toHaveBeenLastCalledWith([ - "Existing", - "Facebook", - "Google", - ]); - - // Close the dropdown so bits-ui's body-scroll-lock cleanup fires while - // jsdom is still alive (otherwise the deferred cleanup fires after teardown - // and produces an unhandled "document is not defined" error). - await act(() => screen.getByLabelText("Open publisher filter").click()); - }); - - it("commits Select mode when leaving In List without value changes", async () => { - const toggleDimensionValueSelections = vi.fn().mockResolvedValue(undefined); - - render(DimensionFilter, { - props: { - filterData: { - name: AD_BIDS_PUBLISHER_DIMENSION, - label: "Publisher", - mode: DimensionFilterMode.InList, - dimensions: new Map([[AD_BIDS_METRICS_NAME, {}]]), - selectedValues: ["Facebook"], - isInclude: true, - }, - expressionMap: new Map(), - openOnMount: false, - timeStart: undefined, - timeEnd: undefined, - timeDimension: undefined, - timeControlsReady: false, - removeDimensionFilter: vi.fn(), - applyDimensionInListMode: vi.fn(), - toggleDimensionValueSelections, - applyDimensionContainsMode: vi.fn(), - toggleDimensionFilterMode: vi.fn(), - }, - context: new Map([ - [ - RUNTIME_CONTEXT_KEY, - new RuntimeClient({ host: "http://localhost", instanceId: "test" }), - ], - ]), - }); - - await act(() => screen.getByLabelText("Open publisher filter").click()); - await selectFirstMode(); - await waitFor(() => expect(getModeSelectorText()).toContain("Select")); - await closeFilterMenu("Open publisher filter"); - - expect(toggleDimensionValueSelections).toHaveBeenCalledWith( - AD_BIDS_PUBLISHER_DIMENSION, - [], - [AD_BIDS_METRICS_NAME], - undefined, - undefined, - false, - ); - }); - - it("rerenders the chip when only the include/exclude operator changes", async () => { - const props = { - filterData: { - name: "device_type", - label: "Device Type", - mode: DimensionFilterMode.Select, - dimensions: new Map([[AD_BIDS_METRICS_NAME, {}]]), - selectedValues: ["ConnectedTV"], - isInclude: false, - }, - expressionMap: new Map(), - openOnMount: false, - timeStart: undefined, - timeEnd: undefined, - timeDimension: undefined, - timeControlsReady: false, - removeDimensionFilter: vi.fn(), - applyDimensionInListMode: vi.fn(), - toggleDimensionValueSelections: vi.fn(), - applyDimensionContainsMode: vi.fn(), - toggleDimensionFilterMode: vi.fn(), - }; - - const { rerender } = render(DimensionFilter, { - props, - context: new Map([ - [ - RUNTIME_CONTEXT_KEY, - new RuntimeClient({ host: "http://localhost", instanceId: "test" }), - ], - ]), - }); - - const chip = screen.getByLabelText("device_type filter"); - expect(screen.getByLabelText("Open device_type filter")).toHaveTextContent( - "Exclude Device Type ConnectedTV", - ); - expect(chip).toHaveClass("exclude"); - - await rerender({ - ...props, - filterData: { - ...props.filterData, - isInclude: true, - }, - }); - - await waitFor(() => - expect( - screen.getByLabelText("Open device_type filter"), - ).toHaveTextContent("Device Type ConnectedTV"), - ); - expect( - screen.getByLabelText("Open device_type filter"), - ).not.toHaveTextContent("Exclude"); - expect(chip).not.toHaveClass("exclude"); - }); - - it("applies a pending include/exclude toggle when select mode closes", async () => { - const toggleDimensionFilterMode = vi.fn().mockResolvedValue(undefined); - const toggleDimensionValueSelections = vi.fn().mockResolvedValue(undefined); - const props = { - filterData: { - name: AD_BIDS_PUBLISHER_DIMENSION, - label: "Publisher", - mode: DimensionFilterMode.Select, - dimensions: new Map([[AD_BIDS_METRICS_NAME, {}]]), - selectedValues: ["Facebook"], - isInclude: true, - }, - expressionMap: new Map(), - openOnMount: false, - timeStart: undefined, - timeEnd: undefined, - timeDimension: undefined, - timeControlsReady: false, - removeDimensionFilter: vi.fn(), - applyDimensionInListMode: vi.fn(), - toggleDimensionValueSelections, - applyDimensionContainsMode: vi.fn(), - toggleDimensionFilterMode, - }; - - render(DimensionFilter, { - props, - context: new Map([ - [ - RUNTIME_CONTEXT_KEY, - new RuntimeClient({ host: "http://localhost", instanceId: "test" }), - ], - ]), - }); - - await act(() => screen.getByLabelText("Open publisher filter").click()); - await act(() => - fireEvent.click(screen.getByLabelText("Include exclude toggle")), - ); - expect(screen.getByLabelText("Include exclude toggle")).toHaveAttribute( - "data-state", - "checked", - ); - await act(() => screen.getByLabelText("Open publisher filter").click()); - - await waitFor(() => - expect(toggleDimensionFilterMode).toHaveBeenCalledWith( - AD_BIDS_PUBLISHER_DIMENSION, - [AD_BIDS_METRICS_NAME], - ), - ); - expect(toggleDimensionValueSelections).not.toHaveBeenCalled(); - }); -}); diff --git a/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilter.svelte b/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilter.svelte index c26e3a789511..e8600fd9ddcd 100644 --- a/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilter.svelte +++ b/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilter.svelte @@ -7,434 +7,340 @@ import Tooltip from "@rilldata/web-common/components/tooltip/Tooltip.svelte"; import TooltipContent from "@rilldata/web-common/components/tooltip/TooltipContent.svelte"; import TooltipTitle from "@rilldata/web-common/components/tooltip/TooltipTitle.svelte"; - import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants"; + import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants.ts"; import { getEffectiveSelectedValues, getItemLists, getSearchPlaceholder, shouldDisableApplyButton, - } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/helpers"; + } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/helpers.ts"; import { mergeDimensionSearchValues, splitDimensionSearchText, - } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/dimension-search-text-utils"; + } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/dimension-search-text-utils.ts"; import DimensionFilterChipBody from "@rilldata/web-common/features/dashboards/filters/dimension-filters/DimensionFilterChipBody.svelte"; import DimensionFilterFooter from "@rilldata/web-common/features/dashboards/filters/dimension-filters/DimensionFilterFooter.svelte"; import DimensionFilterModeSelector from "@rilldata/web-common/features/dashboards/filters/dimension-filters/DimensionFilterModeSelector.svelte"; - import type { V1Expression } from "@rilldata/web-common/runtime-client"; import { useRuntimeClient } from "@rilldata/web-common/runtime-client/v2"; - import { - useAllSearchResultsCount, - useDimensionSearch, - } from "web-common/src/features/dashboards/filters/dimension-filters/dimension-filter-values"; - import type { DimensionFilterItem } from "../../state-managers/selectors/dimension-filters"; - import type { FilterManager } from "@rilldata/web-common/features/canvas/stores/filter-manager"; import PinButton from "../PinButton.svelte"; import RequiredButton from "../RequiredButton.svelte"; - - type Actions = FilterManager["actions"]; - - export let filterData: DimensionFilterItem; - export let expressionMap: Map; - export let openOnMount: boolean = true; - export let readOnly: boolean = false; - export let timeStart: string | undefined; - export let timeEnd: string | undefined; - export let timeDimension: string | undefined = undefined; - export let timeControlsReady: boolean | undefined; - export let smallChip = false; - export let side: "top" | "right" | "bottom" | "left" = "bottom"; - export let removeDimensionFilter: Actions["removeDimensionFilter"]; - export let applyDimensionInListMode: Actions["applyDimensionInListMode"]; - export let toggleDimensionValueSelections: Actions["toggleDimensionValueSelections"]; - export let applyDimensionContainsMode: Actions["applyDimensionContainsMode"]; - export let toggleDimensionFilterMode: Actions["toggleDimensionFilterMode"]; - export let toggleFilterPin: Actions["toggleFilterPin"] | undefined = - undefined; - export let toggleFilterRequired: Actions["toggleFilterRequired"] | undefined = - undefined; - export let isUrlTooLongAfterInListFilter: ( - values: string[], - ) => boolean = () => false; - - let open = - openOnMount && !filterData.selectedValues?.length && !filterData.inputText; - let curMode = filterData.mode; - let curSearchText = filterData.inputText ?? ""; - let curExcludeMode = filterData.isInclude === false; - let inListTooLong = false; - let selectedValuesProxy: string[] = filterData.selectedValues ?? []; - let searchedBulkValues: string[] = - filterData.mode === DimensionFilterMode.InList - ? (filterData.selectedValues ?? []) - : []; - let curPinned = filterData.pinned; - let curRequired = filterData.required; - let excludeModeDirty = false; + import { DimensionFilterManager } from "./DimensionFilterManager.svelte.ts"; + import { + createDimensionSearchCountQuery, + createDimensionSearchQuery, + } from "./queries.svelte.ts"; + import type { ExpressionFilterManager } from "../ExpressionFilterManager.svelte.ts"; + import { onMount } from "svelte"; + import type { YAMLConfigProvider } from "@rilldata/web-common/features/dashboards/providers/YAMLConfigProvider.svelte.ts"; + + let { + manager, + dimensionManager, + yamlConfigProvider, + openOnMount = true, + timeStart = undefined, + timeEnd = undefined, + timeDimension = undefined, + timeControlsReady, + smallChip = false, + removable = true, + side = "bottom", + isUrlTooLongAfterInListFilter = () => false, + }: { + manager: ExpressionFilterManager; + dimensionManager: DimensionFilterManager; + yamlConfigProvider: YAMLConfigProvider; + openOnMount?: boolean; + timeStart?: string | undefined; + timeEnd?: string | undefined; + timeDimension?: string | undefined; + timeControlsReady: boolean | undefined; + smallChip?: boolean; + removable?: boolean; + side?: "top" | "right" | "bottom" | "left"; + isUrlTooLongAfterInListFilter?: (values: string[]) => boolean; + } = $props(); + + let proxyDimensionManager = $derived(dimensionManager.clone()); + + let open = $state(false); + let curSearchText = $state(""); const client = useRuntimeClient(); - $: ({ - name, - label, - mode, - selectedValues = [], - inputText, - isInclude, - dimensions, - pinned, - required, - missingRequired, - } = filterData); - - $: if ( - !open && - excludeModeDirty && - (isInclude === false) === curExcludeMode - ) { - excludeModeDirty = false; - } - - $: if ( - !open && - (mode !== curMode || - (!excludeModeDirty && (isInclude === false) !== curExcludeMode)) - ) { - resyncFilterData(filterData); - } - - // Sync proxy when selectedValues changes (for Select mode) - $: if (!open && mode === DimensionFilterMode.Select) { - selectedValuesProxy = structuredClone(filterData.selectedValues) ?? []; - } - - $: metricsViewNames = Array.from(dimensions.keys()); - - $: excludeMode = isInclude === false; - - $: sanitisedSearchText = inputText?.replace(/^%/, "").replace(/%$/, ""); - - $: checkSearchText(curSearchText); + let pinned = $derived( + Boolean(yamlConfigProvider.pinnedFilters[dimensionManager.name]), + ); + let required = $derived( + Boolean(yamlConfigProvider.requiredFilters[dimensionManager.name]), + ); + let missingRequired = $derived(Boolean(required && !dimensionManager.expr)); + + // Pinned and required are edited locally and only persisted once the dropdown closes. + // svelte-ignore state_referenced_locally + let curPinned = $state(pinned); + // svelte-ignore state_referenced_locally + let curRequired = $state(required); + + // Only InList mode parses the input as a list of values; the other modes treat it as search text, + // so this is read behind a mode check everywhere it is used. + let inListValues = $derived.by(() => { + const values = splitDimensionSearchText(curSearchText); + if (values.length <= 1) return curSearchText === "" ? [] : values; + + // Include both the applied values and the ones in the input so the below-fold query can find + // applied values that might not be in the top 250. + return [...new Set([...dimensionManager.selectedValues, ...values])]; + }); + let inListTooLong = $derived( + proxyDimensionManager.mode === DimensionFilterMode.InList && + inListValues.length > 0 && + isUrlTooLongAfterInListFilter(inListValues), + ); - $: enableSearchQuery = + let enableSearchQuery = $derived( Boolean(timeControlsReady && open) && - (curMode === DimensionFilterMode.Select || - (curMode === DimensionFilterMode.Contains && curSearchText.length > 0) || - (curMode === DimensionFilterMode.InList && - searchedBulkValues.length > 0)); - - $: searchResultsQuery = useDimensionSearch(client, metricsViewNames, name, { - mode: curMode, - values: - curMode === DimensionFilterMode.Select - ? selectedValues - : searchedBulkValues, + (proxyDimensionManager.mode === DimensionFilterMode.Select || + (proxyDimensionManager.mode === DimensionFilterMode.Contains && + curSearchText.length > 0) || + (proxyDimensionManager.mode === DimensionFilterMode.InList && + inListValues.length > 0)), + ); + + // The queries are created once and follow the dropdown through the args getter, so changing the + // mode or the search text updates them instead of replacing them. + const searchResultsQuery = createDimensionSearchQuery(client, () => ({ + manager, + dimensionName: dimensionManager.name, + mode: proxyDimensionManager.mode, + values: inListValues, searchText: curSearchText, timeStart, timeEnd, timeDimension, enabled: enableSearchQuery, - metricsViewWheres: expressionMap, + })); + // The query only returns the top 250 values, so applied values outside that window are merged back + // in: Select mode shows them as checked, InList mode lists them among the values it matched. + let correctedSearchResults = $derived.by(() => { + if (!enableSearchQuery) return []; + + const searchResults = searchResultsQuery.current.data; + const appliedValues = + proxyDimensionManager.mode === DimensionFilterMode.InList + ? inListValues + : proxyDimensionManager.mode === DimensionFilterMode.Select + ? dimensionManager.selectedValues + : []; + if (!appliedValues.length) return searchResults; + + return [...new Set([...searchResults, ...appliedValues])]; }); - $: ({ - data: searchResults, - error: errorFromSearchResults, - isFetching: isFetchingFromSearchResults, - } = $searchResultsQuery); - $: correctedSearchResults = enableSearchQuery ? searchResults : []; - - $: enableSearchCountQuery = + + let enableSearchCountQuery = $derived( Boolean(timeControlsReady) && - ((curMode === DimensionFilterMode.Contains && curSearchText.length > 0) || - (curMode === DimensionFilterMode.InList && - searchedBulkValues.length > 0)); + ((proxyDimensionManager.mode === DimensionFilterMode.Contains && + curSearchText.length > 0) || + (proxyDimensionManager.mode === DimensionFilterMode.InList && + inListValues.length > 0)), + ); - $: allSearchResultsCountQuery = useAllSearchResultsCount( + const allSearchResultsCountQuery = createDimensionSearchCountQuery( client, - metricsViewNames, - name, - { - mode: curMode, - values: searchedBulkValues, + () => ({ + manager, + dimensionName: dimensionManager.name, + mode: proxyDimensionManager.mode, + values: inListValues, searchText: curSearchText, timeStart, timeEnd, timeDimension, enabled: enableSearchCountQuery, + }), + ); + let allSearchResultsCount = $derived(allSearchResultsCountQuery.current.data); + let searchResultCountText = $derived( + enableSearchCountQuery + ? proxyDimensionManager.mode === DimensionFilterMode.Contains + ? `${allSearchResultsCount} results` + : `${allSearchResultsCount} of ${inListValues.length} matched` + : "0 results", + ); - metricsViewWheres: expressionMap, - }, + let searchPlaceholder = $derived( + getSearchPlaceholder(proxyDimensionManager.mode), + ); + + let error = $derived( + searchResultsQuery.current.error ?? + allSearchResultsCountQuery.current.error, + ); + let isFetching = $derived( + searchResultsQuery.current.isFetching || + allSearchResultsCountQuery.current.isFetching, ); - $: ({ - data: allSearchResultsCount, - error: errorFromAllSearchResultsCount, - isFetching: isFetchingFromAllSearchResultsCount, - } = $allSearchResultsCountQuery); - $: searchResultCountText = enableSearchCountQuery - ? curMode === DimensionFilterMode.Contains - ? `${allSearchResultsCount} results` - : `${allSearchResultsCount} of ${searchedBulkValues.length} matched` - : "0 results"; - - $: searchPlaceholder = getSearchPlaceholder(curMode); - - $: error = errorFromSearchResults ?? errorFromAllSearchResultsCount; - $: isFetching = - isFetchingFromSearchResults ?? isFetchingFromAllSearchResultsCount; - - $: showExtraInfo = curMode !== DimensionFilterMode.Select; // || curSearchText.length > 0; (Add once we have docs) - - $: allSelected = Boolean( - effectiveSelectedValues.length && - correctedSearchResults?.length === effectiveSelectedValues.length, + + let showExtraInfo = $derived( + proxyDimensionManager.mode !== DimensionFilterMode.Select, + ); // || curSearchText.length > 0; (Add once we have docs) + + let effectiveSelectedValues = $derived( + getEffectiveSelectedValues( + proxyDimensionManager.mode, + proxyDimensionManager.selectedValues, + correctedSearchResults, + dimensionManager.selectedValues, + ), ); - $: effectiveSelectedValues = getEffectiveSelectedValues( - curMode, - selectedValuesProxy, - correctedSearchResults ?? [], - selectedValues, + let allSelected = $derived( + Boolean( + effectiveSelectedValues.length && + correctedSearchResults.length === effectiveSelectedValues.length, + ), ); - $: disableApplyButton = shouldDisableApplyButton( - curMode, - enableSearchCountQuery, - inListTooLong, + let disableApplyButton = $derived( + shouldDisableApplyButton( + proxyDimensionManager.mode, + enableSearchCountQuery, + inListTooLong, + ), ); // Split results into checked and unchecked for better UX (like SelectionDropdown) // Use actual selectedValues (not proxy) so items only sort after dropdown closes - $: ({ checkedItems, uncheckedItems } = getItemLists( - curMode, - correctedSearchResults ?? [], - selectedValues, - curSearchText, - )); - - /** - * Reset filter settings based on params to the component. - */ - function resetFilterSettings( - mode: DimensionFilterMode, - sanitisedSearchText: string | undefined, - ) { - curExcludeMode = excludeMode; - switch (mode) { + let { checkedItems, uncheckedItems } = $derived( + getItemLists( + proxyDimensionManager.mode, + correctedSearchResults, + dimensionManager.selectedValues, + curSearchText, + ), + ); + + function handleModeChange(newMode: DimensionFilterMode) { + switch (newMode) { case DimensionFilterMode.Select: - curMode = DimensionFilterMode.Select; + proxyDimensionManager.setSelectedValues( + [...proxyDimensionManager.selectedValues], + proxyDimensionManager.exclude, + ); curSearchText = ""; - selectedValuesProxy = [...selectedValues]; break; case DimensionFilterMode.InList: - curMode = DimensionFilterMode.InList; - curSearchText = mergeDimensionSearchValues(selectedValues); - searchedBulkValues = selectedValues; // Ensure searchedBulkValues includes existing selections + proxyDimensionManager.setInList( + [...proxyDimensionManager.selectedValues], + proxyDimensionManager.exclude, + ); + // The values carried over stay editable as text. + curSearchText = mergeDimensionSearchValues( + proxyDimensionManager.selectedValues, + ); break; case DimensionFilterMode.Contains: - curMode = DimensionFilterMode.Contains; - curSearchText = sanitisedSearchText ?? ""; + proxyDimensionManager.setContainsText( + "", + proxyDimensionManager.exclude, + ); + curSearchText = ""; break; } } - function checkSearchText(inputText: string) { - inListTooLong = false; - - // Only InList mode parses bulk values. Other modes treat input as search text. - if (curMode !== DimensionFilterMode.InList) return; - - const values = splitDimensionSearchText(inputText); - - if (values.length <= 1) { - searchedBulkValues = inputText === "" ? [] : values; - return; - } - - // Include both existing selected values and new search values so the - // below-fold query can find existing selected values that might not be - // in the top 250. - searchedBulkValues = [...new Set([...selectedValues, ...values])]; - inListTooLong = isUrlTooLongAfterInListFilter(searchedBulkValues); - } - - function handleModeChange(newMode: DimensionFilterMode) { - curSearchText = ""; - if (newMode !== DimensionFilterMode.InList) { - searchedBulkValues = []; - // Reset proxy when switching to/from Select mode - if (newMode === DimensionFilterMode.Select) { - curExcludeMode = excludeMode; - selectedValuesProxy = [...selectedValues]; - } - } else { - checkSearchText(curSearchText); - } - } - - async function handleOpenChange(open: boolean) { + function handleOpenChange(open: boolean) { if (open) { - curSearchText = - mode === DimensionFilterMode.InList - ? mergeDimensionSearchValues(selectedValues) - : (sanitisedSearchText ?? ""); + resetSearchText(); + curPinned = pinned; + curRequired = required; } else { - if (pinned !== curPinned) { - toggleFilterPin?.(name, metricsViewNames); - } - if (required !== curRequired) { - toggleFilterRequired?.(name, metricsViewNames); - } + persistPinnedAndRequired(); - // Apply proxy changes for Select mode when dropdown closes - if (curMode === DimensionFilterMode.Select) { - await applySelectModeChanges(); - // Don't reset immediately for Select mode - let props update first - return; - } - - if (selectedValues.length === 0 && !inputText) { - // filter was cleared. so remove the filter - await removeDimensionFilter(name, metricsViewNames); + // Select mode applies when the dropdown closes. The other modes only apply through the Apply + // button, so drop whatever they staged. + if (proxyDimensionManager.mode === DimensionFilterMode.Select) { + dimensionManager.apply(proxyDimensionManager); } else { - // reset the settings on unmount (but not for Select mode) - resetFilterSettings(mode, sanitisedSearchText); + proxyDimensionManager.apply(dimensionManager); + resetSearchText(); } } } - function handleToggleExcludeMode(checked: boolean) { - curExcludeMode = checked; - excludeModeDirty = true; + /** Resets the input to the applied filter: the list of values in InList mode, the search text otherwise. */ + function resetSearchText() { + curSearchText = + dimensionManager.mode === DimensionFilterMode.InList + ? mergeDimensionSearchValues(dimensionManager.selectedValues) + : dimensionManager.inputText; + } + + function handleToggleExcludeMode() { + proxyDimensionManager.toggleExclude(); } function onToggleSelectAll() { - if (curMode === DimensionFilterMode.Select) { - // Update proxy for select all/deselect all - if (allSelected) { - selectedValuesProxy = selectedValuesProxy.filter( - (v) => !correctedSearchResults?.includes(v), - ); - } else { - const newValues = - correctedSearchResults?.filter( - (v) => !selectedValuesProxy.includes(v), - ) ?? []; - selectedValuesProxy = [...selectedValuesProxy, ...newValues]; - } - } else { - correctedSearchResults?.forEach((dimensionValue) => { - if (!allSelected && effectiveSelectedValues.includes(dimensionValue)) - return; - - toggleDimensionValueSelections( - name, - [dimensionValue], - metricsViewNames, - ).catch(console.error); - }); - } + proxyDimensionManager.setSelectedValues( + [ + ...proxyDimensionManager.selectedValues, + ...(correctedSearchResults ?? []), + ], + proxyDimensionManager.exclude, + ); } - async function onApply(close = true) { + function onApply(close = true) { if (disableApplyButton) return; - switch (curMode) { - case DimensionFilterMode.Select: - // Apply proxy changes for Select mode - await applySelectModeChanges(); - if (close) open = false; - break; + persistPinnedAndRequired(); + // Select mode stages straight onto the proxy; the other two stage in the input. + switch (proxyDimensionManager.mode) { case DimensionFilterMode.InList: - if (searchedBulkValues.length === 0) return; - await applyDimensionInListMode( - name, - searchedBulkValues, - metricsViewNames, + proxyDimensionManager.setInList( + [...inListValues], + proxyDimensionManager.exclude, ); - if (curExcludeMode !== excludeMode) - await toggleDimensionFilterMode(name, metricsViewNames); - if (close) open = false; break; + case DimensionFilterMode.Contains: - if (curSearchText.length === 0) return; - await applyDimensionContainsMode(name, curSearchText, metricsViewNames); - if (curExcludeMode !== excludeMode) - await toggleDimensionFilterMode(name, metricsViewNames); - if (close) open = false; + proxyDimensionManager.setContainsText( + curSearchText, + proxyDimensionManager.exclude, + ); break; } + dimensionManager.apply(proxyDimensionManager); + if (close) open = false; } - async function applySelectModeChanges() { - // Find values that were added or removed - const currentValues = new Set(selectedValues); - const proxyValues = new Set(selectedValuesProxy); - const changedValues = [...currentValues, ...proxyValues].filter((value) => { - const wasSelected = currentValues.has(value); - const isSelected = proxyValues.has(value); - - return wasSelected !== isSelected; - }); - const shouldToggleExcludeMode = curExcludeMode !== excludeMode; - const shouldCommitSelectMode = - mode !== DimensionFilterMode.Select && currentValues.size > 0; - - if (!currentValues.size && !proxyValues.size) { - // No changes - return; - } - - // Existing filters still need to be negated. New filters get the operator - // from curExcludeMode when values are committed below. - if (shouldToggleExcludeMode && currentValues.size > 0) { - await toggleDimensionFilterMode(name, metricsViewNames); + // Closing via the trigger goes through handleOpenChange, but applying closes the dropdown + // directly, so both paths persist the staged pinned and required states. + function persistPinnedAndRequired() { + if (pinned !== curPinned) { + yamlConfigProvider.togglePinnedFilter(dimensionManager.name); } - - if (changedValues.length || shouldCommitSelectMode) { - await toggleDimensionValueSelections( - name, - changedValues, - metricsViewNames, - undefined, - undefined, - curExcludeMode, - ); + if (required !== curRequired) { + yamlConfigProvider.toggleRequiredFilter(dimensionManager.name); } } - async function handleItemClick(value: string) { - if (curMode === DimensionFilterMode.Select) { - // Update proxy instead of calling onSelect immediately - if (selectedValuesProxy.includes(value)) { - selectedValuesProxy = selectedValuesProxy.filter((v) => v !== value); - } else { - selectedValuesProxy = [...selectedValuesProxy, value]; - } - } else { - await toggleDimensionValueSelections(name, [value], metricsViewNames); - } + function handleItemClick(value: string) { + proxyDimensionManager.toggleValue(value, false); } - function resyncFilterData(filterData: DimensionFilterItem) { - curMode = filterData.mode; - curSearchText = filterData.inputText ?? ""; - curExcludeMode = filterData.isInclude === false; - excludeModeDirty = false; - selectedValuesProxy = filterData.selectedValues ?? []; - searchedBulkValues = - filterData.mode === DimensionFilterMode.InList - ? (filterData.selectedValues ?? []) - : []; - curPinned = filterData.pinned; - curRequired = filterData.required; - } + onMount(() => { + open = + openOnMount && + !dimensionManager.selectedValues?.length && + !dimensionManager.inputText; + resetSearchText(); + }); { - if (e.key === "Enter") { - await onApply(); - } + onkeydown={(e) => { + if (open && e.key === "Enter") onApply(); }} /> @@ -446,36 +352,38 @@ alignment="start" distance={8} location="bottom" - suppress={open || readOnly} + suppress={open} > removeDimensionFilter(name, metricsViewNames)} - removable={!readOnly && !curPinned && !required} - {readOnly} - removeTooltipText="remove {selectedValues.length} value{selectedValues.length !== - 1 + onRemove={() => dimensionManager.clear()} + removable={removable && !pinned && !required} + removeTooltipText="remove {dimensionManager.selectedValues + .length} value{dimensionManager.selectedValues.length !== 1 ? 's' : ''}" > @@ -483,7 +391,9 @@
- {name} + {dimensionManager.name} {required ? "required dimension" @@ -509,41 +419,33 @@ class="flex flex-col max-h-96 w-[400px] overflow-hidden p-0" >
- {#if toggleFilterPin || toggleFilterRequired} + {#if yamlConfigProvider.editable}
- {label} + {dimensionManager.label}
- {#if toggleFilterRequired} - { - curRequired = !curRequired; - }} - /> - {/if} - {#if toggleFilterPin} - { - curPinned = !curPinned; - }} - /> - {/if} + (curRequired = !curRequired)} + /> + (curPinned = !curPinned)} + />
{/if}
{#if showExtraInfo}
- {#if curMode !== DimensionFilterMode.Select} + {#if proxyDimensionManager.mode !== DimensionFilterMode.Select} {searchResultCountText} @@ -586,21 +488,23 @@
List is too long. Please remove some values.
- {:else if correctedSearchResults} - + {:else} + - {#if curMode === DimensionFilterMode.Select && !curSearchText} + {#if proxyDimensionManager.mode === DimensionFilterMode.Select && !curSearchText} {#each checkedItems as name (name)} {@const selected = effectiveSelectedValues.includes(name)} {@const label = name ?? "null"} - handleItemClick(name)} + showXForSelected={proxyDimensionManager.exclude} + onCheckedChange={() => handleItemClick(name)} > {#if label.length > 240} @@ -609,12 +513,12 @@ {label} {/if} - + {/each} {/if} - {#if curMode === DimensionFilterMode.Select && !curSearchText && checkedItems.length > 0 && uncheckedItems.length > 0} + {#if proxyDimensionManager.mode === DimensionFilterMode.Select && !curSearchText && checkedItems.length > 0 && uncheckedItems.length > 0} {/if} @@ -622,20 +526,23 @@ {#each uncheckedItems as name (name)} {@const selected = effectiveSelectedValues.includes(name)} {@const label = name ?? "null"} - - handleItemClick(name)} + checked={proxyDimensionManager.mode === + DimensionFilterMode.Select && selected} + showXForSelected={proxyDimensionManager.exclude} + disabled={proxyDimensionManager.mode !== + DimensionFilterMode.Select} + onCheckedChange={() => handleItemClick(name)} > {#if label.length > 240} @@ -644,11 +551,11 @@ {label} {/if} - + {/each} - {#if uncheckedItems.length === 0 && (curMode !== DimensionFilterMode.Select || checkedItems.length === 0)} + {#if uncheckedItems.length === 0 && (proxyDimensionManager.mode !== DimensionFilterMode.Select || checkedItems.length === 0)}
no results
@@ -658,8 +565,8 @@
void; + export let onToggleExcludeMode: () => void; export let onToggleSelectAll: () => void; export let onApply: () => void; diff --git a/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilterManager.svelte.ts b/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilterManager.svelte.ts new file mode 100644 index 000000000000..4ba51ae55520 --- /dev/null +++ b/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilterManager.svelte.ts @@ -0,0 +1,222 @@ +import { page } from "$app/state"; +import { m } from "@rilldata/web-common/lib/i18n/gen/messages"; +import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants.ts"; +import { + type V1Expression, + V1Operation, +} from "@rilldata/web-common/runtime-client"; +import { eventBus } from "@rilldata/web-common/lib/event-bus/event-bus.ts"; +import { + createInExpression, + createLikeExpression, + getValuesInExpression, +} from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; +import { convertExpressionToFilterParam } from "@rilldata/web-common/features/dashboards/url-state/filters/converters.ts"; +import type { MetricsViewsProvider } from "@rilldata/web-common/features/metrics-views/providers/MetricsViewsProvider.svelte.ts"; +import { getDimensionDisplayName } from "@rilldata/web-common/features/dashboards/filters/getDisplayName.ts"; + +export class DimensionFilterManager { + public expr: V1Expression | undefined = $state(undefined); + // String representation of the filter expression. Used to check duplicate expressions across metrics views. + public param: string = $state(""); + + public mode = $state(DimensionFilterMode.Select); + public selectedValues = $state([]); + public inputText = $state(""); + public exclude = $state(false); + + private oldMode: DimensionFilterMode; + + public constructor( + public readonly name: string, + public readonly label: string, + initExpr: V1Expression = createInExpression(name, []), + isInList: boolean = false, + // Filter dropdown doesnt immediately apply changes. + // This marks this manager as ephemeral, it will not notify about mode changes. + private readonly ephemeral: boolean = false, + ) { + this.reconcile(initExpr, isInList ? [name] : []); + } + + public static createForMetricsViews( + metricsViewsProvider: MetricsViewsProvider, + name: string, + mvName?: string, + initExpr?: V1Expression, + isInList?: boolean, + ) { + const dimensionSpecs = metricsViewsProvider.dimensionSpecs[name]; + if (!dimensionSpecs) return undefined; + const dimensionSpec = mvName + ? dimensionSpecs[mvName] + : Object.values(dimensionSpecs)[0]; + if (!dimensionSpec) return undefined; + + return new DimensionFilterManager( + name, + getDimensionDisplayName(dimensionSpec), + initExpr, + isInList, + ); + } + + public reconcile(expr: V1Expression, inList: string[]) { + let initMode: DimensionFilterMode = DimensionFilterMode.Select; + let initSelectedValues: string[] = []; + let initInputText: string = ""; + let initExclude: boolean = false; + + const op = expr.cond?.op; + if (op === V1Operation.OPERATION_IN || op === V1Operation.OPERATION_NIN) { + initMode = inList.includes(this.name) + ? DimensionFilterMode.InList + : DimensionFilterMode.Select; + initSelectedValues = getValuesInExpression(expr); + initExclude = op === V1Operation.OPERATION_NIN; + } else if ( + op === V1Operation.OPERATION_LIKE || + op === V1Operation.OPERATION_NLIKE + ) { + initMode = DimensionFilterMode.Contains; + initInputText = sanitizeSearchText( + expr.cond?.exprs?.[1]?.val?.toString?.() ?? "", + ); + initExclude = op === V1Operation.OPERATION_NLIKE; + } + + this.mode = initMode; + this.oldMode = initMode; + this.selectedValues = initSelectedValues; + this.inputText = initInputText; + this.exclude = initExclude; + this.commit(false); + } + + public clone() { + return new DimensionFilterManager( + this.name, + this.label, + this.expr, + this.mode === DimensionFilterMode.InList, + true, + ); + } + + public apply(dimensionManager: DimensionFilterManager) { + this.mode = dimensionManager.mode; + this.selectedValues = [...dimensionManager.selectedValues]; + this.inputText = dimensionManager.inputText; + this.exclude = dimensionManager.exclude; + this.commit(); + } + + public setSelectedValues(dimensionValues: string[], exclude: boolean) { + this.mode = DimensionFilterMode.Select; + this.selectedValues = dimensionValues; + this.inputText = ""; + this.exclude = exclude; + this.commit(); + } + + public toggleValue(dimensionValue: string, isExclusiveFilter: boolean) { + const inIdx = this.selectedValues.findIndex((v) => v === dimensionValue); + + if (inIdx === -1) { + if (isExclusiveFilter) { + this.selectedValues = [dimensionValue]; + } else { + this.selectedValues = [...this.selectedValues, dimensionValue]; + } + } else { + this.selectedValues = this.selectedValues.toSpliced(inIdx, 1); + } + this.commit(); + } + + public appendSelectedValues(dimensionValues: string[]) { + const newValues = dimensionValues.filter( + (v) => !this.selectedValues.includes(v), + ); + this.selectedValues = [...this.selectedValues, ...newValues]; + this.commit(); + return newValues; + } + + public removeSelectedValues(dimensionValues: string[]) { + this.selectedValues = this.selectedValues.filter( + (v) => !dimensionValues.includes(v), + ); + this.commit(); + } + + public setInList(values: string[], exclude: boolean) { + this.mode = DimensionFilterMode.InList; + this.selectedValues = values; + this.inputText = ""; + this.exclude = exclude; + this.commit(); + } + + public setContainsText(searchText: string, exclude: boolean) { + this.mode = DimensionFilterMode.Contains; + this.selectedValues = []; + this.inputText = searchText; + this.exclude = exclude; + this.commit(); + } + + public toggleExclude() { + this.exclude = !this.exclude; + this.commit(); + } + + public clear() { + this.selectedValues = []; + this.inputText = ""; + this.commit(); + } + + public commit(notify: boolean = true) { + switch (this.mode) { + case DimensionFilterMode.Select: + if ( + this.oldMode !== DimensionFilterMode.Select && + !this.ephemeral && + notify + ) { + eventBus.emit("notification", { + message: m.filter_converted_to_select(), + link: { + text: m.common_undo(), + href: page.url.href, + }, + }); + } + // eslint-disable-next-line no-fallthrough + case DimensionFilterMode.InList: + this.expr = this.selectedValues.length + ? createInExpression(this.name, this.selectedValues, this.exclude) + : undefined; + break; + + case DimensionFilterMode.Contains: + this.expr = this.inputText + ? createLikeExpression(this.name, `%${this.inputText}%`, this.exclude) + : undefined; + break; + } + this.oldMode = this.mode; + + this.param = this.expr + ? convertExpressionToFilterParam( + this.expr, + this.mode === DimensionFilterMode.InList ? [this.name] : [], + ) + : ""; + } +} + +export function sanitizeSearchText(searchText: string) { + return searchText.replace(/^%/, "").replace(/%$/, ""); +} diff --git a/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilterReadOnlyChip.svelte b/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilterReadOnlyChip.svelte deleted file mode 100644 index c606ad0b3099..000000000000 --- a/web-common/src/features/dashboards/filters/dimension-filters/DimensionFilterReadOnlyChip.svelte +++ /dev/null @@ -1,94 +0,0 @@ - - - - - diff --git a/web-common/src/features/dashboards/filters/dimension-filters/ReadonlyDimensionFilter.svelte b/web-common/src/features/dashboards/filters/dimension-filters/ReadonlyDimensionFilter.svelte new file mode 100644 index 000000000000..49dd9aee1d3c --- /dev/null +++ b/web-common/src/features/dashboards/filters/dimension-filters/ReadonlyDimensionFilter.svelte @@ -0,0 +1,126 @@ + + + + + diff --git a/web-common/src/features/dashboards/filters/dimension-filters/dimension-filter-values.ts b/web-common/src/features/dashboards/filters/dimension-filters/dimension-filter-values.ts index dde8b1356f59..79fed870ea1e 100644 --- a/web-common/src/features/dashboards/filters/dimension-filters/dimension-filter-values.ts +++ b/web-common/src/features/dashboards/filters/dimension-filters/dimension-filter-values.ts @@ -6,7 +6,6 @@ import { createAndExpression, } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import { sanitiseExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; - import { queryClient } from "@rilldata/web-common/lib/svelte-query/globalQueryClient"; import { createQueryServiceMetricsViewAggregation, @@ -14,7 +13,6 @@ import { } from "@rilldata/web-common/runtime-client"; import type { V1Expression } from "@rilldata/web-common/runtime-client"; import type { RuntimeClient } from "@rilldata/web-common/runtime-client/v2"; -import { mergeDimensionAndMeasureFilters } from "../measure-filters/measure-filter-utils"; import { getFiltersForOtherDimensions } from "../../selectors"; type DimensionSearchArgs = { @@ -59,14 +57,10 @@ export function useDimensionSearch( mode, searchText, values, - // TODO - revist whether passing an empty array is the correct approach - bgh additionalFilter: sanitiseExpression( - mergeDimensionAndMeasureFilters( - getFiltersForOtherDimensions( - metricsViewWheres?.get(mvName) ?? createAndExpression([]), - dimensionName, - ), - [], + getFiltersForOtherDimensions( + metricsViewWheres?.get(mvName) ?? createAndExpression([]), + dimensionName, ), undefined, ), @@ -149,12 +143,9 @@ export function useAllSearchResultsCount( searchText, values, additionalFilter: sanitiseExpression( - mergeDimensionAndMeasureFilters( - getFiltersForOtherDimensions( - metricsViewWheres?.get(mvName) ?? createAndExpression([]), - dimensionName, - ), - [], + getFiltersForOtherDimensions( + metricsViewWheres?.get(mvName) ?? createAndExpression([]), + dimensionName, ), undefined, ), diff --git a/web-common/src/features/dashboards/filters/dimension-filters/queries.svelte.ts b/web-common/src/features/dashboards/filters/dimension-filters/queries.svelte.ts new file mode 100644 index 000000000000..11184b0611e1 --- /dev/null +++ b/web-common/src/features/dashboards/filters/dimension-filters/queries.svelte.ts @@ -0,0 +1,217 @@ +import { RuntimeClient } from "@rilldata/web-common/runtime-client/v2"; +import { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; +import { + getQueryServiceMetricsViewAggregationQueryOptions, + V1BuiltinMeasure, + type V1Expression, +} from "@rilldata/web-common/runtime-client"; +import { + createAndExpression, + createInExpression, + createLikeExpression, +} from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; +import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants.ts"; +import { createReactiveQueries } from "@rilldata/web-common/lib/svelte-query/reactive-queries.svelte.ts"; + +type DimensionSearchArgs = { + manager: ExpressionFilterManager; + dimensionName: string; + mode: DimensionFilterMode; + searchText: string; + values: string[]; + timeStart?: string; + timeEnd?: string; + timeDimension?: string; + enabled?: boolean; +}; + +/** + * Returns the search results from the search input in a dimension filter. + * + * A dimension can be defined by more than one metrics view, so this queries each of them and merges + * the values. `getArgs` is read reactively, as are the specs, so the queries follow both the input + * in the dropdown and the metrics views as they load. + * + * Must be called during component init, once per dimension filter. + */ +export function createDimensionSearchQuery( + client: RuntimeClient, + getArgs: () => DimensionSearchArgs, +) { + return createReactiveQueries( + () => { + const { + manager, + dimensionName, + mode, + searchText, + values, + timeStart, + timeEnd, + timeDimension, + enabled, + } = getArgs(); + + return getMetricsViewsForDimension(manager, dimensionName).map( + (metricsView) => + getQueryServiceMetricsViewAggregationQueryOptions( + client, + { + metricsView, + dimensions: [{ name: dimensionName }], + timeRange: { start: timeStart, end: timeEnd, timeDimension }, + limit: "250", + offset: "0", + sort: [{ name: dimensionName }], + where: getFilterForSearchArgs(dimensionName, { + mode, + searchText, + values, + additionalFilter: manager.getOtherDimensionsFilter( + dimensionName, + metricsView, + ), + }), + }, + { + query: { + enabled, + select: (resp) => + resp.data?.map((d) => d[dimensionName] as string) ?? [], + }, + }, + ), + ); + }, + (valuesPerMetricsView) => [ + ...new Set(valuesPerMetricsView.flatMap((values) => values ?? [])), + ], + ); +} + +/** + * Returns the matched search results count. + * + * 1. For Select this will be disabled. + * 2. For InList mode, it returns the count of values actually present in the data source. + * 3. For Contains mode, it returns the count of values matching the search text. + * + * Must be called during component init, once per dimension filter. + */ +export function createDimensionSearchCountQuery( + client: RuntimeClient, + getArgs: () => DimensionSearchArgs, +) { + return createReactiveQueries( + () => { + const { + manager, + dimensionName, + mode, + searchText, + values, + timeStart, + timeEnd, + timeDimension, + enabled, + } = getArgs(); + const countMeasureName = dimensionName + "__distinct_count"; + + return getMetricsViewsForDimension(manager, dimensionName).map( + (metricsView) => + getQueryServiceMetricsViewAggregationQueryOptions( + client, + { + metricsView, + measures: [ + { + name: countMeasureName, + builtinMeasure: + V1BuiltinMeasure.BUILTIN_MEASURE_COUNT_DISTINCT, + builtinMeasureArgs: [dimensionName], + }, + ], + timeRange: { start: timeStart, end: timeEnd, timeDimension }, + where: getFilterForSearchArgs(dimensionName, { + mode, + searchText, + values, + additionalFilter: manager.getOtherDimensionsFilter( + dimensionName, + metricsView, + ), + }), + }, + { + query: { + enabled, + select: (resp) => + resp.data?.length + ? (resp.data[0][countMeasureName] as number) + : 0, + }, + }, + ), + ); + }, + // Absent while the queries are loading or disabled, so that the chip does not show a count yet. + (countPerMetricsView) => + countPerMetricsView.some((count) => count !== undefined) + ? countPerMetricsView.reduce( + (total, count) => (total ?? 0) + (count ?? 0), + 0, + ) + : undefined, + ); +} + +/** + * Metrics views that define the dimension. A dimension filter only applies to those, and querying a + * metrics view without the dimension errors. + */ +function getMetricsViewsForDimension( + manager: ExpressionFilterManager, + dimensionName: string, +) { + return Object.keys( + manager.metricsViewsProvider.dimensionSpecs[dimensionName] ?? {}, + ); +} + +/** + * Builds the filter for dimension search results or dimension search results count. + * Note the difference, this is for the search results from the search input. + * + * 1. For Select mode, while the final query is an `in` filter, the search results from the search input is a `like` filter. + * 2. For InList mode it is an `in` filter with all the selected values. + * 3. For Contains mode it is a `like` filter. + */ +function getFilterForSearchArgs( + dimensionName: string, + { + mode, + searchText, + values, + additionalFilter, + }: { + mode: DimensionFilterMode; + searchText: string; + values: string[]; + additionalFilter?: V1Expression; + }, +) { + let filter: V1Expression; + if (mode === DimensionFilterMode.InList) { + filter = createInExpression(dimensionName, values); + } else { + const addNull = searchText.length !== 0 && "null".includes(searchText); + filter = addNull + ? createInExpression(dimensionName, [null]) + : createLikeExpression(dimensionName, `%${searchText}%`); + } + + if (additionalFilter) { + return createAndExpression([filter, additionalFilter]); + } + return filter; +} diff --git a/web-common/src/features/dashboards/filters/measure-filters/MeasureFilter.svelte b/web-common/src/features/dashboards/filters/measure-filters/MeasureFilter.svelte index abf95db34215..c1b803578817 100644 --- a/web-common/src/features/dashboards/filters/measure-filters/MeasureFilter.svelte +++ b/web-common/src/features/dashboards/filters/measure-filters/MeasureFilter.svelte @@ -1,61 +1,86 @@ { - if (open && pinned !== curPinned) { - toggleFilterPin?.(name, metricsViewNames); - } - if (open && required !== curRequired) { - toggleFilterRequired?.(name, metricsViewNames); + onOpenChange={(open) => { + if (open) { + curPinned = pinned; + curRequired = required; + } else { + persistPinnedAndRequired(); } }} > @@ -72,40 +97,45 @@ {...props} type="measure" active={open} - {label} - gray={!filter} + label={measureManager.label} + gray={!measureManager.expr} error={!!missingRequired} theme - {onRemove} - removable={!curPinned && !required} - removeTooltipText={m.dashboard_remove_label({ label })} + onRemove={() => measureManager.clear()} + removable={removable && !pinned && !required} + removeTooltipText={m.dashboard_remove_label({ + label: measureManager.label, + })} > { - return d.name === dimensionName; + return d.name === measureManager.dimension; })?.displayName ?? ""} {filter} - {label} + label={measureManager.label} slot="body" />
- {name} + {measureManager.name} {required ? m.dashboard_required_measure() - : label || ""} {#if missingRequired} {m.dashboard_filter_required_set_value()} {:else} - {m.dashboard_click_to_edit_values()} + + + {m.dashboard_click_to_edit_values()} + {/if}
@@ -116,24 +146,16 @@ {#if open} { - if (pinned !== curPinned) { - toggleFilterPin?.(name, metricsViewNames); - } - if (required !== curRequired) { - toggleFilterRequired?.(name, metricsViewNames); - } - onApply(params); - }} + onApply={({ dimension, filter }) => onApply(dimension, filter)} bind:pinned={curPinned} bind:required={curRequired} - showPinControl={!!toggleFilterPin} - showRequiredControl={!!toggleFilterRequired} + showPinControl={yamlConfigProvider.editable} + showRequiredControl={yamlConfigProvider.editable} {side} /> {/if} diff --git a/web-common/src/features/dashboards/filters/measure-filters/MeasureFilterManager.svelte.ts b/web-common/src/features/dashboards/filters/measure-filters/MeasureFilterManager.svelte.ts new file mode 100644 index 000000000000..375a9a57366e --- /dev/null +++ b/web-common/src/features/dashboards/filters/measure-filters/MeasureFilterManager.svelte.ts @@ -0,0 +1,105 @@ +import type { V1Expression } from "@rilldata/web-common/runtime-client"; +import { + mapExprToMeasureFilter, + mapMeasureFilterToExpr, + type MeasureFilterEntry, +} from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry.ts"; +import { + MeasureFilterOperation, + MeasureFilterType, +} from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-options.ts"; +import { + createSubQueryExpression, + removeWrapperAndOrExpression, +} from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; +import { convertExpressionToFilterParam } from "@rilldata/web-common/features/dashboards/url-state/filters/converters.ts"; +import type { MetricsViewsProvider } from "@rilldata/web-common/features/metrics-views/providers/MetricsViewsProvider.svelte.ts"; +import { getMeasureDisplayName } from "@rilldata/web-common/features/dashboards/filters/getDisplayName.ts"; + +export class MeasureFilterManager { + public expr: V1Expression | undefined = $state(undefined); + // String representation of the filter expression. Used to check duplicate expressions across metrics views. + public param: string = $state(""); + + public dimension = $state(""); + public operation = $state(MeasureFilterOperation.LessThan); + public type = $state(MeasureFilterType.Value); + public value1 = $state(""); + public value2 = $state(""); + + public constructor( + public readonly name: string, + public readonly label: string, + initExpr: V1Expression | undefined = undefined, + ) { + this.reconcile(initExpr); + } + + public static createForMetricsViews( + metricsViewsProvider: MetricsViewsProvider, + name: string, + mvName?: string, + initExpr?: V1Expression, + ) { + const measureSpecs = metricsViewsProvider.measureSpecs[name]; + if (!measureSpecs) return undefined; + const measureSpec = mvName + ? measureSpecs[mvName] + : Object.values(measureSpecs)[0]; + if (!measureSpec) return undefined; + + return new MeasureFilterManager( + name, + getMeasureDisplayName(measureSpec), + initExpr, + ); + } + + public reconcile(expr: V1Expression | undefined) { + const dimension = expr?.subquery?.dimension; + + const unwrappedHavingFilter = removeWrapperAndOrExpression( + expr?.subquery?.having, + ); + const mappedMeasureFilter = mapExprToMeasureFilter(unwrappedHavingFilter); + + this.dimension = dimension ?? ""; + this.operation = + mappedMeasureFilter?.operation ?? MeasureFilterOperation.LessThan; + this.type = mappedMeasureFilter?.type ?? MeasureFilterType.Value; + this.value1 = mappedMeasureFilter?.value1 ?? ""; + this.value2 = mappedMeasureFilter?.value2 ?? ""; + this.commit(); + } + + public setMeasureFilter(dimension: string, newFilter: MeasureFilterEntry) { + this.dimension = dimension; + this.operation = newFilter.operation; + this.type = newFilter.type; + this.value1 = newFilter.value1; + this.value2 = newFilter.value2; + this.commit(); + } + + public clear() { + this.value1 = ""; + this.value2 = ""; + this.dimension = ""; + this.commit(); + } + + public commit() { + const measureFilterExpr = mapMeasureFilterToExpr({ + measure: this.name, + operation: this.operation, + type: this.type, + value1: this.value1, + value2: this.value2, + }); + const hasFilter = Boolean(this.dimension && measureFilterExpr); + this.expr = hasFilter + ? createSubQueryExpression(this.dimension, [this.name], measureFilterExpr) + : undefined; + this.param = this.expr ? convertExpressionToFilterParam(this.expr, []) : ""; + } +} diff --git a/web-common/src/features/dashboards/filters/measure-filters/MeasureFilterReadOnlyChip.svelte b/web-common/src/features/dashboards/filters/measure-filters/MeasureFilterReadOnlyChip.svelte deleted file mode 100644 index aaa893337bf1..000000000000 --- a/web-common/src/features/dashboards/filters/measure-filters/MeasureFilterReadOnlyChip.svelte +++ /dev/null @@ -1,22 +0,0 @@ - - - - - diff --git a/web-common/src/features/dashboards/filters/measure-filters/ReadonlyMeasureFilter.svelte b/web-common/src/features/dashboards/filters/measure-filters/ReadonlyMeasureFilter.svelte new file mode 100644 index 000000000000..1c9c454bd3ac --- /dev/null +++ b/web-common/src/features/dashboards/filters/measure-filters/ReadonlyMeasureFilter.svelte @@ -0,0 +1,53 @@ + + + + + diff --git a/web-common/src/features/dashboards/filters/measure-filters/measure-filter-utils.ts b/web-common/src/features/dashboards/filters/measure-filters/measure-filter-utils.ts deleted file mode 100644 index dca091b76238..000000000000 --- a/web-common/src/features/dashboards/filters/measure-filters/measure-filter-utils.ts +++ /dev/null @@ -1,72 +0,0 @@ -import { - mapExprToMeasureFilter, - mapMeasureFilterToExpr, -} from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry"; -import { - createAndExpression, - createSubQueryExpression, - filterExpressions, - isExpressionUnsupported, - removeWrapperAndOrExpression, -} from "@rilldata/web-common/features/dashboards/stores/filter-utils"; -import type { DimensionThresholdFilter } from "@rilldata/web-common/features/dashboards/stores/explore-state"; -import type { V1Expression } from "@rilldata/web-common/runtime-client"; - -export function mergeDimensionAndMeasureFilters( - whereFilter: V1Expression | undefined, - dimensionThresholdFilters: DimensionThresholdFilter[], -) { - if (!whereFilter) return createAndExpression([]); - const where = - filterExpressions(whereFilter, () => true) ?? createAndExpression([]); - where.cond?.exprs?.push( - ...dimensionThresholdFilters.map(convertDimensionThresholdFilter), - ); - return where; -} - -/** - * Splits where filter into dimension and measure filters. - * Measure filters will be sub-queries - */ -export function splitWhereFilter(whereFilter: V1Expression | undefined) { - if (whereFilter && isExpressionUnsupported(whereFilter)) { - return { dimensionFilters: whereFilter, dimensionThresholdFilters: [] }; - } - - const dimensionFilters = createAndExpression([]); - const dimensionThresholdFilters: DimensionThresholdFilter[] = []; - whereFilter?.cond?.exprs?.filter((e) => { - const subqueryExpr = e.cond?.exprs?.[1]; - - // While all the types support multiple measure filters per dimension our UI doesn't allow this right now. - // So unwrap while trying to validate a measure filter. - const unwrappedHavingFilter = removeWrapperAndOrExpression( - subqueryExpr?.subquery?.having, - ); - const mappedMeasureFilter = mapExprToMeasureFilter(unwrappedHavingFilter); - // If there is no valid measure filter at level one then we do not support it right now. - if (!mappedMeasureFilter) { - dimensionFilters.cond?.exprs?.push(e); - } else { - dimensionThresholdFilters.push({ - name: subqueryExpr?.subquery?.dimension ?? "", - filters: [mappedMeasureFilter], - }); - } - }); - - return { dimensionFilters, dimensionThresholdFilters }; -} - -function convertDimensionThresholdFilter( - dtf: DimensionThresholdFilter, -): V1Expression { - return createSubQueryExpression( - dtf.name, - dtf.filters.map((f) => f.measure), - createAndExpression( - dtf.filters.map(mapMeasureFilterToExpr).filter(Boolean) as V1Expression[], - ), - ); -} diff --git a/web-common/src/features/dashboards/filters/test/render-filter-component.ts b/web-common/src/features/dashboards/filters/test/render-filter-component.ts deleted file mode 100644 index afec7c2c3fc2..000000000000 --- a/web-common/src/features/dashboards/filters/test/render-filter-component.ts +++ /dev/null @@ -1,31 +0,0 @@ -import Filters from "@rilldata/web-common/features/dashboards/filters/Filters.svelte"; -import { DEFAULT_STORE_KEY } from "@rilldata/web-common/features/dashboards/state-managers/state-managers"; -import { AD_BIDS_METRICS_NAME } from "@rilldata/web-common/features/dashboards/stores/test-data/data"; -import { initStateManagers } from "@rilldata/web-common/features/dashboards/stores/test-data/helpers"; -import { - RUNTIME_CONTEXT_KEY, - RuntimeClient, -} from "@rilldata/web-common/runtime-client/v2"; -import { render } from "@testing-library/svelte"; - -export function renderFilterComponent(hasTimeSeries = false) { - const { stateManagers, queryClient } = initStateManagers(); - - const renderResults = render(Filters, { - props: { - timeRanges: [], - metricsViewName: AD_BIDS_METRICS_NAME, - hasTimeSeries, - }, - context: new Map([ - [DEFAULT_STORE_KEY as unknown as string, stateManagers as unknown], - ["$$_queryClient", queryClient as unknown], - [ - RUNTIME_CONTEXT_KEY, - new RuntimeClient({ host: "http://localhost", instanceId: "test" }), - ], - ]), - }); - - return { stateManagers, queryClient, renderResults }; -} diff --git a/web-common/src/features/dashboards/filters/utils.ts b/web-common/src/features/dashboards/filters/utils.ts new file mode 100644 index 000000000000..6adb5a779026 --- /dev/null +++ b/web-common/src/features/dashboards/filters/utils.ts @@ -0,0 +1,13 @@ +import { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; +import { YAMLConfigProvider } from "@rilldata/web-common/features/dashboards/providers/YAMLConfigProvider.svelte.ts"; + +export function getMissingRequiredFilters( + expressionFilterManager: ExpressionFilterManager, + yamlConfigProvider: YAMLConfigProvider, +) { + return Object.keys(yamlConfigProvider.requiredFilters).filter( + (filterName) => { + return !expressionFilterManager.filterManagersMap[filterName]?.expr; + }, + ); +} diff --git a/web-common/src/features/dashboards/leaderboard/Leaderboard.svelte b/web-common/src/features/dashboards/leaderboard/Leaderboard.svelte index 5c72ec89b690..67b69b2364a8 100644 --- a/web-common/src/features/dashboards/leaderboard/Leaderboard.svelte +++ b/web-common/src/features/dashboards/leaderboard/Leaderboard.svelte @@ -16,12 +16,10 @@ } from "@rilldata/web-common/runtime-client"; import { useRuntimeClient } from "@rilldata/web-common/runtime-client/v2"; import { onMount } from "svelte"; - import type { DimensionThresholdFilter } from "web-common/src/features/dashboards/stores/explore-state"; import { getComparisonRequestMeasures, getURIRequestMeasure, } from "../dashboard-utils"; - import { mergeDimensionAndMeasureFilters } from "../filters/measure-filters/measure-filter-utils"; import { SortType } from "../proto-state/derived-types"; import { getFiltersForOtherDimensions } from "../selectors"; import { getMeasuresForDimensionOrLeaderboardDisplay } from "../state-managers/selectors/dashboard-queries"; @@ -51,8 +49,7 @@ export let timeRange: V1TimeRange; export let comparisonTimeRange: V1TimeRange | undefined; export let selectedValues: ReturnType; - export let whereFilter: V1Expression; - export let dimensionThresholdFilters: DimensionThresholdFilter[]; + export let whereFilter: V1Expression | undefined; export let leaderboardSortByMeasureName: string; export let leaderboardMeasures: MetricsViewSpecMeasure[]; export let leaderboardShowContextForAllMeasures: boolean; @@ -141,20 +138,14 @@ $: isComplexFilter = isExpressionUnsupported(whereFilter); $: where = isComplexFilter ? whereFilter - : sanitiseExpression( - mergeDimensionAndMeasureFilters( - getFiltersForOtherDimensions(whereFilter, dimensionName), - dimensionThresholdFilters, - ), - undefined, - ); + : getFiltersForOtherDimensions(whereFilter, dimensionName); $: measures = [ ...getMeasuresForDimensionOrLeaderboardDisplay( leaderboardShowContextForAllMeasures ? null : leaderboardSortByMeasureName, - dimensionThresholdFilters, + whereFilter, leaderboardMeasureNames, ).map((name) => ({ name }) as V1MetricsViewAggregationMeasure), diff --git a/web-common/src/features/dashboards/leaderboard/LeaderboardDisplay.svelte b/web-common/src/features/dashboards/leaderboard/LeaderboardDisplay.svelte index d8b0af4a7f86..65e34bbfaa95 100644 --- a/web-common/src/features/dashboards/leaderboard/LeaderboardDisplay.svelte +++ b/web-common/src/features/dashboards/leaderboard/LeaderboardDisplay.svelte @@ -7,7 +7,6 @@ V1TimeRange, } from "@rilldata/web-common/runtime-client"; import { useRuntimeClient } from "@rilldata/web-common/runtime-client/v2"; - import type { DimensionThresholdFilter } from "web-common/src/features/dashboards/stores/explore-state"; import { clamp } from "@rilldata/web-common/lib/clamp"; import Leaderboard from "./Leaderboard.svelte"; import LeaderboardControls from "./LeaderboardControls.svelte"; @@ -20,8 +19,7 @@ } from "./leaderboard-widths"; export let metricsViewName: string; - export let whereFilter: V1Expression; - export let dimensionThresholdFilters: DimensionThresholdFilter[]; + export let whereFilter: V1Expression | undefined; export let timeRange: V1TimeRange; export let comparisonTimeRange: V1TimeRange | undefined; export let timeControlsReady: boolean; @@ -35,7 +33,6 @@ measureTooltipFormatters, activeMeasureTooltipFormatter, }, - dimensionFilters: { isFilterExcludeMode }, dimensions: { visibleDimensions }, comparison: { isBeingCompared: isBeingComparedReadable }, sorting: { sortedAscending, sortType }, @@ -49,11 +46,10 @@ actions: { dimensions: { setPrimaryDimension }, sorting: { toggleSort }, - dimensionsFilter: { toggleDimensionValueSelection }, comparison: { toggleComparisonDimension }, }, exploreName, - dashboardStore, + expressionFilterManager, } = StateManagers; const client = useRuntimeClient(); @@ -105,13 +101,14 @@ leaderboardMeasures={$leaderboardMeasures} leaderboardShowContextForAllMeasures={$leaderboardShowContextForAllMeasures} {whereFilter} - {dimensionThresholdFilters} {tableWidth} {timeRange} {dimensionColumnWidth} sortedAscending={$sortedAscending} sortType={$sortType} - filterExcludeMode={$isFilterExcludeMode(dimension.name)} + filterExcludeMode={expressionFilterManager.filterManagers.dimensions.find( + (dfm) => dfm.name === dimension.name, + )?.exclude ?? false} {comparisonTimeRange} {dimension} {parentElement} @@ -119,7 +116,7 @@ selectedValues={selectedDimensionValues( client, [metricsViewName], - $dashboardStore.whereFilter, + whereFilter, dimension.name, timeRange.start, timeRange.end, @@ -136,7 +133,12 @@ }} {setPrimaryDimension} {toggleSort} - {toggleDimensionValueSelection} + toggleDimensionValueSelection={(_1, value, _2, exclusive) => + expressionFilterManager.dimensionFilterAction( + dimension.name!, + (dimensionManager) => + dimensionManager.toggleValue(value, exclusive ?? false), + )} {toggleComparisonDimension} measureLabel={$measureLabel} onDimensionColumnResize={dimensionColumn.set} diff --git a/web-common/src/features/dashboards/pivot/pivot-data-config.ts b/web-common/src/features/dashboards/pivot/pivot-data-config.ts index 3c932647090c..183f6ee3ea18 100644 --- a/web-common/src/features/dashboards/pivot/pivot-data-config.ts +++ b/web-common/src/features/dashboards/pivot/pivot-data-config.ts @@ -1,4 +1,3 @@ -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import { allDimensions } from "@rilldata/web-common/features/dashboards/state-managers/selectors/dimensions"; import { allMeasures } from "@rilldata/web-common/features/dashboards/state-managers/selectors/measures"; import type { StateManagers } from "@rilldata/web-common/features/dashboards/state-managers/state-managers"; @@ -147,10 +146,7 @@ export function getPivotConfig( validMetricsView: metricsView, validExplore: explore, }), - whereFilter: mergeDimensionAndMeasureFilters( - dashboardStore.whereFilter, - dashboardStore.dimensionThresholdFilters, - ), + whereFilter: dashboardStore.whereFilter, pivot: dashboardStore.pivot, enableComparison, comparisonTime, diff --git a/web-common/src/features/dashboards/pivot/pivot-export.ts b/web-common/src/features/dashboards/pivot/pivot-export.ts index c2f81b82822f..0591d4f39c79 100644 --- a/web-common/src/features/dashboards/pivot/pivot-export.ts +++ b/web-common/src/features/dashboards/pivot/pivot-export.ts @@ -1,5 +1,4 @@ import { getDimensionForTimeField } from "@rilldata/web-common/features/dashboards/aggregation-request/dimension-utils.ts"; -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import { sanitiseExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import type { ExploreState } from "@rilldata/web-common/features/dashboards/stores/explore-state"; import { useTimeControlStore } from "@rilldata/web-common/features/dashboards/time-controls/time-control-store"; @@ -194,13 +193,7 @@ export function getPivotAggregationRequest({ ? prepareMeasureForComparison(measures) : measures, dimensions: allDimensions, - where: sanitiseExpression( - mergeDimensionAndMeasureFilters( - exploreState.whereFilter, - exploreState.dimensionThresholdFilters, - ), - undefined, - ), + where: sanitiseExpression(exploreState.whereFilter, undefined), pivotOn, sort, offset: "0", diff --git a/web-common/src/features/dashboards/proto-state/fromProto.ts b/web-common/src/features/dashboards/proto-state/fromProto.ts index d3045c4ebd0b..88267d948131 100644 --- a/web-common/src/features/dashboards/proto-state/fromProto.ts +++ b/web-common/src/features/dashboards/proto-state/fromProto.ts @@ -1,8 +1,4 @@ import { protoBase64, type Timestamp } from "@bufbuild/protobuf"; -import { - mapExprToMeasureFilter, - type MeasureFilterEntry, -} from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry"; import { LeaderboardContextColumn } from "@rilldata/web-common/features/dashboards/leaderboard-context-column"; import { type PivotChipData, @@ -20,7 +16,9 @@ import { import { convertFilterToExpression } from "@rilldata/web-common/features/dashboards/proto-state/filter-converter"; import { createAndExpression, + createSubQueryExpression, filterIdentifiers, + getAllIdentifiers, } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import type { ExploreState } from "@rilldata/web-common/features/dashboards/stores/explore-state"; import { TDDChart } from "@rilldata/web-common/features/dashboards/time-dimension-details/types"; @@ -115,15 +113,18 @@ export function getDashboardStateFromProto( if (dashboard.dimensionsWithInlistFilter) { entity.dimensionsWithInlistFilter = dashboard.dimensionsWithInlistFilter; } - if (dashboard.having) { - entity.dimensionThresholdFilters = dashboard.having.map((h) => { - const expr = fromExpressionProto(h.filter as Expression); - return { - name: h.name, - filters: expr?.cond?.exprs - ?.map(mapExprToMeasureFilter) - .filter(Boolean) as MeasureFilterEntry[], - }; + // Explore state keeps measure filters collapsed into the where filter as subqueries. + // Older protos stored them separately in `having`, so merge those back in. + entity.dimensionThresholdFilters = []; + if (dashboard.having.length) { + entity.whereFilter ??= createAndExpression([]); + const exprs = entity.whereFilter.cond?.exprs; + dashboard.having.forEach((h) => { + if (!h.filter) return; + const expr = fromExpressionProto(h.filter); + exprs?.push( + createSubQueryExpression(h.name, getAllIdentifiers(expr), expr), + ); }); } if (dashboard.compareTimeRange) { @@ -267,6 +268,20 @@ export function fromExpressionProto( .filter((e): e is V1Expression => e !== undefined), }, }; + + case "subquery": + return { + subquery: { + dimension: expression.expression.value.dimension, + measures: expression.expression.value.measures, + where: + expression.expression.value.where && + fromExpressionProto(expression.expression.value.where), + having: + expression.expression.value.having && + fromExpressionProto(expression.expression.value.having), + }, + }; } } diff --git a/web-common/src/features/dashboards/proto-state/sparse-proto.spec.ts b/web-common/src/features/dashboards/proto-state/sparse-proto.spec.ts index 1d145cf27f14..5bb455e83cd6 100644 --- a/web-common/src/features/dashboards/proto-state/sparse-proto.spec.ts +++ b/web-common/src/features/dashboards/proto-state/sparse-proto.spec.ts @@ -6,6 +6,8 @@ import { AD_BIDS_EXPLORE_INIT, AD_BIDS_EXPLORE_NAME, AD_BIDS_METRICS_INIT, + AD_BIDS_METRICS_VIEW, + AD_BIDS_NAME, AD_BIDS_TIME_RANGE_SUMMARY, } from "@rilldata/web-common/features/dashboards/stores/test-data/data"; import { @@ -34,6 +36,7 @@ import { import { deepClone } from "@vitest/utils/helpers"; import { get } from "svelte/store"; import { beforeEach, describe, expect, it } from "vitest"; +import { useTestFilterManager } from "@rilldata/web-common/features/dashboards/url-state/test/url-state-test-utils.ts"; const TestCases: { title: string; @@ -81,6 +84,12 @@ const TestCasesOppositeMutations = [ AD_BIDS_OPEN_DOM_BP_PIVOT, ]; +// Filters live in the ExpressionFilterManager rather than in explore state, so the tests need the +// specs of the metrics view backing AD_BIDS_EXPLORE to build the filter chips. +const getFilterManager = useTestFilterManager({ + [AD_BIDS_NAME]: AD_BIDS_METRICS_VIEW, +}); + describe("sparse proto", () => { beforeEach(() => { resetDashboardStore(); @@ -102,7 +111,11 @@ describe("sparse proto", () => { AD_BIDS_EXPLORE_INIT, ); - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, mutations); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + mutations, + getFilterManager(), + ); metricsExplorerStore.syncFromUrl( AD_BIDS_EXPLORE_NAME, @@ -118,7 +131,11 @@ describe("sparse proto", () => { describe("should reset partial dashboard store", () => { for (const { title, mutations, keys } of TestCases) { it(`to ${title}`, async () => { - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, mutations); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + mutations, + getFilterManager(), + ); const partialDashboard = getPartialDashboard( AD_BIDS_EXPLORE_NAME, keys, @@ -131,6 +148,7 @@ describe("sparse proto", () => { await applyMutationsToDashboard( AD_BIDS_EXPLORE_NAME, TestCasesOppositeMutations, + getFilterManager(), ); metricsExplorerStore.syncFromUrl( diff --git a/web-common/src/features/dashboards/proto-state/toProto.ts b/web-common/src/features/dashboards/proto-state/toProto.ts index 3faa4c2fd515..89e2e1da40bf 100644 --- a/web-common/src/features/dashboards/proto-state/toProto.ts +++ b/web-common/src/features/dashboards/proto-state/toProto.ts @@ -5,7 +5,6 @@ import { Timestamp, Value, } from "@bufbuild/protobuf"; -import { mapMeasureFilterToExpr } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry"; import { LeaderboardContextColumn } from "@rilldata/web-common/features/dashboards/leaderboard-context-column"; import { splitPivotChips } from "@rilldata/web-common/features/dashboards/pivot/pivot-utils"; import { @@ -19,7 +18,6 @@ import { ToProtoTimeGrainMap, } from "@rilldata/web-common/features/dashboards/proto-state/enum-maps"; import type { ExploreState } from "@rilldata/web-common/features/dashboards/stores/explore-state"; -import { createAndExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import { TDDChart } from "@rilldata/web-common/features/dashboards/time-dimension-details/types"; import { arrayOrderedEquals } from "@rilldata/web-common/lib/arrayUtils"; import type { @@ -33,9 +31,9 @@ import { import { Condition, Expression, + Subquery, } from "@rilldata/web-common/proto/gen/rill/runtime/v1/expression_pb"; import { - DashboardDimensionFilter, DashboardState, DashboardState_ActivePage, DashboardState_LeaderboardContextColumn, @@ -84,21 +82,6 @@ export function getProtoFromDashboardState( if (exploreState.dimensionsWithInlistFilter) { state.dimensionsWithInlistFilter = exploreState.dimensionsWithInlistFilter; } - if (exploreState.dimensionThresholdFilters?.length) { - state.having = exploreState.dimensionThresholdFilters.map( - ({ name, filters }) => - new DashboardDimensionFilter({ - name, - filter: toExpressionProto( - createAndExpression( - filters - .map(mapMeasureFilterToExpr) - .filter(Boolean) as V1Expression[], - ), - ), - }), - ); - } if (exploreState.selectedTimeRange) { state.timeRange = toTimeRangeProto(exploreState.selectedTimeRange); if (exploreState.selectedTimeRange.interval) { @@ -251,6 +234,24 @@ function toExpressionProto(expression: V1Expression): Expression { }, }); } + // Measure filters are stored in the where filter as subqueries. + if (expression.subquery) { + return new Expression({ + expression: { + case: "subquery", + value: new Subquery({ + dimension: expression.subquery.dimension, + measures: expression.subquery.measures, + where: + expression.subquery.where && + toExpressionProto(expression.subquery.where), + having: + expression.subquery.having && + toExpressionProto(expression.subquery.having), + }), + }, + }); + } return new Expression(); } diff --git a/web-common/src/features/dashboards/providers/DashboardConfigProvider.svelte.ts b/web-common/src/features/dashboards/providers/DashboardConfigProvider.svelte.ts new file mode 100644 index 000000000000..fe5c62c393e5 --- /dev/null +++ b/web-common/src/features/dashboards/providers/DashboardConfigProvider.svelte.ts @@ -0,0 +1,72 @@ +import { MetricsViewsProvider } from "@rilldata/web-common/features/metrics-views/providers/MetricsViewsProvider.svelte.ts"; +import { YAMLConfigProvider } from "@rilldata/web-common/features/dashboards/providers/YAMLConfigProvider.svelte.ts"; +import { + createQueryServiceResolveCanvas, + createRuntimeServiceGetExplore, +} from "@rilldata/web-common/runtime-client"; +import { RuntimeClient } from "@rilldata/web-common/runtime-client/v2"; + +/** + * Metrics view name and other yaml config provider based on dashboard type. + */ +export class DashboardConfigProvider { + public readonly metricsViewsProvider: MetricsViewsProvider; + public readonly yamlConfigProvider: YAMLConfigProvider; + + // TODO: ensure cleanup is called + public cleanup: (() => void) | undefined = undefined; + + public constructor(runtimeClient: RuntimeClient) { + this.metricsViewsProvider = new MetricsViewsProvider(runtimeClient, []); + this.yamlConfigProvider = new YAMLConfigProvider(); + } +} + +export class ExploreDashboardConfigProvider extends DashboardConfigProvider { + public constructor(runtimeClient: RuntimeClient, exploreName: string) { + super(runtimeClient); + + const getExploreQuery = createRuntimeServiceGetExplore(runtimeClient, { + name: exploreName, + }); + this.cleanup = getExploreQuery.subscribe((getExploreResp) => { + const exploreSpec = + getExploreResp.data?.explore?.explore?.state?.validSpec ?? {}; + + this.metricsViewsProvider.setMetricsViewNames( + exploreSpec.metricsView ? [exploreSpec.metricsView] : [], + ); + + // this.yamlConfigProvider.update() // TODO: once we have this support for explore + }); + } +} + +export class CanvasDashboardConfigProvider extends DashboardConfigProvider { + public constructor(runtimeClient: RuntimeClient, canvasName: string) { + super(runtimeClient); + + const resolveCanvasQuery = createQueryServiceResolveCanvas(runtimeClient, { + canvas: canvasName, + }); + this.cleanup = resolveCanvasQuery.subscribe((resolveCanvasResp) => { + const canvasSpec = + resolveCanvasResp.data?.canvas?.canvas?.state?.validSpec ?? {}; + + this.metricsViewsProvider.setMetricsViewNames( + Object.keys(resolveCanvasResp.data?.referencedMetricsViews ?? {}), + ); + + const defaultFilters = Object.fromEntries( + Object.entries(canvasSpec.defaultPreset?.filterExpr ?? {}).map( + ([mv, sqlFilter]) => [mv, sqlFilter.expression], + ), + ); + this.yamlConfigProvider.update( + defaultFilters, + canvasSpec.pinnedFilters ?? [], + canvasSpec.requiredFilters ?? [], + ); + }); + } +} diff --git a/web-common/src/features/dashboards/providers/YAMLConfigProvider.svelte.ts b/web-common/src/features/dashboards/providers/YAMLConfigProvider.svelte.ts new file mode 100644 index 000000000000..b1f5e187f522 --- /dev/null +++ b/web-common/src/features/dashboards/providers/YAMLConfigProvider.svelte.ts @@ -0,0 +1,55 @@ +import { type V1Expression } from "@rilldata/web-common/runtime-client"; + +/** + * A provider for YAML only configuration. These are only mutable during yaml editing. + */ +export class YAMLConfigProvider { + public defaultFilters = $state>({}); + public pinnedFilters = $state>({}); + public specPinnedFilters = $state>({}); + public requiredFilters = $state>({}); + public specRequiredFilters = $state>({}); + public editable: boolean = false; + + public cleanup: (() => void) | undefined = undefined; + + public update( + defaultFilters: Record, + pinnedFilters: string[], + requiredFilters: string[], + ) { + this.defaultFilters = defaultFilters; + + const pinnedFiltersRec = Object.fromEntries( + pinnedFilters.map((filter) => [filter, true]), + ); + this.pinnedFilters = { ...pinnedFiltersRec }; + this.specPinnedFilters = { ...pinnedFiltersRec }; + + const requiredFiltersRec = Object.fromEntries( + requiredFilters.map((filter) => [filter, true]), + ); + this.requiredFilters = { ...requiredFiltersRec }; + this.specRequiredFilters = { ...requiredFiltersRec }; + } + + public setEditable(newEditable: boolean) { + this.editable = newEditable; + } + + public togglePinnedFilter(filter: string) { + if (!this.pinnedFilters[filter]) { + this.pinnedFilters[filter] = true; + } else { + delete this.pinnedFilters[filter]; + } + } + + public toggleRequiredFilter(filter: string) { + if (!this.requiredFilters[filter]) { + this.requiredFilters[filter] = true; + } else { + delete this.requiredFilters[filter]; + } + } +} diff --git a/web-common/src/features/dashboards/rows-viewer/RowsViewerAccordion.svelte b/web-common/src/features/dashboards/rows-viewer/RowsViewerAccordion.svelte index 8a33eac5c93f..8ba21c9612da 100644 --- a/web-common/src/features/dashboards/rows-viewer/RowsViewerAccordion.svelte +++ b/web-common/src/features/dashboards/rows-viewer/RowsViewerAccordion.svelte @@ -12,7 +12,6 @@ import { useExploreState } from "web-common/src/features/dashboards/stores/dashboard-stores"; import ExportMenu from "../../exports/ExportMenu.svelte"; import { featureFlags } from "../../feature-flags"; - import { mergeDimensionAndMeasureFilters } from "../filters/measure-filters/measure-filter-utils"; import type { PivotFilter } from "../pivot/types"; import RowsViewer from "./RowsViewer.svelte"; @@ -45,7 +44,7 @@ const client = useRuntimeClient(); $: exploreState = useExploreState(exploreName); - $: ({ whereFilter, dimensionThresholdFilters } = $exploreState); + $: whereFilter = $exploreState.whereFilter; $: pivotDataStore = usePivotForExplore(stateManagers); $: ({ activeCellFilters } = $pivotDataStore); $: showPivot = $showPivotStore; @@ -65,10 +64,7 @@ $: filters = isPivotCellSelected ? sanitiseExpression((activeCellFilters as PivotFilter).filters, undefined) - : sanitiseExpression( - mergeDimensionAndMeasureFilters(whereFilter, dimensionThresholdFilters), - undefined, - ); + : sanitiseExpression(whereFilter, undefined); $: filteredTotalsQuery = createQueryServiceMetricsViewAggregation( client, @@ -136,13 +132,7 @@ timeStart: timeRange.start, timeEnd: timeRange.end, timeDimension: $exploreState?.selectedTimeDimension, - where: sanitiseExpression( - mergeDimensionAndMeasureFilters( - $exploreState.whereFilter, - $exploreState.dimensionThresholdFilters, - ), - undefined, - ), + where: sanitiseExpression($exploreState.whereFilter, undefined), }, }; } diff --git a/web-common/src/features/dashboards/selectors.ts b/web-common/src/features/dashboards/selectors.ts index 1efb46af765c..fc12af9dcd59 100644 --- a/web-common/src/features/dashboards/selectors.ts +++ b/web-common/src/features/dashboards/selectors.ts @@ -1,5 +1,7 @@ import { createAndExpression, + forEachExpression, + isSubqueryExpression, matchExpressionByName, } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import { @@ -32,7 +34,6 @@ import { type QueryClient, } from "@tanstack/svelte-query"; import { derived, type Readable } from "svelte/store"; -import type { DimensionThresholdFilter } from "web-common/src/features/dashboards/stores/explore-state"; export function useMetricsView( client: RuntimeClient, @@ -205,33 +206,36 @@ export function hasValidMetricsViewTimeRange( } export function getFiltersForOtherDimensions( - whereFilter: V1Expression, + whereFilter: V1Expression | undefined, dimName: string, ) { - const exprIdx = whereFilter?.cond?.exprs?.findIndex((e) => - matchExpressionByName(e, dimName), + if (!whereFilter) return undefined; + + const exprIdx = whereFilter?.cond?.exprs?.findIndex( + (e) => matchExpressionByName(e, dimName) && !isSubqueryExpression(e), ); if (exprIdx === undefined || exprIdx === -1) return whereFilter; return createAndExpression( whereFilter.cond?.exprs?.filter( - (e) => !matchExpressionByName(e, dimName), + (e) => !matchExpressionByName(e, dimName) || isSubqueryExpression(e), ) ?? [], ); } export function additionalMeasures( activeMeasureName: string | null, - dimensionThresholdFilters: DimensionThresholdFilter[], + expr: V1Expression | undefined, ) { const measures = new Set( activeMeasureName ? [activeMeasureName] : [], ); - dimensionThresholdFilters.forEach(({ filters }) => { - filters.forEach((filter) => { - measures.add(filter.measure); + if (expr) { + forEachExpression(expr, (e) => { + if (!e.subquery?.measures) return; + e.subquery.measures.forEach((m) => measures.add(m)); }); - }); + } return [...measures]; } diff --git a/web-common/src/features/dashboards/state-managers/StateManagersProvider.svelte b/web-common/src/features/dashboards/state-managers/StateManagersProvider.svelte index d446c88b0a45..3857bbaf2f0b 100644 --- a/web-common/src/features/dashboards/state-managers/StateManagersProvider.svelte +++ b/web-common/src/features/dashboards/state-managers/StateManagersProvider.svelte @@ -1,5 +1,5 @@ diff --git a/web-common/src/features/dashboards/state-managers/actions/dimension-filters.ts b/web-common/src/features/dashboards/state-managers/actions/dimension-filters.ts index 5252f0eadfdd..2d627f1dbf1f 100644 --- a/web-common/src/features/dashboards/state-managers/actions/dimension-filters.ts +++ b/web-common/src/features/dashboards/state-managers/actions/dimension-filters.ts @@ -1,324 +1 @@ -import { page } from "$app/stores"; -import { m } from "@rilldata/web-common/lib/i18n/gen/messages"; -import { splitWhereFilter } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; -import { - createInExpression, - createLikeExpression, - getValuesInExpression, - negateExpression, -} from "@rilldata/web-common/features/dashboards/stores/filter-utils"; -import { eventBus } from "@rilldata/web-common/lib/event-bus/event-bus"; -import { - type V1Expression, - V1Operation, -} from "@rilldata/web-common/runtime-client"; -import { get } from "svelte/store"; -import { getWhereFilterExpressionIndex } from "../selectors/dimension-filters"; -import type { DashboardMutables } from "./types"; - -export function toggleDimensionValueSelection( - { dashboard }: DashboardMutables, - dimensionName: string, - dimensionValue: string | null, - keepPillVisible?: boolean, - /** - * This marks the value as being exclusive. All other selected values will be unselected. - */ - isExclusiveFilter?: boolean, -) { - return toggleMultipleDimensionValueSelections( - { dashboard }, - dimensionName, - [dimensionValue], - keepPillVisible, - isExclusiveFilter, - ); -} - -export function toggleMultipleDimensionValueSelections( - { dashboard }: DashboardMutables, - dimensionName: string, - dimensionValues: (string | null)[], - keepPillVisible?: boolean, - isExclusiveFilter?: boolean, - exclude?: boolean, -) { - if (dashboard.temporaryFilterName !== null) { - dashboard.temporaryFilterName = null; - } - - if (exclude !== undefined) { - dashboard.dimensionFilterExcludeMode.set(dimensionName, exclude); - } - const isExclude = - exclude ?? !!dashboard.dimensionFilterExcludeMode.get(dimensionName); - const exprIdx = getWhereFilterExpressionIndex({ dashboard })(dimensionName); - if (exprIdx === undefined || exprIdx === -1) { - dashboard.whereFilter.cond?.exprs?.push( - createInExpression(dimensionName, dimensionValues, isExclude), - ); - return; - } - - const expr = dashboard.whereFilter.cond?.exprs?.[exprIdx]; - if (!expr?.cond?.exprs) { - // should never happen since getWhereFilterExpressionIndex runs a find - return; - } - - const wasInListFilter = - dashboard.dimensionsWithInlistFilter.includes(dimensionName); - const wasLikeFilter = - expr.cond?.op === V1Operation.OPERATION_LIKE || - expr.cond?.op === V1Operation.OPERATION_NLIKE; - if (wasInListFilter || wasLikeFilter) { - eventBus.emit("notification", { - message: m.filter_converted_to_select(), - link: { - text: m.common_undo(), - href: get(page).url.href, - }, - }); - } - - dashboard.dimensionsWithInlistFilter = - dashboard.dimensionsWithInlistFilter.filter((d) => d !== dimensionName); - if (wasLikeFilter) { - eventBus.emit("notification", { - message: m.filter_converted_to_select(), - link: { - text: m.common_undo(), - href: get(page).url.href, - }, - }); - dashboard.whereFilter.cond!.exprs![exprIdx] = createInExpression( - dimensionName, - dimensionValues, - isExclude, - ); - return; - } - - dimensionValues.forEach((v) => { - const removedIndex = toggleDimensionFilterValue( - expr, - v, - !!isExclusiveFilter, - ); - if (removedIndex === -1) return; - - // Only decrement pinIndex if the removed value was before the pinned value - if (dashboard.tdd.pinIndex >= removedIndex) { - dashboard.tdd.pinIndex--; - } - }); - - // remove the dimension entry if all values are removed - if (expr.cond.exprs.length === 1) { - dashboard.whereFilter.cond?.exprs?.splice(exprIdx, 1); - if (keepPillVisible) { - dashboard.temporaryFilterName = dimensionName; - } - } -} - -export function applyDimensionInListMode( - { dashboard }: DashboardMutables, - dimensionName: string, - values: string[], -) { - if (dashboard.temporaryFilterName !== null) { - dashboard.temporaryFilterName = null; - } - - if (!dashboard.whereFilter.cond?.exprs) return; - - const isExclude = !!dashboard.dimensionFilterExcludeMode.get(dimensionName); - const expr = createInExpression(dimensionName, values, isExclude); - if (!dashboard.dimensionsWithInlistFilter.includes(dimensionName)) { - dashboard.dimensionsWithInlistFilter.push(dimensionName); - } - const exprIdx = getWhereFilterExpressionIndex({ dashboard })(dimensionName); - if (exprIdx === undefined || exprIdx === -1) { - dashboard.whereFilter.cond.exprs.push(expr); - } else { - dashboard.whereFilter.cond.exprs[exprIdx] = expr; - } -} - -export function applyDimensionContainsMode( - { dashboard }: DashboardMutables, - dimensionName: string, - searchText: string, -) { - if (dashboard.temporaryFilterName !== null) { - dashboard.temporaryFilterName = null; - } - - if (!dashboard.whereFilter.cond?.exprs) return; - - const isExclude = !!dashboard.dimensionFilterExcludeMode.get(dimensionName); - const expr = createLikeExpression( - dimensionName, - `%${searchText}%`, - isExclude, - ); - const exprIdx = getWhereFilterExpressionIndex({ dashboard })(dimensionName); - if (exprIdx === undefined || exprIdx === -1) { - dashboard.whereFilter.cond.exprs.push(expr); - } else { - dashboard.whereFilter.cond.exprs[exprIdx] = expr; - } -} - -export function toggleDimensionFilterMode( - { dashboard }: DashboardMutables, - dimensionName: string, -) { - const exclude = dashboard.dimensionFilterExcludeMode.get(dimensionName); - dashboard.dimensionFilterExcludeMode.set(dimensionName, !exclude); - - if (!dashboard.whereFilter?.cond?.exprs) { - return; - } - - const exprIdx = dashboard.whereFilter.cond.exprs.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ); - if (exprIdx === -1) { - return; - } - dashboard.whereFilter.cond.exprs[exprIdx] = negateExpression( - dashboard.whereFilter.cond.exprs[exprIdx], - ); -} - -export function removeDimensionFilter( - { dashboard }: DashboardMutables, - dimensionName: string, -) { - if (dashboard.temporaryFilterName === dimensionName) { - dashboard.temporaryFilterName = null; - return; - } - - const exprIdx = getWhereFilterExpressionIndex({ dashboard })(dimensionName); - if (exprIdx === undefined || exprIdx === -1) return; - dashboard.whereFilter?.cond?.exprs?.splice(exprIdx, 1); -} - -export function selectItemsInFilter( - { dashboard }: DashboardMutables, - dimensionName: string, - values: (string | null)[], -) { - const isExclude = !!dashboard.dimensionFilterExcludeMode.get(dimensionName); - const exprIdx = getWhereFilterExpressionIndex({ dashboard })(dimensionName); - if (exprIdx === undefined || exprIdx === -1) { - dashboard.whereFilter.cond?.exprs?.push( - createInExpression(dimensionName, values, isExclude), - ); - return; - } - - const expr = dashboard.whereFilter.cond?.exprs?.[exprIdx]; - if (!expr?.cond?.exprs) { - // should never happen since getWhereFilterExpressionIndex runs a find - return; - } - - // preserve old selections and add only new ones - const oldValues = getValuesInExpression(expr); - const newValues = values.filter((v) => !oldValues.includes(v)); - // newValuesSelected = newValues.length; // TODO - expr.cond.exprs.push(...newValues.map((v): V1Expression => ({ val: v }))); -} - -export function deselectItemsInFilter( - { dashboard }: DashboardMutables, - dimensionName: string, - values: (string | null)[], -) { - const exprIdx = getWhereFilterExpressionIndex({ dashboard })(dimensionName); - if (exprIdx === undefined || exprIdx === -1) { - return; - } - - const expr = dashboard.whereFilter.cond?.exprs?.[exprIdx]; - if (!expr?.cond?.exprs) { - // should never happen since getWhereFilterExpressionIndex runs a find - return; - } - - // remove only deselected values - const oldValues = getValuesInExpression(expr); - const newValues = oldValues.filter((v) => !values.includes(v)); - - if (newValues.length) { - expr.cond.exprs.splice( - 1, - expr.cond.exprs.length - 1, - ...newValues.map((v): V1Expression => ({ val: v })), - ); - } else { - dashboard.whereFilter.cond?.exprs?.splice(exprIdx, 1); - } -} - -export function setFilters( - { dashboard }: DashboardMutables, - filter: V1Expression, -) { - const { dimensionFilters, dimensionThresholdFilters } = - splitWhereFilter(filter); - dashboard.whereFilter = dimensionFilters; - dashboard.dimensionThresholdFilters = dimensionThresholdFilters; -} - -export function toggleDimensionFilterValue( - expr: V1Expression, - dimensionValue: string | null, - isExclusiveFilter: boolean, -) { - if (!expr.cond?.exprs) return -1; - - const ident = expr.cond.exprs[0]; - const values = getValuesInExpression(expr); - - const inIdx = values.findIndex((v) => v === dimensionValue); - - if (inIdx === -1) { - if (isExclusiveFilter) { - expr.cond.exprs = [ident, { val: dimensionValue }]; - return -1; - } else { - values.push(dimensionValue); - } - } else { - values.splice(inIdx, 1); - } - - expr.cond.exprs = [ident, ...values.map((v) => ({ val: v }))]; - - return inIdx; -} - -export const dimensionFilterActions = { - /** - * Toggles whether the given dimension value is selected in the - * dimension filter for the given dimension. - * - * Note that this is different than the include/exclude mode for - * dimension filters. This is a toggle for a specific value, whereas - * the include/exclude mode is a toggle for the entire dimension. - */ - toggleDimensionValueSelection, - toggleMultipleDimensionValueSelections, - applyDimensionInListMode, - applyDimensionContainsMode, - toggleDimensionFilterMode, - removeDimensionFilter, - selectItemsInFilter, - deselectItemsInFilter, - setFilters, -}; +export const dimensionFilterActions = {}; diff --git a/web-common/src/features/dashboards/state-managers/actions/filters.ts b/web-common/src/features/dashboards/state-managers/actions/filters.ts index 32749c48449f..a9306e9676df 100644 --- a/web-common/src/features/dashboards/state-managers/actions/filters.ts +++ b/web-common/src/features/dashboards/state-managers/actions/filters.ts @@ -1,33 +1 @@ -import type { DashboardMutables } from "@rilldata/web-common/features/dashboards/state-managers/actions/types"; -import { createAndExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; - -export function clearAllFilters({ dashboard }: DashboardMutables) { - const hasFilters = - dashboard.whereFilter.cond?.exprs?.length || - dashboard.dimensionThresholdFilters?.length; - if (!hasFilters) { - return; - } - - dashboard.whereFilter = createAndExpression([]); - dashboard.dimensionThresholdFilters = []; - dashboard.temporaryFilterName = null; - dashboard.dimensionFilterExcludeMode.clear(); - dashboard.tdd.pinIndex = -1; -} - -export function setTemporaryFilterName( - { dashboard }: DashboardMutables, - name: string, -) { - dashboard.temporaryFilterName = name; -} - -export const filterActions = { - /** - * Clears all filters and resets related fields - */ - clearAllFilters, - - setTemporaryFilterName, -}; +export const filterActions = {}; diff --git a/web-common/src/features/dashboards/state-managers/actions/measure-filters.ts b/web-common/src/features/dashboards/state-managers/actions/measure-filters.ts index 8888e49c0c75..472a63ea62bc 100644 --- a/web-common/src/features/dashboards/state-managers/actions/measure-filters.ts +++ b/web-common/src/features/dashboards/state-managers/actions/measure-filters.ts @@ -1,72 +1 @@ -import type { MeasureFilterEntry } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry"; -import type { DashboardMutables } from "@rilldata/web-common/features/dashboards/state-managers/actions/types"; -import type { DimensionThresholdFilter } from "@rilldata/web-common/features/dashboards/stores/explore-state"; - -export function setMeasureFilter( - { dashboard }: DashboardMutables, - dimensionName: string, - filter: MeasureFilterEntry, -) { - if (dashboard.temporaryFilterName !== null) { - dashboard.temporaryFilterName = null; - } - - const dimId = dashboard.dimensionThresholdFilters.findIndex( - (dtf) => dtf.name === dimensionName, - ); - let dimThresholdFilter: DimensionThresholdFilter; - if (dimId === -1) { - dimThresholdFilter = { - name: dimensionName, - filters: [], - }; - dashboard.dimensionThresholdFilters.push(dimThresholdFilter); - } else { - dimThresholdFilter = dashboard.dimensionThresholdFilters[dimId]; - } - - const exprIdx = dimThresholdFilter.filters.findIndex( - (f) => f.measure === filter.measure, - ); - if (exprIdx === -1) { - // if there is no expression for the measure push to the end - dimThresholdFilter.filters.push(filter); - } else if (exprIdx >= 0) { - // else replace the existing measure filter - dimThresholdFilter.filters.splice(exprIdx, 1, filter); - } -} - -export function removeMeasureFilter( - { dashboard }: DashboardMutables, - dimensionName: string, - measureName: string, -) { - if (dashboard.temporaryFilterName === measureName) { - dashboard.temporaryFilterName = null; - return; - } - - const dimId = dashboard.dimensionThresholdFilters.findIndex( - (dtf) => dtf.name === dimensionName, - ); - if (dimId === -1) return; - const dimThresholdFilter = dashboard.dimensionThresholdFilters[dimId]; - - const exprIdx = dimThresholdFilter.filters.findIndex( - (f) => f.measure === measureName, - ); - if (exprIdx === -1) return; - dimThresholdFilter.filters.splice(exprIdx, 1); - - // if dimension threshold filter is empty remove it - if (dimThresholdFilter.filters.length === 0) { - dashboard.dimensionThresholdFilters.splice(dimId, 1); - } -} - -export const measureFilterActions = { - setMeasureFilter, - - removeMeasureFilter, -}; +export const measureFilterActions = {}; diff --git a/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.spec.ts b/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.spec.ts index 435684076dae..e591d356fbda 100644 --- a/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.spec.ts +++ b/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.spec.ts @@ -25,7 +25,7 @@ import { AD_BIDS_PUBLISHER_DIMENSION, } from "@rilldata/web-common/features/dashboards/stores/test-data/data"; import { ExploreUrlWebView } from "@rilldata/web-common/features/dashboards/url-state/mappers"; -import { getCleanMetricsExploreForAssertion } from "@rilldata/web-common/features/dashboards/url-state/url-state-variations.spec"; +import { getCleanMetricsExploreForAssertion } from "@rilldata/web-common/features/dashboards/url-state/test/url-state-test-utils"; import { queryClient } from "@rilldata/web-common/lib/svelte-query/globalQueryClient"; import { mockAnimationsForComponentTesting } from "@rilldata/web-common/lib/test/mock-animations"; import { diff --git a/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.svelte b/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.svelte index 14c17a68a992..e8cc303f4e28 100644 --- a/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.svelte +++ b/web-common/src/features/dashboards/state-managers/loaders/DashboardStateManager.svelte @@ -22,6 +22,7 @@ import { useRuntimeClient } from "@rilldata/web-common/runtime-client/v2"; import { onDestroy } from "svelte"; import { clearExploreSessionStore } from "@rilldata/web-common/features/dashboards/state-managers/loaders/explore-web-view-store.ts"; + import { getStateManagers } from "@rilldata/web-common/features/dashboards/state-managers/state-managers.ts"; export let exploreName: string; export let storageNamespacePrefix: string | undefined = undefined; @@ -33,6 +34,9 @@ const client = useRuntimeClient(); + const StateManagers = getStateManagers(); + const { expressionFilterManager } = StateManagers; + $: exploreSpecQuery = useExploreValidSpec(client, exploreName); $: exploreSpec = $exploreSpecQuery.data?.explore ?? {}; $: metricsViewName = exploreSpec?.metricsView ?? ""; @@ -56,6 +60,7 @@ exploreName, storageNamespacePrefix, dataLoader, + expressionFilterManager, ); } diff --git a/web-common/src/features/dashboards/state-managers/loaders/DashboardStateSync.ts b/web-common/src/features/dashboards/state-managers/loaders/DashboardStateSync.ts index 7b1c3e3e1240..102130029eea 100644 --- a/web-common/src/features/dashboards/state-managers/loaders/DashboardStateSync.ts +++ b/web-common/src/features/dashboards/state-managers/loaders/DashboardStateSync.ts @@ -20,6 +20,7 @@ import type { AfterNavigate } from "@sveltejs/kit"; import { getContext, setContext } from "svelte"; import { derived, get, type Readable } from "svelte/store"; import type { CompoundQueryResult } from "@rilldata/web-common/features/compound-query-result"; +import type { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; export const DASHBOARD_STATE_SYNC_KEY = Symbol("state-sync"); @@ -54,6 +55,7 @@ export class DashboardStateSync { private readonly exploreName: string, private readonly extraPrefix: string | undefined, private readonly dataLoader: DashboardStateDataLoader, + private readonly expressionFilterManager: ExpressionFilterManager, ) { this.exploreStore = useExploreState(exploreName); this.timeControlStore = createTimeControlStoreFromName( @@ -185,6 +187,8 @@ export class DashboardStateSync { ); } + log("INIT", redirectUrl); + this.expressionFilterManager.setUrlParams(redirectUrl.searchParams); // If the current url same as the new url then there is no need to do anything if (redirectUrl.search === pageState.url.search) { this.initialized = true; @@ -262,6 +266,7 @@ export class DashboardStateSync { metricsExplorerStore.mergePartialExplorerEntity( this.exploreName, partialExplore, + this.expressionFilterManager, ); // Get time controls state after explore state is updated. const timeControlsState = get(this.timeControlStore); @@ -294,6 +299,8 @@ export class DashboardStateSync { this.updating = false; } + log("URL", redirectUrl); + this.expressionFilterManager.setUrlParams(redirectUrl.searchParams); // If the url doesn't need to be changed further then we can skip the goto if (redirectUrl.search === pageState.url.search) { return; @@ -349,6 +356,8 @@ export class DashboardStateSync { ); } + log("GOTO", newUrl); + this.expressionFilterManager.setUrlParams(newUrl.searchParams); // If the state didnt result in a new url then skip goto. // This avoids adding redundant urls to the history. if (newUrl.search === pageState.url.search) { @@ -362,3 +371,12 @@ export class DashboardStateSync { } } } + +function log(label: string, toUrl: URL) { + const fromUrlSearch = get(page).url.search; + const toUrlSearch = toUrl.search; + const equal = fromUrlSearch === toUrlSearch; + console.log( + `[${label}] ${fromUrlSearch} =${equal ? "X" : "="}> ${toUrlSearch}`, + ); +} diff --git a/web-common/src/features/dashboards/state-managers/loaders/explore-web-view-store.spec.ts b/web-common/src/features/dashboards/state-managers/loaders/explore-web-view-store.spec.ts index e45ce5bd4f3f..38415c443610 100644 --- a/web-common/src/features/dashboards/state-managers/loaders/explore-web-view-store.spec.ts +++ b/web-common/src/features/dashboards/state-managers/loaders/explore-web-view-store.spec.ts @@ -11,6 +11,8 @@ import { AD_BIDS_IMPRESSIONS_MEASURE, AD_BIDS_METRICS_3_MEASURES_DIMENSIONS, AD_BIDS_METRICS_NAME, + AD_BIDS_METRICS_VIEW, + AD_BIDS_NAME, AD_BIDS_TIME_RANGE_SUMMARY, } from "@rilldata/web-common/features/dashboards/stores/test-data/data"; import { @@ -28,7 +30,10 @@ import { applyMutationsToDashboard, type TestDashboardMutation, } from "@rilldata/web-common/features/dashboards/stores/test-data/store-mutations"; -import { getCleanMetricsExploreForAssertion } from "@rilldata/web-common/features/dashboards/url-state/url-state-variations.spec"; +import { + getCleanMetricsExploreForAssertion, + useTestFilterManager, +} from "@rilldata/web-common/features/dashboards/url-state/test/url-state-test-utils"; import { queryClient } from "@rilldata/web-common/lib/svelte-query/globalQueryClient"; import { RUNTIME_CONTEXT_KEY, @@ -153,6 +158,12 @@ const TestCases: { }, ]; +// Filters live in the ExpressionFilterManager rather than in explore state, so the tests need the +// specs of the metrics view backing AD_BIDS_EXPLORE to build the filter chips. +const getFilterManager = useTestFilterManager({ + [AD_BIDS_NAME]: AD_BIDS_METRICS_VIEW, +}); + describe("Explore web view store", () => { const mocks = DashboardFetchMocks.useDashboardFetchMocks(); let pageMock!: PageMockForExploreTests; @@ -186,21 +197,29 @@ describe("Explore web view store", () => { await waitFor(() => expect(screen.getByText("Dashboard loaded!"))); // apply mutations to main view to setup the initial state - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, [ - AD_BIDS_APPLY_PUB_DIMENSION_FILTER, - AD_BIDS_SET_P7D_TIME_RANGE_FILTER, - AD_BIDS_SET_PREVIOUS_PERIOD_COMPARE_TIME_RANGE_FILTER, - AD_BIDS_TOGGLE_BID_PRICE_MEASURE_VISIBILITY(AD_BIDS_EXPLORE_INIT), - AD_BIDS_TOGGLE_BID_DOMAIN_DIMENSION_VISIBILITY(AD_BIDS_EXPLORE_INIT), - AD_BIDS_SORT_ASC_BY_IMPRESSIONS, - AD_BIDS_SORT_BY_PERCENT_VALUE, - ]); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + [ + AD_BIDS_APPLY_PUB_DIMENSION_FILTER, + AD_BIDS_SET_P7D_TIME_RANGE_FILTER, + AD_BIDS_SET_PREVIOUS_PERIOD_COMPARE_TIME_RANGE_FILTER, + AD_BIDS_TOGGLE_BID_PRICE_MEASURE_VISIBILITY(AD_BIDS_EXPLORE_INIT), + AD_BIDS_TOGGLE_BID_DOMAIN_DIMENSION_VISIBILITY(AD_BIDS_EXPLORE_INIT), + AD_BIDS_SORT_ASC_BY_IMPRESSIONS, + AD_BIDS_SORT_BY_PERCENT_VALUE, + ], + getFilterManager(), + ); const initialSearch = `view=${initView.view}${initView.additionalParams ?? ""}`; // simulate going to the init view's url pageMock.gotoSearch(initialSearch); // apply any mutations in the init view - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, initView.mutations); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + initView.mutations, + getFilterManager(), + ); const initState = getCleanMetricsExploreForAssertion(); @@ -208,7 +227,11 @@ describe("Explore web view store", () => { // simulate going to the view's url pageMock.gotoSearch(viewSearch); // apply any mutations in the view - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, view.mutations); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + view.mutations, + getFilterManager(), + ); const stateInView = getCleanMetricsExploreForAssertion(); // All history changes before this are a combination of visiting the view and mutations. @@ -259,9 +282,11 @@ describe("Explore web view store", () => { pageMock.assertSearchParams(""); pageMock.gotoSearch(tddSearch); - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, [ - AD_BIDS_SWITCH_TO_STACKED_BAR_IN_TDD, - ]); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + [AD_BIDS_SWITCH_TO_STACKED_BAR_IN_TDD], + getFilterManager(), + ); pageMock.assertSearchParams( `view=tdd&measure=${AD_BIDS_IMPRESSIONS_MEASURE}&chart_type=stacked_bar`, ); diff --git a/web-common/src/features/dashboards/state-managers/loaders/test/DashboardStateManagerTest.svelte b/web-common/src/features/dashboards/state-managers/loaders/test/DashboardStateManagerTest.svelte index ddf52fedd4ec..19beef13221a 100644 --- a/web-common/src/features/dashboards/state-managers/loaders/test/DashboardStateManagerTest.svelte +++ b/web-common/src/features/dashboards/state-managers/loaders/test/DashboardStateManagerTest.svelte @@ -1,10 +1,14 @@ - -
Dashboard loaded!
-
+ + +
Dashboard loaded!
+
+
diff --git a/web-common/src/features/dashboards/state-managers/most-recent-explore-state.spec.ts b/web-common/src/features/dashboards/state-managers/most-recent-explore-state.spec.ts index 725074f34920..a428f96f4b19 100644 --- a/web-common/src/features/dashboards/state-managers/most-recent-explore-state.spec.ts +++ b/web-common/src/features/dashboards/state-managers/most-recent-explore-state.spec.ts @@ -12,6 +12,7 @@ import { AD_BIDS_EXPLORE_NAME, AD_BIDS_METRICS_3_MEASURES_DIMENSIONS, AD_BIDS_METRICS_NAME, + AD_BIDS_NAME, AD_BIDS_PUBLISHER_DIMENSION, AD_BIDS_TIME_RANGE_SUMMARY, } from "@rilldata/web-common/features/dashboards/stores/test-data/data"; @@ -25,7 +26,10 @@ import { applyMutationsToDashboard, type TestDashboardMutation, } from "@rilldata/web-common/features/dashboards/stores/test-data/store-mutations"; -import { getCleanMetricsExploreForAssertion } from "@rilldata/web-common/features/dashboards/url-state/url-state-variations.spec"; +import { + getCleanMetricsExploreForAssertion, + useTestFilterManager, +} from "@rilldata/web-common/features/dashboards/url-state/test/url-state-test-utils"; import { queryClient } from "@rilldata/web-common/lib/svelte-query/globalQueryClient"; import { DashboardState_LeaderboardSortDirection, @@ -109,6 +113,12 @@ const TestCases: { }, ]; +// Filters live in the ExpressionFilterManager rather than in explore state, so the tests need the +// specs of the metrics view backing AD_BIDS_EXPLORE to build the filter chips. +const getFilterManager = useTestFilterManager({ + [AD_BIDS_NAME]: AD_BIDS_METRICS_3_MEASURES_DIMENSIONS, +}); + describe("Most recent explore state", () => { const mocks = DashboardFetchMocks.useDashboardFetchMocks(); let pageMock!: PageMockForExploreTests; @@ -151,7 +161,11 @@ describe("Most recent explore state", () => { const initState = getCleanMetricsExploreForAssertion(); pageMock.gotoSearch(urlSearch); - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, mutations); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + mutations, + getFilterManager(), + ); // clear the old dashboard to simulate closing the tab unmount(); diff --git a/web-common/src/features/dashboards/state-managers/selectors/dashboard-queries.ts b/web-common/src/features/dashboards/state-managers/selectors/dashboard-queries.ts index 407988549b7a..bb11ee660050 100644 --- a/web-common/src/features/dashboards/state-managers/selectors/dashboard-queries.ts +++ b/web-common/src/features/dashboards/state-managers/selectors/dashboard-queries.ts @@ -1,16 +1,14 @@ import { additionalMeasures } from "../../selectors"; -import type { DimensionThresholdFilter } from "web-common/src/features/dashboards/stores/explore-state"; +import type { V1Expression } from "@rilldata/web-common/runtime-client"; export function getMeasuresForDimensionOrLeaderboardDisplay( sortByMeasureName: string | null, - dimensionThresholdFilters: DimensionThresholdFilter[], + expr: V1Expression | undefined, visibleMeasureNames: string[], ) { const allMeasures = new Set([ ...visibleMeasureNames, - ...(sortByMeasureName - ? additionalMeasures(sortByMeasureName, dimensionThresholdFilters) - : []), + ...(sortByMeasureName ? additionalMeasures(sortByMeasureName, expr) : []), ]); return [...allMeasures]; } diff --git a/web-common/src/features/dashboards/state-managers/selectors/dimension-filters.ts b/web-common/src/features/dashboards/state-managers/selectors/dimension-filters.ts index 94fd870222cd..5cdd34c5eb32 100644 --- a/web-common/src/features/dashboards/state-managers/selectors/dimension-filters.ts +++ b/web-common/src/features/dashboards/state-managers/selectors/dimension-filters.ts @@ -1,12 +1,12 @@ import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants"; import { useDimensionSearch } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/dimension-filter-values"; import { getDimensionDisplayName } from "@rilldata/web-common/features/dashboards/filters/getDisplayName"; -import { filterItemsSortFunction } from "@rilldata/web-common/features/dashboards/state-managers/selectors/filters"; import type { StateManagers } from "@rilldata/web-common/features/dashboards/state-managers/state-managers"; import { forEachIdentifier, getValuesInExpression, isExpressionUnsupported, + isSubqueryExpression, matchExpressionByName, } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import type { @@ -38,8 +38,8 @@ export const selectedDimensionValues = ( data: [], }); - const dimExpr = whereFilter.cond?.exprs?.find((e) => - matchExpressionByName(e, dimensionName), + const dimExpr = whereFilter.cond?.exprs?.find( + (e) => matchExpressionByName(e, dimensionName) && !isSubqueryExpression(e), ); if (!dimExpr?.cond?.op) return readable({ @@ -97,36 +97,12 @@ export const useSelectedValuesForCompareDimension = (ctx: StateManagers) => { ) as ReturnType; }; -export const isFilterExcludeMode = ( - dashData: AtLeast, -): ((dimName: string) => boolean) => { - return (dimName: string) => - dashData.dashboard.dimensionFilterExcludeMode.get(dimName) ?? false; -}; - -export const dimensionHasFilter = ( - dashData: AtLeast, -) => { - return (dimName: string) => { - return getWhereFilterExpression(dashData)(dimName) !== undefined; - }; -}; - -export const getWhereFilterExpression = ( - dashData: AtLeast, -): ((name: string) => V1Expression | undefined) => { - return (name: string) => - dashData.dashboard.whereFilter.cond?.exprs?.find((e) => - matchExpressionByName(e, name), - ); -}; - export const getWhereFilterExpressionIndex = ( dashData: AtLeast, ): ((name: string) => number | undefined) => { return (name: string) => - dashData.dashboard.whereFilter?.cond?.exprs?.findIndex((e) => - matchExpressionByName(e, name), + dashData.dashboard.whereFilter?.cond?.exprs?.findIndex( + (e) => matchExpressionByName(e, name) && !isSubqueryExpression(e), ); }; @@ -144,19 +120,6 @@ export type DimensionFilterItem = { missingRequired?: boolean; }; -export function getDimensionFilterItems( - dashData: AtLeast, -) { - return (dimensionIdMap: Map) => { - return getDimensionFilters( - dimensionIdMap, - dashData.dashboard.whereFilter, - dashData.dashboard.dimensionsWithInlistFilter, - dashData.validExplore?.metricsView, - ); - }; -} - export function getDimensionFiltersMap( dimensionIdMap: Map, filter: V1Expression | undefined, @@ -230,102 +193,4 @@ export function getDimensionFilters( ); } -export const getAllDimensionFilterItems = ( - dashData: AtLeast, -) => { - return ( - dimensionFilterItem: DimensionFilterItem[], - dimensionIdMap: Map, - ) => { - const allDimensionFilterItem = [...dimensionFilterItem]; - - // if the temporary filter is a dimension filter add it - if ( - dashData.dashboard.temporaryFilterName && - dimensionIdMap.has(dashData.dashboard.temporaryFilterName) && - dashData.validExplore?.metricsView - ) { - allDimensionFilterItem.push({ - name: dashData.dashboard.temporaryFilterName, - label: getDimensionDisplayName( - dimensionIdMap.get(dashData.dashboard.temporaryFilterName), - ), - mode: DimensionFilterMode.Select, - selectedValues: [], - isInclude: true, - dimensions: new Map([ - [ - dashData.validExplore?.metricsView, - dimensionIdMap.get(dashData.dashboard.temporaryFilterName)!, - ], - ]), - pinned: false, - }); - } - - // sort based on name to make sure toggling include/exclude is not jarring - return allDimensionFilterItem.sort(filterItemsSortFunction); - }; -}; - -export const unselectedDimensionValues = ( - dashData: AtLeast, -) => { - return (dimensionName: string, values: unknown[]): unknown[] => { - const expr = getWhereFilterExpression(dashData)(dimensionName); - if (expr === undefined) { - return values; - } - - return values.filter( - (v) => expr.cond?.exprs?.findIndex((e) => e.val === v) === -1, - ); - }; -}; - -export const includedDimensionValues = ( - dashData: AtLeast, -) => { - return (dimensionName: string): unknown[] => { - const expr = getWhereFilterExpression(dashData)(dimensionName); - if (expr === undefined || expr.cond?.op !== V1Operation.OPERATION_IN) { - return []; - } - - return getValuesInExpression(expr); - }; -}; - -export const hasAtLeastOneDimensionFilter = ( - dashData: AtLeast, -) => { - const whereFilter = dashData.dashboard.whereFilter; - return whereFilter.cond?.exprs?.length && whereFilter.cond.exprs.length > 0; -}; - -export const dimensionFilterSelectors = { - /** - * Returns a function that can be used to get whether the specified - * dimension is in exclude mode. - */ - isFilterExcludeMode, - - /** - * Check if a dimension has any filter - */ - dimensionHasFilter, - - /** - * Get filter items based on currently selected values for a dimension - */ - getDimensionFilterItems, - - /** - * Get filter items on dimension along with an empty entry for temporary filter if it is a dimension - */ - getAllDimensionFilterItems, - - unselectedDimensionValues, - includedDimensionValues, - hasAtLeastOneDimensionFilter, -}; +export const dimensionFilterSelectors = {}; diff --git a/web-common/src/features/dashboards/state-managers/selectors/measure-filters.ts b/web-common/src/features/dashboards/state-managers/selectors/measure-filters.ts index b56f65e63c7a..ab4ae392c3bd 100644 --- a/web-common/src/features/dashboards/state-managers/selectors/measure-filters.ts +++ b/web-common/src/features/dashboards/state-managers/selectors/measure-filters.ts @@ -1,127 +1 @@ -import { getMeasureDisplayName } from "@rilldata/web-common/features/dashboards/filters/getDisplayName"; -import type { MeasureFilterEntry } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry"; -import type { DashboardDataSources } from "@rilldata/web-common/features/dashboards/state-managers/selectors/types"; -import type { AtLeast } from "@rilldata/web-common/features/dashboards/state-managers/types"; -import type { DimensionThresholdFilter } from "@rilldata/web-common/features/dashboards/stores/explore-state"; -import { - type MetricsViewSpecDimension, - type MetricsViewSpecMeasure, -} from "@rilldata/web-common/runtime-client"; - -export const measureHasFilter = ( - dashData: AtLeast, -) => { - return (measureName: string) => - dashData.dashboard.dimensionThresholdFilters.some((dtf) => - dtf.filters.some((f) => f.measure === measureName), - ); -}; - -export type MeasureFilterItem = { - dimensionName: string; - name: string; - label: string; - measures?: Map; - dimensions?: MetricsViewSpecDimension[]; - filter?: MeasureFilterEntry; - pinned?: boolean; - required?: boolean; - missingRequired?: boolean; - metricsViewNames?: string[]; -}; - -export const getMeasureFilterItems = ( - dashData: AtLeast, -) => { - return (measureIdMap: Map) => { - return getMeasureFilters( - measureIdMap, - dashData.dashboard.dimensionThresholdFilters, - ); - }; -}; - -export function getMeasureFilters( - measureIdMap: Map, - dimensionThresholdFilters: DimensionThresholdFilter[], -) { - const filteredMeasures = new Array(); - const addedMeasure = new Set(); - - for (const dtf of dimensionThresholdFilters) { - filteredMeasures.push( - ...getMeasureFilterForDimension( - measureIdMap, - dtf.filters, - dtf.name, - addedMeasure, - ), - ); - } - - return filteredMeasures; -} - -export function getMeasureFilterForDimension( - measureIdMap: Map, - filters: MeasureFilterEntry[], - name = "", - addedMeasure = new Set(), -) { - if (!filters.length) return []; - - const filteredMeasures = new Array(); - - filters.forEach((filter) => { - if (addedMeasure.has(filter.measure)) { - return; - } - - const measure = measureIdMap.get(filter.measure); - if (!measure) { - return; - } - addedMeasure.add(filter.measure); - filteredMeasures.push({ - dimensionName: name, - name: filter.measure, - label: measure.displayName || measure.expression || filter.measure, - filter, - }); - }); - - return filteredMeasures; -} - -export const getAllMeasureFilterItems = ( - dashData: AtLeast, -) => { - return ( - measureFilterItems: Array, - measureIdMap: Map, - ) => { - const allMeasureFilterItems = [...measureFilterItems]; - - // if the temporary filter is a dimension filter add it - if ( - dashData.dashboard.temporaryFilterName && - measureIdMap.has(dashData.dashboard.temporaryFilterName) - ) { - allMeasureFilterItems.push({ - dimensionName: "", - name: dashData.dashboard.temporaryFilterName, - label: getMeasureDisplayName( - measureIdMap.get(dashData.dashboard.temporaryFilterName), - ), - }); - } - - return allMeasureFilterItems; - }; -}; - -export const measureFilterSelectors = { - measureHasFilter, - getMeasureFilterItems, - getAllMeasureFilterItems, -}; +export const measureFilterSelectors = {}; diff --git a/web-common/src/features/dashboards/state-managers/selectors/measures.ts b/web-common/src/features/dashboards/state-managers/selectors/measures.ts index 031ed78b1039..5be9c1cc60a8 100644 --- a/web-common/src/features/dashboards/state-managers/selectors/measures.ts +++ b/web-common/src/features/dashboards/state-managers/selectors/measures.ts @@ -75,24 +75,30 @@ export const filteredSimpleMeasures = ({ validMetricsView, validExplore, }: DashboardDataSources) => { - return () => { - if (!validMetricsView?.measures || !validExplore?.measures) return []; - - return ( - validMetricsView.measures - .filter( - (m) => validExplore.measures!.includes(m.name!) && isSimpleMeasure(m), - ) - // Sort the filtered measures based on their order in validExplore.measures - .sort( - (a, b) => - validExplore.measures!.indexOf(a.name!) - - validExplore.measures!.indexOf(b.name!), - ) + return () => + getFilteredSimpleMeasures( + validMetricsView?.measures ?? [], + validExplore?.measures, ); - }; }; +export function getFilteredSimpleMeasures( + allMeasures: MetricsViewSpecMeasure[], + exploreMeasures: string[] | undefined, +) { + if (!exploreMeasures) return []; + + return ( + allMeasures + .filter((m) => exploreMeasures.includes(m.name!) && isSimpleMeasure(m)) + // Sort the filtered measures based on their order in validExplore.measures + .sort( + (a, b) => + exploreMeasures.indexOf(a.name!) - exploreMeasures.indexOf(b.name!), + ) + ); +} + export const isSimpleMeasure = (measure: MetricsViewSpecMeasure) => !measure.window && measure.type !== MetricsViewSpecMeasureType.MEASURE_TYPE_TIME_COMPARISON; diff --git a/web-common/src/features/dashboards/state-managers/state-managers.ts b/web-common/src/features/dashboards/state-managers/state-managers.ts index f9f9036cd15b..ffc20be23cd5 100644 --- a/web-common/src/features/dashboards/state-managers/state-managers.ts +++ b/web-common/src/features/dashboards/state-managers/state-managers.ts @@ -33,6 +33,8 @@ import { contextColWidthDefaults, type ContextColWidths, } from "../leaderboard-context-column"; +import { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; +import { ExploreDashboardConfigProvider } from "@rilldata/web-common/features/dashboards/providers/DashboardConfigProvider.svelte.ts"; export type StateManagers = { runtimeClient: RuntimeClient; @@ -65,6 +67,8 @@ export type StateManagers = { */ contextColumnWidths: Writable; defaultExploreState: Readable; + expressionFilterManager: ExpressionFilterManager; + cleanup: () => void; }; export const DEFAULT_STORE_KEY = Symbol("state-managers"); @@ -163,6 +167,23 @@ export function createStateManagers({ }, ); + const dashboardProvider = new ExploreDashboardConfigProvider( + runtimeClient, + exploreName, + ); + const expressionFilterManager = new ExpressionFilterManager( + dashboardProvider.metricsViewsProvider, + dashboardProvider.yamlConfigProvider, + ); + + const stateChangeUnsub = expressionFilterManager.on("state-changed", () => { + metricsExplorerStore.mergePartialExplorerEntity( + exploreName, + {}, + expressionFilterManager, + ); + }); + return { runtimeClient, metricsViewName: metricsViewNameStore, @@ -191,5 +212,11 @@ export function createStateManagers({ }), contextColumnWidths, defaultExploreState, + expressionFilterManager, + cleanup: () => { + dashboardProvider.cleanup?.(); + dashboardProvider.metricsViewsProvider.cleanup(); + stateChangeUnsub(); + }, }; } diff --git a/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.spec.ts b/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.spec.ts index 1a0086c7b0b8..d4a590a0321c 100644 --- a/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.spec.ts +++ b/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.spec.ts @@ -1,7 +1,3 @@ -import { - MeasureFilterOperation, - MeasureFilterType, -} from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-options"; import { AdvancedMeasureCorrector } from "@rilldata/web-common/features/dashboards/stores/AdvancedMeasureCorrector"; import { getFullInitExploreState } from "@rilldata/web-common/features/dashboards/stores/dashboard-store-defaults"; import { getInitExploreStateForTest } from "@rilldata/web-common/features/dashboards/stores/test-data/helpers"; @@ -20,7 +16,6 @@ import { AD_BIDS_IMPRESSIONS_MEASURE_NO_GRAIN, AD_BIDS_IMPRESSIONS_MEASURE_WINDOW, AD_BIDS_METRICS_INIT, - AD_BIDS_PUBLISHER_DIMENSION, AD_BIDS_TIMESTAMP_DIMENSION, } from "./test-data/data"; @@ -75,26 +70,11 @@ describe("AdvancedMeasureCorrector", () => { getInitExploreStateForTest(MetricsView, Explore), ); dashboard.leaderboardSortByMeasureName = AD_BIDS_IMPRESSIONS_MEASURE; - dashboard.dimensionThresholdFilters = [ - { - name: AD_BIDS_PUBLISHER_DIMENSION, - filters: [ - { - measure: AD_BIDS_IMPRESSIONS_MEASURE, - operation: MeasureFilterOperation.GreaterThan, - type: MeasureFilterType.Value, - value1: "10", - value2: "", - }, - ], - }, - ]; AdvancedMeasureCorrector.correct(dashboard, MetricsView); expect(dashboard.leaderboardSortByMeasureName).toEqual( AD_BIDS_IMPRESSIONS_MEASURE, ); - expect(dashboard.dimensionThresholdFilters[0]?.filters.length).toEqual(1); // metrics view spec updated to make AD_BIDS_IMPRESSIONS_MEASURE an advanced measure AdvancedMeasureCorrector.correct(dashboard, { @@ -136,6 +116,5 @@ describe("AdvancedMeasureCorrector", () => { expect(dashboard.leaderboardSortByMeasureName).toEqual( AD_BIDS_IMPRESSIONS_MEASURE_NO_GRAIN, ); - expect(dashboard.dimensionThresholdFilters.length).toEqual(0); }); }); diff --git a/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.ts b/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.ts index f027cc438e4c..09fff3e8766f 100644 --- a/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.ts +++ b/web-common/src/features/dashboards/stores/AdvancedMeasureCorrector.ts @@ -48,26 +48,12 @@ export class AdvancedMeasureCorrector { } private correct() { - this.correctFilters(); + // Filters are owned by ExpressionFilterManager, which corrects them itself. this.correctLeaderboards(); this.correctTimeDimensionDetails(); this.correctPivot(); } - private correctFilters() { - this.exploreState.dimensionThresholdFilters.forEach( - (dimensionThreshold) => { - dimensionThreshold.filters = dimensionThreshold.filters.filter( - (dtf) => !this.measureIsValidForComponent(dtf.measure, false, false), - ); - }, - ); - this.exploreState.dimensionThresholdFilters = - this.exploreState.dimensionThresholdFilters.filter( - (dt) => dt.filters.length, - ); - } - private correctLeaderboards() { const validLeaderboardMeasures = this.exploreState.visibleMeasures.filter( (m) => !this.measureIsValidForComponent(m, true, false), diff --git a/web-common/src/features/dashboards/stores/Filters.ts b/web-common/src/features/dashboards/stores/Filters.ts deleted file mode 100644 index 1c6c98ddc6e0..000000000000 --- a/web-common/src/features/dashboards/stores/Filters.ts +++ /dev/null @@ -1,520 +0,0 @@ -import { DimensionFilterMode } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/constants"; -import { - getDimensionDisplayName, - getMeasureDisplayName, -} from "@rilldata/web-common/features/dashboards/filters/getDisplayName.ts"; -import type { MeasureFilterEntry } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-entry.ts"; -import { toggleDimensionFilterValue } from "@rilldata/web-common/features/dashboards/state-managers/actions/dimension-filters.ts"; -import { - type DimensionFilterItem, - getDimensionFilters, -} from "@rilldata/web-common/features/dashboards/state-managers/selectors/dimension-filters.ts"; -import { filterItemsSortFunction } from "@rilldata/web-common/features/dashboards/state-managers/selectors/filters.ts"; -import type { MeasureFilterItem } from "@rilldata/web-common/features/dashboards/state-managers/selectors/measure-filters.ts"; -import type { - DimensionThresholdFilter, - ExploreState, -} from "@rilldata/web-common/features/dashboards/stores/explore-state.ts"; -import { - copyFilterExpression, - createAndExpression, - createInExpression, - createLikeExpression, - matchExpressionByName, - negateExpression, -} from "@rilldata/web-common/features/dashboards/stores/filter-utils.ts"; -import { dedupe } from "@rilldata/web-common/lib/arrayUtils.ts"; -import { - type MetricsViewSpecMeasure, - type V1Expression, - V1Operation, -} from "@rilldata/web-common/runtime-client"; -import { - derived, - get, - writable, - type Readable, - type Writable, -} from "svelte/store"; -import type { ExploreMetricsViewMetadata } from "@rilldata/web-common/features/dashboards/stores/ExploreMetricsViewMetadata.ts"; - -export type FiltersState = Pick< - ExploreState, - | "whereFilter" - | "dimensionsWithInlistFilter" - | "dimensionThresholdFilters" - | "dimensionFilterExcludeMode" ->; - -/** - * Filters class encapsulates all filter related selectors and actions into a single class. - * It has individual stores for each data point. - * - * This is a copy of canvas filter class without canvas related stuff. - * TODO: refactor canvas to use this - */ -export class Filters { - // ------------------- - // STORES (writable) - // ------------------- - public readonly whereFilter: Writable; - public readonly dimensionsWithInlistFilter: Writable; - public readonly dimensionThresholdFilters: Writable< - Array - >; - public readonly dimensionFilterExcludeMode: Writable>; - public readonly temporaryFilterName: Writable; - - // ------------------- - // "SELECTORS" (readable/derived) - // ------------------- - public readonly measureFilterItems: Readable; - public readonly allMeasureFilterItems: Readable; - public readonly measureHasFilter: Readable<(measureName: string) => boolean>; - - public readonly dimensionFilterItems: Readable; - public readonly allDimensionFilterItems: Readable; - public readonly isFilterExcludeMode: Readable<(dimName: string) => boolean>; - public readonly dimensionHasFilter: Readable<(dimName: string) => boolean>; - - public readonly hasFilters: Readable; - - constructor( - public readonly metricsViewMetadata: ExploreMetricsViewMetadata, - { - whereFilter, - dimensionsWithInlistFilter, - dimensionThresholdFilters, - dimensionFilterExcludeMode, - }: FiltersState, - ) { - // ----------------------------- - // Initialize writable stores - // Lot of these are edited in place. So create a copy to avoid updating the original. - // ----------------------------- - this.whereFilter = writable(copyFilterExpression(whereFilter)); - this.dimensionsWithInlistFilter = writable([...dimensionsWithInlistFilter]); - this.dimensionThresholdFilters = writable( - structuredClone(dimensionThresholdFilters), - ); - this.dimensionFilterExcludeMode = writable( - new Map(dimensionFilterExcludeMode), - ); - this.temporaryFilterName = writable(null); - - // ------------------------------- - // MEASURE SELECTORS - // ------------------------------- - this.measureFilterItems = derived( - [this.metricsViewMetadata.measureNameMap, this.dimensionThresholdFilters], - ([$measureNameMap, $dimensionThresholdFilters]) => { - return this.getMeasureFilters( - $measureNameMap, - $dimensionThresholdFilters, - ); - }, - ); - - this.allMeasureFilterItems = derived( - [ - this.metricsViewMetadata.measureNameMap, - this.measureFilterItems, - this.temporaryFilterName, - ], - ([$measureNameMap, $measureFilterItems, tempFilter]) => { - const itemsCopy = [...$measureFilterItems]; - if (tempFilter && $measureNameMap.has(tempFilter)) { - itemsCopy.push({ - dimensionName: "", - name: tempFilter, - label: getMeasureDisplayName($measureNameMap.get(tempFilter)), - // dimensions, // TODO: for canvas - }); - } - return itemsCopy; - }, - ); - - this.measureHasFilter = derived( - this.dimensionThresholdFilters, - ($dimensionThresholdFilters) => { - return (measureName: string) => { - return $dimensionThresholdFilters.some((dtf) => - dtf.filters.some((f) => f.measure === measureName), - ); - }; - }, - ); - - // ------------------------------- - // DIMENSION SELECTORS - // ------------------------------- - this.dimensionFilterItems = derived( - [ - this.metricsViewMetadata.dimensionNameMap, - this.whereFilter, - this.dimensionsWithInlistFilter, - ], - ([$dimensionNameMap, $whereFilter, $dimensionsWithInlistFilter]) => { - // TODO: fill in metricsViewNames for each dimension filter item when integrated into canvas - return getDimensionFilters( - $dimensionNameMap, - $whereFilter, - $dimensionsWithInlistFilter, - this.metricsViewMetadata.metricsViewName, - ); - }, - ); - - this.allDimensionFilterItems = derived( - [ - this.metricsViewMetadata.dimensionNameMap, - this.dimensionFilterItems, - this.temporaryFilterName, - ], - ([$dimensionNameMap, $dimensionFilterItems, tempFilter]) => { - const merged = $dimensionFilterItems.map((dfi) => ({ - ...dfi, - metricsViewNames: [this.metricsViewMetadata.metricsViewName], - })); - if (tempFilter) { - const dimension = $dimensionNameMap.get(tempFilter); - if (dimension) { - merged.push({ - mode: DimensionFilterMode.Select, - name: tempFilter, - label: getDimensionDisplayName(dimension), - selectedValues: [], - isInclude: true, - metricsViewNames: [this.metricsViewMetadata.metricsViewName], - dimensions: new Map([ - [this.metricsViewMetadata.metricsViewName, dimension], - ]), - }); - } - } - - return merged.sort(filterItemsSortFunction); - }, - ); - - this.isFilterExcludeMode = derived( - this.dimensionFilterExcludeMode, - ($excludeMode) => { - return (dimName: string) => { - return $excludeMode.get(dimName) ?? false; - }; - }, - ); - - this.dimensionHasFilter = derived(this.whereFilter, ($whereFilter) => { - return (dimName: string) => { - return ( - $whereFilter.cond?.exprs?.find((e) => - matchExpressionByName(e, dimName), - ) !== undefined - ); - }; - }); - - this.hasFilters = derived( - [this.dimensionFilterItems, this.measureFilterItems], - ([$dimensionFilterItems, $measureFilterItems]) => - $dimensionFilterItems.length > 0 || $measureFilterItems.length > 0, - ); - } - - // -------------------- - // ACTIONS / MUTATORS - // -------------------- - - public setMeasureFilter = ( - dimensionName: string, - filter: MeasureFilterEntry, - ) => { - const tempFilter = get(this.temporaryFilterName); - if (tempFilter !== null) { - this.temporaryFilterName.set(null); - } - - const dtfs = get(this.dimensionThresholdFilters); - let dimThresholdFilter = dtfs.find((dtf) => dtf.name === dimensionName); - if (!dimThresholdFilter) { - dimThresholdFilter = { name: dimensionName, filters: [] }; - dtfs.push(dimThresholdFilter); - } - const exprIdx = dimThresholdFilter.filters.findIndex( - (f) => f.measure === filter.measure, - ); - if (exprIdx === -1) { - dimThresholdFilter.filters.push(filter); - } else { - dimThresholdFilter.filters.splice(exprIdx, 1, filter); - } - this.dimensionThresholdFilters.set(dtfs); - }; - - public removeMeasureFilter = (dimensionName: string, measureName: string) => { - const tempFilter = get(this.temporaryFilterName); - if (tempFilter === measureName) { - this.temporaryFilterName.set(null); - return; - } - const dtfs = get(this.dimensionThresholdFilters); - const dimIdx = dtfs.findIndex((dtf) => dtf.name === dimensionName); - if (dimIdx === -1) return; - const filters = dtfs[dimIdx].filters; - const exprIdx = filters.findIndex((f) => f.measure === measureName); - if (exprIdx === -1) return; - filters.splice(exprIdx, 1); - if (!filters.length) { - dtfs.splice(dimIdx, 1); - } - this.dimensionThresholdFilters.set(dtfs); - }; - - toggleDimensionValueSelection = ( - dimensionName: string, - dimensionValue: string, - keepPillVisible?: boolean, - isExclusiveFilter?: boolean, - ) => { - this.toggleMultipleDimensionValueSelections( - dimensionName, - [dimensionValue], - keepPillVisible, - isExclusiveFilter, - ); - }; - - toggleMultipleDimensionValueSelections = ( - dimensionName: string, - dimensionValues: string[], - keepPillVisible?: boolean, - isExclusiveFilter?: boolean, - exclude?: boolean, - ) => { - const tempFilter = get(this.temporaryFilterName); - if (tempFilter !== null) { - this.temporaryFilterName.set(null); - } - - const excludeMode = get(this.dimensionFilterExcludeMode); - if (exclude !== undefined) { - excludeMode.set(dimensionName, exclude); - this.dimensionFilterExcludeMode.set(excludeMode); - } - const isExclude = exclude ?? !!excludeMode.get(dimensionName); - const wf = get(this.whereFilter); - - // Use the derived selector: - let exprIndex = this.getWhereFilterExpressionIndex(dimensionName) ?? -1; - let expr = wf.cond?.exprs?.[exprIndex]; - - const wasLikeFilter = - expr?.cond?.op === V1Operation.OPERATION_LIKE || - expr?.cond?.op === V1Operation.OPERATION_NLIKE; - if (!expr?.cond?.exprs || wasLikeFilter) { - expr = createInExpression(dimensionName, [], isExclude); - wf.cond?.exprs?.push(expr); - exprIndex = wf.cond!.exprs!.length - 1; - } - - const wasInListFilter = get(this.dimensionsWithInlistFilter).includes( - dimensionName, - ); - if (wasInListFilter) { - this.dimensionsWithInlistFilter.update((dimensionsWithInlistFilter) => - dimensionsWithInlistFilter.filter((d) => d !== dimensionName), - ); - } - - dimensionValues.forEach((dimensionValue) => { - toggleDimensionFilterValue(expr, dimensionValue, !!isExclusiveFilter); - }); - - if (expr?.cond?.exprs?.length === 1) { - wf.cond?.exprs?.splice(exprIndex, 1); - - if (keepPillVisible) { - this.setTemporaryFilterName(dimensionName); - } - } - - this.whereFilter.set(wf); - }; - - public applyDimensionInListMode = ( - dimensionName: string, - values: string[], - ) => { - const tempFilter = get(this.temporaryFilterName); - if (tempFilter !== null) { - this.temporaryFilterName.set(null); - } - const excludeMode = get(this.dimensionFilterExcludeMode); - const isExclude = !!excludeMode.get(dimensionName); - const wf = get(this.whereFilter); - - const expr = createInExpression(dimensionName, values, isExclude); - this.dimensionsWithInlistFilter.update((dimensionsWithInlistFilter) => { - return [...dimensionsWithInlistFilter, dimensionName]; - }); - - const exprIndex = this.getWhereFilterExpressionIndex(dimensionName); - if (exprIndex === undefined || exprIndex === -1) { - wf.cond!.exprs!.push(expr); - } else { - wf.cond!.exprs![exprIndex] = expr; - } - this.whereFilter.set(wf); - }; - - public applyDimensionContainsMode = ( - dimensionName: string, - searchText: string, - ) => { - const tempFilter = get(this.temporaryFilterName); - if (tempFilter !== null) { - this.temporaryFilterName.set(null); - } - const excludeMode = get(this.dimensionFilterExcludeMode); - const isExclude = !!excludeMode.get(dimensionName); - const wf = get(this.whereFilter); - - const expr = createLikeExpression( - dimensionName, - `%${searchText}%`, - isExclude, - ); - const exprIndex = this.getWhereFilterExpressionIndex(dimensionName); - if (exprIndex === undefined || exprIndex === -1) { - wf.cond!.exprs!.push(expr); - } else { - wf.cond!.exprs![exprIndex] = expr; - } - this.whereFilter.set(wf); - }; - - public toggleDimensionFilterMode = (dimensionName: string) => { - const excludeMode = get(this.dimensionFilterExcludeMode); - const newExclude = !excludeMode.get(dimensionName); - excludeMode.set(dimensionName, newExclude); - this.dimensionFilterExcludeMode.set(excludeMode); - - const wf = get(this.whereFilter); - if (!wf.cond?.exprs) return; - const exprIdx = wf.cond.exprs.findIndex( - (e) => e.cond?.exprs?.[0].ident === dimensionName, - ); - if (exprIdx === -1) return; - wf.cond.exprs[exprIdx] = negateExpression(wf.cond.exprs[exprIdx]); - this.whereFilter.set(wf); - }; - - public removeDimensionFilter = (dimensionName: string) => { - const tempFilter = get(this.temporaryFilterName); - if (tempFilter === dimensionName) { - this.temporaryFilterName.set(null); - return; - } - const wf = get(this.whereFilter); - const exprIdx = this.getWhereFilterExpressionIndex(dimensionName); - if (exprIdx === undefined || exprIdx === -1) return; - wf.cond?.exprs?.splice(exprIdx, 1); - this.whereFilter.set(wf); - }; - - public setTemporaryFilterName = (name: string) => { - this.temporaryFilterName.set(name); - }; - - public toState(): FiltersState { - return { - whereFilter: get(this.whereFilter), - dimensionThresholdFilters: get(this.dimensionThresholdFilters), - dimensionsWithInlistFilter: get(this.dimensionsWithInlistFilter), - dimensionFilterExcludeMode: get(this.dimensionFilterExcludeMode), - }; - } - - public getStore(): Readable { - return derived( - [ - this.whereFilter, - this.dimensionThresholdFilters, - this.dimensionsWithInlistFilter, - this.dimensionFilterExcludeMode, - ], - ([ - whereFilter, - dimensionThresholdFilters, - dimensionsWithInlistFilter, - dimensionFilterExcludeMode, - ]) => ({ - whereFilter, - dimensionThresholdFilters, - dimensionsWithInlistFilter, - dimensionFilterExcludeMode, - }), - ); - } - - public clearAllFilters = () => { - const wf = get(this.whereFilter); - const dtfs = get(this.dimensionThresholdFilters); - const hasFilters = wf.cond?.exprs?.length || dtfs.length; - if (!hasFilters) return; - this.whereFilter.set(createAndExpression([])); - this.dimensionThresholdFilters.set([]); - this.temporaryFilterName.set(null); - const excludeMode = get(this.dimensionFilterExcludeMode); - excludeMode.clear(); - this.dimensionFilterExcludeMode.set(excludeMode); - }; - - private getMeasureFilters( - measureNameMap: Map, - dimensionThresholdFilters: DimensionThresholdFilter[], - ): MeasureFilterItem[] { - return dedupe( - dimensionThresholdFilters - .map((dtf) => - this.getMeasureFilterForDimension( - measureNameMap, - dtf.filters, - dtf.name, - ), - ) - .flat(), - (i) => i.name, - ); - } - - private getMeasureFilterForDimension( - measureNameMap: Map, - filters: MeasureFilterEntry[], - name: string, - ): MeasureFilterItem[] { - return filters - .map((filter) => { - const measure = measureNameMap.get(filter.measure); - if (!measure) return undefined; - return { - dimensionName: name, - name: filter.measure, - label: measure.displayName || measure.expression || filter.measure, - filter, - // dimensions, // TODO: for canvas - }; - }) - .filter(Boolean) as MeasureFilterItem[]; - } - - private getWhereFilterExpressionIndex(name: string) { - const $whereFilter = get(this.whereFilter); - return $whereFilter.cond?.exprs?.findIndex((e) => - matchExpressionByName(e, name), - ); - } -} diff --git a/web-common/src/features/dashboards/stores/correct-explore-state.spec.ts b/web-common/src/features/dashboards/stores/correct-explore-state.spec.ts index 073dbaeaac94..f9a6f2c91491 100644 --- a/web-common/src/features/dashboards/stores/correct-explore-state.spec.ts +++ b/web-common/src/features/dashboards/stores/correct-explore-state.spec.ts @@ -1,7 +1,3 @@ -import { - MeasureFilterOperation, - MeasureFilterType, -} from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-options"; import { getFullInitExploreState } from "@rilldata/web-common/features/dashboards/stores/dashboard-store-defaults"; import { getInitExploreStateForTest } from "@rilldata/web-common/features/dashboards/stores/test-data/helpers"; import type { DashboardTimeControls } from "@rilldata/web-common/lib/time/types"; @@ -19,7 +15,6 @@ import { AD_BIDS_IMPRESSIONS_MEASURE_NO_GRAIN, AD_BIDS_IMPRESSIONS_MEASURE_WINDOW, AD_BIDS_METRICS_INIT, - AD_BIDS_PUBLISHER_DIMENSION, AD_BIDS_TIME_RANGE_SUMMARY, AD_BIDS_TIMESTAMP_DIMENSION, } from "./test-data/data"; @@ -80,26 +75,11 @@ describe("correctExploreState", () => { getInitExploreStateForTest(MetricsView, Explore), ); dashboard.leaderboardSortByMeasureName = AD_BIDS_IMPRESSIONS_MEASURE; - dashboard.dimensionThresholdFilters = [ - { - name: AD_BIDS_PUBLISHER_DIMENSION, - filters: [ - { - measure: AD_BIDS_IMPRESSIONS_MEASURE, - operation: MeasureFilterOperation.GreaterThan, - type: MeasureFilterType.Value, - value1: "10", - value2: "", - }, - ], - }, - ]; correctExploreState(MetricsView, dashboard); expect(dashboard.leaderboardSortByMeasureName).toEqual( AD_BIDS_IMPRESSIONS_MEASURE, ); - expect(dashboard.dimensionThresholdFilters[0]?.filters.length).toEqual(1); // metrics view spec updated to make AD_BIDS_IMPRESSIONS_MEASURE an advanced measure const updatedMetricsView = { @@ -143,6 +123,5 @@ describe("correctExploreState", () => { expect(dashboard.leaderboardSortByMeasureName).toEqual( AD_BIDS_IMPRESSIONS_MEASURE_NO_GRAIN, ); - expect(dashboard.dimensionThresholdFilters.length).toEqual(0); }); }); diff --git a/web-common/src/features/dashboards/stores/dashboard-stores.ts b/web-common/src/features/dashboards/stores/dashboard-stores.ts index 6beecd0c54b3..55b856dd89ab 100644 --- a/web-common/src/features/dashboards/stores/dashboard-stores.ts +++ b/web-common/src/features/dashboards/stores/dashboard-stores.ts @@ -5,7 +5,6 @@ import { correctExploreState } from "@rilldata/web-common/features/dashboards/st import { type ExploreState } from "@rilldata/web-common/features/dashboards/stores/explore-state"; import { createAndExpression, - filterExpressions, forEachIdentifier, } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import { TDDChart } from "@rilldata/web-common/features/dashboards/time-dimension-details/types"; @@ -33,6 +32,7 @@ import { type PivotMeasureFormatting, type PivotTableMode, } from "../pivot/types"; +import type { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; export interface MetricsExplorerStoreType { entities: Record; @@ -124,12 +124,6 @@ function syncDimensions(explore: V1ExploreSpec, exploreState: ExploreState) { const dimensionsSet = new Set(explore.dimensions ?? []); const measuresSet = new Set(explore.measures ?? []); - exploreState.whereFilter = - filterExpressions(exploreState.whereFilter, (e) => { - if (!e.cond?.exprs?.length) return true; - return dimensionsSet.has(e.cond.exprs[0].ident!); - }) ?? createAndExpression([]); - if ( exploreState.selectedDimensionName && !dimensionsSet.has(exploreState.selectedDimensionName) @@ -164,10 +158,6 @@ function syncDimensions(explore: V1ExploreSpec, exploreState: ExploreState) { const metricsViewReducers = { init(name: string, initState: ExploreState) { update((state) => { - // TODO: revisit this during the url state / restore user refactor - initState.dimensionFilterExcludeMode = includeExcludeModeFromFilters( - initState.whereFilter, - ); state.entities[name] = structuredClone(initState); state.entities[name].name = name; @@ -196,9 +186,6 @@ const metricsViewReducers = { if (!partial.showTimeComparison) { exploreState.showTimeComparison = false; } - exploreState.dimensionFilterExcludeMode = includeExcludeModeFromFilters( - partial.whereFilter, - ); correctExploreState(metricsView, exploreState); }); }, @@ -206,6 +193,7 @@ const metricsViewReducers = { mergePartialExplorerEntity( name: string, partialExploreState: Partial, + expressionFilterManager: ExpressionFilterManager, ) { partialExploreState = structuredClone(partialExploreState); @@ -213,14 +201,22 @@ const metricsViewReducers = { for (const key in partialExploreState) { exploreState[key] = partialExploreState[key]; } + + const mvName = + expressionFilterManager.metricsViewsProvider.metricsViewNames[0]; + if (mvName) { + exploreState.whereFilter = + expressionFilterManager.managerByMetricsView[mvName].expr ?? + createAndExpression([]); + exploreState.dimensionsWithInlistFilter = + expressionFilterManager.inList; + } + // this hack is needed since what is shown for comparison is not a single source // TODO: use an enum and get rid of this if (!partialExploreState.showTimeComparison) { exploreState.showTimeComparison = false; } - exploreState.dimensionFilterExcludeMode = includeExcludeModeFromFilters( - partialExploreState.whereFilter, - ); // Partial comes from getMergedExploreState and is already corrected }); }, diff --git a/web-common/src/features/dashboards/stores/filter-utils.ts b/web-common/src/features/dashboards/stores/filter-utils.ts index f86914ae0087..6e2e7cdfd585 100644 --- a/web-common/src/features/dashboards/stores/filter-utils.ts +++ b/web-common/src/features/dashboards/stores/filter-utils.ts @@ -1,11 +1,7 @@ -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; -import type { DimensionThresholdFilter } from "@rilldata/web-common/features/dashboards/stores/explore-state"; import { - V1Operation, - type MetricsViewSpecDimension, - type MetricsViewSpecMeasure, type V1Condition, type V1Expression, + V1Operation, type V1Subquery, } from "@rilldata/web-common/runtime-client"; @@ -315,9 +311,13 @@ export const matchExpressionByName = (e: V1Expression, name: string) => { return e.cond?.exprs?.[0].ident === name; }; +export function isSubqueryExpression(e: V1Expression): boolean { + return !!e.cond?.exprs?.[1]?.subquery; +} + export const sanitiseExpression = ( where: V1Expression | undefined, - having: V1Expression | undefined, + having: V1Expression | undefined = undefined, ) => { if (!having) { if (!where?.cond?.exprs?.length) return undefined; @@ -403,6 +403,14 @@ export function removeWrapperAndOrExpression( return expression.cond?.exprs?.[0]; } +export function maybeWrapAndExpression(expr: V1Expression | undefined) { + const needsWrapper = + !!expr && + expr.cond?.op !== V1Operation.OPERATION_AND && + expr.cond?.op !== V1Operation.OPERATION_OR; + return needsWrapper ? createAndExpression([expr]) : expr; +} + const SupportedOperations = new Set([ V1Operation.OPERATION_IN, V1Operation.OPERATION_NIN, @@ -410,7 +418,8 @@ const SupportedOperations = new Set([ V1Operation.OPERATION_NLIKE, ]); -export function isExpressionUnsupported(expression: V1Expression) { +export function isExpressionUnsupported(expression: V1Expression | undefined) { + if (!expression) return false; if ( !expression.cond || !expression.cond.exprs || @@ -445,37 +454,6 @@ export function isSubqueryExpressionUnsupported(subquery: V1Subquery) { ); } -export function buildValidMetricsViewFilter( - filter: V1Expression, - dtf: DimensionThresholdFilter[], - dimensions: MetricsViewSpecDimension[], - measures: MetricsViewSpecMeasure[], -) { - const whereFilter = - filterIdentifiers(filter, (e, ident) => { - const dim = dimensions?.find((d) => d.name === ident); - // ignore if dimension is not present anymore - if (!dim) return false; - return true; - }) ?? createAndExpression([]); - - const dimensionThresholdFilter = dtf.filter((f) => { - const dim = dimensions?.find((d) => d.name === f.name); - if (!dim) return false; - - const hasValidMeasures = f.filters.every((filter) => { - const measure = measures?.find((m) => m.name === filter.measure); - return !!measure; - }); - return hasValidMeasures; - }); - - return sanitiseExpression( - mergeDimensionAndMeasureFilters(whereFilter, dimensionThresholdFilter), - undefined, - ); -} - export function wrapNonJoinerExpression(expr: V1Expression): V1Expression { if (isAndOrExpression(expr)) return expr; return createAndExpression([expr]); @@ -530,3 +508,58 @@ export function flattenInExpressionValues(expr: V1Expression) { expr.cond!.op === V1Operation.OPERATION_NIN, ); } + +// This should be deprecated eventually in favor of better support for variously formatted expressions +export function flattenExpression( + expression: V1Expression | undefined, +): V1Expression { + if (!expression) { + return createAndExpression([]); + } + + let root: V1Expression; + + // Ensure top level is an OPERATION_AND + if (!expression.cond || expression.cond.op !== V1Operation.OPERATION_AND) { + root = createAndExpression([expression]); + } else { + root = expression; + } + + const rootCond = root.cond; + if ( + !rootCond || + rootCond.op !== V1Operation.OPERATION_AND || + !Array.isArray(rootCond.exprs) + ) { + return root; + } + + // Recursively flatten all nested ANDs, preserving order + rootCond.exprs = flattenAndExprs(rootCond.exprs); + + // Normalize array-valued IN/NIN expressions into individual value expressions + rootCond.exprs = rootCond.exprs.map(flattenInExpressionValues); + + return root; +} + +function flattenAndExprs(exprs: V1Expression[]): V1Expression[] { + const result: V1Expression[] = []; + + for (const expr of exprs) { + const cond = expr.cond; + if ( + cond && + cond.op === V1Operation.OPERATION_AND && + Array.isArray(cond.exprs) + ) { + // Inline children in order + result.push(...flattenAndExprs(cond.exprs)); + } else { + result.push(expr); + } + } + + return result; +} diff --git a/web-common/src/features/dashboards/stores/test-data/helpers.ts b/web-common/src/features/dashboards/stores/test-data/helpers.ts index f861a30ee9a1..4b9a9c5b9712 100644 --- a/web-common/src/features/dashboards/stores/test-data/helpers.ts +++ b/web-common/src/features/dashboards/stores/test-data/helpers.ts @@ -1,6 +1,5 @@ -import { QueryClient } from "@tanstack/svelte-query"; import { createStateManagers } from "@rilldata/web-common/features/dashboards/state-managers/state-managers"; -import { RuntimeClient } from "@rilldata/web-common/runtime-client/v2"; +import { renderInRuntimeContext } from "@rilldata/web-common/features/metrics-views/providers/test/metrics-views-test-utils.svelte.ts"; import { metricsExplorerStore } from "@rilldata/web-common/features/dashboards/stores/dashboard-stores"; import { createAndExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import type { ExploreState } from "@rilldata/web-common/features/dashboards/stores/explore-state"; @@ -103,36 +102,31 @@ export function assertMetricsViewRaw( expect(metricsView.leaderboardSortByMeasureName).toEqual(selectedMeasure); } -export function initStateManagers(metricsViewName?: string) { - metricsViewName ??= AD_BIDS_NAME; +/** + * createStateManagers builds providers that call `createQuery`, so it can only run during + * component initialisation. renderInRuntimeContext mounts a harness that supplies the + * QueryClient context and an effect owner. Callers own the returned `destroy`. + */ +export function initStateManagers(metricsViewName = AD_BIDS_NAME) { const exploreName = metricsViewName + "_explore"; metricsExplorerStore.remove(AD_BIDS_EXPLORE_NAME); initAdBidsInStore(); - const queryClient = new QueryClient({ - defaultOptions: { - queries: { - refetchOnMount: false, - refetchOnReconnect: false, - refetchOnWindowFocus: false, - retry: false, - networkMode: "always", - }, - }, - }); - const runtimeClient = new RuntimeClient({ - host: "http://localhost", - instanceId: "test", - }); - const stateManagers = createStateManagers({ + const { + value: stateManagers, queryClient, - metricsViewName, - exploreName, - runtimeClient, - }); + destroy, + } = renderInRuntimeContext(({ queryClient, runtimeClient }) => + createStateManagers({ + queryClient, + metricsViewName, + exploreName, + runtimeClient, + }), + ); - return { stateManagers, queryClient }; + return { stateManagers, queryClient, destroy }; } export function getPartialDashboard( diff --git a/web-common/src/features/dashboards/stores/test-data/store-mutations.ts b/web-common/src/features/dashboards/stores/test-data/store-mutations.ts index ca23c7d60b9f..80f127821ce4 100644 --- a/web-common/src/features/dashboards/stores/test-data/store-mutations.ts +++ b/web-common/src/features/dashboards/stores/test-data/store-mutations.ts @@ -1,24 +1,14 @@ +import type { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; import { MeasureFilterOperation, MeasureFilterType, } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-options"; import { PivotChipType } from "@rilldata/web-common/features/dashboards/pivot/types"; -import { - applyDimensionContainsMode, - applyDimensionInListMode, - removeDimensionFilter, - toggleDimensionValueSelection, -} from "@rilldata/web-common/features/dashboards/state-managers/actions/dimension-filters"; import { handleDimensionMeasureColumnHeaderClick } from "@rilldata/web-common/features/dashboards/state-managers/actions/dimension-table.ts"; import { setPrimaryDimension, toggleDimensionVisibility, } from "@rilldata/web-common/features/dashboards/state-managers/actions/dimensions"; -import { clearAllFilters } from "@rilldata/web-common/features/dashboards/state-managers/actions/filters"; -import { - removeMeasureFilter, - setMeasureFilter, -} from "@rilldata/web-common/features/dashboards/state-managers/actions/measure-filters"; import { toggleMeasureVisibility } from "@rilldata/web-common/features/dashboards/state-managers/actions/measures"; import { setSortDescending, @@ -65,80 +55,123 @@ import { toggleLeaderboardShowContextForAllMeasures, } from "../../state-managers/actions/leaderboard"; -export type TestDashboardMutation = (mut: DashboardMutables) => void; -export const AD_BIDS_APPLY_PUB_DIMENSION_FILTER: TestDashboardMutation = ( - mut, -) => toggleDimensionValueSelection(mut, AD_BIDS_PUBLISHER_DIMENSION, "Google"); -export const AD_BIDS_REMOVE_PUB_DIMENSION_FILTER: TestDashboardMutation = ( - mut, -) => removeDimensionFilter(mut, AD_BIDS_PUBLISHER_DIMENSION); -export const AD_BIDS_APPLY_DOM_DIMENSION_FILTER: TestDashboardMutation = ( - mut, -) => toggleDimensionValueSelection(mut, AD_BIDS_DOMAIN_DIMENSION, "google.com"); +/** + * Mutables handed to a test mutation. + * + * `filterManager` is only set when the test passes one to {@link applyMutationsToDashboard}, + * so only reach for it from a filter mutation. + */ +export type TestDashboardMutables = DashboardMutables & { + filterManager: ExpressionFilterManager; +}; +export type TestDashboardMutation = (mut: TestDashboardMutables) => void; +export const AD_BIDS_APPLY_PUB_DIMENSION_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.dimensionFilterAction(AD_BIDS_PUBLISHER_DIMENSION, (manager) => + manager.toggleValue("Google", false), + ); +}; +export const AD_BIDS_REMOVE_PUB_DIMENSION_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.dimensionFilterAction(AD_BIDS_PUBLISHER_DIMENSION, (manager) => + manager.clear(), + ); +}; +export const AD_BIDS_APPLY_DOM_DIMENSION_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.dimensionFilterAction(AD_BIDS_DOMAIN_DIMENSION, (manager) => + manager.toggleValue("google.com", false), + ); +}; export const AD_BIDS_LARGE_FILTER = createAndExpression([ createInExpression(AD_BIDS_PUBLISHER_DIMENSION, RandomPublishers), createInExpression(AD_BIDS_DOMAIN_DIMENSION, RandomDomains), ]); -export const AD_BIDS_APPLY_LARGE_FILTERS: TestDashboardMutation = (mut) => { - mut.dashboard.whereFilter = AD_BIDS_LARGE_FILTER; +export const AD_BIDS_APPLY_LARGE_FILTERS: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.setExprForMetricsView( + filterManager.metricsViewsProvider.metricsViewNames[0], + AD_BIDS_LARGE_FILTER, + ); }; -export const AD_BIDS_APPLY_PUBLISHER_INLIST_FILTER: TestDashboardMutation = ( - mut, -) => { - applyDimensionInListMode(mut, AD_BIDS_PUBLISHER_DIMENSION, [ - "Facebook", - "Google", - ]); +export const AD_BIDS_APPLY_PUBLISHER_INLIST_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.dimensionFilterAction(AD_BIDS_PUBLISHER_DIMENSION, (manager) => + manager.setInList(["Facebook", "Google"], false), + ); }; -export const AD_BIDS_APPLY_DOMAIN_CONTAINS_FILTER: TestDashboardMutation = ( - mut, -) => { - applyDimensionContainsMode(mut, AD_BIDS_DOMAIN_DIMENSION, "%oo%"); +export const AD_BIDS_APPLY_DOMAIN_CONTAINS_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + // setContainsText wraps the text in `%`, so the extra pair here keeps the `%%oo%%` of the + // equivalent dashboard action. + filterManager.dimensionFilterAction(AD_BIDS_DOMAIN_DIMENSION, (manager) => + manager.setContainsText("%oo%", false), + ); }; -export const AD_BIDS_APPLY_IMP_MEASURE_FILTER: TestDashboardMutation = (mut) => - setMeasureFilter(mut, AD_BIDS_PUBLISHER_DIMENSION, { - measure: AD_BIDS_IMPRESSIONS_MEASURE, - type: MeasureFilterType.Value, - operation: MeasureFilterOperation.GreaterThan, - value1: "10", - value2: "", - }); -export const AD_BIDS_APPLY_IMP_COUNTRY_BETWEEN_MEASURE_FILTER: TestDashboardMutation = - (mut) => - setMeasureFilter(mut, AD_BIDS_COUNTRY_DIMENSION, { - measure: AD_BIDS_BID_PRICE_MEASURE, +export const AD_BIDS_APPLY_IMP_MEASURE_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.measureFilterAction(AD_BIDS_IMPRESSIONS_MEASURE, (manager) => + manager.setMeasureFilter(AD_BIDS_PUBLISHER_DIMENSION, { + measure: AD_BIDS_IMPRESSIONS_MEASURE, type: MeasureFilterType.Value, - operation: MeasureFilterOperation.Between, + operation: MeasureFilterOperation.GreaterThan, value1: "10", - value2: "20", - }); + value2: "", + }), + ); +}; +export const AD_BIDS_APPLY_IMP_COUNTRY_BETWEEN_MEASURE_FILTER: TestDashboardMutation = + ({ filterManager }) => { + filterManager.measureFilterAction(AD_BIDS_BID_PRICE_MEASURE, (manager) => + manager.setMeasureFilter(AD_BIDS_COUNTRY_DIMENSION, { + measure: AD_BIDS_BID_PRICE_MEASURE, + type: MeasureFilterType.Value, + operation: MeasureFilterOperation.Between, + value1: "10", + value2: "20", + }), + ); + }; export const AD_BIDS_APPLY_IMP_COUNTRY_NOT_BETWEEN_MEASURE_FILTER: TestDashboardMutation = - (mut) => - setMeasureFilter(mut, AD_BIDS_COUNTRY_DIMENSION, { + ({ filterManager }) => { + filterManager.measureFilterAction(AD_BIDS_BID_PRICE_MEASURE, (manager) => + manager.setMeasureFilter(AD_BIDS_COUNTRY_DIMENSION, { + measure: AD_BIDS_BID_PRICE_MEASURE, + type: MeasureFilterType.Value, + operation: MeasureFilterOperation.NotBetween, + value1: "10", + value2: "20", + }), + ); + }; +export const AD_BIDS_REMOVE_IMP_MEASURE_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.measureFilterAction(AD_BIDS_IMPRESSIONS_MEASURE, (manager) => + manager.clear(), + ); +}; +export const AD_BIDS_APPLY_BP_MEASURE_FILTER: TestDashboardMutation = ({ + filterManager, +}) => { + filterManager.measureFilterAction(AD_BIDS_BID_PRICE_MEASURE, (manager) => + manager.setMeasureFilter(AD_BIDS_DOMAIN_DIMENSION, { measure: AD_BIDS_BID_PRICE_MEASURE, type: MeasureFilterType.Value, - operation: MeasureFilterOperation.NotBetween, + operation: MeasureFilterOperation.GreaterThan, value1: "10", - value2: "20", - }); -export const AD_BIDS_REMOVE_IMP_MEASURE_FILTER: TestDashboardMutation = (mut) => - removeMeasureFilter( - mut, - AD_BIDS_PUBLISHER_DIMENSION, - AD_BIDS_IMPRESSIONS_MEASURE, + value2: "", + }), ); -export const AD_BIDS_APPLY_BP_MEASURE_FILTER: TestDashboardMutation = (mut) => - setMeasureFilter(mut, AD_BIDS_DOMAIN_DIMENSION, { - measure: AD_BIDS_BID_PRICE_MEASURE, - type: MeasureFilterType.Value, - operation: MeasureFilterOperation.GreaterThan, - value1: "10", - value2: "", - }); - -export const AD_BIDS_CLEAR_FILTERS: TestDashboardMutation = (mut) => - clearAllFilters(mut); +}; export const AD_BIDS_SET_P7D_TIME_RANGE_FILTER: TestDashboardMutation = () => metricsExplorerStore.selectTimeRange( @@ -526,14 +559,29 @@ export const AD_BIDS_SET_TIME_DIMENSION_PRIMARY: TestDashboardMutation = ( export async function applyMutationsToDashboard( name: string, mutations: TestDashboardMutation[], + filterManager?: ExpressionFilterManager, ) { for (const mutation of mutations) { updateMetricsExplorerByName(name, (dashboard) => { const dashboardMutables = { dashboard, - } as DashboardMutables; + filterManager, + } as TestDashboardMutables; mutation(dashboardMutables); }); + if (filterManager) { + // Explore state does not own the filters anymore, so mirror them back into it the way + // DashboardStateSync does for the app. + updateMetricsExplorerByName(name, (dashboard) => { + const mvName = filterManager.metricsViewsProvider.metricsViewNames[0]; + dashboard.whereFilter = + filterManager.managerByMetricsView[mvName]?.expr ?? + createAndExpression([]); + dashboard.dimensionThresholdFilters = []; + dashboard.dimensionsWithInlistFilter = filterManager.inList; + dashboard.dimensionFilterExcludeMode = new Map(); + }); + } // DashboardStateSync.gotoNewState that listens to changes to the dashboard store is an async function. // So go through the mutations individually and wait for 1ms for that to finish. // Without this the lock in gotoNewState will stop the very quick successive changes to dashboard. diff --git a/web-common/src/features/dashboards/time-controls/time-control-store.spec.ts b/web-common/src/features/dashboards/time-controls/time-control-store.spec.ts index 1b9b60b2934d..040d1de481e3 100644 --- a/web-common/src/features/dashboards/time-controls/time-control-store.spec.ts +++ b/web-common/src/features/dashboards/time-controls/time-control-store.spec.ts @@ -408,14 +408,21 @@ describe("time-control-store", () => { metricsView, AD_BIDS_EXPLORE_INIT, ); - const { stateManagers, queryClient } = initStateManagers(); + const { stateManagers, queryClient, destroy } = initStateManagers(); const timeControlsStore = createTimeControlStore(stateManagers); const { unmount } = render(TimeControlsStoreTest, { timeControlsStore, }); - return { unmount, queryClient, timeControlsStore }; + return { + unmount: () => { + unmount(); + destroy(); + }, + queryClient, + timeControlsStore, + }; } }); diff --git a/web-common/src/features/dashboards/time-controls/time-control-store.ts b/web-common/src/features/dashboards/time-controls/time-control-store.ts index e9e39ca53629..131f8b0edfdf 100644 --- a/web-common/src/features/dashboards/time-controls/time-control-store.ts +++ b/web-common/src/features/dashboards/time-controls/time-control-store.ts @@ -82,6 +82,7 @@ export type ComparisonTimeRangeState = { export interface TimeAndFilterStore { timeRange: V1TimeRange; comparisonTimeRange: V1TimeRange | undefined; + dimensionOnlyWhere?: V1Expression | undefined; where: V1Expression | undefined; timeGrain: V1TimeGrain | undefined; showTimeComparison: boolean; diff --git a/web-common/src/features/dashboards/time-dimension-details/TDDHeader.svelte b/web-common/src/features/dashboards/time-dimension-details/TDDHeader.svelte index ba844e368db1..40beb8d90a3e 100644 --- a/web-common/src/features/dashboards/time-dimension-details/TDDHeader.svelte +++ b/web-common/src/features/dashboards/time-dimension-details/TDDHeader.svelte @@ -30,15 +30,29 @@ import type { TDDComparison } from "./types"; import { V1TimeGrainToDateTimeUnit } from "@rilldata/web-common/lib/time/new-grains"; - export let exploreName: string; - export let dimensionName: string; - export let isFetching = false; - export let comparing: TDDComparison | undefined; - export let areAllTableRowsSelected = false; - export let isRowsEmpty = false; - export let expandedMeasureName: string; - export let onToggleSearchItems: () => void; - export let hideStartPivotButton = false; + interface Props { + exploreName: string; + dimensionName: string; + isFetching?: boolean; + comparing: TDDComparison | undefined; + areAllTableRowsSelected?: boolean; + isRowsEmpty?: boolean; + expandedMeasureName: string; + onToggleSearchItems: () => void; + hideStartPivotButton?: boolean; + } + + let { + exploreName, + dimensionName, + isFetching = false, + comparing, + areAllTableRowsSelected = false, + isRowsEmpty = false, + expandedMeasureName, + onToggleSearchItems, + hideStartPivotButton = false, + }: Props = $props(); const { adminServer, exports } = featureFlags; const stateManagers = getStateManagers(); @@ -48,30 +62,34 @@ measures: { measureLabel, allMeasures }, dimensions: { getDimensionDisplayName }, }, - actions: { - dimensionsFilter: { toggleDimensionFilterMode }, - }, dashboardStore, validSpecStore, + expressionFilterManager, } = stateManagers; - $: selectableMeasures = $allMeasures - .filter((m) => m.name !== undefined || m.displayName !== undefined) - .map((m) => - // Note: undefined values are filtered out above, so the - // empty string fallback is unreachable. - ({ - name: m.name || "", - label: m.displayName || "", - }), - ); + const selectableMeasures = $derived( + $allMeasures + .filter((m) => m.name !== undefined || m.displayName !== undefined) + .map((m) => + // Note: undefined values are filtered out above, so the + // empty string fallback is unreachable. + ({ + name: m.name || "", + label: m.displayName || "", + }), + ), + ); - $: selectedMeasureLabel = + const selectedMeasureLabel = $derived( $allMeasures.find((m) => m.name === expandedMeasureName)?.displayName || - expandedMeasureName; + expandedMeasureName, + ); - $: excludeMode = - $dashboardStore?.dimensionFilterExcludeMode.get(dimensionName) ?? false; + const excludeMode = $derived( + expressionFilterManager.filterManagers.dimensions.find( + (dfm) => dfm.name === dimensionName, + )?.exclude ?? false, + ); function closeSearchBar() { dimensionSearchText.set(""); @@ -85,14 +103,17 @@ } function toggleFilterMode() { - toggleDimensionFilterMode(dimensionName); + expressionFilterManager.dimensionFilterAction( + dimensionName, + (dimensionManager) => dimensionManager.toggleExclude(), + ); } function switchMeasure(measureName: string) { metricsExplorerStore.setExpandedMeasureName(exploreName, measureName); } - let showReplacePivotModal = false; + let showReplacePivotModal = $state(false); function startPivotForTDD() { const pivot = $dashboardStore?.pivot; @@ -139,17 +160,21 @@ const timeControlsStore = useTimeControlStore(stateManagers); - $: ({ minTimeGrain, timeStart, timeEnd, selectedTimeRange } = - $timeControlsStore); + const minTimeGrain = $derived($timeControlsStore.minTimeGrain); + const timeStart = $derived($timeControlsStore.timeStart); + const timeEnd = $derived($timeControlsStore.timeEnd); + const selectedTimeRange = $derived($timeControlsStore.selectedTimeRange); - $: activeTimeGrain = selectedTimeRange?.interval; + const activeTimeGrain = $derived(selectedTimeRange?.interval); - $: baseTimeRange = selectedTimeRange?.start && - selectedTimeRange?.end && { - name: selectedTimeRange?.name, - start: selectedTimeRange.start, - end: selectedTimeRange.end, - }; + const baseTimeRange = $derived( + selectedTimeRange?.start && + selectedTimeRange?.end && { + name: selectedTimeRange?.name, + start: selectedTimeRange.start, + end: selectedTimeRange.end, + }, + ); function onTimeGrainSelect(timeGrain: V1TimeGrain) { if (baseTimeRange) { diff --git a/web-common/src/features/dashboards/time-dimension-details/TimeDimensionDisplay.svelte b/web-common/src/features/dashboards/time-dimension-details/TimeDimensionDisplay.svelte index ae6095da00c6..b82dcf2d88b5 100644 --- a/web-common/src/features/dashboards/time-dimension-details/TimeDimensionDisplay.svelte +++ b/web-common/src/features/dashboards/time-dimension-details/TimeDimensionDisplay.svelte @@ -23,84 +23,105 @@ import type { TDDComparison, TableData } from "./types"; import { m } from "@rilldata/web-common/lib/i18n/gen/messages"; - export let exploreName: string; - export let expandedMeasureName: string; - export let hideStartPivotButton = false; + interface Props { + exploreName: string; + expandedMeasureName: string; + hideStartPivotButton?: boolean; + } + + let { + exploreName, + expandedMeasureName, + hideStartPivotButton = false, + }: Props = $props(); - $: isEmbedded = EmbedStore.isEmbedded(); + const isEmbedded = $derived(EmbedStore.isEmbedded()); const stateManagers = getStateManagers(); const { dashboardStore, selectors: { dimensions: { allDimensions }, - dimensionFilters: { unselectedDimensionValues }, measures: { allMeasures }, }, actions: { - dimensionsFilter: { - toggleDimensionValueSelection, - selectItemsInFilter, - deselectItemsInFilter, - }, sorting: { toggleSort }, }, + expressionFilterManager, } = getStateManagers(); const timeDimensionDataStore = useTimeDimensionDataStore(stateManagers); const timeControlStore = useTimeControlStore(stateManagers); - $: dimensionName = $dashboardStore?.selectedComparisonDimension ?? ""; - $: comparing = $timeDimensionDataStore?.comparing; + const dimensionName = $derived( + $dashboardStore?.selectedComparisonDimension ?? "", + ); + const comparing = $derived($timeDimensionDataStore?.comparing); - $: pinIndex = $dashboardStore?.tdd.pinIndex; + const pinIndex = $derived($dashboardStore?.tdd.pinIndex); - $: timeGrain = $timeControlStore.selectedTimeRange?.interval; + const timeGrain = $derived($timeControlStore.selectedTimeRange?.interval); - $: measure = $allMeasures.find((m) => m.name === expandedMeasureName); + const measure = $derived( + $allMeasures.find((m) => m.name === expandedMeasureName), + ); - $: measureLabel = measure?.displayName ?? ""; + const measureLabel = $derived(measure?.displayName ?? ""); - let dimensionLabel = ""; - $: if (comparing === "dimension") { - dimensionLabel = - $allDimensions.find((d) => d.name === dimensionName)?.displayName ?? ""; - } else if (comparing === "time") { - dimensionLabel = m.dashboard_tdd_time(); - } else if (comparing === "none") { - dimensionLabel = m.dashboard_tdd_no_comparison(); - } + const dimensionLabel = $derived.by(() => { + if (comparing === "dimension") { + return ( + $allDimensions.find((d) => d.name === dimensionName)?.displayName ?? "" + ); + } else if (comparing === "time") { + return m.dashboard_tdd_time(); + } else if (comparing === "none") { + return m.dashboard_tdd_no_comparison(); + } + return ""; + }); // Create a copy of the data to avoid flashing of table in transient states - let timeDimensionDataCopy: TableData; - let comparisonCopy: TDDComparison | undefined; - $: if ( - $timeDimensionDataStore?.data && - $timeDimensionDataStore?.data?.columnHeaderData - ) { - comparisonCopy = comparing; - timeDimensionDataCopy = $timeDimensionDataStore.data; - } - $: formattedData = timeDimensionDataCopy; - $: excludeMode = - $dashboardStore?.dimensionFilterExcludeMode.get(dimensionName) ?? false; + let timeDimensionDataCopy = $state(); + let comparisonCopy = $state(); + $effect(() => { + if ( + $timeDimensionDataStore?.data && + $timeDimensionDataStore?.data?.columnHeaderData + ) { + comparisonCopy = comparing; + timeDimensionDataCopy = $timeDimensionDataStore.data; + } + }); + const formattedData = $derived(timeDimensionDataCopy); + const excludeMode = $derived( + expressionFilterManager.filterManagers.dimensions.find( + (dfm) => dfm.name === dimensionName, + )?.exclude ?? false, + ); - $: rowHeaderLabels = - formattedData?.rowHeaderData?.slice(1)?.map((row) => row[0]?.value) ?? []; + const rowHeaderLabels = $derived( + formattedData?.rowHeaderData?.slice(1)?.map((row) => row[0]?.value) ?? [], + ); - $: areAllTableRowsSelected = rowHeaderLabels?.every( - (val) => val !== undefined && formattedData?.selectedValues?.includes(val), + const areAllTableRowsSelected = $derived( + rowHeaderLabels?.every( + (val) => + val !== undefined && formattedData?.selectedValues?.includes(val), + ), ); - $: columnHeaders = formattedData?.columnHeaderData?.flat(); + const columnHeaders = $derived(formattedData?.columnHeaderData?.flat()); - $: highlightedColStart = $hoverIndex?.start; - $: highlightedColEnd = $hoverIndex?.end; + const highlightedColStart = $derived($hoverIndex?.start); + const highlightedColEnd = $derived($hoverIndex?.end); // Create a time formatter for the column headers - $: timeFormatter = timeFormat( - timeGrain ? TIME_GRAIN[timeGrain].d3format : "%H:%M", - ) as (d: Date) => string; + const timeFormatter = $derived( + timeFormat(timeGrain ? TIME_GRAIN[timeGrain].d3format : "%H:%M") as ( + d: Date, + ) => string, + ); function highlightCell(x: number | undefined, y: number | undefined) { if (x === undefined || y === undefined) { @@ -127,8 +148,11 @@ const debounceHighlightCell = debounce(highlightCell, 50); - function toggleFilter(label: string | null) { - toggleDimensionValueSelection(dimensionName, label); + function toggleFilter(label: string) { + expressionFilterManager.dimensionFilterAction( + dimensionName, + (dimensionManager) => dimensionManager.toggleValue(label, false), + ); } function toggleAllSearchItems() { @@ -139,9 +163,10 @@ if (headerHasUndefined) return; if (areAllTableRowsSelected) { - deselectItemsInFilter( + expressionFilterManager.dimensionFilterAction( dimensionName, - rowHeaderLabels as (string | null)[], + (dimensionManager) => + dimensionManager.removeSelectedValues(rowHeaderLabels as string[]), ); eventBus.emit("notification", { @@ -151,11 +176,11 @@ }); return; } else { - const newValuesSelected = $unselectedDimensionValues( + const newValuesSelected = expressionFilterManager.dimensionFilterAction( dimensionName, - rowHeaderLabels, + (dimensionManager) => + dimensionManager.appendSelectedValues(rowHeaderLabels as string[]), ); - selectItemsInFilter(dimensionName, rowHeaderLabels as (string | null)[]); eventBus.emit("notification", { message: m.dashboard_added_items_filter({ count: newValuesSelected.length.toString(), @@ -166,23 +191,24 @@ function togglePin() { let newPinIndex = -1; + const selectedCount = formattedData?.selectedValues?.length ?? 0; // Pin if some selected items are not pinned yet - if (pinIndex > -1 && pinIndex < formattedData?.selectedValues?.length - 1) { - newPinIndex = formattedData?.selectedValues?.length - 1; + if (pinIndex > -1 && pinIndex < selectedCount - 1) { + newPinIndex = selectedCount - 1; } // Pin if no items are pinned yet else if (pinIndex === -1) { - newPinIndex = formattedData?.selectedValues?.length - 1; + newPinIndex = selectedCount - 1; } metricsExplorerStore.setPinIndex(exploreName, newPinIndex); } - function handleKeyDown(e) { + function handleKeyDown(e: KeyboardEvent) { if (comparisonCopy !== "dimension") return; // Select all items on Meta+A if ((e.ctrlKey || e.metaKey) && e.key === "a") { - if (e.target.tagName === "INPUT") return; + if ((e.target as HTMLElement)?.tagName === "INPUT") return; e.preventDefault(); if (areAllTableRowsSelected) return; toggleAllSearchItems(); diff --git a/web-common/src/features/dashboards/time-dimension-details/tdd-export.ts b/web-common/src/features/dashboards/time-dimension-details/tdd-export.ts index 0a3404497bae..bbc379d353f0 100644 --- a/web-common/src/features/dashboards/time-dimension-details/tdd-export.ts +++ b/web-common/src/features/dashboards/time-dimension-details/tdd-export.ts @@ -117,7 +117,6 @@ export function getTDDAggregationRequest({ ], where: buildWhereParamForDimensionTableAndTDDExports( exploreState.whereFilter, - exploreState.dimensionThresholdFilters, dimensionName, dimensionSearchText, ), diff --git a/web-common/src/features/dashboards/time-series/MetricsTimeSeriesCharts.svelte b/web-common/src/features/dashboards/time-series/MetricsTimeSeriesCharts.svelte index 1a4832521b3b..5ca8cd14528d 100644 --- a/web-common/src/features/dashboards/time-series/MetricsTimeSeriesCharts.svelte +++ b/web-common/src/features/dashboards/time-series/MetricsTimeSeriesCharts.svelte @@ -3,7 +3,6 @@ import CaretDownIcon from "@rilldata/web-common/components/icons/CaretDownIcon.svelte"; import { m } from "@rilldata/web-common/lib/i18n/gen/messages"; import DashboardMetricsDraggableList from "@rilldata/web-common/components/menu/DashboardMetricsDraggableList.svelte"; - import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import ReplacePivotDialog from "@rilldata/web-common/features/dashboards/pivot/ReplacePivotDialog.svelte"; import { splitPivotChips } from "@rilldata/web-common/features/dashboards/pivot/pivot-utils"; import { @@ -15,7 +14,6 @@ metricsExplorerStore, useExploreState, } from "@rilldata/web-common/features/dashboards/stores/dashboard-stores"; - import { sanitiseExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import { useTimeControlStore } from "@rilldata/web-common/features/dashboards/time-controls/time-control-store"; import ChartTypeSelector from "@rilldata/web-common/features/dashboards/time-dimension-details/charts/ChartTypeSelector.svelte"; import { TDDChart } from "@rilldata/web-common/features/dashboards/time-dimension-details/types"; @@ -31,7 +29,10 @@ type AvailableTimeGrain, type DashboardTimeControls, } from "@rilldata/web-common/lib/time/types"; - import { type MetricsViewSpecMeasure } from "@rilldata/web-common/runtime-client/gen/index.schemas"; + import { + type MetricsViewSpecMeasure, + type V1Expression, + } from "@rilldata/web-common/runtime-client/gen/index.schemas"; import { useRuntimeClient } from "@rilldata/web-common/runtime-client/v2"; import { DateTime, Interval } from "luxon"; import { Button } from "../../../components/button"; @@ -47,17 +48,28 @@ import { ScrubController } from "./measure-chart/ScrubController"; import ThreeDot from "@rilldata/web-common/components/icons/ThreeDot.svelte"; import ScreenshotContainer from "@rilldata/web-common/features/dashboards/time-series/ScreenshotContainer.svelte"; + import { DimensionFilterManager } from "@rilldata/web-common/features/dashboards/filters/dimension-filters/DimensionFilterManager.svelte.ts"; const { rillTime } = featureFlags; // Singleton scrub controller — shared across all charts const scrubController = new ScrubController(); - export let exploreName: string; - export let hideStartPivotButton = false; - // Height of the expanded chart in the Time Dimension Detail view, controlled - // by the resizable divider between the timeseries and the detail table. - export let tddChartHeight = 245; + let { + exploreName, + dimensionOnlyFilter, + whereFilter, + hideStartPivotButton = false, + tddChartHeight = 245, + }: { + exploreName: string; + dimensionOnlyFilter: V1Expression | undefined; + whereFilter: V1Expression | undefined; + hideStartPivotButton?: boolean; + // Height of the expanded chart in the Time Dimension Detail view, controlled + // by the resizable divider between the timeseries and the detail table. + tddChartHeight?: number; + } = $props(); const StateManagers = getStateManagers(); @@ -66,23 +78,23 @@ dashboardStore, selectors: { measures: { allMeasures, visibleMeasures, getMeasureByName }, - dimensionFilters: { includedDimensionValues }, charts: { canPanLeft, canPanRight, getNewPanRange }, tags: { measureTagIndex }, }, actions: { measures: { setMeasureVisibility }, }, + expressionFilterManager, } = StateManagers; const timeControlsStore = useTimeControlStore(StateManagers); - let grainDropdownOpen = false; - let connectNulls = true; + let grainDropdownOpen = $state(false); + let connectNulls = $state(true); const client = useRuntimeClient(); - $: ({ + let { selectedTimeRange, selectedComparisonTimeRange, timeDimension, @@ -93,13 +105,12 @@ comparisonTimeEnd, comparisonTimeStart, aggregationOptions, - } = $timeControlsStore); + } = $derived($timeControlsStore); - $: ({ whereFilter, dimensionThresholdFilters, selectedTimezone } = - $dashboardStore); + let { selectedTimezone } = $derived($dashboardStore); // Use the full selected time range for chart data fetching (not modified by scrub) - $: chartInterval = + let chartInterval = $derived( selectedTimeRange?.start && selectedTimeRange?.end ? (Interval.fromDateTimes( DateTime.fromJSDate(selectedTimeRange.start, { @@ -109,8 +120,9 @@ zone: selectedTimezone, }), ) as Interval) - : undefined; - $: chartComparisonInterval = + : undefined, + ); + let chartComparisonInterval = $derived( selectedComparisonTimeRange?.start && selectedComparisonTimeRange?.end ? (Interval.fromDateTimes( DateTime.fromJSDate(selectedComparisonTimeRange.start, { @@ -120,74 +132,88 @@ zone: selectedTimezone, }), ) as Interval) - : undefined; + : undefined, + ); - $: exploreState = useExploreState(exploreName); + let exploreState = $derived(useExploreState(exploreName)); - $: activePage = $exploreState?.activePage; - $: showTimeDimensionDetail = Boolean( - activePage === DashboardState_ActivePage.TIME_DIMENSIONAL_DETAIL, + let activePage = $derived($exploreState?.activePage); + let showTimeDimensionDetail = $derived( + Boolean(activePage === DashboardState_ActivePage.TIME_DIMENSIONAL_DETAIL), ); - $: expandedMeasureName = $exploreState?.tdd?.expandedMeasureName; + let expandedMeasureName = $derived($exploreState?.tdd?.expandedMeasureName); - $: comparisonDimension = $exploreState?.selectedComparisonDimension; - $: showComparison = Boolean(showTimeComparison); - $: tddChartType = $exploreState?.tdd?.chartType; - $: dynamicYAxisScale = $exploreState?.dynamicYAxisScale ?? false; + let comparisonDimension = $derived( + $exploreState?.selectedComparisonDimension, + ); + let showComparison = $derived(Boolean(showTimeComparison)); + let tddChartType = $derived($exploreState?.tdd?.chartType); + let dynamicYAxisScale = $derived($exploreState?.dynamicYAxisScale ?? false); - $: activeTimeGrain = selectedTimeRange?.interval; + let activeTimeGrain = $derived(selectedTimeRange?.interval); - $: measureSelection.setZone(selectedTimezone); - $: if (activeTimeGrain) measureSelection.setTimeGrain(activeTimeGrain); + $effect(() => measureSelection.setZone(selectedTimezone)); + $effect(() => { + if (activeTimeGrain) measureSelection.setTimeGrain(activeTimeGrain); + }); - $: chartScrubInterval = (() => { + let chartScrubInterval = $derived.by(() => { const range = $exploreState?.lastDefinedScrubRange; if (!range) return undefined; const a = DateTime.fromJSDate(range.start, { zone: selectedTimezone }); const b = DateTime.fromJSDate(range.end, { zone: selectedTimezone }); const [start, end] = a <= b ? [a, b] : [b, a]; return Interval.fromDateTimes(start, end) as Interval; - })(); - $: includedValuesForDimension = $includedDimensionValues( - comparisonDimension as string, + }); + let managerForCompareDimension = $derived( + comparisonDimension + ? expressionFilterManager.filterManagersMap[comparisonDimension] + : undefined, + ); + let includedValuesForDimension = $derived( + managerForCompareDimension && + managerForCompareDimension instanceof DimensionFilterManager + ? managerForCompareDimension.selectedValues + : [], + ); + let chartDimensionValues = $derived( + includedValuesForDimension.slice(0, showTimeDimensionDetail ? 11 : 7) as ( + | string + | null + )[], ); - $: chartDimensionValues = includedValuesForDimension.slice( - 0, - showTimeDimensionDetail ? 11 : 7, - ) as (string | null)[]; - - $: expandedMeasure = $getMeasureByName(expandedMeasureName); - let renderedMeasures: MetricsViewSpecMeasure[]; - $: { - renderedMeasures = - showTimeDimensionDetail && expandedMeasure - ? [expandedMeasure] - : $visibleMeasures; - } - $: visibleMeasureNames = $visibleMeasures - .map(({ name }) => name) - .filter(isDefined); - $: allMeasureNames = $allMeasures.map(({ name }) => name).filter(isDefined); + let expandedMeasure = $derived($getMeasureByName(expandedMeasureName)); + let renderedMeasures: MetricsViewSpecMeasure[] = $derived( + showTimeDimensionDetail && expandedMeasure + ? [expandedMeasure] + : $visibleMeasures, + ); + + let visibleMeasureNames = $derived( + $visibleMeasures.map(({ name }) => name).filter(isDefined), + ); + let allMeasureNames = $derived( + $allMeasures.map(({ name }) => name).filter(isDefined), + ); function isDefined(value: string | undefined): value is string { return value !== undefined; } - $: chartMetricsViewName = $metricsViewName; - $: chartWhere = sanitiseExpression( - mergeDimensionAndMeasureFilters(whereFilter, dimensionThresholdFilters), - undefined, - ); + let chartMetricsViewName = $derived($metricsViewName); - $: chartReady = !!ready; + let chartReady = $derived(!!ready); // Check if annotations are enabled for this explore - $: exploreValidSpec = useExploreValidSpec(client, exploreName); - $: annotationsEnabled = - !!$exploreValidSpec.data?.metricsView?.annotations?.length; + let exploreValidSpec = $derived(useExploreValidSpec(client, exploreName)); + let annotationsEnabled = $derived( + !!$exploreValidSpec.data?.metricsView?.annotations?.length, + ); - let screenshotDialogOpen = false; - let screenshotDialogMeasure: MetricsViewSpecMeasure | undefined = undefined; + let screenshotDialogOpen = $state(false); + let screenshotDialogMeasure = $state( + undefined, + ); // Pan handler function handlePan(direction: "left" | "right") { @@ -206,7 +232,7 @@ ); } - let showReplacePivotModal = false; + let showReplacePivotModal = $state(false); function startPivotForTimeseries() { const pivot = $exploreState?.pivot; if (!pivot) return; @@ -399,7 +425,7 @@ isMeasureExpanded={showTimeDimensionDetail} {showComparison} metricsViewName={chartMetricsViewName} - where={chartWhere} + where={whereFilter} {timeDimension} {timeStart} {timeEnd} @@ -416,7 +442,7 @@ {connectNulls} tddChartType={tddChartType ?? TDDChart.DEFAULT} metricsViewName={chartMetricsViewName} - where={chartWhere} + where={whereFilter} {timeDimension} interval={chartInterval} comparisonInterval={chartComparisonInterval} @@ -426,7 +452,7 @@ {chartScrubInterval} {comparisonDimension} dimensionValues={chartDimensionValues} - dimensionWhere={whereFilter} + dimensionWhere={dimensionOnlyFilter} {annotationsEnabled} canPanLeft={$canPanLeft} canPanRight={$canPanRight} @@ -482,7 +508,8 @@ measure={screenshotDialogMeasure} metricsViewName={chartMetricsViewName} tddChartType={tddChartType ?? TDDChart.DEFAULT} - where={chartWhere} + {expressionFilterManager} + where={whereFilter} {timeDimension} {timeStart} {timeEnd} @@ -494,7 +521,7 @@ timeGranularity={activeTimeGrain} timeZone={selectedTimezone} dimensionValues={chartDimensionValues} - dimensionWhere={whereFilter} + dimensionWhere={dimensionOnlyFilter} {showComparison} {showTimeDimensionDetail} dynamicYAxis={dynamicYAxisScale} diff --git a/web-common/src/features/dashboards/time-series/ScreenshotContainer.svelte b/web-common/src/features/dashboards/time-series/ScreenshotContainer.svelte index d7219f5dd859..da110bb68b02 100644 --- a/web-common/src/features/dashboards/time-series/ScreenshotContainer.svelte +++ b/web-common/src/features/dashboards/time-series/ScreenshotContainer.svelte @@ -13,15 +13,17 @@ import MeasureChart from "./measure-chart/MeasureChart.svelte"; import MeasureChartXAxis from "./measure-chart/MeasureChartXAxis.svelte"; import { prettyFormatTimeRange } from "@rilldata/web-common/lib/time/ranges/formatter.ts"; - import ExploreFilterChipsReadOnly from "@rilldata/web-common/features/dashboards/filters/ExploreFilterChipsReadOnly.svelte"; import ThemeProvider from "@rilldata/web-common/features/dashboards/ThemeProvider.svelte"; import { activeDashboardTheme } from "@rilldata/web-common/features/themes/active-dashboard-theme.ts"; import { m } from "@rilldata/web-common/lib/i18n/gen/messages"; + import type { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; + import ReadonlyExpressionFilters from "@rilldata/web-common/features/dashboards/filters/ReadonlyExpressionFilters.svelte"; export let open = false; export let measure: MetricsViewSpecMeasure; export let metricsViewName: string; export let where: V1Expression | undefined = undefined; + export let expressionFilterManager: ExpressionFilterManager; export let tddChartType: TDDChart = TDDChart.DEFAULT; export let timeDimension: string | undefined = undefined; export let timeStart: string | undefined = undefined; @@ -123,12 +125,7 @@
- +
{#if timeGranularity} diff --git a/web-common/src/features/dashboards/time-series/multiple-dimension-queries.ts b/web-common/src/features/dashboards/time-series/multiple-dimension-queries.ts index e4afa8f60a42..6185a8c69d89 100644 --- a/web-common/src/features/dashboards/time-series/multiple-dimension-queries.ts +++ b/web-common/src/features/dashboards/time-series/multiple-dimension-queries.ts @@ -2,7 +2,6 @@ import { getURIRequestMeasure, URI_DIMENSION_SUFFIX, } from "@rilldata/web-common/features/dashboards/dashboard-utils"; -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import { selectedDimensionValues } from "@rilldata/web-common/features/dashboards/state-managers/selectors/dimension-filters"; import { createAndExpression, @@ -39,11 +38,8 @@ import { } from "@tanstack/svelte-query"; import { DashboardState_ActivePage } from "../../../proto/gen/rill/ui/v1/dashboard_pb"; import { dimensionSearchText } from "../stores/dashboard-stores"; -import { - getFilterForComparedDimension, - prepareTimeSeries, - transformAggregateDimensionData, -} from "./utils"; +import { prepareTimeSeries, transformAggregateDimensionData } from "./utils"; +import { getFiltersForOtherDimensions } from "@rilldata/web-common/features/dashboards/selectors.ts"; const MAX_TDD_VALUES_LENGTH = 250; const BATCH_SIZE = 50; @@ -149,13 +145,10 @@ export function getDimensionValuesForComparison( measures: tddMeasures, dimensions: [{ name: dimensionName }], where: sanitiseExpression( - mergeDimensionAndMeasureFilters( - getDimensionFilterWithSearch( - dashboardStore?.whereFilter, - searchText, - dimensionName, - ), - dashboardStore.dimensionThresholdFilters, + getDimensionFilterWithSearch( + dashboardStore?.whereFilter, + searchText, + dimensionName, ), undefined, ), @@ -207,10 +200,11 @@ export function getDimensionValuesForComparison( totals: totalValues, values: topListValues?.slice(0, MAX_TDD_VALUES_LENGTH), uris: uriValues?.slice(0, MAX_TDD_VALUES_LENGTH), - filter: getFilterForComparedDimension( - dimensionName, - dashboardStore?.whereFilter, - ), + filter: + getFiltersForOtherDimensions( + dashboardStore?.whereFilter, + dimensionName, + ) ?? createAndExpression([]), }; }, ).subscribe(set); diff --git a/web-common/src/features/dashboards/time-series/timeseries-data-store.ts b/web-common/src/features/dashboards/time-series/timeseries-data-store.ts index 41faf475bd93..48a8dd21b26c 100644 --- a/web-common/src/features/dashboards/time-series/timeseries-data-store.ts +++ b/web-common/src/features/dashboards/time-series/timeseries-data-store.ts @@ -1,4 +1,3 @@ -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import { filterOutSomeAdvancedMeasures } from "@rilldata/web-common/features/dashboards/state-managers/selectors/measures"; import type { StateManagers } from "@rilldata/web-common/features/dashboards/state-managers/state-managers"; import { sanitiseExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; @@ -65,13 +64,7 @@ export function createMetricsViewTimeSeries( { metricsViewName, measureNames: measures, - where: sanitiseExpression( - mergeDimensionAndMeasureFilters( - dashboardStore.whereFilter, - dashboardStore.dimensionThresholdFilters, - ), - undefined, - ), + where: sanitiseExpression(dashboardStore.whereFilter, undefined), timeStart: isComparison ? timeControls.comparisonAdjustedStart : timeControls.adjustedStart, @@ -246,7 +239,7 @@ export function createTimeSeriesDataStore( } if (primaryTotal.error) { isError = true; - error["totals"] = (primaryTotal.error as Error).message; + error["totals"] = primaryTotal.error.message; } const primaryIsFetching = primary.isFetching; const primaryTotalIsFetching = primaryTotal.isFetching; diff --git a/web-common/src/features/dashboards/time-series/totals-data-store.ts b/web-common/src/features/dashboards/time-series/totals-data-store.ts index 5576201e5adb..bc7269f04647 100644 --- a/web-common/src/features/dashboards/time-series/totals-data-store.ts +++ b/web-common/src/features/dashboards/time-series/totals-data-store.ts @@ -1,16 +1,11 @@ -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import type { StateManagers } from "@rilldata/web-common/features/dashboards/state-managers/state-managers"; -import { - createAndExpression, - filterExpressions, - matchExpressionByName, - sanitiseExpression, -} from "@rilldata/web-common/features/dashboards/stores/filter-utils"; +import { sanitiseExpression } from "@rilldata/web-common/features/dashboards/stores/filter-utils"; import { useTimeControlStore } from "@rilldata/web-common/features/dashboards/time-controls/time-control-store"; import type { V1MetricsViewAggregationResponse } from "@rilldata/web-common/runtime-client"; import { createQueryServiceMetricsViewAggregation } from "@rilldata/web-common/runtime-client"; import type { CreateQueryResult } from "@tanstack/svelte-query"; import { derived } from "svelte/store"; +import { getFiltersForOtherDimensions } from "@rilldata/web-common/features/dashboards/selectors.ts"; export function createTotalsForMeasure( ctx: StateManagers, @@ -25,13 +20,7 @@ export function createTotalsForMeasure( { metricsView: metricsViewName, measures: measures.map((measure) => ({ name: measure })), - where: sanitiseExpression( - mergeDimensionAndMeasureFilters( - dashboard.whereFilter, - dashboard.dimensionThresholdFilters, - ), - undefined, - ), + where: sanitiseExpression(dashboard.whereFilter, undefined), timeRange: { start: isComparison ? timeControls?.comparisonTimeStart @@ -61,18 +50,9 @@ export function createUnfilteredTotalsForMeasure( return derived( [ctx.metricsViewName, useTimeControlStore(ctx), ctx.dashboardStore], ([metricsViewName, timeControls, dashboard], set) => { - const filter = sanitiseExpression( - mergeDimensionAndMeasureFilters( - dashboard.whereFilter, - dashboard.dimensionThresholdFilters, - ), - undefined, - ); + const filter = sanitiseExpression(dashboard.whereFilter, undefined); - const updatedFilter = filterExpressions( - filter || createAndExpression([]), - (e) => !matchExpressionByName(e, dimensionName), - ); + const updatedFilter = getFiltersForOtherDimensions(filter, dimensionName); createQueryServiceMetricsViewAggregation( ctx.runtimeClient, diff --git a/web-common/src/features/dashboards/url-state/convert-partial-explore-state-to-url-params.ts b/web-common/src/features/dashboards/url-state/convert-partial-explore-state-to-url-params.ts index 30e9b9a8e48e..a6f4e5f1d221 100644 --- a/web-common/src/features/dashboards/url-state/convert-partial-explore-state-to-url-params.ts +++ b/web-common/src/features/dashboards/url-state/convert-partial-explore-state-to-url-params.ts @@ -1,4 +1,3 @@ -import { mergeDimensionAndMeasureFilters } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import { toPivotFormattingParam } from "@rilldata/web-common/features/dashboards/pivot/pivot-formatting-param"; import { type PivotChipData, @@ -109,14 +108,10 @@ export function convertPartialExploreStateToUrlParams( } if ("whereFilter" in partialExploreState) { - const expr = mergeDimensionAndMeasureFilters( - partialExploreState.whereFilter, - partialExploreState.dimensionThresholdFilters ?? [], - ); let filterParam = ""; - if (expr && expr?.cond?.exprs?.length) { + if (partialExploreState.whereFilter?.cond?.exprs?.length) { filterParam = convertExpressionToFilterParam( - expr, + partialExploreState.whereFilter, partialExploreState.dimensionsWithInlistFilter, ); } diff --git a/web-common/src/features/dashboards/url-state/convertPresetToExploreState.ts b/web-common/src/features/dashboards/url-state/convertPresetToExploreState.ts index 6df0c4e0dfd6..bce116eeeb7e 100644 --- a/web-common/src/features/dashboards/url-state/convertPresetToExploreState.ts +++ b/web-common/src/features/dashboards/url-state/convertPresetToExploreState.ts @@ -1,4 +1,3 @@ -import { splitWhereFilter } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import { fromPivotFormattingParam } from "@rilldata/web-common/features/dashboards/pivot/pivot-formatting-param"; import { type PivotChipData, @@ -75,11 +74,8 @@ export function convertPresetToExploreState( } if (preset.where) { - const { dimensionFilters, dimensionThresholdFilters } = splitWhereFilter( - preset.where, - ); - partialExploreState.whereFilter = dimensionFilters; - partialExploreState.dimensionThresholdFilters = dimensionThresholdFilters; + partialExploreState.whereFilter = preset.where; + partialExploreState.dimensionThresholdFilters = []; } if (preset.dimensionsWithInlistFilter) { partialExploreState.dimensionsWithInlistFilter = diff --git a/web-common/src/features/dashboards/url-state/invalid-url-state-variations.spec.ts b/web-common/src/features/dashboards/url-state/invalid-url-state-variations.spec.ts index 2b3fe471f59d..9976b5b2b961 100644 --- a/web-common/src/features/dashboards/url-state/invalid-url-state-variations.spec.ts +++ b/web-common/src/features/dashboards/url-state/invalid-url-state-variations.spec.ts @@ -9,6 +9,7 @@ import { AD_BIDS_EXPLORE_NAME, AD_BIDS_METRICS_3_MEASURES_DIMENSIONS, AD_BIDS_METRICS_INIT, + AD_BIDS_METRICS_NAME, AD_BIDS_TIME_RANGE_SUMMARY, } from "@rilldata/web-common/features/dashboards/stores/test-data/data"; import { getInitExploreStateForTest } from "@rilldata/web-common/features/dashboards/stores/test-data/helpers"; @@ -16,11 +17,18 @@ import { getDefaultExplorePreset } from "@rilldata/web-common/features/dashboard import { applyURLToExploreState, getCleanMetricsExploreForAssertion, -} from "@rilldata/web-common/features/dashboards/url-state/url-state-variations.spec"; + useTestFilterManager, +} from "@rilldata/web-common/features/dashboards/url-state/test/url-state-test-utils"; import type { DashboardTimeControls } from "@rilldata/web-common/lib/time/types"; import { DashboardState_ActivePage } from "@rilldata/web-common/proto/gen/rill/ui/v1/dashboard_pb"; import { beforeEach, describe, expect, it } from "vitest"; +// The filter manager validates the filter param against the metrics view specs, so an invalid +// filter has to be invalid for it as well. +const getFilterManager = useTestFilterManager({ + [AD_BIDS_METRICS_NAME]: AD_BIDS_METRICS_3_MEASURES_DIMENSIONS, +}); + const TestCases: { title: string; url: string; @@ -157,6 +165,7 @@ describe("Invalid Human readable URL State", () => { new URL(url), AD_BIDS_EXPLORE_INIT, defaultExplorePreset, + getFilterManager(), ); expect(errorsFromUrl.map((e) => e.message)).toEqual(errors); const currentState = getCleanMetricsExploreForAssertion(); diff --git a/web-common/src/features/dashboards/url-state/test/url-state-test-utils.ts b/web-common/src/features/dashboards/url-state/test/url-state-test-utils.ts new file mode 100644 index 000000000000..efb082ae687b --- /dev/null +++ b/web-common/src/features/dashboards/url-state/test/url-state-test-utils.ts @@ -0,0 +1,126 @@ +import { ExpressionFilterManager } from "@rilldata/web-common/features/dashboards/filters/ExpressionFilterManager.svelte.ts"; +import { YAMLConfigProvider } from "@rilldata/web-common/features/dashboards/providers/YAMLConfigProvider.svelte.ts"; +import { metricsExplorerStore } from "@rilldata/web-common/features/dashboards/stores/dashboard-stores"; +import type { ExploreState } from "@rilldata/web-common/features/dashboards/stores/explore-state"; +import { + AD_BIDS_EXPLORE_NAME, + AD_BIDS_METRICS_VIEW, +} from "@rilldata/web-common/features/dashboards/stores/test-data/data"; +import { decompressUrlParams } from "@rilldata/web-common/features/dashboards/url-state/compression"; +import { convertURLSearchParamsToExploreState } from "@rilldata/web-common/features/dashboards/url-state/convertURLSearchParamsToExploreState"; +import { ExploreStateURLParams } from "@rilldata/web-common/features/dashboards/url-state/url-params"; +import type { MetricsViewsProvider } from "@rilldata/web-common/features/metrics-views/providers/MetricsViewsProvider.svelte.ts"; +import { + createInEffectRoot, + createTestMetricsViewsProvider, + type MetricsViewSpecs, + useMetricsViewMocks, +} from "@rilldata/web-common/features/metrics-views/providers/test/metrics-views-test-utils.svelte.ts"; +import { ALL_TIME_RANGE_ALIAS } from "@rilldata/web-common/features/dashboards/time-controls/new-time-controls"; +import type { DashboardTimeControls } from "@rilldata/web-common/lib/time/types"; +import type { + V1ExplorePreset, + V1ExploreSpec, +} from "@rilldata/web-common/runtime-client"; +import { deepClone } from "@vitest/utils/helpers"; +import { get } from "svelte/store"; +import { afterAll, afterEach, beforeAll, beforeEach } from "vitest"; + +/** + * Serves `specs` from ListResources and hands each test its own ExpressionFilterManager over them. + * + * The specs are read-only, so a single MetricsViewsProvider serves the whole file. The filter + * manager holds the filter state though, so it is rebuilt for every test. + */ +export function useTestFilterManager(specs: MetricsViewSpecs) { + useMetricsViewMocks(specs); + + let metricsViewsProvider: MetricsViewsProvider; + let destroyProvider: () => void; + let filterManager: ExpressionFilterManager; + let destroyFilterManager: () => void; + + beforeAll(async () => { + const provider = await createTestMetricsViewsProvider(Object.keys(specs)); + metricsViewsProvider = provider.value; + destroyProvider = provider.destroy; + }); + + beforeEach(() => { + const created = createInEffectRoot( + () => + new ExpressionFilterManager( + metricsViewsProvider, + new YAMLConfigProvider(), + ), + ); + filterManager = created.value; + destroyFilterManager = created.destroy; + }); + + afterEach(() => destroyFilterManager()); + + afterAll(() => destroyProvider()); + + return () => filterManager; +} + +export function applyURLToExploreState( + url: URL, + exploreSpec: V1ExploreSpec, + defaultExplorePreset: V1ExplorePreset, + filterManager: ExpressionFilterManager, +) { + // convertURLSearchParamsToExploreState expands the compressed params itself, + // but the filter manager only looks for the filter params, so expand them here as well. + filterManager.setUrlParams(expandCompressedParams(url.searchParams)); + + const { partialExploreState: partialExploreStateDefaultUrl, errors } = + convertURLSearchParamsToExploreState( + url.searchParams, + AD_BIDS_METRICS_VIEW, + exploreSpec, + defaultExplorePreset, + ); + metricsExplorerStore.mergePartialExplorerEntity( + AD_BIDS_EXPLORE_NAME, + partialExploreStateDefaultUrl, + filterManager, + ); + return errors; +} + +// cleans the metrics explore of any state that is not stored or restored from url state +export function getCleanMetricsExploreForAssertion() { + // clone the existing state so that any mutations do affect the copy during assertion + const cleanedState = deepClone( + get(metricsExplorerStore).entities[AD_BIDS_EXPLORE_NAME], + ) as Partial; + + delete cleanedState.name; + delete cleanedState.proto; + delete cleanedState.dimensionFilterExcludeMode; + delete cleanedState.temporaryFilterName; + delete cleanedState.contextColumnWidths; + if (cleanedState.selectedTimeRange) { + cleanedState.selectedTimeRange = { + name: cleanedState.selectedTimeRange?.name ?? ALL_TIME_RANGE_ALIAS, + interval: cleanedState.selectedTimeRange?.interval, + } as DashboardTimeControls; + } + delete cleanedState.lastDefinedScrubRange; + + // TODO + delete cleanedState.leaderboardContextColumn; + + return cleanedState; +} + +function expandCompressedParams(searchParams: URLSearchParams) { + const compressedParams = searchParams.get( + ExploreStateURLParams.GzippedParams, + ); + if (!compressedParams) return searchParams; + + return new URLSearchParams(decompressUrlParams(compressedParams)); +} diff --git a/web-common/src/features/dashboards/url-state/url-state-variations.spec.ts b/web-common/src/features/dashboards/url-state/url-state-variations.spec.ts index 570e779418d5..70e950f36dc0 100644 --- a/web-common/src/features/dashboards/url-state/url-state-variations.spec.ts +++ b/web-common/src/features/dashboards/url-state/url-state-variations.spec.ts @@ -8,6 +8,7 @@ import { AD_BIDS_EXPLORE_NAME, AD_BIDS_METRICS_3_MEASURES_DIMENSIONS_WITH_TIME, AD_BIDS_METRICS_VIEW, + AD_BIDS_NAME, AD_BIDS_PIVOT_PRESET, AD_BIDS_PRESET, AD_BIDS_PUBLISHER_DIMENSION, @@ -76,6 +77,11 @@ import { getTimeControlState } from "@rilldata/web-common/features/dashboards/ti import { getCleanedUrlParamsForGoto } from "@rilldata/web-common/features/dashboards/url-state/convert-partial-explore-state-to-url-params"; import { getRillDefaultExploreUrlParams } from "@rilldata/web-common/features/dashboards/url-state/get-rill-default-explore-url-params"; import { getDefaultExplorePreset } from "@rilldata/web-common/features/dashboards/url-state/getDefaultExplorePreset"; +import { + applyURLToExploreState, + getCleanMetricsExploreForAssertion, + useTestFilterManager, +} from "@rilldata/web-common/features/dashboards/url-state/test/url-state-test-utils"; import { type DashboardTimeControls, TimeComparisonOption, @@ -86,14 +92,18 @@ import { type V1ExplorePreset, type V1ExploreSpec, } from "@rilldata/web-common/runtime-client"; -import { deepClone } from "@vitest/utils/helpers"; import { get } from "svelte/store"; import { beforeEach, describe, expect, it, vi } from "vitest"; -import { ALL_TIME_RANGE_ALIAS } from "../time-controls/new-time-controls"; import { convertURLSearchParamsToExploreState } from "./convertURLSearchParamsToExploreState"; vi.stubEnv("TZ", "UTC"); +// Filters live in the ExpressionFilterManager rather than in explore state, so the tests need the +// specs of the metrics view backing AD_BIDS_EXPLORE to build the filter chips. +const getFilterManager = useTestFilterManager({ + [AD_BIDS_NAME]: AD_BIDS_METRICS_VIEW, +}); + const TestCases: { title: string; mutations: TestDashboardMutation[]; @@ -113,13 +123,13 @@ const TestCases: { AD_BIDS_APPLY_IMP_COUNTRY_BETWEEN_MEASURE_FILTER, ], expectedSearch: - "f=publisher+IN+LIST+%28%27Facebook%27%2C%27Google%27%29+AND+domain+LIKE+%27%25%25oo%25%25%27+AND+country+having+%28%28bid_price+GT+10+AND+bid_price+LT+20%29%29", + "f=publisher+IN+LIST+%28%27Facebook%27%2C%27Google%27%29+AND+domain+LIKE+%27%25%25oo%25%25%27+AND+country+having+%28bid_price+GT+10+AND+bid_price+LT+20%29", }, { title: "Not-between measure filter", mutations: [AD_BIDS_APPLY_IMP_COUNTRY_NOT_BETWEEN_MEASURE_FILTER], expectedSearch: - "f=country+having+%28%28bid_price+LTE+10+OR+bid_price+GTE+20%29%29", + "f=country+having+%28bid_price+LTE+10+OR+bid_price+GTE+20%29", }, { @@ -590,7 +600,11 @@ describe("Human readable URL state variations", () => { AD_BIDS_TIME_RANGE_SUMMARY.timeRangeSummary, ); - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, mutations); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + mutations, + getFilterManager(), + ); // load url params with updated metrics state const updateUrlParams = getCleanedUrlParamsForGoto( @@ -613,6 +627,7 @@ describe("Human readable URL state variations", () => { defaultUrl, explore, defaultExplorePreset, + getFilterManager(), ); expect(errors.length).toEqual(0); const currentState = getCleanMetricsExploreForAssertion(); @@ -651,7 +666,11 @@ describe("Human readable URL state variations", () => { ); const initState = getCleanMetricsExploreForAssertion(); - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, mutations); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + mutations, + getFilterManager(), + ); const curState = getCleanMetricsExploreForAssertion() as ExploreState; const url = new URL("http://localhost"); @@ -709,12 +728,16 @@ describe("Human readable URL state variations", () => { AD_BIDS_TIME_RANGE_SUMMARY.timeRangeSummary, ); - await applyMutationsToDashboard(AD_BIDS_EXPLORE_NAME, [ - AD_BIDS_APPLY_LARGE_FILTERS, - AD_BIDS_SET_P4W_TIME_RANGE_FILTER, - AD_BIDS_SET_PREVIOUS_PERIOD_COMPARE_TIME_RANGE_FILTER, - AD_BIDS_OPEN_PIVOT_WITH_ALL_FIELDS, - ]); + await applyMutationsToDashboard( + AD_BIDS_EXPLORE_NAME, + [ + AD_BIDS_APPLY_LARGE_FILTERS, + AD_BIDS_SET_P4W_TIME_RANGE_FILTER, + AD_BIDS_SET_PREVIOUS_PERIOD_COMPARE_TIME_RANGE_FILTER, + AD_BIDS_OPEN_PIVOT_WITH_ALL_FIELDS, + ], + getFilterManager(), + ); // load url params with updated metrics state const url = new URL("http://localhost"); @@ -737,9 +760,15 @@ describe("Human readable URL state variations", () => { new URL("http://localhost"), AD_BIDS_EXPLORE, defaultExplorePreset, + getFilterManager(), ); // reapply the compressed url - applyURLToExploreState(url, AD_BIDS_EXPLORE, defaultExplorePreset); + applyURLToExploreState( + url, + AD_BIDS_EXPLORE, + defaultExplorePreset, + getFilterManager(), + ); const currentState = getCleanMetricsExploreForAssertion(); expect(currentState.selectedTimeRange?.name).toEqual( @@ -809,7 +838,12 @@ describe("Human readable URL state variations", () => { // Deserialize URL back to state (simulates page refresh) const url = new URL("http://localhost"); url.search = urlParams.toString(); - applyURLToExploreState(url, explore, defaultExplorePreset); + applyURLToExploreState( + url, + explore, + defaultExplorePreset, + getFilterManager(), + ); const stateAfterRoundtrip = getCleanMetricsExploreForAssertion(); expect(stateAfterRoundtrip.pivot?.sorting).toEqual( @@ -848,7 +882,12 @@ describe("Human readable URL state variations", () => { // Deserialize URL back to state (simulates page refresh) const url = new URL("http://localhost"); url.search = urlParams.toString(); - applyURLToExploreState(url, explore, defaultExplorePreset); + applyURLToExploreState( + url, + explore, + defaultExplorePreset, + getFilterManager(), + ); const stateAfterRoundtrip = getCleanMetricsExploreForAssertion(); expect(stateAfterRoundtrip.pivot?.sorting).toEqual( @@ -857,48 +896,3 @@ describe("Human readable URL state variations", () => { }); }); }); - -export function applyURLToExploreState( - url: URL, - exploreSpec: V1ExploreSpec, - defaultExplorePreset: V1ExplorePreset, -) { - const { partialExploreState: partialExploreStateDefaultUrl, errors } = - convertURLSearchParamsToExploreState( - url.searchParams, - AD_BIDS_METRICS_VIEW, - exploreSpec, - defaultExplorePreset, - ); - metricsExplorerStore.mergePartialExplorerEntity( - AD_BIDS_EXPLORE_NAME, - partialExploreStateDefaultUrl, - ); - return errors; -} - -// cleans the metrics explore of any state that is not stored or restored from url state -export function getCleanMetricsExploreForAssertion() { - // clone the existing state so that any mutations do affect the copy during assertion - const cleanedState = deepClone( - get(metricsExplorerStore).entities[AD_BIDS_EXPLORE_NAME], - ) as Partial; - - delete cleanedState.name; - delete cleanedState.proto; - delete cleanedState.dimensionFilterExcludeMode; - delete cleanedState.temporaryFilterName; - delete cleanedState.contextColumnWidths; - if (cleanedState.selectedTimeRange) { - cleanedState.selectedTimeRange = { - name: cleanedState.selectedTimeRange?.name ?? ALL_TIME_RANGE_ALIAS, - interval: cleanedState.selectedTimeRange?.interval, - } as DashboardTimeControls; - } - delete cleanedState.lastDefinedScrubRange; - - // TODO - delete cleanedState.leaderboardContextColumn; - - return cleanedState; -} diff --git a/web-common/src/features/dashboards/workspace/Dashboard.svelte b/web-common/src/features/dashboards/workspace/Dashboard.svelte index 2e78e25f02a6..1aad030740fb 100644 --- a/web-common/src/features/dashboards/workspace/Dashboard.svelte +++ b/web-common/src/features/dashboards/workspace/Dashboard.svelte @@ -56,26 +56,24 @@ pivot: { showPivot }, }, dashboardStore, + expressionFilterManager, } = StateManagers; const { adminServer, cloudDataViewer, readOnly } = featureFlags; const timeControlsStore = useTimeControlStore(StateManagers); - onMount(() => { - // Github star nudge is Rill developer only. - // Nudge on dashboard render. - if (!isEmbedded && !get(adminServer)) githubStarNudge.armPayoff(); - }); - let exploreContainerWidth: number; let exploreContainerHeight: number; let resizing = false; const client = useRuntimeClient(); - $: ({ whereFilter, dimensionThresholdFilters, selectedTimeDimension } = - $dashboardStore); + $: ({ selectedTimeDimension } = $dashboardStore); + const filterStore = + expressionFilterManager.getExprStoreForMetricsView(metricsViewName); + $: dimensionOnlyFilter = $filterStore?.dimensionOnlyExpr; + $: whereFilter = $filterStore?.expr; $: extraLeftPadding = !$navigationOpen; @@ -152,6 +150,12 @@ // Publish the resolved theme to the shared store for external components (e.g., chat in layout) $: activeDashboardTheme.set($theme); + onMount(() => { + // Github star nudge is Rill developer only. + // Nudge on dashboard render. + if (!isEmbedded && !get(adminServer)) githubStarNudge.armPayoff(); + }); + // Clear the active theme when this dashboard is destroyed onDestroy(() => activeDashboardTheme.set(undefined)); @@ -213,11 +217,17 @@ {#if hasTimeSeries} {:else} - + {/if} {/key}
@@ -265,7 +275,6 @@ dimension={selectedDimension} {metricsViewName} {whereFilter} - {dimensionThresholdFilters} {timeRange} {comparisonTimeRange} {timeControlsReady} @@ -276,7 +285,6 @@ 1 || - dashboard.dimensionThresholdFilters.length > 0 - ) { - // If there are dimension threshold and having filter we just add a subquery in where filter. - // This will be marked as "advanced filter" that is not editable. - // TODO: find a way to merge having filter into dimension threshold - const extraFilter = createSubQueryExpression( + } else { + // Measure filters are stored as a subquery on the dimension within the where filter. + havingFilter = createSubQueryExpression( dimension, getAllIdentifiers(req.having), req.having, ); - if (dashboard.whereFilter?.cond?.exprs?.length) { - dashboard.whereFilter = createAndExpression([ - dashboard.whereFilter, - extraFilter, - ]); - } else { - dashboard.whereFilter = extraFilter; - } - } else { - dashboard.dimensionThresholdFilters = [ - { - name: dimension, - filters: - req.having?.cond?.exprs - ?.map(mapExprToMeasureFilter) - .filter((f): f is NonNullable => f != null) ?? [], - }, - ]; } + + dashboard.whereFilter = + mergeFilters( + dashboard.whereFilter ?? createAndExpression([]), + createAndExpression([havingFilter]), + ) ?? createAndExpression([]); } // everything after this can be loaded from the dashboard state if present diff --git a/web-common/src/features/explores/explore-link/explore-state-transformer.ts b/web-common/src/features/explores/explore-link/explore-state-transformer.ts index b1af95eb9ecb..40abf2b1a081 100644 --- a/web-common/src/features/explores/explore-link/explore-state-transformer.ts +++ b/web-common/src/features/explores/explore-link/explore-state-transformer.ts @@ -1,4 +1,3 @@ -import { splitWhereFilter } from "@rilldata/web-common/features/dashboards/filters/measure-filters/measure-filter-utils"; import type { ExploreState } from "@rilldata/web-common/features/dashboards/stores/explore-state"; import type { TimeAndFilterStore } from "@rilldata/web-common/features/dashboards/time-controls/time-control-store"; import { TimeRangePreset } from "@rilldata/web-common/lib/time/types"; @@ -12,11 +11,7 @@ export function transformTimeAndFiltersToExploreState( const exploreState: Partial = {}; if (timeAndFilterStore.where) { - const { dimensionFilters, dimensionThresholdFilters } = splitWhereFilter( - timeAndFilterStore.where, - ); - exploreState.whereFilter = dimensionFilters; - exploreState.dimensionThresholdFilters = dimensionThresholdFilters; + exploreState.whereFilter = timeAndFilterStore.where; } if (timeAndFilterStore.timeRangeState) { diff --git a/web-common/src/features/exports/export-filters.spec.ts b/web-common/src/features/exports/export-filters.spec.ts index e8ed94ab1834..d92321516fbf 100644 --- a/web-common/src/features/exports/export-filters.spec.ts +++ b/web-common/src/features/exports/export-filters.spec.ts @@ -26,7 +26,6 @@ describe("buildWhereParamForDimensionTableAndTDDExports", () => { const result = buildWhereParamForDimensionTableAndTDDExports( params.whereFilter, - params.measureFilters, params.dimensionName, params.searchText, ); @@ -42,7 +41,6 @@ describe("buildWhereParamForDimensionTableAndTDDExports", () => { const result = buildWhereParamForDimensionTableAndTDDExports( params.whereFilter, - params.measureFilters, params.dimensionName, params.searchText, ); @@ -59,7 +57,6 @@ describe("buildWhereParamForDimensionTableAndTDDExports", () => { const result = buildWhereParamForDimensionTableAndTDDExports( params.whereFilter, - params.measureFilters, params.dimensionName, params.searchText, ); diff --git a/web-common/src/features/exports/export-filters.ts b/web-common/src/features/exports/export-filters.ts index 10d41f9c7cbf..bd34d6d3a873 100644 --- a/web-common/src/features/exports/export-filters.ts +++ b/web-common/src/features/exports/export-filters.ts @@ -1,8 +1,6 @@ import type { V1Expression } from "@rilldata/web-admin/client/gen/index.schemas"; import { getDimensionFilterWithSearch } from "../dashboards/dimension-table/dimension-table-utils"; -import { mergeDimensionAndMeasureFilters } from "../dashboards/filters/measure-filters/measure-filter-utils"; import { sanitiseExpression } from "../dashboards/stores/filter-utils"; -import type { DimensionThresholdFilter } from "web-common/src/features/dashboards/stores/explore-state"; /** * If there's input in the search field, then all search results will be included in the export. @@ -10,7 +8,6 @@ import type { DimensionThresholdFilter } from "web-common/src/features/dashboard */ export function buildWhereParamForDimensionTableAndTDDExports( whereFilter: V1Expression, - dimensionThresholdFilters: DimensionThresholdFilter[], dimensionName: string, searchText: string, ) { @@ -25,10 +22,5 @@ export function buildWhereParamForDimensionTableAndTDDExports( dimensionFilter = whereFilter; } - const where = mergeDimensionAndMeasureFilters( - dimensionFilter, - dimensionThresholdFilters, - ); - const sanitisedWhere = sanitiseExpression(where, undefined); - return sanitisedWhere; + return sanitiseExpression(dimensionFilter, undefined); } diff --git a/web-common/src/features/exports/pdf/CanvasPdfExportHeader.svelte b/web-common/src/features/exports/pdf/CanvasPdfExportHeader.svelte index 70c80f5391cb..098ec473618c 100644 --- a/web-common/src/features/exports/pdf/CanvasPdfExportHeader.svelte +++ b/web-common/src/features/exports/pdf/CanvasPdfExportHeader.svelte @@ -1,18 +1,20 @@
{/if} - {#if hasFilters} - + {#if expressionFilterManager.hasSomeFilter} + {/if}
diff --git a/web-common/src/features/metrics-views/providers/MetricsViewsProvider.spec.ts b/web-common/src/features/metrics-views/providers/MetricsViewsProvider.spec.ts new file mode 100644 index 000000000000..2578d60d17af --- /dev/null +++ b/web-common/src/features/metrics-views/providers/MetricsViewsProvider.spec.ts @@ -0,0 +1,80 @@ +import { + AD_BIDS_BID_PRICE_MEASURE, + AD_BIDS_DOMAIN_DIMENSION, + AD_BIDS_IMPRESSIONS_MEASURE, + AD_BIDS_METRICS_INIT, + AD_BIDS_METRICS_NAME, + AD_BIDS_PUBLISHER_DIMENSION, +} from "@rilldata/web-common/features/dashboards/stores/test-data/data"; +import { + createTestMetricsViewsProvider, + useMetricsViewMocks, +} from "@rilldata/web-common/features/metrics-views/providers/test/metrics-views-test-utils.svelte.ts"; +import { describe, expect, it } from "vitest"; + +const AD_BIDS_MIRROR_METRICS_NAME = "AdBids_mirror_metrics"; + +useMetricsViewMocks({ + [AD_BIDS_METRICS_NAME]: AD_BIDS_METRICS_INIT, + // Shares the publisher dimension and the impressions measure with AdBids. + [AD_BIDS_MIRROR_METRICS_NAME]: { + ...AD_BIDS_METRICS_INIT, + dimensions: [{ name: AD_BIDS_PUBLISHER_DIMENSION }], + measures: [{ name: AD_BIDS_IMPRESSIONS_MEASURE }], + }, +}); + +describe("MetricsViewsProvider", () => { + it("loads the spec for each metrics view", async () => { + const { value: provider, destroy } = await createTestMetricsViewsProvider([ + AD_BIDS_METRICS_NAME, + ]); + + // Not an exact match: the transport fills in proto default values. + expect(provider.specs[AD_BIDS_METRICS_NAME]).toMatchObject( + AD_BIDS_METRICS_INIT, + ); + expect(provider.measures.map((m) => m.name)).toEqual([ + AD_BIDS_IMPRESSIONS_MEASURE, + AD_BIDS_BID_PRICE_MEASURE, + ]); + expect(provider.dimensions.map((d) => d.name)).toEqual([ + AD_BIDS_PUBLISHER_DIMENSION, + AD_BIDS_DOMAIN_DIMENSION, + ]); + // No time dimension, so there is no time range summary to wait for. + expect(provider.ready).toBe(true); + + destroy(); + }); + + it("maps a shared measure or dimension to every metrics view defining it", async () => { + const { value: provider, destroy } = await createTestMetricsViewsProvider([ + AD_BIDS_METRICS_NAME, + AD_BIDS_MIRROR_METRICS_NAME, + ]); + + expect( + Object.keys(provider.dimensionSpecs[AD_BIDS_PUBLISHER_DIMENSION]), + ).toEqual([AD_BIDS_METRICS_NAME, AD_BIDS_MIRROR_METRICS_NAME]); + expect( + Object.keys(provider.measureSpecs[AD_BIDS_IMPRESSIONS_MEASURE]), + ).toEqual([AD_BIDS_METRICS_NAME, AD_BIDS_MIRROR_METRICS_NAME]); + + // Only AdBids defines these, so they stay single-entry. + expect( + Object.keys(provider.dimensionSpecs[AD_BIDS_DOMAIN_DIMENSION]), + ).toEqual([AD_BIDS_METRICS_NAME]); + expect( + Object.keys(provider.measureSpecs[AD_BIDS_BID_PRICE_MEASURE]), + ).toEqual([AD_BIDS_METRICS_NAME]); + + // Deduped across metrics views, first definition wins. + expect(provider.dimensions.map((d) => d.name)).toEqual([ + AD_BIDS_PUBLISHER_DIMENSION, + AD_BIDS_DOMAIN_DIMENSION, + ]); + + destroy(); + }); +}); diff --git a/web-common/src/features/metrics-views/providers/MetricsViewsProvider.svelte.ts b/web-common/src/features/metrics-views/providers/MetricsViewsProvider.svelte.ts new file mode 100644 index 000000000000..35af7ade301d --- /dev/null +++ b/web-common/src/features/metrics-views/providers/MetricsViewsProvider.svelte.ts @@ -0,0 +1,251 @@ +import { + createQueryServiceMetricsViewTimeRange, + createRuntimeServiceListResources, + type MetricsViewSpecDimension, + type MetricsViewSpecMeasure, + type V1MetricsViewSpec, + type V1Resource, + type V1TimeRangeSummary, +} from "@rilldata/web-common/runtime-client"; +import type { RuntimeClient } from "@rilldata/web-common/runtime-client/v2"; +import { isSimpleMeasure } from "@rilldata/web-common/features/dashboards/state-managers/selectors/measures.ts"; +import { Duration } from "luxon"; +import { queryClient } from "@rilldata/web-common/lib/svelte-query/globalQueryClient.ts"; +import { ResourceKind } from "@rilldata/web-common/features/entity-management/resource-selectors.ts"; + +export type MetricsViewName = string; +export type DimensionName = string; +export type MeasureName = string; + +/** + * Reactive view over a set of metrics views. + * + * Specs for every metrics view come from a single ListResources subscription. + * Time range summaries are fetched per metrics view, and only for the ones that have a time dimension, + * so the summaries arrive after the specs rather than alongside them. + * + * Measures and dimensions are exposed two ways: + * as deduped flat lists for pickers, and as name -> metrics view -> spec maps for callers that need to + * know which metrics views a given measure or dimension belongs to. + */ +export class MetricsViewsProvider { + /** Valid spec per metrics view name. Absent while the resource is loading or invalid. */ + public specs = $state>({}); + /** Time range summary per metrics view name. Absent for metrics views without a time dimension. */ + public timeRangeSummaries = $state< + Record + >({}); + /** Max queryable time range in milliseconds per metrics view name. Zero when unrestricted. */ + public maxQueryTimeRangeMillis = $state>({}); + + /** Dimension spec per metrics view, keyed by dimension name (or column when unnamed). */ + public dimensionSpecs = $state< + Record> + >({}); + /** + * Measure spec per metrics view, keyed by measure name. + * The same measure name can be defined by more than one metrics view. + */ + public measureSpecs = $state< + Record> + >({}); + + /** Deduped by name across metrics views; the first metrics view to define a name wins. */ + public measures = $state([]); + public simpleMeasures = $state([]); + public dimensions = $state([]); + + /** Union of the individual summaries: earliest min, latest max, latest watermark. */ + public timeRangeSummary: V1TimeRangeSummary | undefined; + /** Smallest restriction across the metrics views, since it has to hold for all of them. */ + public maxQueryTimeRange: Duration | undefined; + /** True once every metrics view has a spec and every time series metrics view has a summary. */ + public ready: boolean; + public metricsViewNames = $state([]); + + public cleanup: () => void; // TODO: ensure this is called by creators + + private resources: V1Resource[] = []; + private readonly timeRangeUnsubs = new Map void>(); + + public constructor( + public readonly runtimeClient: RuntimeClient, + initMetricsViewNames: string[], + ) { + this.metricsViewNames = initMetricsViewNames; + + const allResourcesQuery = createRuntimeServiceListResources( + runtimeClient, + {}, + undefined, + queryClient, + ); + const allResourcesUnsub = allResourcesQuery.subscribe( + (allResourcesResp) => { + this.resources = allResourcesResp.data?.resources ?? []; + this.processResources(); + }, + ); + + this.timeRangeSummary = $derived.by(() => { + let min: string | undefined; + let max: string | undefined; + let watermark: string | undefined; + let minTime = Infinity; + let maxTime = -Infinity; + let watermarkTime = -Infinity; + + for (const metricsViewName of this.metricsViewNames) { + const summary = this.timeRangeSummaries[metricsViewName]; + if (!summary) continue; + + // Date.parse returns NaN for missing or malformed timestamps, + // and every comparison against NaN is false, so those simply never win. + const minCandidate = Date.parse(summary.min ?? ""); + if (minCandidate < minTime) { + minTime = minCandidate; + min = summary.min; + } + + const maxCandidate = Date.parse(summary.max ?? ""); + if (maxCandidate > maxTime) { + maxTime = maxCandidate; + max = summary.max; + } + + const watermarkCandidate = Date.parse(summary.watermark ?? ""); + if (watermarkCandidate > watermarkTime) { + watermarkTime = watermarkCandidate; + watermark = summary.watermark; + } + } + + if (!min && !max && !watermark) return undefined; + return { min, max, watermark }; + }); + + this.maxQueryTimeRange = $derived.by(() => { + let smallestMillis = Infinity; + for (const metricsViewName of this.metricsViewNames) { + const millis = this.maxQueryTimeRangeMillis[metricsViewName] ?? 0; + if (millis > 0 && millis < smallestMillis) smallestMillis = millis; + } + return smallestMillis === Infinity + ? undefined + : Duration.fromMillis(smallestMillis); + }); + + this.ready = $derived( + this.metricsViewNames.every((metricsViewName) => { + const spec = this.specs[metricsViewName]; + if (!spec) return false; + return ( + !spec.timeDimension || !!this.timeRangeSummaries[metricsViewName] + ); + }), + ); + + this.cleanup = () => { + allResourcesUnsub(); + this.timeRangeUnsubs.forEach((unsub) => unsub()); + this.timeRangeUnsubs.clear(); + }; + } + + public setMetricsViewNames(metricsViewNames: string[]) { + this.metricsViewNames = metricsViewNames; + this.processResources(); + } + + private processResources() { + const specs: Record = {}; + + const measureSpecs: Record< + string, + Record + > = {}; + const measures: MetricsViewSpecMeasure[] = []; + const simpleMeasures: MetricsViewSpecMeasure[] = []; + + const dimensionSpecs: Record< + string, + Record + > = {}; + const dimensions: MetricsViewSpecDimension[] = []; + + for (const metricsViewName of this.metricsViewNames) { + const res = this.resources.find( + (resource) => + resource.meta?.name?.name === metricsViewName && + resource.meta?.name?.kind === ResourceKind.MetricsView, + ); + const spec = res?.metricsView?.state?.validSpec; + if (!spec) continue; + specs[metricsViewName] = spec; + + spec.measures?.forEach((measure) => { + if (!measure.name) return; + + let specsForMeasure = measureSpecs[measure.name]; + if (!specsForMeasure) { + specsForMeasure = measureSpecs[measure.name] = {}; + measures.push(measure); + if (isSimpleMeasure(measure)) simpleMeasures.push(measure); + } + specsForMeasure[metricsViewName] = measure; + }); + + spec.dimensions?.forEach((dimension) => { + // Filter expressions identify an unnamed dimension by its column. + const dimensionName = dimension.name || dimension.column; + if (!dimensionName) return; + + let specsForDimension = dimensionSpecs[dimensionName]; + if (!specsForDimension) { + specsForDimension = dimensionSpecs[dimensionName] = {}; + dimensions.push(dimension); + } + specsForDimension[metricsViewName] = dimension; + }); + + this.subscribeToTimeRange(metricsViewName, spec); + } + + this.specs = specs; + this.measureSpecs = measureSpecs; + this.measures = measures; + this.simpleMeasures = simpleMeasures; + this.dimensionSpecs = dimensionSpecs; + this.dimensions = dimensions; + } + + /** + * Starts the time range query for a metrics view the first time its spec shows up. + * Metrics views without a time dimension have no summary to fetch. + */ + private subscribeToTimeRange( + metricsViewName: string, + spec: V1MetricsViewSpec, + ) { + if (!spec.timeDimension || this.timeRangeUnsubs.has(metricsViewName)) { + return; + } + + const timeRangeQuery = createQueryServiceMetricsViewTimeRange( + this.runtimeClient, + { metricsViewName }, + undefined, + queryClient, + ); + this.timeRangeUnsubs.set( + metricsViewName, + timeRangeQuery.subscribe((timeRangeResp) => { + const summary = timeRangeResp.data?.timeRangeSummary; + if (summary) this.timeRangeSummaries[metricsViewName] = summary; + this.maxQueryTimeRangeMillis[metricsViewName] = Number( + timeRangeResp.data?.maxQueryTimeRangeMillis ?? 0, + ); + }), + ); + } +} diff --git a/web-common/src/features/metrics-views/providers/test/RuntimeContextHarness.svelte b/web-common/src/features/metrics-views/providers/test/RuntimeContextHarness.svelte new file mode 100644 index 000000000000..a9e22a5643d9 --- /dev/null +++ b/web-common/src/features/metrics-views/providers/test/RuntimeContextHarness.svelte @@ -0,0 +1,34 @@ + diff --git a/web-common/src/features/metrics-views/providers/test/metrics-views-test-utils.svelte.ts b/web-common/src/features/metrics-views/providers/test/metrics-views-test-utils.svelte.ts new file mode 100644 index 000000000000..1231e4922c67 --- /dev/null +++ b/web-common/src/features/metrics-views/providers/test/metrics-views-test-utils.svelte.ts @@ -0,0 +1,156 @@ +import { DashboardFetchMocks } from "@rilldata/web-common/features/dashboards/dashboard-fetch-mocks"; +import { MetricsViewsProvider } from "@rilldata/web-common/features/metrics-views/providers/MetricsViewsProvider.svelte.ts"; +import RuntimeContextHarness from "@rilldata/web-common/features/metrics-views/providers/test/RuntimeContextHarness.svelte"; +import { waitUntil } from "@rilldata/web-common/lib/waitUtils"; +import type { V1MetricsViewSpec } from "@rilldata/web-common/runtime-client"; +import { RuntimeClient } from "@rilldata/web-common/runtime-client/v2"; +import { QueryClient } from "@tanstack/svelte-query"; +import { mount, unmount } from "svelte"; + +/** + * Helpers for unit tests that need real metrics view specs rather than hand-stubbed ones. + * + * useMetricsViewMocks({ [AD_BIDS_METRICS_NAME]: AD_BIDS_METRICS_INIT }); + * + * it("filters by publisher", async () => { + * const { value: provider, destroy } = await createTestMetricsViewsProvider([ + * AD_BIDS_METRICS_NAME, + * ]); + * ... + * destroy(); + * }); + */ + +export type MetricsViewSpecs = Record; + +export type RuntimeTestContext = { + runtimeClient: RuntimeClient; + queryClient: QueryClient; +}; + +export type RenderedInRuntimeContext = RuntimeTestContext & { + /** Whatever `init` returned. */ + value: T; + destroy: () => void; +}; + +/** + * Serves `specs` from ListResources for the duration of the test file. + * + * Call this at module or `describe` scope, since it registers the `beforeAll` hook + * that stubs `fetch`. The returned mocks can be used to add responses for other + * endpoints, such as aggregation queries backing dimension value lists. + */ +export function useMetricsViewMocks(specs: MetricsViewSpecs) { + const mocks = DashboardFetchMocks.useDashboardFetchMocks(); + for (const [metricsViewName, spec] of Object.entries(specs)) { + mocks.mockMetricsView(metricsViewName, spec); + } + return mocks; +} + +/** + * Runs `init` inside an effect root, which is all a class needs when it only calls + * `$effect` in its constructor, such as ExpressionFilterManager. Classes that also + * call `createQuery` need a QueryClient context, so use {@link renderInRuntimeContext} + * for those. + */ +export function createInEffectRoot(init: () => T): { + value: T; + destroy: () => void; +} { + let value: T | undefined; + const destroy = $effect.root(() => { + value = init(); + }); + return { value: value as T, destroy }; +} + +/** + * Runs `init` inside a mounted component so that it has a QueryClient context and an + * effect owner. Classes like MetricsViewsProvider call `createQuery` in their + * constructors, so they can only be built here and not directly from a test body. + * + * The caller owns the returned `destroy`; call it once the test is done to unmount + * the harness and stop the queries. + */ +export function renderInRuntimeContext( + init: (ctx: RuntimeTestContext) => T, +): RenderedInRuntimeContext { + const runtimeClient = new RuntimeClient({ + host: "http://localhost", + instanceId: "test", + }); + const queryClient = new QueryClient({ + defaultOptions: { + queries: { + refetchOnMount: false, + refetchOnReconnect: false, + refetchOnWindowFocus: false, + retry: false, + networkMode: "always", + }, + }, + }); + + let value: T | undefined; + const component = mount(RuntimeContextHarness, { + target: document.createElement("div"), + props: { + queryClient, + runtimeClient, + init: () => { + value = init({ runtimeClient, queryClient }); + }, + }, + }); + + return { + value: value as T, + runtimeClient, + queryClient, + destroy: () => { + void unmount(component); + queryClient.clear(); + runtimeClient.dispose(); + }, + }; +} + +/** + * Creates a MetricsViewsProvider for `metricsViewNames` and resolves once the specs + * mocked by {@link useMetricsViewMocks} have landed. + */ +export async function createTestMetricsViewsProvider( + metricsViewNames: string[], +): Promise> { + const rendered = renderInRuntimeContext(({ runtimeClient }) => { + return new MetricsViewsProvider(runtimeClient, metricsViewNames); + }); + + await waitForMetricsViewSpecs(rendered.value, metricsViewNames); + + return rendered; +} + +/** Resolves once every requested metrics view has a spec, or throws on timeout. */ +export async function waitForMetricsViewSpecs( + metricsViewsProvider: MetricsViewsProvider, + metricsViewNames: string[], + timeout = 5000, +) { + const loaded = await waitUntil( + () => metricsViewNames.every((name) => !!metricsViewsProvider.specs[name]), + timeout, + 10, + ); + if (!loaded) { + const missing = metricsViewNames.filter( + (name) => !metricsViewsProvider.specs[name], + ); + throw new Error( + `Timed out waiting for metrics view specs: ${missing.join(", ")}. ` + + `Did the test call useMetricsViewMocks with these metrics views?`, + ); + } +} diff --git a/web-common/src/features/scheduled-reports/BaseScheduledReportForm.svelte b/web-common/src/features/scheduled-reports/BaseScheduledReportForm.svelte index 994737ec28c9..209186a0bc6d 100644 --- a/web-common/src/features/scheduled-reports/BaseScheduledReportForm.svelte +++ b/web-common/src/features/scheduled-reports/BaseScheduledReportForm.svelte @@ -5,7 +5,6 @@ import MultiInput from "@rilldata/web-common/components/forms/MultiInput.svelte"; import FormSection from "@rilldata/web-common/components/forms/FormSection.svelte"; import { getHasSlackConnection } from "@rilldata/web-common/features/alerts/delivery-tab/notifiers-utils"; - import type { Filters } from "@rilldata/web-common/features/dashboards/stores/Filters.ts"; import type { TimeControls } from "@rilldata/web-common/features/dashboards/stores/TimeControls.ts"; import FiltersForm from "@rilldata/web-common/features/scheduled-reports/FiltersForm.svelte"; import RowsAndColumnsForm from "@rilldata/web-common/features/scheduled-reports/fields/RowsAndColumnsForm.svelte"; @@ -24,6 +23,7 @@ import Select from "../../components/forms/Select.svelte"; import Checkbox from "../../components/forms/Checkbox.svelte"; import { useRuntimeClient } from "@rilldata/web-common/runtime-client/v2"; + import type { ExpressionFilterManager } from "../dashboards/filters/ExpressionFilterManager.svelte.ts"; import { useExploreValidSpec } from "@rilldata/web-common/features/explores/selectors.ts"; import { ResourceKind, @@ -39,13 +39,13 @@ export let errors: SuperFormErrors; export let submit: () => void; export let enhance; - // Exactly one of exploreName and canvasName is non-empty; canvasName selects the canvas PDF variant of the form. + export let metricsViewName: string; export let exploreName: string; export let canvasName: string = ""; // Canvas state (URL search string) to display instead of the page URL; set when // editing a report so the filter bar shows the report's captured state. export let canvasStateOverride: string | undefined = undefined; - export let filters: Filters | undefined = undefined; + export let filters: ExpressionFilterManager | undefined = undefined; export let timeControls: TimeControls | undefined = undefined; const RUN_AS_OPTIONS = [ @@ -245,7 +245,13 @@ id="filters" capitalize={false} /> - +
{/if} diff --git a/web-common/src/features/scheduled-reports/FiltersForm.svelte b/web-common/src/features/scheduled-reports/FiltersForm.svelte index 3aa46b4e2261..22c340e24b4e 100644 --- a/web-common/src/features/scheduled-reports/FiltersForm.svelte +++ b/web-common/src/features/scheduled-reports/FiltersForm.svelte @@ -1,18 +1,9 @@