IBX-9840: Implemented service fetching content fields from expression and validating if field is within expression #1500

barw4 · 2025-03-14T13:16:28Z

🎫 Issue	IBX-9840

Description:

The parser will parse the following expressions:

expr         ::= (<group> '/')? <content_type> '/' <field> 
group        ::= id | '{' <id> (',' <id>)* '}'
content_type ::= id | '{' <id> (',' <id>)* '}' | '*'
field        ::= id | '{' <id> (',' <id>)* '}'

and fetch asked field definitions, then provide an output in the form of a list that consists of field definition ids.

Example of usage:

$extractedFieldIds = $this->contentTypeFieldsExtractor->extractFieldsFromExpression('{Media,Content}/*/name');

will result in:

.array:2 [
  0 => 8
  1 => 9
]

There is also a possibility to check whether a FieldDefinition is within a given expression. The API reference is as follows:

`ContentTypeFieldsByExpressionServiceInterface` service:

interface ContentTypeFieldsByExpressionServiceInterface
{
    /**
     * @return list<\Ibexa\Contracts\Core\Repository\Values\ContentType\FieldDefinition>
     *
     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
     */
    public function getFieldsFromExpression(string $expression): array;

    /**
     * @throws \Ibexa\Contracts\Core\Repository\Exceptions\NotFoundException
     */
    public function isFieldIncludedInExpression(FieldDefinition $fieldDefinition, string $expression): bool;
}

For QA:

Documentation:

sonarqubecloud · 2025-03-14T13:17:35Z

Quality Gate passed

Issues
10 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

mikadamczyk

Do we need to expose a method to validate an expression? Will it be possible to edit it by hand?

src/bundle/Resources/config/services/services.yaml

mikadamczyk · 2025-07-31T09:09:16Z

src/lib/Util/ContentTypeFieldsExpressionParser.php

+                $this->expectSlash();
+                $fieldTokens = $this->parseSection();
+            } else {
+                throw new RuntimeException('Invalid expression, expected one or two T_SLASH delimiters.');


WDYT about throwing a dedicated exception, like SyntaxError/Exception? And what about catching it, should it be in service or by client code? T_SLASH or "/" like here https://github.com/ibexa/admin-ui/pull/1500/files#diff-74127d24456a18e891c75260b495952ea2359a27853f3bea40933252aa41f3ffR133?

I've added the Ibexa\AdminUi\Exception\FieldTypeExpressionParserException and imo it should be catched by client code to throw 4xx (when there is one)

mikadamczyk · 2025-07-31T09:17:55Z

src/lib/Util/ContentTypeFieldsExtractor.php

+
+        $contentTypes = $this->resolveContentTypes($extractedMetadata);
+
+        return $this->mergeFieldIds($extractedMetadata[2], $contentTypes);


Instead of fetching by indexes, is it worth creating a structure for metadata?

Do you mean by that that public function parseExpression(string $expression): array should give us some kind of structured object instead?

yes, like ExpresionMetadata or sth

please see a5bbca7

src/lib/Util/ContentTypeFieldsExtractor.php

sonarqubecloud · 2025-07-31T22:29:57Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

mikadamczyk

Could you add tests for:

leading slash
trailing slash
empty {} lists
missing closing brace

mikadamczyk · 2025-10-15T08:37:37Z

src/lib/Util/ContentTypeFieldsExtractor.php

+            );
+        }
+
+        return $finalFieldIds;


Is it possible to have duplicated IDs because of overlapping content types?

Not anymore, please see 14228d3

src/lib/Util/ContentTypeFieldsExpressionParserInterface.php

Steveb-p

I would like to have a more specific description of what the intended use for this feature is. I know what it does (or have a rough idea), but I don't get how it will be utilized?

tests/integration/Util/ContentTypeFieldsExtractorTest.php

barw4 · 2025-10-15T12:43:54Z

I would like to have a more specific description of what the intended use for this feature is. I know what it does (or have a rough idea), but I don't get how it will be utilized?

@Steveb-p it's used in selection of fields in taxonomy suggestions AI action config: https://www.figma.com/design/WkIyhysX3ZGSRwwxnPcFXE/-AI-Features--AI?node-id=9016-163408&t=oh4c1TG5zkMCmlFJ-0

Steveb-p · 2025-10-15T12:46:00Z

@barw4 these?

barw4 · 2025-10-15T12:48:11Z

@Steveb-p yes, the ones at the bottom. Content Type Group can have "All" option selected - meaning we will store "*" in the db or just identifiers, and so on and so on

Steveb-p · 2025-10-15T12:55:56Z

Why are we building a full expression syntax if all we need is to store values selected in those forms?

I don't intend to discard this work, but from my perspective it's very specific "language" (3 elements separated by / with multiple elements wrapped using { and } + * as wildcard), while all that would be needed is to... store JSON value?

You could even use Serializer if you want to transform value back and forth.

This feels overengineered to be honest. Adds complexity, limitations to this construct (certain symbols can't be used) and hides the structure behind expression. I am sorry, but in my opinion it should not be merged 😞

barw4 · 2025-10-16T12:24:06Z

Could you add tests for:

leading slash

trailing slash

empty {} lists

missing closing brace

@mikadamczyk I've added few test cases inside the dataProviderForTestParseInvalidExpressions, some were already there like trailing/leading slashes

…ssion

…sion

sonarqubecloud · 2025-10-16T14:02:32Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

barw4 added Feature New feature request Work in progress labels Mar 14, 2025

barw4 self-assigned this Mar 14, 2025

github-actions bot assigned ciastektk, mikadamczyk and ViniTou Mar 14, 2025

barw4 changed the title ~~IBX-9631: Implement parser fetching content fields from expression~~ [WIP]IBX-9631: Implement parser fetching content fields from expression Mar 14, 2025

barw4 changed the title ~~[WIP]IBX-9631: Implement parser fetching content fields from expression~~ IBX-9631: Implement parser fetching content fields from expression and validating if field is within expression Jul 30, 2025

barw4 added Ready for review and removed Work in progress labels Jul 30, 2025

barw4 force-pushed the ibx-9631-taxonomy-suggestions-source-parser branch from 0da192d to 78947c5 Compare July 30, 2025 11:45

barw4 marked this pull request as ready for review July 30, 2025 11:45

barw4 requested a review from a team July 30, 2025 11:47

ezrobot requested review from Steveb-p, ViniTou, adamwojs, alongosz, ciastektk, konradoboza, mikadamczyk, tbialcz and wiewiurdp and removed request for a team July 30, 2025 11:48

barw4 changed the title ~~IBX-9631: Implement parser fetching content fields from expression and validating if field is within expression~~ IBX-9840: Implement parser fetching content fields from expression and validating if field is within expression Jul 30, 2025

barw4 changed the title ~~IBX-9840: Implement parser fetching content fields from expression and validating if field is within expression~~ IBX-9840: Implement service fetching content fields from expression and validating if field is within expression Jul 30, 2025

mikadamczyk reviewed Jul 31, 2025

View reviewed changes

barw4 force-pushed the ibx-9631-taxonomy-suggestions-source-parser branch from 7079418 to 0e1b4d7 Compare July 31, 2025 11:27

barw4 requested a review from mikadamczyk July 31, 2025 11:31

barw4 changed the title ~~IBX-9840: Implement service fetching content fields from expression and validating if field is within expression~~ IBX-9840: Implemented service fetching content fields from expression and validating if field is within expression Jul 31, 2025

barw4 force-pushed the ibx-9631-taxonomy-suggestions-source-parser branch from a5bbca7 to 3cf3ce8 Compare October 8, 2025 08:28

mikadamczyk approved these changes Oct 15, 2025

View reviewed changes

ViniTou approved these changes Oct 15, 2025

View reviewed changes

Steveb-p reviewed Oct 15, 2025

View reviewed changes

tests/integration/Util/ContentTypeFieldsExtractorTest.php Outdated Show resolved Hide resolved

tests/integration/Util/ContentTypeFieldsExtractorTest.php Outdated Show resolved Hide resolved

barw4 force-pushed the ibx-9631-taxonomy-suggestions-source-parser branch from 14228d3 to 4fe64dd Compare October 16, 2025 12:24

barw4 added 6 commits October 16, 2025 16:01

IBX-9631: Implement parser fetching content fields from regular expre…

0ad2e83

…ssion

IBX-9631: Added method validating if field def id is within an expres…

cb2d026

…sion

IBX-9631: Applied review remarks

fa2c4a6

IBX-9631: Namespaces

989b72c

IBX-9631: Used a better structure for parsed metadata

83b094d

Review remarks

eb30ab2

barw4 force-pushed the ibx-9631-taxonomy-suggestions-source-parser branch from 4fe64dd to eb30ab2 Compare October 16, 2025 14:01

mikadamczyk merged commit de085b4 into 4.6 Oct 17, 2025
28 checks passed

mikadamczyk deleted the ibx-9631-taxonomy-suggestions-source-parser branch October 17, 2025 10:41


		$contentTypes = $this->resolveContentTypes($extractedMetadata);

		return $this->mergeFieldIds($extractedMetadata[2], $contentTypes);

IBX-9840: Implemented service fetching content fields from expression and validating if field is within expression #1500

IBX-9840: Implemented service fetching content fields from expression and validating if field is within expression #1500

Uh oh!

Conversation

barw4 commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description:

ContentTypeFieldsByExpressionServiceInterface service:

For QA:

Documentation:

Uh oh!

sonarqubecloud bot commented Mar 14, 2025

Quality Gate passed

Uh oh!

mikadamczyk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Jul 31, 2025

Quality Gate passed

Uh oh!

mikadamczyk left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Steveb-p left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

barw4 commented Oct 15, 2025

Uh oh!

Steveb-p commented Oct 15, 2025

Uh oh!

barw4 commented Oct 15, 2025

Uh oh!

Steveb-p commented Oct 15, 2025

Uh oh!

barw4 commented Oct 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Oct 16, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

barw4 commented Mar 14, 2025 •

edited

Loading

`ContentTypeFieldsByExpressionServiceInterface` service:

barw4 commented Oct 16, 2025 •

edited

Loading