LPD-55983 Add Entity Field Type for filter and serialize the URL with… #4955

RoselaineMarquesMontero · 2025-06-09T16:07:35Z

Add the "Entity Type Field" to the Object "Data Set Selection Filter", this feature also fix the issue when sending the filter param always as String, as we are adding and validating whether this field is not null in the CustomFDSSerializer class, it should not generate any breaking change.

markocikos

@RoselaineMarquesMontero LGTM, but @dsanz should take a look

dsanz

Hi Rose, I think this is mostly ok, just see inline comment as we might need some polishing on the way we generate the value

dsanz · 2025-06-12T08:12:16Z

...urces/META-INF/resources/js/data_set/filters/components/selection_filter/SelectionFilter.tsx


 		if (success) {
 			let formData: any = {
+				entityFieldType: selectedField?.type,


we might need to extend this in order to set the actual entityFieldType value as expected by the FDS. Most likely, this works like that for the case of striung and integers, nevertheless, for arrays and objects we are using collection as the entity type.

We are working on this use case now, for array of String and Integers

dsanz · 2025-06-12T11:05:53Z

Rose told us she plans to send a followup. So no additional review is needed here

RoselaineMarquesMontero · 2025-06-13T10:57:52Z

Hi @dsanz , @markocikos I've finished the changes, could you please review the PR, take into account that this one is to fix the issue sending always String for the OData Query, so we have added the Entity Field Type for Data Set Selection Filter and compatibility with older filters.

RoselaineMarquesMontero · 2025-06-13T11:38:03Z

ci:test:sf

RoselaineMarquesMontero · 2025-06-13T11:39:09Z

ci:test:frontend

dsanz

Rose, thanks for sending this. I believe we should change some logic in the serializer in order to avoid a breaking change. Please take a look to the inline comments and let me know. Best

...mpl/src/main/java/com/liferay/frontend/data/set/internal/serializer/CustomFDSSerializer.java

dsanz · 2025-06-13T15:10:02Z

...mpl/src/main/java/com/liferay/frontend/data/set/internal/serializer/CustomFDSSerializer.java

-
-				return fieldName.substring(0, index);
-			}
+			"id", fieldName


Why this code was removed? Is now object REST api able to filter by a picklist field using parent/child format in the field name and using a non-collection entity type?

We had to add this special case for picklist because object REST api expects the parent field name (as exposed by the REST) even if the value used for comparison is a child field indeed.

dsanz · 2025-06-13T15:22:18Z

...-set/frontend-data-set-admin-web/src/main/resources/META-INF/resources/js/utils/getFields.ts

 				});
 			}

+			field.entityFieldType = type;


Note, this piece of code will make data set manager to store types like 'object' or 'array' as valid values for the entityFieldType field, in addition to the well known string, date or integer

This is fine 👍 . At this level, we don't want to "translate" anything to the FDS domain but just persist information provided by REST openapi metadata.

dsanz · 2025-06-13T15:30:38Z

...mpl/src/main/java/com/liferay/frontend/data/set/internal/serializer/CustomFDSSerializer.java

 			"entityFieldType",
 			() -> {
+				if (Validator.isNotNull(entityFieldType)) {
+					return entityFieldType;


This change represents a breaking change, as follows:

Consider a new filter over a child-leaf field of a root-level field of type object or array (let's imagine they are announced as filterable)

Prior to this change, the method _isCollection() was able to guess the type using the field name.

In case it was considered a collection, we returned FDSEntityFieldTypes.COLLECTION

However, this code now returns literally the field type as coming in the filter object entry, that is, object or array in this example

Another example:

Consider a pre-existing filter (say, created a month ago) over a child-leaf field of a root-level field of type object or array (older versions of Data Set Manager allowed this)

Open the filter in the DSM, then save. This updates entityFieldType in the filter object entry, to object or array

Now, the serializer would send literally the field type as coming in the filter object entry, that is, object or array

Note FDS can't handle these values for entity field type, so odata query would be generated in a different way. This is the breaking change we'd like to avoid.

We can fix it bu translating both object and array field types to FDSEntityFieldTypes.COLLECTION to keep backwards compatibility

dsanz · 2025-06-13T15:35:19Z

...ources/META-INF/resources/management_bar/controls/filters/implementation/SelectionFilter.tsx

-		entityFieldType === EEntityFieldType.STRING
-			? `'${item.value}'`
-			: item.value
+		entityFieldType === EEntityFieldType.INTEGER


👏 this is great, now we don't need to guess.

This logic should be fine for old data sets which have STRING as default entity field type. Also, situation in case of a collection looks fine for the purposes of calculating quotedSelectedItems 👍

RoselaineMarquesMontero · 2025-06-16T07:29:06Z

Hi @dsanz , I've added the changes here, just missing the one to control the name when there is a parent/child, since as I said, I didn't finde any use case, in fact it's breaking now the query if we add it. We can discuss in a call if you want quickly. Thanks a million, Rose

RoselaineMarquesMontero · 2025-06-19T09:19:45Z

ci:test:frontend

… this value in case exist

…r preselected value

…before this extension.

…id breaking change for CX FDS created before this extension.

RoselaineMarquesMontero requested a review from liferay-frontend as a code owner June 9, 2025 16:07

markocikos reviewed Jun 10, 2025

View reviewed changes

dsanz reviewed Jun 12, 2025

View reviewed changes

RoselaineMarquesMontero force-pushed the LPD-55983 branch from 3b326df to ef86b62 Compare June 13, 2025 10:50

dsanz requested changes Jun 13, 2025

View reviewed changes

RoselaineMarquesMontero force-pushed the LPD-55983 branch from 469ecf4 to a43c464 Compare June 24, 2025 10:57

RoselaineMarquesMontero added 7 commits June 24, 2025 13:00

LPD-55983 Add Entity Field Type for filter and serialize the URL with…

cd4e9e8

… this value in case exist

LPD-55983 Add the compatibility for old filters and consider inter fo…

673d311

…r preselected value

LPD-55983 Eliminate duplicity for new Entity Field Type

3117fcb

LPD-55983 Apply formatSource frontend-data-set-sample-web

aea719b

LPD-55983 Add validation to avoid breaking change for CX FDS created …

92de8d1

…before this extension.

LPD-55983 Add compatibility for Array and Object as collection to avo…

3fa4659

…id breaking change for CX FDS created before this extension.

LPD-55983 Add CustomFDSSerializerTest for EntityFieldType

4948d60

RoselaineMarquesMontero force-pushed the LPD-55983 branch from a43c464 to 4948d60 Compare June 24, 2025 11:01

4lejandrito and others added 2 commits June 25, 2025 18:16

LPD-55983 Adding new {picklist}Key field modeled as string

f02267f

LPD-55983 Fill MultiSelectPickList and PickList to OpenAPI as string

d2a1576

markocikos added the ⌛ On hold label Jul 8, 2025

RoselaineMarquesMontero force-pushed the LPD-55983 branch from 38628a4 to d2a1576 Compare August 3, 2025 08:33

LPD-55983 Add Entity Field Type for filter and serialize the URL with… #4955

Are you sure you want to change the base?

LPD-55983 Add Entity Field Type for filter and serialize the URL with… #4955

Uh oh!

Conversation

RoselaineMarquesMontero commented Jun 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markocikos left a comment

Choose a reason for hiding this comment

Uh oh!

dsanz left a comment

Choose a reason for hiding this comment

Uh oh!

dsanz Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

RoselaineMarquesMontero Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

dsanz commented Jun 12, 2025

Uh oh!

RoselaineMarquesMontero commented Jun 13, 2025

Uh oh!

RoselaineMarquesMontero commented Jun 13, 2025

Uh oh!

RoselaineMarquesMontero commented Jun 13, 2025

Uh oh!

dsanz left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dsanz Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

dsanz Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

dsanz Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

dsanz Jun 13, 2025

Choose a reason for hiding this comment

Uh oh!

RoselaineMarquesMontero commented Jun 16, 2025

Uh oh!

RoselaineMarquesMontero commented Jun 19, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

RoselaineMarquesMontero commented Jun 9, 2025 •

edited

Loading