matomo-org/matomo

Output Segment ID or Name with Exception

Open

#18,436 opened on Dec 2, 2021

View on GitHub
 (6 comments) (0 reactions) (0 assignees)PHP (21,513 stars) (2,847 forks)batch import
Easier debuggingEnhancementHelp wantedc: Platform

Description

When users run a database update and have segments that use unsupported segment conditions (For example when a plugin was removed or a dimension disabled) it results in an exception during the database upgrade.

For example, when a dimension is disabled but used in a segment we will see the following sort of error:

./console core:update --yes -vvv
*** Update ***
Database Upgrade Required
Your Matomo database is out-of-date, and must be upgraded before you can continue.
Matomo database will be upgraded from version 4.5.0 to the new version 4.6.1.

ERROR [2021-12-01 11:47:55] 51704 Uncaught exception: /matomo/core/Segment.php(215): Segment 'dimension1' is not a supported segment. [Query: , CLI mode: 1]
DEBUG [2021-12-01 11:47:55] 51704 Loaded plugins: (...)

[Exception]
Segment 'dimension1' is not a supported segment.

Exception trace:
(...)

It would be much easier to troubleshoot if we were to output the Segment name or Segment ID that has the unsupported condition.

Contributor guide

Tech stack
None
Domain
backenddatabase
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Matomo segmentationPHP error handling
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The error occurs in /matomo/core/Segment.php around line 215. The fix should output the segment ID or name in the exception message. Review the exception handling code and add the missing information. No linked PRs or maintainer response yet.