IBX-7172: Fixed Repository Filtering by multiple ObjectStateId criteria

[vidarl]

Question	Answer
JIRA issue	IBX-7172
Type	bug
Target Ibexa version	v3.3
BC breaks	no

If user has policy with limitation on multiple object states, the api call for $locationService->loadLocationChildren($location) creates (eZ\Publish\Core\Persistence\Legacy\Filter\CriterionQueryBuilder\Content\ObjectStateIdQueryBuilder) an incorrect sql for checking the object states.

The sql looks as follows :

SELECT
  DISTINCT COUNT(DISTINCT location.node_id)
FROM
  ezcontentobject_tree location
  INNER JOIN ezcontentobject content ON content.id = location.contentobject_id
  INNER JOIN ezcontentobject_version version ON (
    content.id = version.contentobject_id
  )
  AND (
    content.current_version = version.version
  )
  AND (version.status = :dcValue1)
  INNER JOIN ezcobj_state_link object_state_link ON content.id = object_state_link.contentobject_id
  INNER JOIN ezcontent_language language ON language.id & version.language_mask = language.id
WHERE
  (
    location.parent_node_id IN (:dcValue2)
  )
  AND (
    (
      language.locale IN (:dcValue3)
    )
    OR (version.language_mask & 1 = 1)
  )
  AND (
    (
      content.section_id IN (:dcValue4)
    )
    AND (
      (
        object_state_link.contentobject_state_id IN (:dcValue5)
      )
      AND (
        object_state_link.contentobject_state_id IN (:dcValue6)
      )
    )
  )

Obviously, object_state_link.contentobject_state_id cannot be equal both :dcValue5 and :dcValue6 at the same time.
Instead the objet_state_link table should be joined once for each id and the sql should read:

SELECT
  DISTINCT COUNT(DISTINCT location.node_id)
FROM
  ezcontentobject_tree location
  INNER JOIN ezcontentobject content ON content.id = location.contentobject_id
  INNER JOIN ezcontentobject_version version ON (
    content.id = version.contentobject_id
  )
  AND (
    content.current_version = version.version
  )
  AND (version.status = :dcValue1)
  INNER JOIN ezcobj_state_link object_state_link_1 ON content.id = object_state_link.contentobject_id
  INNER JOIN ezcobj_state_link object_state_link_2 ON content.id = object_state_link.contentobject_id
  INNER JOIN ezcontent_language language ON language.id & version.language_mask = language.id
WHERE
  (
    location.parent_node_id IN (:dcValue2)
  )
  AND (
    (
      language.locale IN (:dcValue3)
    )
    OR (version.language_mask & 1 = 1)
  )
  AND (
    (
      content.section_id IN (:dcValue4)
    )
    AND (
      (
        object_state_link_1.contentobject_state_id IN (:dcValue5)
      )
      AND (
        object_state_link_2.contentobject_state_id IN (:dcValue6)
      )
    )
  )

Checklist:

• Provided PR description.
• Tested the solution manually.
• Provided automated test coverage.
• Checked that target branch is set correctly (master for features, the oldest supported for bugs).
• Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
• Asked for a review (ping @ezsystems/engineering-team).

[alongosz]

Foremost, please add an integration test case showing the issue.

[vidarl]

Foremost, please add an integration test case showing the issue.

Honestly, a bit unsure how you want that test. Didn't find a existing test I could reuse by just adding more fixture. So created a new test in 3271b67

[alongosz]

Looks good, some minor tweaks are needed:

[vidarl]

FYI: Review comments implemented, @Steveb-p , @alongosz

[Steveb-p]

Test looks very good. 👍

[Steveb-p]

Consider it as a non merge blocking comment:

Just a remark - if we will always generate custom table alias for each ObjectStateId criteria, then it would make sense to switch into simpler QueryBuilder::join, which does not contain additional checks against table uniqueness.

[vidarl]

Good point.. Changed joinOnce() into a join()

[sonarcloud]

Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[tomaszszopinski]

QA approved on IbexaDXP 3.3 experience.