Skip to content

feat: @ measure picker in the adhoc measure expression input #9953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nishantmonu51 merged 4 commits into from
Sep 25, 2026
Merged

feat: @ measure picker in the adhoc measure expression input #9953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4d31972
feat: `@` measure picker in the adhoc measure expression input
nishantmonu51 Sep 24, 2026
2444fc2
feat: measure chips, unique display names and descriptions for adhoc …
nishantmonu51 Sep 24, 2026
8eb73d1
fix: adhoc measure review feedback
nishantmonu51 Sep 25, 2026
0159065
refactor: share the adhoc measure form between explore and canvas
nishantmonu51 Sep 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
182 changes: 15 additions & 167 deletions web-common/src/features/canvas/inspector/fields/EphemeralMeasureEditor.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
<!-- @component
Creates or edits an ephemeral measure in a canvas component's `adhoc_measures`.
-->
<script lang="ts">
import { Button } from "@rilldata/web-common/components/button";
import Chip from "@rilldata/web-common/components/chip/core/Chip.svelte";
import * as Dialog from "@rilldata/web-common/components/dialog";
import Input from "@rilldata/web-common/components/forms/Input.svelte";
import type { BaseCanvasComponent } from "@rilldata/web-common/features/canvas/components/BaseCanvasComponent";
import type { ComponentSpec } from "@rilldata/web-common/features/canvas/components/types";
import { getCanvasStore } from "@rilldata/web-common/features/canvas/state-managers/state-managers";
Expand All @@ -12,20 +11,9 @@
removeMeasureFromComponentSpec,
type EphemeralMeasureSpec,
} from "@rilldata/web-common/features/dashboards/ephemeral-measures/canvas";
import {
formatMeasureRef,
parseMeasureExpression,
} from "@rilldata/web-common/features/dashboards/ephemeral-measures/expression-parser";
import EphemeralMeasureForm from "@rilldata/web-common/features/dashboards/ephemeral-measures/EphemeralMeasureForm.svelte";
import type { EphemeralMeasureDef } from "@rilldata/web-common/features/dashboards/ephemeral-measures/types";
import {
isReferenceableMeasure,
slugifyEphemeralMeasureName,
validateEphemeralMeasureCount,
validateEphemeralMeasureDef,
} from "@rilldata/web-common/features/dashboards/ephemeral-measures/validation";
import { m } from "@rilldata/web-common/lib/i18n/gen/messages";
import { ephemeralFormatPresetOptions } from "@rilldata/web-common/features/dashboards/ephemeral-measures/format-presets";
import { FormatPreset } from "@rilldata/web-common/lib/number-formatting/humanizer-types";
import { isReferenceableMeasure } from "@rilldata/web-common/features/dashboards/ephemeral-measures/validation";
import { useRuntimeClient } from "@rilldata/web-common/runtime-client/v2";
import type { AllKeys } from "../types";

Expand All @@ -46,13 +34,6 @@
// The spec key holding the definitions on every component that supports them.
const EPHEMERAL_SPEC_KEY = "adhoc_measures" as AllKeys<ComponentSpec>;

const FORMAT_PRESETS = ephemeralFormatPresetOptions();

let displayName = editingDef?.displayName ?? "";
let expression = editingDef?.expression ?? "";
let formatPreset: string = editingDef?.formatPreset ?? FormatPreset.HUMANIZE;
let saveError: string | undefined = undefined;

$: ctx = getCanvasStore(canvasName, client.instanceId);
$: metricsViewStore =
ctx.canvasEntity.metricsView.getMetricsViewFromName(metricName);
Expand All @@ -68,28 +49,6 @@
$: referenceableMeasures = (metricsViewSpec?.measures ?? []).filter(
(mes) => mes.name && isReferenceableMeasure(mes),
);
$: knownMeasureNames = new Set(
referenceableMeasures.map((mes) => mes.name as string),
);

$: reservedNames = new Set([
...(metricsViewSpec?.measures ?? []).map((mes) => mes.name as string),
...(metricsViewSpec?.dimensions ?? []).map(
(d) => (d.name || d.column) as string,
),
...(metricsViewSpec?.timeDimension ? [metricsViewSpec.timeDimension] : []),
...defs.filter((d) => d.name !== editingDef?.name).map((d) => d.name),
]);

$: parsed = parseMeasureExpression(expression);
$: unknownRef = parsed.refs.find((ref) => !knownMeasureNames.has(ref));
$: expressionError =
expression.trim() === ""
? undefined
: (parsed.error?.message ??
(unknownRef
? `"${unknownRef}" is not a measure in this metrics view`
: undefined));

// The raw YAML list, re-read at write time so a save never clobbers entries
// added or reordered elsewhere (code editor, another refetch) while the
Expand All @@ -107,25 +66,7 @@
);
}

function insertMeasure(name: string) {
const token = formatMeasureRef(name);
expression = expression === "" ? token : `${expression} ${token}`;
}

function save() {
const def: EphemeralMeasureDef = {
name:
editingDef?.name ??
slugifyEphemeralMeasureName(displayName, reservedNames),
displayName: displayName.trim(),
expression: expression.trim(),
...(formatPreset !== FormatPreset.HUMANIZE ? { formatPreset } : {}),
};
saveError =
validateEphemeralMeasureDef(def, knownMeasureNames, reservedNames) ??
(editingDef ? undefined : validateEphemeralMeasureCount(defs.length));
if (saveError) return;

function save(def: EphemeralMeasureDef) {
const rawSpecs = currentRawSpecs();
const [spec] = ephemeralDefsToSpecs([def]);
const index = rawSpecs.findIndex((entry) => entry?.name === def.name);
Expand Down Expand Up @@ -159,105 +100,12 @@
}
</script>

<Dialog.Root
open
onOpenChange={(open) => {
if (!open) onClose();
}}
>
<Dialog.Content class="w-[480px] max-h-[90vh] flex flex-col">
<Dialog.Header>
<Dialog.Title>
{editingDef
? m.dashboard_pivot_ephemeral_edit_title()
: m.dashboard_pivot_ephemeral_new_title()}
</Dialog.Title>
</Dialog.Header>

<!-- Body scrolls if the dialog still exceeds the viewport; the small gutter
keeps the inputs' focus ring from being clipped by the overflow. -->
<div class="flex flex-col gap-y-4 min-h-0 overflow-y-auto -mx-1 px-1">
<Input
bind:value={displayName}
id="canvas-ephemeral-measure-name"
label={m.dashboard_pivot_ephemeral_display_name_label()}
placeholder={m.dashboard_pivot_ephemeral_display_name_placeholder()}
claimFocusOnMount
/>

<Input
bind:value={expression}
id="canvas-ephemeral-measure-expression"
label={m.dashboard_pivot_ephemeral_expression_label()}
placeholder={m.dashboard_pivot_ephemeral_expression_placeholder()}
hint={m.dashboard_pivot_ephemeral_expression_hint()}
errors={expressionError}
alwaysShowError
/>

{#if referenceableMeasures.length}
<div class="flex flex-col gap-y-1.5">
<span class="text-xs text-fg-secondary">
{m.dashboard_pivot_ephemeral_insert_measure()}
</span>
<!-- Cap the chip list so dashboards with hundreds of measures scroll
inside the dialog instead of pushing the footer off-screen. -->
<div class="flex flex-wrap gap-1 max-h-40 overflow-y-auto">
{#each referenceableMeasures as mes (mes.name)}
<button
type="button"
on:click={() => insertMeasure(mes.name ?? "")}
>
<Chip type="measure" label={mes.displayName || mes.name}>
<span slot="body" class="text-xs">
{mes.displayName || mes.name}
</span>
</Chip>
</button>
{/each}
</div>
</div>
{/if}

<label class="flex flex-col gap-y-1">
<span class="text-sm font-medium text-fg-primary">
{m.dashboard_pivot_ephemeral_format_label()}
</span>
<select
bind:value={formatPreset}
class="h-8 rounded-sm border bg-surface px-2 text-xs"
>
{#each FORMAT_PRESETS as preset (preset.value)}
<option value={preset.value}>{preset.label}</option>
{/each}
</select>
</label>

{#if saveError}
<p class="text-xs text-destructive">{saveError}</p>
{/if}
</div>

<Dialog.Footer>
{#if editingDef}
<div class="mr-auto">
<Button type="secondary-destructive" onClick={remove}>
{m.common_delete()}
</Button>
</div>
{/if}
<Button type="secondary" onClick={onClose}>
{m.common_cancel()}
</Button>
<Button
type="primary"
disabled={!displayName.trim() ||
!expression.trim() ||
!!expressionError}
onClick={save}
>
{m.dashboard_pivot_ephemeral_save()}
</Button>
</Dialog.Footer>
</Dialog.Content>
</Dialog.Root>
<EphemeralMeasureForm
{editingDef}
metricsView={metricsViewSpec}
{referenceableMeasures}
existingDefs={defs}
onSave={save}
onRemove={editingDef ? remove : undefined}
{onClose}
/>
Loading
Loading