RFI: Reasoning behind not being able to whitelist the path containing the reference

[royteeuwen]

In our project we have proxies / extensions of AEM Forms components. Sadly enough it seems that AEM Forms content classification is not properly setup, they reference INTERNAL things in their open-source core components that you want to proxy, e.g.:

https://github.com/adobe/aem-core-forms-components/blob/master/ui.af.apps/src/main/content/jcr_root/apps/core/fd/components/form/base/v1/base/_cq_dialog/.content.xml#L361

[ERROR] ValidationViolation: Element with name "optionsBindRef" references resource 'fd/af/authoring/components/granite/form/bindrefselector' which is marked as 'granite:InternalArea'. It therefore violates the content classification! @ jcr_root/apps/adaptive-forms/core/fd/components/form/dropdown/_cq_dialog/.content.xml, line 48, column 78, validator: netcentric-aem-classification, JCR node path: /apps/adaptive-forms/core/fd/components/form/dropdown/cq:dialog/content/items/tabs/items/basic/items/columns/items/column/items/optionsBindRef

I was trying to ignore this in the plugin by doing

<whitelistedResourcePathPatterns>/apps/adaptive-forms/core/fd/components/form/.*</whitelistedResourcePathPatterns>

But it seems I have to ignore fd/af/authoring/components/granite/form/bindrefselector, which sadly enough isn't the only one not correctly setup by AEM Forms. It would be easier to be able to say "forms are not properly setup by AEM, just ignore things in /apps/adaptive-forms/core/fd/components/form/.*

For now, I will work around this by ignoring fd/af/authoring/components/granite/form/bindrefselector in the whitelisted resource path patterns, so not blocking, just a request for information

[kwin]

I would like to add the AEM Forms components to https://github.com/Netcentric/aem-classification/blob/master/aem-classification-maps/aem-classification-map-repo-annotations/README.md#known-incorrect-classifications, however I don't see /libs/fd/af at all in AEMaaCS. There is only node /libs/fd/expeditor but no sibling nodes. @royteeuwen Do you know by chance if adaptive forms components need to be installed separately? I couldn't find anything in https://github.com/adobe/aem-core-forms-components?tab=readme-ov-file#system-requirements...

[kwin]

The parameter whitelistedResourcePathPatterns is supposed to be evaluated as regular expression and evaluated in

aem-classification/aem-classification-validator/src/main/java/biz/netcentric/filevault/validator/aem/classification/map/ContentClassificationMapImpl.java

Line 156 in bf37eca

return whitelistedResourceTypes.stream().anyMatch(r -> r.matcher(resourcePath).matches());

. But it is evaluated against the classified resource type not against the location which contains the reference, so this is working as expected.
The readme explicitly states

The path is referring to the referenced/inherited/overlaid resource path (not the path containing the reference/supertype/overlay).

I am not sure how useful it is to just skip content validation in general for a certain part of the repo?

In my opinion either the content classification info is wrong (and should therefore be ignored no matter where /how the resource type is used) or it is correct (then excluding certain areas from validation feel wrong as well).

[royteeuwen]

I would like to add the AEM Forms components to https://github.com/Netcentric/aem-classification/blob/master/aem-classification-maps/aem-classification-map-repo-annotations/README.md#known-incorrect-classifications, however I don't see /libs/fd/af at all in AEMaaCS. There is only node /libs/fd/expeditor but no sibling nodes. @royteeuwen Do you know by chance if adaptive forms components need to be installed separately? I couldn't find anything in https://github.com/adobe/aem-core-forms-components?tab=readme-ov-file#system-requirements...

Yep, the aem-core-forms-components are components that are part of the AEM Forms add-on package (https://experienceleague.adobe.com/en/docs/experience-manager-release-information/aem-release-updates/forms-updates/aem-forms-releases) that you can download from the Software Distribution, to use it on PRO you need a separate license :).

[royteeuwen]

In my opinion either the content classification info is wrong (and should therefore be ignored no matter where /how the resource type is used) or it is correct (then excluding certain areas from validation feel wrong as well).

Indeed, by adding the validator today for the first time on an existing project of 10 years old, I noticed that there are a lot of things that are wrongly classified, like mentioned already in the other ticket as well: workflow, content fragment models, forms resource types, ...

So I was trying to fix a symptom, not the root cause (which sadly enough isn't in our control of course)

[kwin]

I would like to add the AEM Forms components to https://github.com/Netcentric/aem-classification/blob/master/aem-classification-maps/aem-classification-map-repo-annotations/README.md#known-incorrect-classifications, however I don't see /libs/fd/af at all in AEMaaCS. There is only node /libs/fd/expeditor but no sibling nodes. @royteeuwen Do you know by chance if adaptive forms components need to be installed separately? I couldn't find anything in https://github.com/adobe/aem-core-forms-components?tab=readme-ov-file#system-requirements...

Yep, the aem-core-forms-components are components that are part of the AEM Forms add-on package (https://experienceleague.adobe.com/en/docs/experience-manager-release-information/aem-release-updates/forms-updates/aem-forms-releases) that you can download from the Software Distribution, to use it on PRO you need a separate license :).

Would it make sense to provide classification maps also for the forms add on?

[royteeuwen]

Aha definitely! Didn't notice yet that they actually aren't included :). I wouldn't mind making it, but how would you propose doing it? As a separate classification map? Then the process wont be that easy because as you already noticed, the resource types are also under /libs/fd/af (and other paths), which means what I could do is make an export pre-install of the add-on and post-install and then create a sort of diff? Would sadly enough not be fully automated anymore then using the plugin :)

[kwin]

I now created an aggregate map with CIF and Forms Add On included at #40. Please have a look. I don't think this causes any harm to include in the same map, because if you don't use those, then you don't reference those resource types either.

[royteeuwen]

To come back to the initial RFI, I did find a "valid case" (i think) on when you would like to have the possibility to list the resource that is using the resource type:

• We have a custom "my-site/components/reference" component that uses the pathbrowser, so that you can select a node on a page
• The pathbrowser is deprecated (part of the INTERNAL_DEPRECATED) and should no longer be used
• In this case, I only want that components/reference to use it, but no other component should use it, they should all use the /pathfield resource type instead

In the current way, I can't keep the problem from "spreading", and using the pathfield for the reference component would make it unusable because that one only allows pages to be selected

[kwin]

Sounds legit. Can you come up with a PR for it?