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

feat: 'Only Mine' toggle for execution tasks list #343

Merged
merged 1 commit into from
Mar 23, 2022
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
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@
"@storybook/testing-library": "^0.0.9",
"@testing-library/jest-dom": "^5.5.0",
"@testing-library/react": "^10.0.3",
"@testing-library/react-hooks": "^7.0.2",
"@types/cheerio": "^0.22.2",
"@types/compression-webpack-plugin": "^9.1.1",
"@types/d3-shape": "^1.2.6",
Expand Down
12 changes: 5 additions & 7 deletions src/components/Entities/EntityExecutions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import * as React from 'react';
import { Typography } from '@material-ui/core';
import { makeStyles, Theme } from '@material-ui/core/styles';
import { contentMarginGridUnits } from 'common/layout';
import { fetchStates } from 'components/hooks/types';
import { WaitForData } from 'components/common/WaitForData';
import { ExecutionFilters } from 'components/Executions/ExecutionFilters';
import { useExecutionShowArchivedState } from 'components/Executions/filters/useExecutionArchiveState';
Expand All @@ -14,6 +13,7 @@ import { SortDirection } from 'models/AdminEntity/types';
import { ResourceIdentifier } from 'models/Common/types';
import { executionSortFields } from 'models/Execution/constants';
import { compact } from 'lodash';
import { useOnlyMyExecutionsFilterState } from 'components/Executions/filters/useOnlyMyExecutionsFilterState';
import { executionFilterGenerator } from './generators';

const useStyles = makeStyles((theme: Theme) => ({
Expand Down Expand Up @@ -42,6 +42,7 @@ export const EntityExecutions: React.FC<EntityExecutionsProps> = ({
const styles = useStyles();
const filtersState = useWorkflowExecutionFiltersState();
const archivedFilter = useExecutionShowArchivedState();
const onlyMyExecutionsFilterState = useOnlyMyExecutionsFilterState({});

const sort = {
key: executionSortFields.createdAt,
Expand All @@ -57,7 +58,9 @@ export const EntityExecutions: React.FC<EntityExecutionsProps> = ({
...baseFilters,
...filtersState.appliedFilters,
archivedFilter.getFilter(),
onlyMyExecutionsFilterState.getFilter(),
]);

const executions = useWorkflowExecutions(
{ domain, project },
{
Expand All @@ -71,12 +74,6 @@ export const EntityExecutions: React.FC<EntityExecutionsProps> = ({
executions.value = executions.value.filter((item) => chartIds.includes(item.id.name));
}

/** Don't render component until finish fetching user profile */
const lastIndex = filtersState.filters.length - 1;
if (filtersState.filters[lastIndex].status !== fetchStates.LOADED) {
return null;
}

return (
<>
<Typography className={styles.header} variant="h6">
Expand All @@ -89,6 +86,7 @@ export const EntityExecutions: React.FC<EntityExecutionsProps> = ({
clearCharts={clearCharts}
showArchived={archivedFilter.showArchived}
onArchiveFilterChange={archivedFilter.setShowArchived}
onlyMyExecutionsFilterState={onlyMyExecutionsFilterState}
/>
</div>
<WaitForData {...executions}>
Expand Down
6 changes: 0 additions & 6 deletions src/components/Entities/EntityExecutionsBarChart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,6 @@ export const EntityExecutionsBarChart: React.FC<EntityExecutionsBarChartProps> =
[onToggle],
);

/** Don't render component until finish fetching user profile */
const lastIndex = filtersState.filters.length - 1;
if (filtersState.filters[lastIndex].status !== fetchStates.LOADED) {
return null;
}

return (
<WaitForData {...executions}>
<Typography className={styles.header} variant="h6">
Expand Down
50 changes: 42 additions & 8 deletions src/components/Executions/ExecutionFilters.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,21 @@ const useStyles = makeStyles((theme: Theme) => ({
},
}));

interface OnlyMyExecutionsFilterState {
onlyMyExecutionsValue: boolean;
isFilterDisabled: boolean;
onOnlyMyExecutionsFilterChange: (filterOnlyMyExecutions: boolean) => void;
}

export interface ExecutionFiltersProps {
filters: (FilterState | BooleanFilterState)[];
chartIds?: string[];
clearCharts?: () => void;
showArchived?: boolean;
onArchiveFilterChange?: (showArchievedItems: boolean) => void;
onlyMyExecutionsFilterState?: OnlyMyExecutionsFilterState;
}

const RenderFilter: React.FC<{ filter: FilterState }> = ({ filter }) => {
const searchFilterState = filter as SearchFilterState;
switch (filter.type) {
Expand All @@ -51,13 +66,14 @@ const RenderFilter: React.FC<{ filter: FilterState }> = ({ filter }) => {
* This allows for the consuming code to have direct access to the
* current filters without relying on complicated callback arrangements
*/
export const ExecutionFilters: React.FC<{
filters: (FilterState | BooleanFilterState)[];
chartIds?: string[];
clearCharts?: () => void;
showArchived?: boolean;
onArchiveFilterChange?: (showArchievedItems: boolean) => void;
}> = ({ filters, chartIds, clearCharts, showArchived, onArchiveFilterChange }) => {
export const ExecutionFilters: React.FC<ExecutionFiltersProps> = ({
filters,
chartIds,
clearCharts,
showArchived,
onArchiveFilterChange,
onlyMyExecutionsFilterState,
}) => {
const styles = useStyles();

filters = filters.map((filter) => {
Expand Down Expand Up @@ -111,14 +127,32 @@ export const ExecutionFilters: React.FC<{
buttonText="Clear Manually Selected Executions"
onReset={clearCharts}
key="charts"
data-testId="clear-charts"
/>
)}
{!!onlyMyExecutionsFilterState && (
<FormGroup>
<FormControlLabel
control={
<Checkbox
checked={onlyMyExecutionsFilterState.onlyMyExecutionsValue}
disabled={onlyMyExecutionsFilterState.isFilterDisabled}
onChange={(_, checked) =>
onlyMyExecutionsFilterState.onOnlyMyExecutionsFilterChange(checked)
}
/>
}
className={styles.checkbox}
label="Only my executions"
/>
</FormGroup>
)}
{!!onArchiveFilterChange && (
<FormGroup>
<FormControlLabel
control={
<Checkbox
value={showArchived}
checked={showArchived}
onChange={(_, checked) => onArchiveFilterChange(checked)}
/>
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ stories.add('Workflow executions - all', () => (
clearCharts={action('clearCharts')}
showArchived={false}
onArchiveFilterChange={action('onArchiveFilterChange')}
onlyMyExecutionsFilterState={{
isFilterDisabled: false,
onlyMyExecutionsValue: false,
onOnlyMyExecutionsFilterChange: action('onOnlyMyExecutionsFilterChange'),
}}
/>
));
stories.add('Workflow executions - minimal', () => (
Expand Down
2 changes: 0 additions & 2 deletions src/components/Executions/filters/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,8 @@ export type FilterStateType = 'single' | 'multi' | 'search' | 'boolean';
export interface FilterState {
active: boolean;
button: FilterButtonState;
hidden?: boolean;
label: string;
type: FilterStateType;
status?: string;
getFilter: () => FilterOperation[];
onReset: () => void;
onChange?: (value) => void;
Expand Down
46 changes: 0 additions & 46 deletions src/components/Executions/filters/useCurrentUserOnlyFilterState.ts

This file was deleted.

2 changes: 0 additions & 2 deletions src/components/Executions/filters/useExecutionFiltersState.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ import { FilterState } from './types';
import { useMultiFilterState } from './useMultiFilterState';
import { useSearchFilterState } from './useSearchFilterState';
import { useSingleFilterState } from './useSingleFilterState';
import { useCurrentUserOnlyFilterState } from './useCurrentUserOnlyFilterState';

export interface ExecutionFiltersState {
appliedFilters: FilterOperation[];
Expand Down Expand Up @@ -57,7 +56,6 @@ export function useWorkflowExecutionFiltersState() {
label: filterLabels.duration,
queryStateKey: 'duration',
}),
useCurrentUserOnlyFilterState(),
]);
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { useState } from 'react';
import { FilterOperation, FilterOperationName } from 'models/AdminEntity/types';
import { useUserProfile } from 'components/hooks/useUserProfile';

interface OnlyMyExecutionsFilterState {
onlyMyExecutionsValue: boolean;
isFilterDisabled: boolean;
onOnlyMyExecutionsFilterChange: (newValue: boolean) => void;
getFilter: () => FilterOperation | null;
}

interface OnlyMyExecutionsFilterStateProps {
isFilterDisabled?: boolean;
initialValue?: boolean;
}

/**
* Allows to filter executions by Current User Id
*/
export function useOnlyMyExecutionsFilterState({
isFilterDisabled,
initialValue,
}: OnlyMyExecutionsFilterStateProps): OnlyMyExecutionsFilterState {
const profile = useUserProfile();
const userId = profile.value?.subject ? profile.value.subject : '';
const [onlyMyExecutionsValue, setOnlyMyExecutionsValue] = useState<boolean>(
initialValue ?? false,
);

const getFilter = (): FilterOperation | null => {
if (!onlyMyExecutionsValue) {
return null;
}

return {
key: 'user',
value: userId,
operation: FilterOperationName.EQ,
};
};

return {
onlyMyExecutionsValue,
isFilterDisabled: isFilterDisabled ?? false,
onOnlyMyExecutionsFilterChange: setOnlyMyExecutionsValue,
getFilter,
};
}
Loading