Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[ui] Allow freeform schedule/sensor name in launched-by Runs filter #27288

Merged
merged 1 commit into from
Jan 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
52 changes: 40 additions & 12 deletions js_modules/dagster-ui/packages/ui-core/src/runs/RunsFilterInput.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -490,11 +490,11 @@ export const useRunsFilterInput = ({tokens, onChange, enabledFilters}: RunsFilte
matchType: 'any-of',
});

const launchedByFilter = useStaticSetFilter({
const launchedByFilter = useSuggestionFilter({
name: 'Launched by',
allowMultipleSelections: false,
icon: 'add_circle',
allValues: createdByValues,
initialSuggestions: createdByValues,
allowMultipleSelections: false,
renderLabel: ({value}) => {
let icon;
let labelValue = value.value;
Expand Down Expand Up @@ -522,16 +522,38 @@ export const useRunsFilterInput = ({tokens, onChange, enabledFilters}: RunsFilte
return x.value!;
},
state: useMemo(() => {
return new Set(
tokens
.filter(
({token, value}) =>
token === 'tag' && CREATED_BY_TAGS.includes(value.split('=')[0] as DagsterTag),
)
.map(({value}) => tagValueToFilterObject(value)),
);
return tokens
.filter(
({token, value}) =>
token === 'tag' && CREATED_BY_TAGS.includes(value.split('=')[0] as DagsterTag),
)
.map(({value}) => tagValueToFilterObject(value));
}, [tokens]),
onStateChanged: (values) => {
freeformSearchResult(query, suggestionPath) {
if (suggestionPath.length === 0) {
return [
{
value: {
key: `${DagsterTag.ScheduleName}-freeform`,
type: DagsterTag.ScheduleName,
value: query,
},
final: true,
},
{
value: {
key: `${DagsterTag.SensorName}-freeform`,
type: DagsterTag.SensorName,
value: query,
},
final: true,
},
];
}
return null;
},
freeformResultPosition: 'end',
setState: (values) => {
onChange([
...tokens.filter((token) => {
if (token.token !== 'tag') {
Expand All @@ -545,6 +567,12 @@ export const useRunsFilterInput = ({tokens, onChange, enabledFilters}: RunsFilte
})),
]);
},
getKey: ({value}) => value,
isMatch: ({value}, query) => value.toLowerCase().includes(query.toLowerCase()),
matchType: 'any-of',
onSuggestionClicked: async (value) => {
return [{value}];
},
});

const createdDateFilter = useTimeRangeFilter({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import {waitFor} from '@testing-library/dom';
import {act, renderHook} from '@testing-library/react-hooks';
import {renderHook} from '@testing-library/react-hooks';
import {act} from 'react';

import {useSuggestionFilter} from '../useSuggestionFilter';

Expand Down Expand Up @@ -193,4 +194,61 @@ describe('useSuggestionFilter', () => {

expect(result.current.activeJSX).toBeTruthy();
});

it('should correctly handle allowMultipleSelections `false`', () => {
let state: string[] = [''];
const setState = (newState: string[]) => {
state = newState;
};

const {result, rerender} = renderHook(() =>
useSuggestionFilter({...hookArgs, allowMultipleSelections: false, state, setState}),
);

expect(result.current.state).toEqual(['']);

act(() => {
result.current.onSelect({value: {final: true, value: 'apple'}} as any);
});
rerender();

expect(result.current.state).toEqual(['apple']);

act(() => {
result.current.onSelect({value: {final: true, value: 'banana'}} as any);
});
rerender();

// Replaced `apple` with `banana`
expect(result.current.state).toEqual(['banana']);
});

it('should correctly handle freeformResultPosition `end`', () => {
let state: string[] = [''];
const setState = (newState: string[]) => {
state = newState;
};

const freeformSearchResult = (query: string) => ({final: true, value: `Custom: ${query}`});

const {result} = renderHook(() =>
useSuggestionFilter({
...hookArgs,
freeformSearchResult,
freeformResultPosition: 'end',
state,
setState,
}),
);

// Freeform result applied after `apple`
const expectedResult = [
...initialSuggestions.filter(({value}) => isMatch(value, 'ap')),
{final: true, value: 'Custom: ap'},
];

expect(result.current.getResults('ap').map((suggestion) => suggestion.value)).toEqual(
expectedResult,
);
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ type Args<TValue> = {
freeformSearchResult?: (
query: string,
suggestionPath: TValue[],
) => SuggestionFilterSuggestion<TValue> | null;
) => SuggestionFilterSuggestion<TValue> | SuggestionFilterSuggestion<TValue>[] | null;
freeformResultPosition?: 'start' | 'end';

state: TValue[]; // Active suggestions
setState: (state: TValue[]) => void;

allowMultipleSelections?: boolean;
initialSuggestions: SuggestionFilterSuggestion<TValue>[];
getNoSuggestionsPlaceholder?: (query: string) => string;
onSuggestionClicked: (value: TValue) => Promise<SuggestionFilterSuggestion<TValue>[]> | void;
Expand All @@ -45,6 +47,8 @@ export function useSuggestionFilter<TValue>({
state,
setState,
initialSuggestions,
allowMultipleSelections = true,
freeformResultPosition = 'start',
onSuggestionClicked,
getNoSuggestionsPlaceholder,
getStringValue,
Expand Down Expand Up @@ -122,28 +126,42 @@ export function useSuggestionFilter<TValue>({
if (!hasExactMatch && freeformSearchResult && query.length) {
const suggestion = freeformSearchResult(query, suggestionPath);
if (suggestion) {
results.unshift({
label: (
<SuggestionFilterLabel
value={suggestion.value}
renderLabel={renderLabel}
filter={filterObjRef.current}
/>
),
key: getKey?.(suggestion.value) || 'freeform',
value: suggestion,
});
const suggestions = Array.isArray(suggestion) ? suggestion : [suggestion];
const freeformResults =
suggestions
.filter((s): s is SuggestionFilterSuggestion<TValue> => s !== null)
.map((suggestion) => ({
label: (
<SuggestionFilterLabel
value={suggestion.value}
renderLabel={renderLabel}
filter={filterObjRef.current}
/>
),
key: getKey?.(suggestion.value) || 'freeform',
value: suggestion,
})) || [];

if (freeformResultPosition === 'start') {
results.unshift(...freeformResults);
} else {
results.push(...freeformResults);
}
}
}
return results;
},

onSelect: async ({value, clearSearch}) => {
if (value.final) {
if (state.includes(value.value)) {
setState(state.filter((v) => v !== value.value));
if (!allowMultipleSelections) {
const result = state.includes(value.value) ? [] : [value.value];
setState(result);
} else {
setState([...state, value.value]);
const result = state.includes(value.value)
? state.filter((v) => v !== value.value)
: [...state, value.value];
setState(result);
}
} else {
clearSearch();
Expand Down
Loading