feat: Introduce Value Types for Context Fields #10026

ivarconr · 2025-05-23T12:14:17Z

(Warning: This entire PR was implemented with Copilot Agent with Gemini 2.5 Pro model.)

feat: Introduce Value Types for Context Fields

This PR introduces the ability to define a specific valueType for context fields in Unleash. This enhancement allows the UI to display only relevant operators for a selected context field, improving user experience and reducing potential configuration errors.

Problem

Previously, all operators were available for every context field, regardless of the field's intended data type. This could lead to confusion and the selection of incompatible operators (e.g., using a string operator on a date field).

Solution

We've added a new optional valueType property to context fields, which can be one of "String", "Number", "Semver", or "Date".

When a valueType is defined for a context field, the UI (specifically in constraint creation/editing) will now only show operators that are compatible with that type.
For backward compatibility, if valueType is not set (i.e., null or undefined), all operators will continue to be available for that context field.
The backend validates the valueType upon creation of new context fields.

Key Changes

1. Database

-   Added a new `value_type` column (TEXT, DEFAULT NULL) to the `context_fields` table via a database migration (`20250523100000-add-value-type-to-context-fields.js`).

2. Backend (`src/lib`)

-   Updated OpenAPI schemas (`create-context-field-schema.ts`, `context-field-schema.ts`) to include the new `valueType` field (string, nullable, enum: 'String', 'Number', 'Semver', 'Date').
-   Modified `IContextFieldDto` and `IContextField` in `context-field-store-type.ts` to include `value_type`.
-   Updated `context-field-store.ts` to handle the `value_type` column in database operations and map it to `valueType` in the DTO.
-   The `context.ts` controller now handles the mapping between the API's `valueType` and the service/DB's `value_type`, and includes validation for `valueType` during context field creation.

3. Frontend Core Logic (`frontend/src`)

-   Introduced `ContextFieldType` (enum-like object) and a helper function `getOperatorsForContextFieldType` in `constants/operators.ts` to define and retrieve type-specific operators.
-   Added `valueType` to the `IUnleashContextDefinition` interface in `interfaces/context.ts`.
-   Exported `getContextField` from `utils/operatorsForContext.ts` for easier access to context field definitions.

4. Frontend UI & State Management (`frontend/src/component`)

Context Field Forms:
- useContextForm.ts: Added valueType to the form state, initialization logic, and included it in the submission payload.
- ContextForm.tsx: Added a Select dropdown for choosing the valueType when creating or editing a context field.
- CreateUnleashContext.tsx & EditContext.tsx: Updated to pass valueType and its setter to the ContextForm.
Operator Filtering in Constraints:
- ConstraintOperatorSelect.tsx (in common/NewConstraintAccordion and feature/FeatureStrategy): Modified to accept a contextFieldType prop and filter the displayed operators using getOperatorsForContextFieldType.
- ProjectActionsFilterItem.tsx: Fetches the context definition to determine and pass the contextFieldType to the operator select.
- EditableConstraint.tsx:
  - Determines the contextFieldType of the selected context field.
  - Passes contextFieldType and allOperators to its ConstraintOperatorSelect component.
- constraint-reducer.ts (in useEditableConstraint):
  - Updated the 'set context field' action payload to include valueType.
  - When a context field is changed, it now selects the first appropriate operator based on the new field's valueType.
  - Improved handling for the currentTime context field and transitions to/from date-type fields to ensure appropriate date operators are selected.
Context List Display:
- ContextList.tsx: Updated to display the valueType of each context field in the list.

Commits

The changes were implemented across two commits:

feat: Add value_type to context_fields table (Database migration)
feat: Implement context field value types (Backend and frontend implementation)

This feature aims to make strategy constraint configuration more intuitive and robust.

Images of the new feature in action:

CRUD context fields with new valueType option:

Use with a feature flag:

vercel · 2025-05-23T12:14:22Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
unleash-docs	⬜️ Ignored (Inspect)	Visit Preview		May 26, 2025 1:54pm

github-actions · 2025-05-23T12:14:33Z

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

Copilot

Pull Request Overview

This PR adds a new valueType property to context fields to restrict operators based on the field’s type, improving UI behavior and reducing configuration errors. Key changes include:

Database migration and backend adjustments to support a new value_type column.
Frontend modifications adding a dropdown for selecting a context field’s valueType and updating operator filtering.
Updates to types, schemas, and reducer logic to map and propagate the new valueType.

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated 2 comments.

File	Description
src/lib/openapi/spec/context-field-schema.ts	Added a new valueType property in the OpenAPI schema.
src/lib/features/context/context.ts	Updated controller logic to map and validate valueType.
src/lib/features/context/context-field-store.ts and context-field-store-type.ts	Added valueType support in DB row mapping and type definitions.
frontend/src/*	Updated utilities, interfaces, and UI components (forms, constraint selectors, etc.) to include valueType and filter operators accordingly.

src/lib/openapi/spec/context-field-schema.ts

frontend/src/component/common/NewConstraintAccordion/ConstraintOperatorSelect.tsx

coveralls · 2025-05-23T12:23:28Z

coverage: 91.239%. first build
when pulling 87d509c on feat/context-value-type
into e52fcd1 on main.

ivarconr · 2025-05-23T12:25:17Z

src/lib/openapi/spec/context-field-schema.ts

@@ -57,11 +57,20 @@ export const contextFieldSchema = {
        },
        legalValues: {
            description:
-                'Allowed values for this context field schema. Can be used to narrow down accepted input',
+                'Allowed values for this context field. Can be used to extend the context field schema',


this change seems unrelated.

gastonfournier

One thing that I notice is that it may inadvertedly break backward compatibility. I think with these agents it becomes more relevant to have better guardrails and tests.

Maybe if it does a lint:fix at the end would output PRs in better shape

...dion/ConstraintAccordionEdit/ConstraintAccordionEditHeader/ConstraintAccordionEditHeader.tsx

gastonfournier · 2025-05-23T12:55:19Z

frontend/src/component/context/ContextForm/ContextForm.tsx

+                            Do you want to define a set of legal values for this
+                            context field? (optional)


Some of these improvements are impressive, making the UX clearer and more usable. Perhaps some UI dimension has to be adapted, but I'm sure the agent made this decision.

gastonfournier · 2025-05-23T12:56:56Z

frontend/src/component/context/ContextForm/ContextForm.tsx

+                <Typography variant='body2' sx={{ mb: 1 }}>
+                    Do you want this context field to be sticky? (optional)
+                </Typography>


Here, on the other hand, it got rid of the stickiness explanation and also modified the switch by removing the on/off label

I have no clue why it changed this tbh. Seems like it was too eager. I will ask it to redo this.

...gy/FeatureStrategyConstraints/EditableConstraint/useEditableConstraint/constraint-reducer.ts

src/lib/features/context/context.ts

feat: Add value_type to context_fields table

1ea6f7a

ivarconr requested a review from Copilot May 23, 2025 12:14

github-project-automation bot added this to Issues and PRs May 23, 2025

github-project-automation bot moved this to New in Issues and PRs May 23, 2025

github-actions bot assigned ivarconr May 23, 2025

Copilot AI reviewed May 23, 2025

View reviewed changes

src/lib/openapi/spec/context-field-schema.ts Show resolved Hide resolved

frontend/src/component/common/NewConstraintAccordion/ConstraintOperatorSelect.tsx Outdated Show resolved Hide resolved

ivarconr commented May 23, 2025

View reviewed changes

gastonfournier reviewed May 23, 2025

View reviewed changes

ivarconr force-pushed the feat/context-value-type branch from 62c52d4 to 8ab0f30 Compare May 26, 2025 09:22

ivarconr added 2 commits May 26, 2025 11:34

feat: Implement context field value types

edefd97

fix: minor cleanup on operator selector

b2757e9

ivarconr force-pushed the feat/context-value-type branch from 8ab0f30 to b2757e9 Compare May 26, 2025 11:04

ivarconr added 5 commits May 26, 2025 13:09

fix: simplify the API controller

17d7e33

fix: Add test scenarios

60884b0

fix: Do not allow valueType to change for context fields

659e13e

fix: cleanup the constraint-reducer and fix tests

a36271a

fix: ts check

87d509c

chriswk moved this from New to Todo in Issues and PRs May 27, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: Introduce Value Types for Context Fields #10026

feat: Introduce Value Types for Context Fields #10026

Uh oh!

ivarconr commented May 23, 2025 •

edited

Loading

Uh oh!

vercel bot commented May 23, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 23, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

coveralls commented May 23, 2025 •

edited

Loading

Uh oh!

ivarconr May 23, 2025

Uh oh!

gastonfournier left a comment

Uh oh!

Uh oh!

gastonfournier May 23, 2025

Uh oh!

gastonfournier May 23, 2025

Uh oh!

ivarconr May 26, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

		Do you want to define a set of legal values for this
		context field? (optional)

Uh oh!

feat: Introduce Value Types for Context Fields #10026

Are you sure you want to change the base?

feat: Introduce Value Types for Context Fields #10026

Uh oh!

Conversation

ivarconr commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

feat: Introduce Value Types for Context Fields

Problem

Solution

Key Changes

1. Database

2. Backend (src/lib)

3. Frontend Core Logic (frontend/src)

4. Frontend UI & State Management (frontend/src/component)

Commits

Images of the new feature in action:

Uh oh!

vercel bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Dependency Review

Scanned Files

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

coveralls commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ivarconr May 23, 2025

Choose a reason for hiding this comment

Uh oh!

gastonfournier left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

gastonfournier May 23, 2025

Choose a reason for hiding this comment

Uh oh!

gastonfournier May 23, 2025

Choose a reason for hiding this comment

Uh oh!

ivarconr May 26, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ivarconr commented May 23, 2025 •

edited

Loading

2. Backend (`src/lib`)

3. Frontend Core Logic (`frontend/src`)

4. Frontend UI & State Management (`frontend/src/component`)

vercel bot commented May 23, 2025 •

edited

Loading

github-actions bot commented May 23, 2025 •

edited

Loading

coveralls commented May 23, 2025 •

edited

Loading