Add Two New segments

[peterhashair]

Description:

Fixes: #15985

Add Two New segment Order Revenue (Ecommerce). Revenue left in cart (Ecommerce)

Review

• Functional review done
• Potential edge cases thought about (behavior of the code with strange input, with strange internal state or possible interactions with other Matomo subsystems)
• Usability review done (is anything maybe unclear or think about anything that would cause people to reach out to support)
• Security review done
• Wording review done
• Code review done
• Tests were added if useful/possible
• Reviewed for breaking changes
• Developer changelog updated if needed
• Documentation added if needed
• Existing documentation updated if needed

[peterhashair]

Revenue left in the cart still needs a condition on the query, but not sure how to do that. I notice lists of segments maybe needs a update as well https://developer.matomo.org/api-reference/reporting-api-segmentation

[sgiehl]

@peterhashair Adding new column classes has a lot bigger impact than you may think. At least the way it is currently done. Having methods to update the column values shouldn't be needed here at all, as that would duplicate code.
I guess the simplest solution would be to overwrite the configureSegments method in the class Piwik\Plugins\Ecommerce\Columns\Revenue and add both segments there. Btw. Revenue left in cart might be selectable using the idGoal IDGOAL_CART

[peterhashair]

@sgiehl thanks for the hints, I am still struggling to add an extra condition idGoal =-1, not sure where is the best place to put that, should I make a new Columns and update in getDbDiscriminator function?

[sgiehl]

@peterhashair Unfortunately this one won't be easy. the getDbDiscriminator method is actually only used for the CustomReports plugin. So it won't have any effect on segments. I would need to have a closer look at that as well to provide a detailed solution. But I would start checking if we can use a segment sqlFilter for that.

[peterhashair]

@sgiehl I think somehow it works. but on the bulk tests, TwoVisitsWithCustomVariablesSegmentMatchNONETest::testApi. Somewhere bind map to a wrong field, still trying to fight out why.

[sgiehl]

@peterhashair You need to "transform" the $matchType parameter. In the segment definition it is ==, but in SQL it would need to be =. You can find something similar in the Segment class of MediaAnalytics plugin for example.

[peterhashair]

@sgiehl I think this is working. But not sure where should I document this.

[sgiehl]

This doesn't work correctly yet.

[sgiehl]

Have you actually checked/tested you changes once? Looking at the failing tests you would have noticed that the ones with the new segments are failing.

[peterhashair]

@sgiehl sorry, should be fixed now.

[sgiehl]

@peterhashair Seems that is working now. Regarding documentation. The segment listing doesn't need an update, as it is included from demo.matomo.cloud. See https://github.com/matomo-org/developer-documentation/blob/live/docs/4.x/reporting-api-segmentation.md
So once, that was deployed, the list will be updated automatically.

A general documentation around segmentation would also be good to have. Currently it seems there is none, so I have created matomo-org/developer-documentation#630. Feel free to pick that one and start adding a new documentation with the findings you had while developing this issue.