FEATURE: Add additionalParams to ConvertUrisImplementation

[jonnitto]

If you create newsletter with Neos, it is crucial to have some additional parameters like utm_source, utm_medium and utm_campaign to every link. This change enables the ConvertUrisImplementation to have additionalParams.

prototype(Neos.Neos:ConvertUris) {
    absolute = true
    forceConversion = true
    additionalParams {
         utm_source = 'newsletter'
         utm_medium = 'email'
         utm_campaign = ${node.label}
    }
}

[bwaidelich]

We mix that in other parts already, but additionalParams != query arguments.
IMO we should keep the routing part to the UriBuilder and don't mess with the resolved URI "manually".
Depending on your routing setup the resolved URL could already contain query arguments so appending additional ones with ?... would not work.
Instead we should probably extend LinkingService::resolveNodeUri() such that it can accept additional arguments that it passes to

neos-development-collection/Neos.Neos/Classes/Service/LinkingService.php

Line 245 in 1427f95

public function createNodeUri(ControllerContext $controllerContext, $node = null, NodeInterface $baseNode = null, $format = null, $absolute = false, array $arguments = [], $section = '', $addQueryString = false, array $argumentsToBeExcludedFromQueryString = [], $resolveShortcuts = true): string

I also wonder if those arguments are always to be appended to node and asset links.

[markusguenther]

Something new about this PR? It seems like an ongoing discussion :)

[markusguenther]

Can we find a solution here? As we have feature freeze tomorrow ;)

[bwaidelich]

Can we find a solution here?

I still stand to my suggested solution (extend LinkingService::resolveNodeUri()) but it would require proper testing and I can't take care of this atm.

To work around the limitation (i.e. to achieve what @jonnitto described in the original PR message) I would suggest to add a separate processor that just appends query parameters to already converted URLs:

@process.convertUris = Neos.Neos:ConvertUris
@process.addNewsletterQueryParams = Some.Package:AddQueryParamsToLinks {
  params {
    utm_source = 'newsletter'
    utm_medium = 'email'
    utm_campaign = ${node.label}
  }
}

[jonnitto]

I think, it won't make it into 7.3 anyway, but I will look to bring it into Neos 8 with the extended LinkingService

[markusguenther]

Are you able to work on that for 8.3?

[bwaidelich]

This might be related to neos/flow-development-collection#2744

[bwaidelich]

..and maybe #3914

[mficzel]

Not sure about this, i would rather use a custom processor for that rather than extend convertUris.

@process.convertUris = Neos.Neos:ConvertUris
@process.addTrackingParams = Vendor.Site:AddTrackingParameters {
    utm_source = 'newsletter'
    utm_medium = 'email'
    utm_campaign = ${node.label}
}

Could be distributed as package for reusability so imho there is no need to support this directly from the core.

Just seen that Bastian already suggested a custom processor for that. So i second that

[Sebobo]

@jonnitto you want to take another try at this or should we close it?