[WEB-5804] refactor: decouple filter value types from filter configurations

Open prateekshourya29 opened this issue 1 week ago • 2 comments

Description

Problem

Filter configurations were constrained to a single value type (e.g., TFilterConfig<'priority', TIssuePriorities>), but different operators for the same filter can accept different value types.

Solution

Remove value type parameter from filter configs: TFilterConfig<P, V> → TFilterConfig
Make value types operator-specific rather than filter-specific
Simplify all filter config creators across the codebase
Add forceUpdate parameter to updateConditionValue() for explicit updates

Impact

More accurate type representation
Better flexibility for diverse operator types
Simplified filter configuration APIs
No breaking runtime changes

Files Changed

Types: filter-config.ts, operator-configs/*
Filters: priority, state, user, date, cycle, label, module, project
State: enhanced updateConditionValue in filter.ts

Type of Change

[x] Code refactoring

[!NOTE] Refactor rich filter typing

Convert TFilterConfig<P, V> to TFilterConfig and remove TFilterValue generics across config, manager, and factories; move value typing to operator-specific configs (TOperatorSpecificConfigs, TOperatorConfigMap).

Update FilterConfig, FilterConfigManager, and all work-item filter creators (state, priority, user, date, cycle, label, module, project) to new signatures.

Add forceUpdate?: boolean to updateConditionValue() in FilterInstance to allow explicit updates even when values are equal.

Minor UI: replace Calendar with CalendarLayoutIcon for created/updated date filters.

^{Written by Cursor Bugbot for commit ccce43ba3d3bbe863d1e3722eb0df1287efb6946. This will update automatically on new commits. Configure here.}

Summary by CodeRabbit

New Features
- Added an optional parameter to force filter condition reassessment, allowing manual re-evaluation of a filter even when its value hasn't changed.
Updated UI
- Switched the date filter icon used for created/updated date filters to an updated calendar icon.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Dec 23 '25 14:12 prateekshourya29

Linked to Plane Work Item(s)

[WEB-5804] Refactor: Decouple Filter Value Types from Filter Configurations

This comment was auto-generated by Plane

Dec 23 '25 14:12 makeplane[bot]

Walkthrough

This PR removes the generic type parameter V from rich-filter operator and filter config types across the codebase so types use TFilterValue directly. It also adds an optional forceUpdate parameter to FilterInstance.updateConditionValue to allow forcing reassessment even when values are equal.

Changes

Cohort / File(s)	Summary
Filter instance `packages/shared-state/src/store/rich-filters/filter.ts`	Added optional `forceUpdate?: boolean` to `IFilterInstance.updateConditionValue` and implementation `updateConditionValue(..., forceUpdate: boolean = false)`. Equality early-return now guarded by `if (!forceUpdate && isEqual(...)) { return; }`. JSDoc added.
Filter config runtime `packages/shared-state/src/store/rich-filters/config.ts`, `packages/shared-state/src/store/rich-filters/config-manager.ts`	Dropped `V` generic from `IFilterConfig`, `FilterConfig`, `IFilterConfigManager`, and `FilterConfigManager`. Updated constructors, methods, public fields, maps, and internal collections to use `TFilterValue` / non‑generic `TFilterConfig<P>` types.
Type definitions (core & index) `packages/types/src/rich-filters/config/filter-config.ts`, `packages/types/src/rich-filters/operator-configs/core.ts`, `packages/types/src/rich-filters/operator-configs/index.ts`, `packages/types/src/rich-filters/operator-configs/extended.ts`, `packages/types/src/rich-filters/derived/core.ts`	Removed the generic `V extends TFilterValue` from many operator and config type aliases; replaced V-parameterized unions/maps with non-generic equivalents that reference `TFilterValue` directly. Removed unused `TFilterValue` imports where applicable.
Utils — factories & helpers `packages/utils/src/rich-filters/factories/configs/shared.ts`, `packages/utils/src/rich-filters/factories/configs/properties/shared.ts`, `packages/utils/src/rich-filters/factories/configs/properties/shared.ts`	Simplified `createFilterConfig` signature from `<P, V>` to `<P>`. Adjusted `createOperatorConfigEntry` and `getSupportedDateOperators` return types to use non-generic `TOperatorConfigMap` / `TOperatorSpecificConfigs`.
Work-item filters — call sites `packages/utils/src/work-item-filters/configs/filters/*` `packages/utils/src/work-item-filters/configs/filters/cycle.ts`, `.../date.ts`, `.../label.ts`, `.../module.ts`, `.../priority.ts`, `.../project.ts`, `.../state.ts`, `.../user.ts`, `.../shared.ts`	Removed second generic argument on `createFilterConfig` calls (e.g., `createFilterConfig<P, string>` → `createFilterConfig<P>`) across multiple filter builders. Adjusted return types where they referenced operator map generics.
App hook — icons & config typing `apps/web/ce/hooks/work-item-filters/use-work-item-filters-config.tsx`	Replaced `Calendar` with `CalendarLayoutIcon` for some filter icons. Updated exported `TWorkItemFiltersConfig` shape to use `TFilterConfig<TWorkItemFilterProperty>[]` and `configMap` entries to `TFilterConfig<TWorkItemFilterProperty>` (dropped `TFilterValue` generic).

Sequence Diagram(s)

(omitted — changes are type-level and a small update to a single-method behavior; conditions for sequence diagrams not met)

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~50 minutes

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the main change: decoupling filter value types from configurations, directly aligned with the PR's core objective.
Description check	✅ Passed	The description includes the template's required sections: a detailed problem statement, solution approach, impact analysis, and explicitly marks this as a code refactoring, meeting all template requirements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

[ ] 📝 Generate docstrings

🧪 Generate unit tests (beta)

[ ] Create PR with unit tests
[ ] Post copyable unit tests in a comment
[ ] Commit unit tests in branch refactor-filter-types

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 28ebe65b427e2aeb3d2193ca35249b446653deae and ccce43ba3d3bbe863d1e3722eb0df1287efb6946.

📒 Files selected for processing (7)

apps/web/ce/hooks/work-item-filters/use-work-item-filters-config.tsx
packages/shared-state/src/store/rich-filters/config-manager.ts
packages/shared-state/src/store/rich-filters/config.ts
packages/types/src/rich-filters/derived/core.ts
packages/types/src/rich-filters/operator-configs/extended.ts
packages/utils/src/rich-filters/factories/configs/properties/shared.ts
packages/utils/src/work-item-filters/configs/filters/shared.ts

🧰 Additional context used

📓 Path-based instructions (5)

**/*.{ts,tsx,mts,cts}

📄 CodeRabbit inference engine (.github/instructions/typescript.instructions.md)

**/*.{ts,tsx,mts,cts}: Use const type parameters for more precise literal inference in TypeScript 5.0+ Use the satisfies operator to validate types without widening them Leverage inferred type predicates to reduce the need for explicit is return types in filter/check functions Use NoInfer<T> utility to block inference for specific type arguments when they should be determined by other arguments Utilize narrowing in switch(true) blocks for control flow analysis (TypeScript 5.3+) Rely on narrowing from direct boolean comparisons for type guards Trust preserved narrowing in closures when variables aren't modified after the check (TypeScript 5.4+) Use constant indices to narrow object/array properties (TypeScript 5.5+) Use standard ECMAScript decorators (Stage 3) instead of legacy experimentalDecorators Use using declarations for explicit resource management with Disposable pattern instead of manual cleanup (TypeScript 5.2+) Use with { type: "json" } for import attributes; avoid deprecated assert syntax (TypeScript 5.3/5.8+) Use import type explicitly when importing types to ensure they are erased during compilation, respecting verbatimModuleSyntax flag Use .ts, .mts, .cts extensions in import type statements (TypeScript 5.2+) Use import type { Type } from "mod" with { "resolution-mode": "import" } for specific module resolution contexts (TypeScript 5.3+) Use new iterator methods (map, filter, etc.) if targeting modern environments (TypeScript 5.6+) Utilize new Set methods like union, intersection, etc., when available (TypeScript 5.5+) Use Object.groupBy / Map.groupBy standard methods for grouping instead of external libraries (TypeScript 5.4+) Use Promise.withResolvers() for creating promises with exposed resolve/reject functions (TypeScript 5.7+) Use copying array methods (toSorted, toSpliced, with) for immutable array operations (TypeScript 5.2+) Avoid accessing instance fields via super in classes (TypeScript 5....

Files:

packages/types/src/rich-filters/operator-configs/extended.ts
packages/utils/src/rich-filters/factories/configs/properties/shared.ts
packages/shared-state/src/store/rich-filters/config.ts
packages/utils/src/work-item-filters/configs/filters/shared.ts
packages/types/src/rich-filters/derived/core.ts
apps/web/ce/hooks/work-item-filters/use-work-item-filters-config.tsx
packages/shared-state/src/store/rich-filters/config-manager.ts

**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

Enable TypeScript strict mode and ensure all files are fully typed

Files:

packages/types/src/rich-filters/operator-configs/extended.ts
packages/utils/src/rich-filters/factories/configs/properties/shared.ts
packages/shared-state/src/store/rich-filters/config.ts
packages/utils/src/work-item-filters/configs/filters/shared.ts
packages/types/src/rich-filters/derived/core.ts
apps/web/ce/hooks/work-item-filters/use-work-item-filters-config.tsx
packages/shared-state/src/store/rich-filters/config-manager.ts

**/*.{js,jsx,ts,tsx,json,css}

📄 CodeRabbit inference engine (AGENTS.md)

Use Prettier with Tailwind plugin for code formatting, run pnpm fix:format

Files:

packages/types/src/rich-filters/operator-configs/extended.ts
packages/utils/src/rich-filters/factories/configs/properties/shared.ts
packages/shared-state/src/store/rich-filters/config.ts
packages/utils/src/work-item-filters/configs/filters/shared.ts
packages/types/src/rich-filters/derived/core.ts
apps/web/ce/hooks/work-item-filters/use-work-item-filters-config.tsx
packages/shared-state/src/store/rich-filters/config-manager.ts

**/*.{js,jsx,ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

**/*.{js,jsx,ts,tsx}: Use ESLint with shared config across packages, adhering to max warnings limits per package Use camelCase for variable and function names, PascalCase for components and types Use try-catch with proper error types and log errors appropriately

Files:

packages/types/src/rich-filters/operator-configs/extended.ts
packages/utils/src/rich-filters/factories/configs/properties/shared.ts
packages/shared-state/src/store/rich-filters/config.ts
packages/utils/src/work-item-filters/configs/filters/shared.ts
packages/types/src/rich-filters/derived/core.ts
apps/web/ce/hooks/work-item-filters/use-work-item-filters-config.tsx
packages/shared-state/src/store/rich-filters/config-manager.ts

packages/shared-state/**/*.{ts,tsx}

📄 CodeRabbit inference engine (AGENTS.md)

Maintain MobX stores in packages/shared-state using reactive patterns

Files:

packages/shared-state/src/store/rich-filters/config.ts
packages/shared-state/src/store/rich-filters/config-manager.ts

🧠 Learnings (11)

📓 Common learnings

Learnt from: CR
Repo: makeplane/plane PR: 0
File: .github/instructions/typescript.instructions.md:0-0
Timestamp: 2025-11-25T10:18:05.172Z
Learning: Applies to **/*.{ts,tsx,mts,cts} : Leverage inferred type predicates to reduce the need for explicit `is` return types in filter/check functions