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

Adds stale status filtering capability to the asset catalog UI #27886

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export const ASSET_TABLE_DEFINITION_FRAGMENT = gql`
name
}
}
staleStatus
}
`;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import {

import {
ChangeReason,
StaleStatus,
buildAssetGroupSelector,
buildDefinitionTag,
buildRepository,
Expand Down Expand Up @@ -219,6 +220,36 @@ describe('filterAssetDefinition', () => {
expect(filterAssetDefinition(filters, definition)).toBe(true);
});

it('returns false when staleStatus filter does not match definition status', () => {
const filters = {
staleStatuses: [StaleStatus.FRESH],
};
const definition = {
staleStatus: StaleStatus.STALE,
};
expect(filterAssetDefinition(filters, definition)).toBe(false);
});

it('returns true when staleStatus filter matches definition status', () => {
const filters = {
staleStatuses: [StaleStatus.STALE, StaleStatus.FRESH],
};
const definition = {
staleStatus: StaleStatus.STALE,
};
expect(filterAssetDefinition(filters, definition)).toBe(true);
});

it('filters using selectAllFilter: staleStatuses', () => {
const filters: Partial<AssetFilterType> = {
selectAllFilters: ['staleStatuses'],
};
const definition = {
staleStatus: StaleStatus.FRESH,
};
expect(filterAssetDefinition(filters, definition)).toBe(true);
});

(
['changedInBranch', 'kinds', 'groups', 'owners', 'codeLocations', 'tags'] as Array<
keyof AssetFilterBaseType
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import {

import {useAssetGroupSelectorsForAssets} from './AssetGroupSuggest';
import {CloudOSSContext} from '../app/CloudOSSContext';
import {ChangeReason} from '../graphql/types';
import {ChangeReason, StaleStatus} from '../graphql/types';
import {useFilters} from '../ui/BaseFilters';
import {FilterObject} from '../ui/BaseFilters/useFilter';
import {useAssetGroupFilter} from '../ui/Filters/useAssetGroupFilter';
Expand All @@ -16,6 +16,7 @@ import {useChangedFilter} from '../ui/Filters/useChangedFilter';
import {useCodeLocationFilter} from '../ui/Filters/useCodeLocationFilter';
import {useDefinitionTagFilter, useTagsForAssets} from '../ui/Filters/useDefinitionTagFilter';
import {useAssetKindsForAssets, useKindFilter} from '../ui/Filters/useKindFilter';
import {useStaleStatusFilter} from '../ui/Filters/useStaleStatusFilter';
import {WorkspaceContext} from '../workspace/WorkspaceContext/WorkspaceContext';
import {buildRepoAddress} from '../workspace/buildRepoAddress';

Expand Down Expand Up @@ -48,6 +49,7 @@ export function useAssetCatalogFiltering<
setGroups,
setOwners,
setCodeLocations,
setStaleStatuses,
setSelectAllFilters,
} = useAssetDefinitionFilterState({isEnabled});

Expand Down Expand Up @@ -105,8 +107,24 @@ export function useAssetCatalogFiltering<
setCodeLocations,
});

const allStaleStatuses = Object.values(StaleStatus);

const staleStatusFilter = useStaleStatusFilter({
allStaleStatuses,
staleStatuses: filters.selectAllFilters?.includes('staleStatuses')
? Object.values(StaleStatus)
: filters.staleStatuses,
setStaleStatuses,
});

const uiFilters = React.useMemo(() => {
const uiFilters: FilterObject[] = [groupsFilter, kindFilter, ownersFilter, tagsFilter];
const uiFilters: FilterObject[] = [
groupsFilter,
kindFilter,
ownersFilter,
tagsFilter,
staleStatusFilter,
];
if (isBranchDeployment) {
uiFilters.push(changedInBranchFilter);
}
Expand All @@ -123,6 +141,7 @@ export function useAssetCatalogFiltering<
isBranchDeployment,
ownersFilter,
reposFilter,
staleStatusFilter,
tagsFilter,
]);
const components = useFilters({filters: uiFilters});
Expand Down Expand Up @@ -156,6 +175,7 @@ export function useAssetCatalogFiltering<
['groups', filters.groups, allAssetGroupOptions] as const,
['changedInBranch', filters.changedInBranch, Object.values(ChangeReason)] as const,
['codeLocations', filters.codeLocations, allRepos] as const,
['staleStatuses', filters.staleStatuses, Object.values(StaleStatus)] as const,
].forEach(([key, activeItems, allItems]) => {
if (!allItems.length) {
return;
Expand All @@ -181,6 +201,7 @@ export function useAssetCatalogFiltering<
allAssetOwners,
allKinds,
allRepos,
allStaleStatuses,
didWaitAfterLoading,
filters,
loading,
Expand All @@ -203,6 +224,7 @@ export function useAssetCatalogFiltering<
filteredAssetsLoading: false,
kindFilter,
groupsFilter,
staleStatusFilter,
renderFilterButton: components.renderButton,
};
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
AssetOwner,
ChangeReason,
DefinitionTag,
StaleStatus,
} from '../graphql/types';
import {useQueryPersistedState} from '../hooks/useQueryPersistedState';
import {doesFilterArrayMatchValueArray} from '../ui/Filters/doesFilterArrayMatchValueArray';
Expand All @@ -21,7 +22,10 @@ type Nullable<T> = {

export type FilterableAssetDefinition = Nullable<
Partial<
Pick<AssetNode, 'changedReasons' | 'owners' | 'groupName' | 'tags' | 'kinds'> & {
Pick<
AssetNode,
'changedReasons' | 'owners' | 'groupName' | 'tags' | 'kinds' | 'staleStatus'
> & {
repository: Pick<AssetNode['repository'], 'name'> & {
location: Pick<AssetNode['repository']['location'], 'name'>;
};
Expand All @@ -36,6 +40,7 @@ export type AssetFilterBaseType = {
owners: AssetOwner[];
tags: Omit<DefinitionTag, '__typename'>[];
codeLocations: RepoAddress[];
staleStatuses: StaleStatus[];
};

export type AssetFilterType = AssetFilterBaseType & {
Expand All @@ -45,13 +50,23 @@ export type AssetFilterType = AssetFilterBaseType & {
export const useAssetDefinitionFilterState = ({isEnabled = true}: {isEnabled?: boolean}) => {
const [filters, setFilters] = useQueryPersistedState<AssetFilterType>({
encode: isEnabled
? ({groups, kinds, changedInBranch, owners, tags, codeLocations, selectAllFilters}) => ({
? ({
groups,
kinds,
changedInBranch,
owners,
tags,
codeLocations,
staleStatuses,
selectAllFilters,
}) => ({
groups: groups?.length ? JSON.stringify(groups) : undefined,
kinds: kinds?.length ? JSON.stringify(kinds) : undefined,
changedInBranch: changedInBranch?.length ? JSON.stringify(changedInBranch) : undefined,
owners: owners?.length ? JSON.stringify(owners) : undefined,
tags: tags?.length ? JSON.stringify(tags) : undefined,
codeLocations: codeLocations?.length ? JSON.stringify(codeLocations) : undefined,
staleStatuses: staleStatuses?.length ? JSON.stringify(staleStatuses) : undefined,
selectAllFilters: selectAllFilters?.length ? JSON.stringify(selectAllFilters) : undefined,
})
: () => ({}),
Expand All @@ -67,6 +82,7 @@ export const useAssetDefinitionFilterState = ({isEnabled = true}: {isEnabled?: b
buildRepoAddress(repo.name, repo.location),
)
: [],
staleStatuses: qs.staleStatuses && isEnabled ? JSON.parse(qs.staleStatuses) : [],
selectAllFilters: qs.selectAllFilters ? JSON.parse(qs.selectAllFilters) : [],
}),
});
Expand All @@ -83,6 +99,7 @@ export const useAssetDefinitionFilterState = ({isEnabled = true}: {isEnabled?: b
setOwners,
setAssetTags,
setCodeLocations,
setStaleStatuses,
setSelectAllFilters,
} = useMemo(() => {
function makeSetter<T extends keyof AssetFilterType>(field: T) {
Expand All @@ -100,6 +117,7 @@ export const useAssetDefinitionFilterState = ({isEnabled = true}: {isEnabled?: b
setOwners: makeSetter('owners'),
setAssetTags: makeSetter('tags'),
setCodeLocations: makeSetter('codeLocations'),
setStaleStatuses: makeSetter('staleStatuses'),
setSelectAllFilters: makeSetter('selectAllFilters'),
};
}, [setFilters]);
Expand All @@ -114,6 +132,7 @@ export const useAssetDefinitionFilterState = ({isEnabled = true}: {isEnabled?: b
setOwners,
setAssetTags,
setCodeLocations,
setStaleStatuses,
setSelectAllFilters,
};
};
Expand Down Expand Up @@ -234,6 +253,17 @@ export function filterAssetDefinition(
}
}

const isAllStaleStatusSelected = filters.selectAllFilters?.includes('staleStatuses');
if (isAllStaleStatusSelected) {
if (!definition?.staleStatus?.length) {
return false;
}
} else if (filters.staleStatuses?.length) {
if (!definition?.staleStatus || !filters.staleStatuses.includes(definition.staleStatus)) {
return false;
}
}

return true;
}

Expand All @@ -246,6 +276,7 @@ const KEYS: Record<keyof AssetFilterType | 'asset-selection', '1'> = {
codeLocations: '1',
'asset-selection': '1',
selectAllFilters: '1',
staleStatuses: '1',
};
export function getAssetFilterStateQueryString(search: string = location.search) {
const params = new URLSearchParams(search);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
import {Box, Colors} from '@dagster-io/ui-components';
import {useMemo} from 'react';

import {assertUnreachable} from '../../app/Util';
import {StaleStatus} from '../../graphql/types';
import {StaticBaseConfig, useStaticSetFilter} from '../BaseFilters/useStaticSetFilter';

const emptyArray: any[] = [];

export const useStaleStatusFilter = ({
allStaleStatuses = Object.values(StaleStatus),
staleStatuses,
setStaleStatuses,
}: {
allStaleStatuses?: StaleStatus[];
staleStatuses?: null | StaleStatus[];
setStaleStatuses?: null | ((s: StaleStatus[]) => void);
}) => {
return useStaticSetFilter<StaleStatus>({
...BaseConfig,
allValues: useMemo(
() =>
allStaleStatuses.map((value) => ({
value,
match: [getStatusString(value)],
})),
[allStaleStatuses],
),
menuWidth: '300px',
state: staleStatuses ?? emptyArray,
onStateChanged: (values) => {
setStaleStatuses?.(Array.from(values));
},
canSelectAll: true,
});
};

function getStatusString(status: StaleStatus): string {
switch (status) {
case StaleStatus.FRESH:
return 'Fresh';
case StaleStatus.STALE:
return 'Stale';
case StaleStatus.MISSING:
return 'Missing';
default:
return assertUnreachable(status);
}
}

function getStatusColor(status: StaleStatus): string {
switch (status) {
case StaleStatus.FRESH:
return Colors.accentGreen();
case StaleStatus.STALE:
return Colors.accentYellow();
case StaleStatus.MISSING:
return Colors.accentGray();
default:
return assertUnreachable(status);
}
}

export const BaseConfig: StaticBaseConfig<StaleStatus> = {
name: 'Status',
icon: 'status',
renderLabel: ({value}) => (
<Box flex={{direction: 'row', gap: 4, alignItems: 'center'}}>
<span style={{color: getStatusColor(value)}}>●</span>
{getStatusString(value)}
</Box>
),
getStringValue: (status) => getStatusString(status),
getKey: getStatusString,
matchType: 'any-of',
};
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import {BaseConfig as ChangedFilterBaseConfig} from './useChangedFilter';
import {BaseConfig as CodeLocationFilterBaseConfig} from './useCodeLocationFilter';
import {BaseConfig as AssetTagFilterBaseConfig, Tag} from './useDefinitionTagFilter';
import {BaseConfig as KindFilterBaseConfig} from './useKindFilter';
import {AssetGroupSelector, AssetOwner, ChangeReason} from '../../graphql/types';
import {BaseConfig as StaleStatusFilterBaseConfig} from './useStaleStatusFilter';
import {AssetGroupSelector, AssetOwner, ChangeReason, StaleStatus} from '../../graphql/types';
import {RepoAddress} from '../../workspace/types';
import {StaticBaseConfig} from '../BaseFilters/useStaticSetFilter';

Expand All @@ -15,11 +16,13 @@ export const STATIC_FILTER_CONFIGS: {
owners: StaticBaseConfig<AssetOwner>;
tags: StaticBaseConfig<Tag>;
codeLocations: StaticBaseConfig<RepoAddress>;
staleStatuses: StaticBaseConfig<StaleStatus>;
} = {
groups: AssetGroupsFilterBaseConfig,
kinds: KindFilterBaseConfig,
changedInBranch: ChangedFilterBaseConfig,
owners: AssetOwnerFilterBaseConfig,
tags: AssetTagFilterBaseConfig,
codeLocations: CodeLocationFilterBaseConfig,
staleStatuses: StaleStatusFilterBaseConfig,
};
Loading